Skip to content

MQE-1463: Fixes for Suite documentation in devdocs #517

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Dec 3, 2019
Merged

MQE-1463: Fixes for Suite documentation in devdocs #517

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0cdb294
MQE-1463: Fixes for Suite documentation in devdocs
tomreece Dec 2, 2019
9aeb0e3
Merge branch 'develop' into MQE-1463
KevinBKozan Dec 2, 2019
1471d80
Grammar and formatting
dobooth Dec 2, 2019
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
9 changes: 4 additions & 5 deletions docs/suite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ Suites are essentially groups of tests that run in the specific conditions (prec
They enable you including, excluding, and grouping tests for a customized test run when you need it.
You can form suites using separate tests, groups, and modules.

Each suite must be defined in the `<magento 2 root>/dev/tests/acceptance/tests/_suite/suite.xml` file.
The generated tests for each suite go into a separate directory under `<magento 2 root>/dev/tests/acceptance/tests/functional/Magento/FunctionalTest/_generated/`.
By default, all generated tests are stored in the _default_ suite under `.../Magento/FunctionalTest/_generated/default/`
Each suite must be defined in the `<VendorName>/<ModuleName>/Test/Mftf/Suite` directory.

The tests for each suite are generated in a separate directory under `<magento 2 root>/dev/tests/acceptance/tests/functional/Magento/FunctionalTest/_generated/`.
All tests that are not within a suite are generated in the _default_ suite at `.../Magento/FunctionalTest/_generated/default/`.

<div class="bs-callout bs-callout-info">
If a test is generated into at least one custom suite, it will not appear in the _default_ suite.
Expand Down Expand Up @@ -59,8 +60,6 @@ The code lives in one place and executes once per suite.
- Set up preconditions and postconditions using [actions] in [`<before>`] and [`<after>`] correspondingly, just similar to use in a [test].
- Clean up after suites just like after tests.
The MFTF enforces the presence of both `<before>` and `<after>` if either is present.
- Do not reference in the subsequent tests to data that was persisted in the preconditions.
Referencing to `$stepKey.field$` of these actions is not valid.

## Test writing

Expand Down