Skip to content

Commit f630b5d

Browse files
soumyausoumyau
authored
MQE-2203: Create CHANGELOG.MD entry for 3.0.0 (#748)
consolidated change log for 3.0.0
1 parent c0255ee commit f630b5d

File tree

1 file changed

+60
-98
lines changed

1 file changed

+60
-98
lines changed

Diff for: ‎CHANGELOG.md

+60-98
Original file line numberDiff line numberDiff line change
@@ -1,131 +1,93 @@
11
Magento Functional Testing Framework Changelog
22
================================================
3-
3.0.0 RC5
4-
---------
5-
6-
### Enhancements
7-
8-
* Readability
9-
* Removed blacklist/whitelist terminology in MFTF.
10-
11-
### Fixes
12-
13-
* Fixed javascript error seen on chrome 81 for dragAndDrop action.
14-
* Fixed allure issue when `WebDriverCurlException` is encountered in `afterStep`.
15-
16-
3.0.0 RC4
3+
3.0.0
174
---------
185

196
### Enhancements
207

218
* Customizability
9+
* Introduced MFTF helpers `<helper>` to create custom actions outside of MFTF.[See custom-helpers page for details](./docs/custom-helpers.md)
10+
* Removed deprecated actions `<executeSelenium>` and `<performOn>`.
2211
* `<group value="skip"/>` no longer skips a test. Instead, the test is added to the `skip` group.
23-
* Maintainability
24-
* `mftf.log` no longer includes notices and warnings at test execution time.
25-
* Added the Chrome option `--ignore-certificate-errors` to `functional.suite.dist.yml`.
26-
* Traceability
27-
* Changed the `bin/mftf static-checks` error file directory from the current working directory to `TESTS_BP/tests/_output/static-results/`.
28-
* Readability
29-
* Documented [3.0.0 Backward Incompatible Changes.](./docs/backward-incompatible-changes.md)
30-
31-
### Fixes
32-
33-
* Fixed issue where an extended data entity would not merge array items. Array items should merge properly now.
34-
* Fixed issue where Chrome remains running after MFTF suite finishes.
35-
36-
3.0.0 RC3
37-
---------
38-
39-
### Enhancements
40-
41-
* Maintainability
42-
* Added support for Two-Factor Authentication (2FA). [See configure-2fa page for details](./docs/configure-2fa.md)
43-
* Added new static check `annotationsCheck` that checks and reports missing annotations in tests.
44-
* Updated `bin/mftf static-checks` command to allow executing static-checks defined in `staticRuleSet.json` by default. [See command page for details](./docs/commands/mftf.md#static-checks)
45-
* Added new upgrade script to remove unused arguments from action groups.
46-
* Added unhandledPromptBehavior driver capability for Chrome 75+ support.
47-
* Removed redundant and unused classes.
48-
49-
### Fixes
50-
51-
* Fixed issue with custom helper usage in suites.
52-
* Fixed issue with decryption of secrets during data entity creation.
53-
* Fixed issue with merging of `array` items in data entity.
54-
55-
3.0.0 RC2
56-
---------
57-
58-
### Enhancements
59-
60-
* Maintainability
61-
* Added support for PHP 7.4.
62-
* Removed support for PHP 7.2.
63-
* Added support for PHPUnit 9.
64-
* Improved assertion actions to support PHPUnit 9 changes. [See assertions page for details](./docs/test/assertions.md)
65-
* Added new actions: `assertEqualsWithDelta`, `assertNotEqualsWithDelta`, `assertEqualsCanonicalizing`, `assertNotEqualsCanonicalizing`, `assertEqualsIgnoringCase`, `assertNotEqualsIgnoringCase`.
66-
* Added new actions: `assertStringContainsString`, `assertStringNotContainsString`, `assertStringContainsStringIgnoringCase`, `assertStringNotContainsStringIgnoringCase` for string haystacks.
67-
* Removed actions: `assertInternalType`, `assertNotInternalType`, `assertArraySubset`.
68-
* Removed delta option from `assertEquals` and `assertNotEquals`.
69-
* Removed action `pauseExecution` and added `pause`. [See actions page for details](./docs/test/actions.md#pause)
70-
* Removed action `formatMoney` and added `formatCurrency`. [See actions page for details](./docs/test/actions.md#formatcurrency)
71-
* Added new static check that checks and reports references to deprecated test entities.
72-
* Bumped dependencies to support PHP/PHPUnit upgrade.
73-
74-
* Traceability
75-
* Introduced new `.env` configuration `VERBOSE_ARTIFACTS` to toggle saving attachments in Allure. [See configuration page for details](./docs/configuration.md)
7612

77-
### Fixes
78-
79-
* Fixed issue of resolving arguments of type `entity` in action groups within a custom helper.
80-
* Fixed reporting issue in output file for `testDependencies` static check.
81-
* Fixed a bug in `actionGroupArguments` static check when action group filename is missing `ActionGroup`.
82-
* Fixed issue of running suites under root `_suite` directory in Standalone MFTF.
83-
84-
### GitHub Issues/Pull Requests
85-
86-
* [#567](https://github.com/magento/magento2-functional-testing-framework/pull/567) -- log attachments for failed requests.
87-
88-
3.0.0 RC1
89-
---------
90-
91-
### Enhancements
92-
93-
* Customizability
94-
* Introduced MFTF helpers `<helper>` to create custom actions outside of MFTF.
95-
* Removed deprecated actions `<executeSelenium>` and `<performOn>`.
9613
* Maintainability
14+
* Added support for PHP 7.4.
15+
* Added support for PHPUnit 9.
16+
* Dropped support for PHP 7.0, 7.1, 7.2.
9717
* Schema updates for test entities to only allow single entity per file except Data and Metadata.
9818
* Support for sub-folders in test modules.
9919
* Removed support to read test entities from `<magento>dev/tests/acceptance/tests/functional/Magento/FunctionalTest`.
100-
* Removed support for PHP 7.0 and 7.1.
10120
* Removed file attribute for `<module>` in suiteSchema.
21+
* Removed action `pauseExecution` and added `pause`. [See actions page for details](./docs/test/actions.md#pause)
22+
* Removed action `formatMoney` and added `formatCurrency`. [See actions page for details](./docs/test/actions.md#formatcurrency)
23+
* Improved assertion actions to support PHPUnit 9 changes. [See assertions page for details](./docs/test/assertions.md)
24+
* Added new actions: `assertEqualsWithDelta`, `assertNotEqualsWithDelta`, `assertEqualsCanonicalizing`, `assertNotEqualsCanonicalizing`, `assertEqualsIgnoringCase`, `assertNotEqualsIgnoringCase`.
25+
* Added new actions: `assertStringContainsString`, `assertStringNotContainsString`, `assertStringContainsStringIgnoringCase`, `assertStringNotContainsStringIgnoringCase` for string haystacks.
26+
* Removed actions: `assertInternalType`, `assertNotInternalType`, `assertArraySubset`.
27+
* Removed delta option from `assertEquals` and `assertNotEquals`.
28+
* Added static check `deprecatedEntityUsage` that checks and reports references to deprecated test entities.
29+
* Added static check `annotations` that checks and reports missing annotations in tests.
30+
* Updated `bin/mftf static-checks` command to allow executing static-checks defined in `staticRuleSet.json` by default. [See command page for details](./docs/commands/mftf.md#static-checks)
31+
* Added support for Two-Factor Authentication (2FA). [See configure-2fa page for details](./docs/configure-2fa.md)
32+
* Added new upgrade script to remove unused arguments from action groups.
33+
* `mftf.log` no longer includes notices and warnings at test execution time.
34+
* Added unhandledPromptBehavior driver capability for Chrome 75+ support.
35+
* Added the Chrome option `--ignore-certificate-errors` to `functional.suite.dist.yml`.
36+
10237
* Traceability
103-
* Removed `--debug` option NONE to disallow ability to turn off schema validation.
38+
* Removed `--debug` option `NONE` to disallow ability to turn off schema validation.
10439
* Notices added for test entity naming convention violations.
10540
* Metadata file names changed to `*Meta.xml`.
41+
* Introduced new `.env` configuration `VERBOSE_ARTIFACTS` to toggle saving attachments in Allure. [See configuration page for details](./docs/configuration.md)
42+
* Changed the `bin/mftf static-checks` error file directory from the current working directory to `TESTS_BP/tests/_output/static-results/`.
43+
10644
* Readability
107-
* Support only nested assertion syntax [See assertions page for details](./docs/test/assertions.md)
45+
* Support only nested assertion syntax [See assertions page for details](./docs/test/assertions.md).
46+
* Documented [3.0.0 Backward Incompatible Changes](./docs/backward-incompatible-changes.md).
47+
* Removed blacklist/whitelist terminology in MFTF.
48+
10849
* Upgrade scripts added to upgrade tests to MFTF major version requirements. See upgrade instructions below.
109-
* Bumped dependencies to latest possible versions.
110-
111-
### Fixes
112-
113-
* Throw exception during generation when leaving out .url for `amOnPage`.
114-
* `request_timeout` and `connection_timeout` added to functional.suite.yml.dist.
115-
* Fixed `ModuleResolver` to resolve test modules moved out of deprecated path.
50+
* Bumped dependencies to support PHP/PHPUnit upgrade.
11651

11752
### Upgrade Instructions
11853

11954
* Run `bin/mftf reset --hard` to remove old generated configurations.
12055
* Run `bin/mftf build:project` to generate new configurations.
12156
* Run `bin/mftf upgrade:tests`. [See command page for details](./docs/commands/mftf.md#upgradetests).
12257
* After running the above command, some tests may need manually updates:
123-
* Remove all occurrences of `<executeInSelenium>` and `<performOn>`
124-
* Remove all occurrences of `<module file=""/>` from any `<suite>`s
58+
* Remove all occurrences of `<executeInSelenium>` and `<performOn>`.
59+
* Remove all occurrences of `<module file=""/>` from any `<suite>`s.
12560
* Ensure all `<assert*>` actions in your tests have a valid schema.
12661
* Lastly, try to generate all tests. Tests should all be generated as a result of the upgrades.
12762
* If not, the most likely issue will be a changed XML schema. Check error messaging and search your codebase for the attributes listed.
12863

64+
### Fixes
65+
66+
* Throw exception during generation when leaving out .url for `amOnPage`.
67+
* `request_timeout` and `connection_timeout` added to functional.suite.yml.dist.
68+
* Fixed `ModuleResolver` to resolve test modules moved out of deprecated path.
69+
* Fixed issue of resolving arguments of type `entity` in action groups within a custom helper.
70+
* Fixed reporting issue in output file for `testDependencies` static check.
71+
* Fixed a bug in `actionGroupArguments` static check when action group filename is missing `ActionGroup`.
72+
* Fixed issue of running suites under root `_suite` directory in Standalone MFTF.
73+
* Fixed issue with custom helper usage in suites.
74+
* Fixed issue with decryption of secrets during data entity creation.
75+
* Fixed issue with merging of `array` items in data entity.
76+
* Fixed issue where an extended data entity would not merge array items. Array items should merge properly now.
77+
* Fixed issue where Chrome remains running after MFTF suite finishes.
78+
* Fixed javascript error seen on Chrome 83 for dragAndDrop action.
79+
* Fixed allure issue when `WebDriverCurlException` is encountered in `afterStep`.
80+
81+
### GitHub Issues/Pull Requests
82+
83+
* [#567](https://github.com/magento/magento2-functional-testing-framework/pull/567) -- log attachments for failed requests.
84+
85+
### Demo Video links
86+
87+
* [MFTF 3.0.0 RC1](https://www.youtube.com/watch?v=z0ZaZCmnw-A&t=2s)
88+
* [MFTF 3.0.0 RC2](https://www.youtube.com/watch?v=BJOQAw6dX5o)
89+
* [MFTF 3.0.0 RC3](https://www.youtube.com/watch?v=scLb7pi8pR0)
90+
12991
2.6.3
13092
-----
13193

0 commit comments

Comments
 (0)