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

Updated docs on how to run a list of flows #99

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.idea/

24 changes: 19 additions & 5 deletions cli/test-suites-and-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

### Running multiple tests

Maestro can run a suite of tests and generate a test report at the end.
#### Using a folder

Maestro can run a suite of tests that live in a folder and generate a test report at the end.

To run a suite, point `maestro test` to a folder that contains the Flows

Expand All @@ -12,6 +14,18 @@ maestro test myFolderWithTests/

Maestro will run every flow from the directory _excluding subfolders_. The command will complete successfully if and only if all the Flows have been completed successfully.

#### Using a list of flows

Maestro can run a list of tests and generate a test report at the end.

To run a list of tests, pass to `maestro test` the Flows paths to the Flows you want to run separated by spaces:

```
maestro test myFolderWithTests/test1.yaml myFolderWithTests/test2.yaml
```

Maestro will run the flow for each file provided. The command will complete successfully if and only if all the Flows have been completed successfully.

### Generating reports

To generate a report, add a `--format` parameter to a `test` command:
Expand Down Expand Up @@ -95,10 +109,10 @@ To run your Flows in a given order, you can add the following configuration to y
```yaml
# config.yaml
executionOrder:
continueOnFailure: false # default is true
flowsOrder:
- flowA
- flowB
continueOnFailure: false # default is true
flowsOrder:
- flowA
- flowB
```

This configuration describes to Maestro the order of the Flows you want to run. The list accepts either the Flow file names (without the `.yaml` extension) or the [Flow name](https://maestro.mobile.dev/api-reference/configuration/flow-configuration).
Expand Down