diff --git a/CHANGELOG.md b/CHANGELOG.md index a41360787..1d1ae20a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ Magento Functional Testing Framework Changelog ================================================ +3.0.0 +----- +### Upgrade Instructions +* Run `bin/mftf reset --hard` to remove old generated configurations. +* Run `bin/mftf build:project` to generate new configurations. +* Run `bin/mftf upgrade:tests`. [See command page for details](./docs/commands/mftf.md#upgradetests). +* After running the above command, some tests may need manually updates: + * Remove all occurrences of `` and `` + * Remove all occurrences of `` from any ``s + * Ensure all `` actions in your tests have a valid schema. +* Lastly, try to generate all tests. Tests should all be generated as a result of the upgrades. + * If not, the most likely issue will be a changed XML schema. Check error messaging and search your codebase for the attributes listed. + 2.6.3 ----- diff --git a/docs/commands/mftf.md b/docs/commands/mftf.md index 5cdefdf54..6d2dedfd1 100644 --- a/docs/commands/mftf.md +++ b/docs/commands/mftf.md @@ -477,6 +477,10 @@ Otherwise, it will apply all the major version MFTF upgrade scripts to all insta `Test Module` should have the directory structure of ActionGroup, Data, Metadata, Page, Section, Test, and Suite. +**Note**: + +The upgrade scripts are meant to be used for Test Modules under source code control. If you have old versions of test modules under vendor, those test modules will get upgraded + #### Usage ```bash diff --git a/docs/guides/git-vs-composer-install.md b/docs/guides/git-vs-composer-install.md index 3a45e3a68..fd9006cc1 100644 --- a/docs/guides/git-vs-composer-install.md +++ b/docs/guides/git-vs-composer-install.md @@ -55,6 +55,8 @@ The file structure under both paths is the same: │   └── ... ├── Section │   └── ... +├── Suite +│   └── ... └── Test └── ... ``` @@ -65,6 +67,7 @@ With either type of installation, all tests and test data are read and merged by 1. `/app/code///Test/Mftf/` 1. `/vendor///Test/Mftf/` +1. `/dev/tests/acceptance/tests/functional///` ## Conclusion diff --git a/docs/introduction.md b/docs/introduction.md index 61c1eaef3..b68cca819 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,5 +1,10 @@ # Introduction to the Magento Functional Testing Framework +
+These are the docs for the latest MFTF release. +To find older documentation, please refer to the [docs folder] of your desired release in Github. +
+ [Find your MFTF version][] of the MFTF. The Magento Functional Testing Framework (MFTF) aims to replace the [Functional Testing Framework] in future releases. @@ -99,14 +104,14 @@ codeception.dist.yml // Codeception configuration (generated while ru ## MFTF tests -The MFTF supports two different locations for storing the tests and test artifacts: - +The MFTF supports three different locations for storing the tests and test artifacts: - `/app/code///Test/Mftf/` is the directory to create new tests. - `/vendor///Test/Mftf/` is the directory with the out of the box tests (fetched by the Composer). +- `/dev/tests/acceptance/tests/functional///` is used to store tests that depend on multiple modules. All tests and test data from these locations are merged in the order indicated in the above list. -The file structure under the both path cases is the same: +Directories immediately following the above paths will use the same format, and sub-directories under each category are supported. ```tree @@ -120,6 +125,8 @@ The file structure under the both path cases is the same: │   └── ... ├── Section │   └── ... +├── Suite +│   └── ... └── Test └── ... ``` @@ -134,3 +141,4 @@ Follow the [MFTF project] and [contribute on Github]. [MFTF project]: https://github.com/magento/magento2-functional-testing-framework [Find your MFTF version]: #find-your-mftf-version [MFTF Test Migration]: https://github.com/magento/magento-functional-tests-migration +[docs folder]: https://github.com/magento/magento2-functional-testing-framework/tree/master/docs diff --git a/docs/test/assertions.md b/docs/test/assertions.md index 17a3d194a..dfe4c3d4b 100644 --- a/docs/test/assertions.md +++ b/docs/test/assertions.md @@ -53,14 +53,13 @@ The following example shows a common test that gets text from a page and asserts Example: ```xml - + + color: #333; + ``` Attribute|Type|Use|Description ---|---|---|--- -`selector`|string|required| -`expectedValue`|string|optional| A value of the expected result. -`attribute`|string|required| `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. `after`|string|optional| `stepKey` of the preceding action. @@ -92,12 +91,7 @@ It must be in typical array format like `[1,2,3,4,5]` or `[alpha, brontosaurus, See [assertArrayHasKey docs on codeception.com](http://codeception.com/docs/modules/Asserts#assertArrayHasKey) Attribute|Type|Use|Description ----|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`message`|string|optional|Text of informational message about a cause of failure. +---|---|---|---`message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. `after`|string|optional| `stepKey` of the preceding action. @@ -108,10 +102,6 @@ See [assertArrayNotHasKey docs on codeception.com](http://codeception.com/docs/m Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -123,10 +113,6 @@ See [assertArraySubset docs on codeception.com](http://codeception.com/docs/modu Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `strict`|boolean|optional| `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. @@ -139,10 +125,6 @@ See [assertContains docs on codeception.com](http://codeception.com/docs/modules Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -154,10 +136,6 @@ See [assertCount docs on codeception.com](http://codeception.com/docs/modules/As Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -169,8 +147,6 @@ See [assertEmpty docs on codeception.com](http://codeception.com/docs/modules/As Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -182,10 +158,6 @@ See [assertEquals docs on codeception.com](http://codeception.com/docs/modules/A Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `delta`|string|optional| `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. @@ -198,8 +170,6 @@ See [assertFalse docs on codeception.com](http://codeception.com/docs/modules/As Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| Actual value. -`actualType`|assertEnum|optional| Type of actual value. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -211,8 +181,6 @@ See [assertFileExists docs on codeception.com](http://codeception.com/docs/modul Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -224,8 +192,6 @@ See [assertFileNotExists docs on codeception.com](http://codeception.com/docs/mo Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -237,10 +203,6 @@ See [assertGreaterOrEquals docs on codeception.com](http://codeception.com/docs/ Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -252,10 +214,6 @@ See [assertGreaterThan docs on codeception.com](http://codeception.com/docs/modu Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -267,10 +225,6 @@ See [assertGreaterThanOrEqual docs on codeception.com](http://codeception.com/do Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -282,10 +236,6 @@ See [assertInstanceOf docs on codeception.com](http://codeception.com/docs/modul Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -297,10 +247,6 @@ See [assertInternalType docs on codeception.com](http://codeception.com/docs/mod Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -312,8 +258,6 @@ See [assertIsEmpty docs on codeception.com](http://codeception.com/docs/modules/ Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -325,10 +269,6 @@ See [assertLessOrEquals docs on codeception.com](http://codeception.com/docs/mod Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -340,10 +280,6 @@ See [assertLessThan docs on codeception.com](http://codeception.com/docs/modules Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -355,10 +291,6 @@ See [assertLessThanOrEqual docs on codeception.com](http://codeception.com/docs/ Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -370,10 +302,6 @@ See [assertNotContains docs on codeception.com](http://codeception.com/docs/modu Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -385,8 +313,6 @@ See [assertNotEmpty docs on codeception.com](http://codeception.com/docs/modules Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -398,10 +324,6 @@ See [assertNotEquals docs on codeception.com](http://codeception.com/docs/module Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `delta`|string|optional| `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. @@ -414,10 +336,6 @@ See [assertNotInstanceOf docs on codeception.com](http://codeception.com/docs/mo Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -429,8 +347,6 @@ See [assertNotNull docs on codeception.com](http://codeception.com/docs/modules/ Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -442,10 +358,6 @@ See [assertNotRegExp docs on codeception.com](http://codeception.com/docs/module Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -457,10 +369,6 @@ See [assertNotSame docs on codeception.com](http://codeception.com/docs/modules/ Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -472,8 +380,6 @@ See [assertNull docs on codeception.com](http://codeception.com/docs/modules/Ass Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -485,10 +391,6 @@ See [assertRegExp docs on codeception.com](http://codeception.com/docs/modules/A Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -500,10 +402,6 @@ See [assertSame docs on codeception.com](http://codeception.com/docs/modules/Ass Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -515,10 +413,6 @@ See [assertStringStartsNotWith docs on codeception.com](http://codeception.com/d Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -530,10 +424,6 @@ See [assertStringStartsWith docs on codeception.com](http://codeception.com/docs Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -545,8 +435,6 @@ See [assertTrue docs on codeception.com](http://codeception.com/docs/modules/Ass Attribute|Type|Use|Description ---|---|---|--- -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `message`|string|optional|Text of informational message about a cause of failure. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. @@ -558,10 +446,6 @@ See [expectException docs on codeception.com](http://codeception.com/docs/module Attribute|Type|Use|Description ---|---|---|--- -`expected`|string|required| A value of the expected result. -`expectedType`|string|optional| A type of the expected result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. -`actual`|string|required| A value of the actual result. -`actualType`|string|optional| A type of the actual result. Possible values: `const` (default), `int`, `float`, `bool`, `string`, `variable`, `array`. `stepKey`|string|required| A unique identifier of the text step. `before`|string|optional| `stepKey` of action that must be executed next. `after`|string|optional| `stepKey` of the preceding action. diff --git a/docs/update.md b/docs/update.md deleted file mode 100644 index 129742346..000000000 --- a/docs/update.md +++ /dev/null @@ -1,79 +0,0 @@ -# Update the Magento Functional Testing Framework - -
-[Find your version][] of the MFTF. - -The latest Magento 2.3 release supports MFTF 2.3.13. -The latest Magento 2.2 release supports MFTF 2.3.8. -
- -Magento tests and the framework are stored in different repositories. - -Magento tests are stored in the same repository as the Magento code base. -When you pull changes in the Magento code, you're potentially pulling corresponding tests as well. - -The MFTF is installed separately as a dependency using Composer. -When pulling the latest Magento code, update the corresponding Composer dependencies in the `magento2` root directory. -This ensures that the MFTF is up to date. - -## Update the MFTF from 2.3.x - -To update the MFTF to the latest patch: - -1. Verify that the Magento [WYSIWYG settings][] and [Security settings][] are set appropriately. -1. Check details about backward incompatible changes in the [Changelog][] and update your new or customized tests. -1. Get the latest framework version using Composer: - - ```bash - composer update - ``` - -1. Generate the updated tests: - - ```bash - vendor/bin/mftf generate:tests - ``` - -## Update the MFTF from 2.2 - -To update the MFTF from the previous minor version: - -1. When you update Magento, verify that the Magento [WYSIWYG settings][] and [Security settings][] are set appropriately. -1. Starting at the `magento2/` root directory remove the `vendor/` directory: - - ```bash - rm -rf vendor/ - ``` - -1. Get the latest framework version from the Composer dependencies: - - ```bash - composer install - ``` - -1. Run the `upgrade:tests` using the new command line tool: - - ```bash - vendor/bin/mftf upgrade:tests app - ``` - -1. If you are using Phpstorm, update the urn catalog: - - ```bash - vendor/bin/mftf generate:urn-catalog .idea/ - ``` - -1. Update your own tests, including data, metadata, and so on, if they contain tags that are unsupported in the newer version. - - Check details about backward incompatible changes and review new MFTF release documentation in the [Changelog][]. - -1. Generate newly pulled tests: - - ```bash - vendor/bin/mftf generate:tests - ``` - - -[Changelog]: https://github.com/magento/magento2-functional-testing-framework/blob/master/CHANGELOG.md -[WYSIWYG settings]: getting-started.md#wysiwyg-settings -[Security settings]: getting-started.md#security-settings