Skip to content

Commit ece0f58

Browse files
authored
Formatting changes
1 parent 11a250d commit ece0f58

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/guides/test-isolation.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
# Test Isolation
22

3-
Since MFTF is a framework for testing a highly customizable and ever changing application, MFTF tests need to be properly isolated.
3+
Because MFTF is a framework for testing a highly customizable and ever changing application, MFTF tests need to be properly isolated.
44

55
## What is test isolation?
66

7-
Test isolation refers to a test that does not leave behind any data or configurations in the Magento instance.
7+
Test isolation refers to a test that does not leave behind any data or configuration changes in the Magento instance.
88

9-
An MFTF test is considered fully isolated if
9+
An MFTF test is considered fully isolated if:
1010

1111
1. It does not leave data behind.
12-
2. It does not leave Magento configured in a different state than when the test started.
13-
3. It does not affect a following test's outcome.
14-
4. It does not rely on an irregular configuration to start its preconditions.
12+
1. It does not leave Magento configured in a different state than when the test started.
13+
1. It does not affect a following test's outcome.
14+
1. It does not rely on an irregular configuration to start its preconditions.
1515

16-
### Deleting versus Restoring
16+
### Deleting versus restoring
1717

18-
In the above list, points 1 and 2 refer to leaving things behind during test execution. This means you will be either deleting or restoring entities in Magento after your test's execution.
18+
In the above list, points 1 and 2 refer to leaving things behind during test execution. This means you are either deleting or restoring entities in Magento after your test's execution.
1919

2020
Some examples of entities to be deleted include:
21+
2122
1. Products
22-
2. Categories
23-
3. Rules (Price, Related Products)
23+
1. Categories
24+
1. Rules (Price, Related Products)
2425

2526
The list of entities to restore is much simpler:
27+
2628
1. Application Configuration
2729

2830
The distinction above is because MFTF tests expect the environment to be in a completely clean state, outside of a test or suite's preconditions. Data must be cleaned up and any application configuration must go back to the default.
@@ -115,5 +117,3 @@ A test's workflow can also alter the application's configuration, and much like
115117
```
116118

117119
One thing to note, unless a test is specifically testing the configuration page's frontend capabilities, configuring the application should always be done with a `<magentoCLI>` action.
118-
119-
<!-- Link definitions -->

0 commit comments

Comments
 (0)