Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 How to trigger Android tests? #30

Merged
merged 2 commits into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ coverage

# custom
temp
.DS_Store
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,18 @@ You can also use a reusable workflow to enable this action in your repository de

## Use the Action to trigger a new test on TestIO from a PR

To trigger a test on TestIO multiple steps are required:
We highly recommend creating a separate product in your TestIO account dedicated to test creation from a PR.
This avoids interference with the tests in your main product(s).
You can easily achieve that via the menu as can be seen in the following screenshot.

<img src="docs/assets/images/testio-create-product.png" alt="create new TestIO product" />

### For the Default Devices in Your Account

In the product you dedicate for triggering tests from PRs we recommend configuring the default devices so that
they correspond to your required Desktop test environments. Refer to the [FAQs](#faqs) how to achieve this.

To trigger a test on TestIO for your default devices the following steps are required:

1. Add the comment `@bot-testio exploratory-test create` to the PR from which the test should be triggered.
<img src="docs/assets/images/test-create.png" alt="create test comment" />
Expand All @@ -64,6 +75,36 @@ To trigger a test on TestIO multiple steps are required:
5. This triggers the test on TestIO and successful creation is commented back as a new comment.
<img src="docs/assets/images/test-success.png" alt="success test comment" />

### For Android Devices

To trigger a test on TestIO explicitly for Android devices the same steps as described for [Default Devices](#for-the-default-devices-in-your-account)
need to be followed but with the following small adjustment:

- The comment to be added to trigger the whole process from step 1 needs to be `@bot-testio exploratory-test create android`.
- In addition to the other requested information you now need to provide the following:
```json
"native": {
"android": {
"min": 8,
"max": 10
}
}
```
- You need to provide minimal and maximum Android version of devices the testers should use.
- Only `integer` values are allowed.
- `min` is mandatory and `max` optional.
- If `max` is not provided TestIO automatically sets it to `latest`.

## FAQs

<details>
<summary>How/Where to configure the default devices on TestIO?</summary>
Find the Default Devices in the menu as can be seen in the following screenshot.

<img src="docs/assets/images/testio-manage-default-devices.png" alt="manage default TestIO devices" />

</details>

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
Expand Down
Binary file added docs/assets/images/testio-create-product.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.