From f89a7da98945d6207c4cd50699f2594c81cf2304 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Tue, 30 Aug 2022 10:52:24 -0500 Subject: [PATCH 1/7] Added migration metadata to docs --- docs/backward-incompatible-changes.md | 5 +++++ docs/best-practices.md | 7 +++++- docs/commands/codeception.md | 5 +++++ docs/commands/mftf.md | 5 +++++ docs/configuration.md | 5 +++++ docs/configure-2fa.md | 5 +++++ docs/credentials.md | 5 +++++ docs/custom-helpers.md | 7 +++++- docs/data.md | 5 +++++ docs/debugging.md | 5 +++++ docs/extending.md | 5 +++++ docs/getting-started.md | 5 +++++ docs/guides/action-groups.md | 5 +++++ docs/guides/cicd.md | 5 +++++ docs/guides/git-vs-composer-install.md | 5 +++++ docs/guides/selectors.md | 9 ++++++-- docs/guides/test-isolation.md | 5 +++++ docs/guides/test-modularity.md | 5 +++++ docs/guides/using-suites.md | 5 +++++ docs/interactive-pause.md | 5 +++++ docs/introduction.md | 5 +++++ docs/merge_points/extend-action-groups.md | 5 +++++ docs/merge_points/extend-data.md | 5 +++++ docs/merge_points/extend-tests.md | 5 +++++ docs/merge_points/introduction.md | 5 +++++ docs/merge_points/merge-action-groups.md | 5 +++++ docs/merge_points/merge-data.md | 5 +++++ docs/merge_points/merge-pages.md | 5 +++++ docs/merge_points/merge-sections.md | 5 +++++ docs/merge_points/merge-tests.md | 5 +++++ docs/merging.md | 5 +++++ docs/metadata.md | 5 +++++ docs/mftf-tests-packaging.md | 5 +++++ docs/page.md | 5 +++++ docs/reporting.md | 5 +++++ docs/section.md | 5 +++++ docs/section/locator-functions.md | 5 +++++ docs/section/parameterized-selectors.md | 5 +++++ docs/selectors.md | 5 +++++ docs/suite.md | 5 +++++ docs/test-prep.md | 17 +++++++++----- docs/test.md | 5 +++++ docs/test/action-groups.md | 5 +++++ docs/test/actions.md | 7 +++++- docs/test/annotations.md | 5 +++++ docs/test/assertions.md | 27 ++++++++++++++--------- docs/tips-tricks.md | 5 +++++ docs/troubleshooting.md | 5 +++++ docs/update.md | 5 +++++ docs/versioning.md | 5 +++++ 50 files changed, 272 insertions(+), 22 deletions(-) diff --git a/docs/backward-incompatible-changes.md b/docs/backward-incompatible-changes.md index 5ddf1c9cb..4000ccb34 100644 --- a/docs/backward-incompatible-changes.md +++ b/docs/backward-incompatible-changes.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/backward-incompatible-changes/ +layout: migrated +--- + # MFTF 3.0.0 backward incompatible changes This page highlights backward incompatible changes between releases that have a major impact and require detailed explanation and special instructions to ensure third-party tests continue working with Magento core tests. diff --git a/docs/best-practices.md b/docs/best-practices.md index 1f3a25e02..d320dba16 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/best-practices/ +layout: migrated +--- + # Best practices Check out our best practices below to ensure you are getting the absolute most out of the Magento Functional Testing Framework. @@ -85,7 +90,7 @@ The following pattern is used when merging with `extends`: Use a corresponding [``] test step in your [``] block when using a [``] action in a [``] block. 2. Make specific data entries under test to be unique. Enable data uniqueness where data values are required to be unique in a database by test design. - Use `unique=”suffix”` or `unique=”prefix”` to append or prepend a unique value to the [entity] attribute. + Use `unique="suffix"` or `unique="prefix"` to append or prepend a unique value to the [entity] attribute. This ensures that tests using the entity can be repeated. 3. Do not modify existing data entity fields or merge additional data fields without complete understanding and verifying the usage of existing data in tests. Create a new data entity for your test if you are not sure. diff --git a/docs/commands/codeception.md b/docs/commands/codeception.md index 8e6d76c11..2f112c25d 100644 --- a/docs/commands/codeception.md +++ b/docs/commands/codeception.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/codeception/ +layout: migrated +--- + # CLI commands: vendor/bin/codecept
diff --git a/docs/commands/mftf.md b/docs/commands/mftf.md index 4b4bb4bab..a9c242a69 100644 --- a/docs/commands/mftf.md +++ b/docs/commands/mftf.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf/ +layout: migrated +--- + # CLI commands: vendor/bin/mftf The Magento Functional Testing Framework (MFTF) introduces the command line interface (CLI) tool `vendor/bin/mftf` to facilitate your interaction with the framework. diff --git a/docs/configuration.md b/docs/configuration.md index 501b1d5e9..c17c2d9af 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/configuration/ +layout: migrated +--- + # Configuration The `*.env` file provides additional configuration for the Magento Functional Testing Framework (MFTF). diff --git a/docs/configure-2fa.md b/docs/configure-2fa.md index 7b01913b9..08b3d9273 100644 --- a/docs/configure-2fa.md +++ b/docs/configure-2fa.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/two-factor-authentication/ +layout: migrated +--- + # Configuring MFTF for Two-Factor Authentication (2FA) Using two-factor authentication (2FA) with MFTF is possible with some configurations settings in Magento. diff --git a/docs/credentials.md b/docs/credentials.md index 56f1ddbc4..bd71550be 100644 --- a/docs/credentials.md +++ b/docs/credentials.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/credentials/ +layout: migrated +--- + # Credentials When you test functionality that involves external services such as UPS, FedEx, PayPal, or SignifyD, diff --git a/docs/custom-helpers.md b/docs/custom-helpers.md index bf1ebc572..b0aba01c3 100644 --- a/docs/custom-helpers.md +++ b/docs/custom-helpers.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/custom-helpers/ +layout: migrated +--- + # Custom Helpers
@@ -37,7 +42,7 @@ This functionality is used to select text on the page and cannot be accomplished ```php ` entities defined in XML. Default `` entities are provided for use and as templates for entity creation and manipulation. diff --git a/docs/debugging.md b/docs/debugging.md index be17e952a..b4dbde2b3 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/debugging/ +layout: migrated +--- + # Debugging Debugging within the Magento Functional Testing Framework is helpful in identifying test bugs by allowing you to pause execution so that you may: diff --git a/docs/extending.md b/docs/extending.md index 576bfdb24..a901249f4 100644 --- a/docs/extending.md +++ b/docs/extending.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/extending/ +layout: migrated +--- + # Extending There are cases when you need to create many tests that are very similar to each other. diff --git a/docs/getting-started.md b/docs/getting-started.md index 87cb04f79..f8644f92d 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started/ +layout: migrated +--- + # Getting started
diff --git a/docs/guides/action-groups.md b/docs/guides/action-groups.md index 30c531e4e..fe635b4dd 100644 --- a/docs/guides/action-groups.md +++ b/docs/guides/action-groups.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/action-group-best-practices/ +layout: migrated +--- + # Action Group Best Practices We strive to write tests using only action groups. Fortunately, we have built up a large set of action groups to get started. We can make use of them and extend them for our own specific needs. In some cases, we may never even need to write action groups of our own. We may be able to simply chain together calls to existing action groups to implement our new test case. diff --git a/docs/guides/cicd.md b/docs/guides/cicd.md index 80cf134d8..1933a9da3 100644 --- a/docs/guides/cicd.md +++ b/docs/guides/cicd.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/cicd/ +layout: migrated +--- + # How to use MFTF in CICD To integrate MFTF tests into your CICD pipeline, it is best to start with the conceptual flow of the pipeline code. diff --git a/docs/guides/git-vs-composer-install.md b/docs/guides/git-vs-composer-install.md index fd9006cc1..61b9f882b 100644 --- a/docs/guides/git-vs-composer-install.md +++ b/docs/guides/git-vs-composer-install.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/git-vs-composer-install/ +layout: migrated +--- + # Git vs Composer installation of Magento with MFTF Depending on how you plan to use Magnto code, there are different options for installing Magento. diff --git a/docs/guides/selectors.md b/docs/guides/selectors.md index d1441865a..98dadba9a 100644 --- a/docs/guides/selectors.md +++ b/docs/guides/selectors.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors/ +layout: migrated +--- + # How To write good selectors Selectors are the atomic unit of test writing. They fit into the hierarchy like this: MFTF tests make use of action groups > which are made up of actions > which interact with page objects > which contain elements > which are specified by selectors. Because they are fundamental building blocks, we must take care when writing them. @@ -213,7 +218,7 @@ Similarly, the relative XPath selector is a double forward slash `//`. It is use Example: ```xpath -//div[@class=’form-group’]//input[@id='user-message'] +//div[@class='form-group']//input[@id='user-message'] ``` In the `GOOD` example above, all `
` elements in the DOM are matched first. Then all `` with `
` as one of its parents are matched. The parent does not have to immediately precede it since it uses another double forward slash `//`. @@ -247,7 +252,7 @@ Given this HTML: ```html - Edit + Edit
Unique Value
diff --git a/docs/guides/test-isolation.md b/docs/guides/test-isolation.md index 474867ff2..1841b1df3 100644 --- a/docs/guides/test-isolation.md +++ b/docs/guides/test-isolation.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/test-isolation/ +layout: migrated +--- + # Test Isolation Because MFTF is a framework for testing a highly customizable and ever changing application, MFTF tests need to be properly isolated. diff --git a/docs/guides/test-modularity.md b/docs/guides/test-modularity.md index ed182313e..c6ddfbf50 100644 --- a/docs/guides/test-modularity.md +++ b/docs/guides/test-modularity.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/test-modularity/ +layout: migrated +--- + # Test Modularity One of MFTF's most distinguishing functionalities is the framework's modularity. diff --git a/docs/guides/using-suites.md b/docs/guides/using-suites.md index 99413cb78..265aabcfb 100644 --- a/docs/guides/using-suites.md +++ b/docs/guides/using-suites.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/using-suites/ +layout: migrated +--- + # Using suites With an increasing number of MFTF tests, it is important to have a mechanism to organize and consolidate them for ease-of-use. diff --git a/docs/interactive-pause.md b/docs/interactive-pause.md index 5914c6339..8d20d6e45 100644 --- a/docs/interactive-pause.md +++ b/docs/interactive-pause.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/interactive-pause/ +layout: migrated +--- + # Interactive Pause It can be difficut to write a successful test on the first attempt. You will need to try different commands, with different arguments, before you find the correct path. diff --git a/docs/introduction.md b/docs/introduction.md index 73b068ba0..c2dfcf3bb 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/ +layout: migrated +--- + # Introduction to the Magento Functional Testing Framework
diff --git a/docs/merge_points/extend-action-groups.md b/docs/merge_points/extend-action-groups.md index 6e7a54d70..fc988b075 100644 --- a/docs/merge_points/extend-action-groups.md +++ b/docs/merge_points/extend-action-groups.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-action-groups/ +layout: migrated +--- + # Extend action groups Extending an action group doesn't affect the existing action group. diff --git a/docs/merge_points/extend-data.md b/docs/merge_points/extend-data.md index 91d2a67bb..0ac84d4e6 100644 --- a/docs/merge_points/extend-data.md +++ b/docs/merge_points/extend-data.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-data/ +layout: migrated +--- + # Extend data entities Extending a data entity does not affect the existing data entity. diff --git a/docs/merge_points/extend-tests.md b/docs/merge_points/extend-tests.md index 763977049..1c06948d2 100644 --- a/docs/merge_points/extend-tests.md +++ b/docs/merge_points/extend-tests.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-tests/ +layout: migrated +--- + # Extend tests Tests can be extended to cover the needs of your extension. diff --git a/docs/merge_points/introduction.md b/docs/merge_points/introduction.md index af03dade6..e62785b54 100644 --- a/docs/merge_points/introduction.md +++ b/docs/merge_points/introduction.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/ +layout: migrated +--- + # Merge Points for testing extensions in MFTF The Magento Functional Testing Framework (MFTF) allows great flexibility when writing XML tests for extensions. diff --git a/docs/merge_points/merge-action-groups.md b/docs/merge_points/merge-action-groups.md index ca6d20e68..4eecd5c32 100644 --- a/docs/merge_points/merge-action-groups.md +++ b/docs/merge_points/merge-action-groups.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-action-groups/ +layout: migrated +--- + # Merge action groups An action group is a set of individual actions working together as a group. diff --git a/docs/merge_points/merge-data.md b/docs/merge_points/merge-data.md index b3342cc46..083fce236 100644 --- a/docs/merge_points/merge-data.md +++ b/docs/merge_points/merge-data.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-data/ +layout: migrated +--- + # Merge data Data objects can be merged to cover the needs of your extension. diff --git a/docs/merge_points/merge-pages.md b/docs/merge_points/merge-pages.md index c7a3e8fa8..e9c86475c 100644 --- a/docs/merge_points/merge-pages.md +++ b/docs/merge_points/merge-pages.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-pages/ +layout: migrated +--- + # Merge pages Sections can be merged into pages to cover your extension. diff --git a/docs/merge_points/merge-sections.md b/docs/merge_points/merge-sections.md index 135b3f7d8..13226b150 100644 --- a/docs/merge_points/merge-sections.md +++ b/docs/merge_points/merge-sections.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-sections/ +layout: migrated +--- + # Merge sections Sections can be merged together to cover your extension. diff --git a/docs/merge_points/merge-tests.md b/docs/merge_points/merge-tests.md index b9e50d296..6555c2803 100644 --- a/docs/merge_points/merge-tests.md +++ b/docs/merge_points/merge-tests.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-tests/ +layout: migrated +--- + # Merge tests Tests can be merged to create a new test that covers new extension capabilities. diff --git a/docs/merging.md b/docs/merging.md index d8436492e..fcda9c45e 100644 --- a/docs/merging.md +++ b/docs/merging.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merging/ +layout: migrated +--- + # Merging MFTF allows you to merge test components defined in XML files, such as: diff --git a/docs/metadata.md b/docs/metadata.md index 414f4bc04..ae7e0878a 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata/ +layout: migrated +--- + # Metadata In this topic we talk about handling entities that you need in your tests (such as categories, products, wish lists, and similar) using MFTF. diff --git a/docs/mftf-tests-packaging.md b/docs/mftf-tests-packaging.md index 8a37b8013..59b36a068 100644 --- a/docs/mftf-tests-packaging.md +++ b/docs/mftf-tests-packaging.md @@ -1,3 +1,8 @@ +--- +migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/mftf-tests-packaging/ +layout: migrated +--- +