Skip to content

Commit b686548

Browse files
authored
Grammar and formatting
1 parent 7c0309f commit b686548

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/test.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Test
22

33
Test cases in the Magento Functional Testing Framework (MFTF) are defined in XML as [`<tests>`].
4-
`<tests>` is a [Codeception test container][Codeception] that contains individual test [`<test>`] with it's metadata ([`<annotations>`]), before ([`<before>`]) and after ([`<after>`]) section.
4+
`<tests>` is a [Codeception test container][Codeception] that contains individual test [`<test>`] with its metadata ([`<annotations>`]), before ([`<before>`]) and after ([`<after>`]) section.
55

66
MFTF `<test>` is considered a sequence of actions with associated parameters.
77
Any failed [assertion] within a test constitutes a failed test.
@@ -18,7 +18,7 @@ The following diagram shows the structure of an MFTF test case:
1818

1919
## Format
2020

21-
The format of Test XML file is:
21+
The format of a test XML file is:
2222

2323
```xml
2424
<?xml version="1.0" encoding="UTF-8"?>
@@ -35,7 +35,6 @@ The format of Test XML file is:
3535
<after>
3636
<!-- ACTIONS AND ACTION GROUPS PERFORMED AFTER THE TEST -->
3737
</after>
38-
3938
<!-- TEST ACTIONS, ACTION GROUPS, AND ASSERTIONS-->
4039
</test>
4140
</tests>
@@ -47,13 +46,13 @@ The following conventions apply to MFTF tests:
4746

4847
* One `<test>` tag is allowed per test XML file.
4948
* All names within the framework are in the **PascalCase** format and must be alphanumeric.
50-
* Each action and action group call has its own identifier `<stepKey>` for reference purposes.
49+
* Each action and action group call should have its own identifier `<stepKey>`.
5150
* A test may have any number of [assertions][assertion] at any point within the `<test>`.
5251
* If `<test>` is included in [`<suite>`][suites], it **cannot be generated in isolation** from `<before>` and `<after>` section of the suite (see [suites] for details).
5352

5453
## Elements reference
5554

56-
There are several XML elements that are used in `<test>` in the MFTF.
55+
There are several XML elements that are used within `<test>` in the MFTF.
5756

5857
### tests {#tests-tag}
5958

@@ -92,7 +91,7 @@ Allure annotations provide metadata for reporting.
9291

9392
### after {#after-tag}
9493

95-
`<after>` wraps the steps to perform after the [`<test>`]. The steps are run in both successful **and** failed test runs. The goal of this section is to perform cleanup (revert the environment to the pre-test state).
94+
`<after>` wraps the steps to perform after the [`<test>`]. The steps are run in both successful **and** failed test runs. The goal of this section is to perform cleanup (revert the environment to the pre-test state).
9695

9796
`<after>` may contain:
9897

0 commit comments

Comments
 (0)