diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4a567c7c4..f54e1b395 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -3,7 +3,10 @@ name: CI -on: [pull_request] +on: + pull_request: + paths-ignore: + - 'docs/**' jobs: unit-tests: diff --git a/docs/backward-incompatible-changes.md b/docs/backward-incompatible-changes.md index 5ddf1c9cb..5ee285941 100644 --- a/docs/backward-incompatible-changes.md +++ b/docs/backward-incompatible-changes.md @@ -1,3 +1,9 @@ +--- +title: MFTF 3.0.0 backward incompatible changes +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/backward-incompatible-changes/ +status: 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..ec6237b1c 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -1,3 +1,9 @@ +--- +title: Best practices +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/best-practices/ +status: 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 +91,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..1905d7a1e 100644 --- a/docs/commands/codeception.md +++ b/docs/commands/codeception.md @@ -1,3 +1,9 @@ +--- +title: CLI commands - vendor/bin/codecept +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/codeception/ +status: migrated +--- + # CLI commands: vendor/bin/codecept
diff --git a/docs/commands/mftf.md b/docs/commands/mftf.md index 4b4bb4bab..4cfbdab93 100644 --- a/docs/commands/mftf.md +++ b/docs/commands/mftf.md @@ -1,3 +1,9 @@ +--- +title: CLI commands - vendor/bin/mftf +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf/ +status: 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..fff885e1f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,3 +1,9 @@ +--- +title: Configuration +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/configuration/ +status: 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..783e9e360 100644 --- a/docs/configure-2fa.md +++ b/docs/configure-2fa.md @@ -1,3 +1,9 @@ +--- +title: Configuring MFTF for two-factor authentication (2FA) +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/two-factor-authentication/ +status: 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..dc77cdb39 100644 --- a/docs/credentials.md +++ b/docs/credentials.md @@ -1,3 +1,9 @@ +--- +title: Credentials +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/credentials/ +status: 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..d6647705f 100644 --- a/docs/custom-helpers.md +++ b/docs/custom-helpers.md @@ -1,3 +1,9 @@ +--- +title: Custom helpers +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/custom-helpers/ +status: migrated +--- + # Custom Helpers
@@ -37,7 +43,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..ad4fe33ee 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -1,3 +1,9 @@ +--- +title: Debugging +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/debugging/ +status: 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..9672c0732 100644 --- a/docs/extending.md +++ b/docs/extending.md @@ -1,3 +1,9 @@ +--- +title: Extending +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/extending/ +status: 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..efdd16dbc 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,3 +1,9 @@ +--- +title: Getting started +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started/ +status: migrated +--- + # Getting started
diff --git a/docs/guides/action-groups.md b/docs/guides/action-groups.md index 30c531e4e..354ae707d 100644 --- a/docs/guides/action-groups.md +++ b/docs/guides/action-groups.md @@ -1,3 +1,9 @@ +--- +title: Action group best practices +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/action-group-best-practices/ +status: 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..985a5123f 100644 --- a/docs/guides/cicd.md +++ b/docs/guides/cicd.md @@ -1,3 +1,9 @@ +--- +title: How to use MFTF in CICD +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/cicd/ +status: 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..bf24ed219 100644 --- a/docs/guides/git-vs-composer-install.md +++ b/docs/guides/git-vs-composer-install.md @@ -1,3 +1,9 @@ +--- +title: Git vs Composer installation of Magento with MFTF +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/git-vs-composer-install/ +status: 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..cdbfa5fcc 100644 --- a/docs/guides/selectors.md +++ b/docs/guides/selectors.md @@ -1,3 +1,9 @@ +--- +title: How to write good selectors +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors/ +status: 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 +219,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 +253,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..64a04a152 100644 --- a/docs/guides/test-isolation.md +++ b/docs/guides/test-isolation.md @@ -1,3 +1,9 @@ +--- +title: Test isolation +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/test-isolation/ +status: 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..e9a407c3b 100644 --- a/docs/guides/test-modularity.md +++ b/docs/guides/test-modularity.md @@ -1,3 +1,9 @@ +--- +title: Test modularity +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/test-modularity/ +status: 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..ea5f4c924 100644 --- a/docs/guides/using-suites.md +++ b/docs/guides/using-suites.md @@ -1,3 +1,9 @@ +--- +title: Using suites +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/using-suites/ +status: 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/img/action-groups-dia.svg b/docs/img/action-groups-dia.svg index 853420d54..9fbe68886 100644 --- a/docs/img/action-groups-dia.svg +++ b/docs/img/action-groups-dia.svg @@ -1,516 +1 @@ - - - - - - image/svg+xml - - - - - - - - - - actionTypeTags - - - - - - - - - - - - argument - 0..∞ - - - - - - - - - - - - - - - - - - - arguments - - - - - - - - - - - - - - - - - - - - - - 0..∞ - - - - - - - - - - actionGroup - 1..∞ - - - - - - - - - - - actionGroups - - - - - - - - - - - - - - - - +actionTypeTagsargument0..∞arguments0..∞actionGroup1..∞actionGroups \ No newline at end of file diff --git a/docs/img/data-dia.svg b/docs/img/data-dia.svg index fbaf7d8ec..1b2c315e7 100644 --- a/docs/img/data-dia.svg +++ b/docs/img/data-dia.svg @@ -1,489 +1 @@ - - - - - - image/svg+xml - - - - - - - 0..∞ - - - - - data - - - 0..∞ - - - - - var - - - 0..∞ - - - - - requiredEntity - - - 0..∞ - - - - - item - - - - - - - - - - - - - - 0..∞ - - - - - array - - - - - - - - - - - - - - - - - - - - - - - 1..∞ - - - - - - - - - entity - - - 0..∞ - - - - - - - - - - - - - - - entities - - - +0..∞data0..∞var0..∞requiredEntity0..∞item0..∞array1..∞entity0..∞entities \ No newline at end of file diff --git a/docs/img/metadata-dia.svg b/docs/img/metadata-dia.svg index 0ce0fc27a..9e898be3b 100644 --- a/docs/img/metadata-dia.svg +++ b/docs/img/metadata-dia.svg @@ -1,1050 +1 @@ - - - - - - image/svg+xml - - - - - - - - - - - field - 0..∞ - - - - - - - array - 0..∞ - - - - - - - - - - - - object - 0..∞ - - - - - - - - - - - - - - - - - - - - - - 0..∞ - - - - - - - - - - field - 0..∞ - - - - - - value - - - - - - - object - 0..∞ - - - - - - - - - - - - - - - - - - - - - - - 0..∞ - - - - - - - - - - array - 0..∞ - - - - - - - - - header - - - 0..∞ - - - - - param - 0..∞ - - - - - - - - object - 0..∞ - - - - - - - - - - - - - - contentType - - - - - - - - - - - - - - - - - - - 0..∞ - - - - - - - - - - operation - 0..∞ - - - - - - - - - - - - - - - - - - - - - operations - - - - - +field0..∞array0..∞object0..∞0..∞field0..∞valueobject0..∞0..∞array0..∞header0..∞param0..∞object0..∞contentType0..∞operation0..∞operations \ No newline at end of file diff --git a/docs/img/page-dia.svg b/docs/img/page-dia.svg index 668891db0..10f014328 100644 --- a/docs/img/page-dia.svg +++ b/docs/img/page-dia.svg @@ -1,290 +1 @@ - - - - - - image/svg+xml - - - - - - - - - - section - - 0..∞ - - - - - - - - - - - - - - - - - page - - 1..∞ - - - - - - - - - - - - - - - - - - - pages - - - - - +section0..∞page1..∞pages \ No newline at end of file diff --git a/docs/img/section-dia.svg b/docs/img/section-dia.svg index 1ee7611af..5eb80bbb4 100644 --- a/docs/img/section-dia.svg +++ b/docs/img/section-dia.svg @@ -1,296 +1 @@ - - - - - - image/svg+xml - - - - - - - - - - - element - - - 1..∞ - - - - - - - - - - - - - - - - - - - - - 1..∞ - - - - - - - - - - - - - - - - - - - - - sections - - - - - +element1..∞1..∞sections \ No newline at end of file diff --git a/docs/img/test-dia.svg b/docs/img/test-dia.svg index fcf2628da..47439dbb0 100644 --- a/docs/img/test-dia.svg +++ b/docs/img/test-dia.svg @@ -1,1228 +1 @@ - - - - - - image/svg+xml - - - - - - - - - testTypeTags - - - - - - - - - testTypeTags - - - - - - - - - - - - - - - - - - - - - 0..∞ - - - - - - - - - before - - - - - - - testTypeTags - - - - - - - - - - - - - - - - - - - - - 0..∞ - - - - - - - - - after - - - - - - - - annotations - - - - - - - - - - - - - - - - - - - - - - - - - 0..∞ - - - - - - - - - - test - 1..∞ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - tests - - - - - - - - actionTypeTags - - - - - - - - - - - argument - - - - - - - - - - - - 0..∞ - - - - - - - - - actionGroup - - - - - - - - - - - - - - - - - - - - - - - - - - - testTypeTags - - - +testTypeTagstestTypeTags0..∞beforetestTypeTags0..∞afterannotations0..∞test1..∞testsactionTypeTagsargument0..∞actionGrouptestTypeTags \ No newline at end of file diff --git a/docs/interactive-pause.md b/docs/interactive-pause.md index 5914c6339..19a8e5681 100644 --- a/docs/interactive-pause.md +++ b/docs/interactive-pause.md @@ -1,3 +1,9 @@ +--- +title: Interactive pause +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/interactive-pause/ +status: 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..c92083afe 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,3 +1,9 @@ +--- +title: Introduction to the Magento Functional Testing Framework +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/ +status: 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..c8fefade4 100644 --- a/docs/merge_points/extend-action-groups.md +++ b/docs/merge_points/extend-action-groups.md @@ -1,3 +1,9 @@ +--- +title: Extend action groups +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-action-groups/ +status: 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..d2150fc61 100644 --- a/docs/merge_points/extend-data.md +++ b/docs/merge_points/extend-data.md @@ -1,3 +1,9 @@ +--- +title: Extend data entities +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-data/ +status: 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..90e2c8b95 100644 --- a/docs/merge_points/extend-tests.md +++ b/docs/merge_points/extend-tests.md @@ -1,3 +1,9 @@ +--- +title: Extend tests +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-tests/ +status: 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..d0c75f784 100644 --- a/docs/merge_points/introduction.md +++ b/docs/merge_points/introduction.md @@ -1,3 +1,9 @@ +--- +title: Merge points for testing extensions in MFTF +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/ +status: 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..b4e2c4273 100644 --- a/docs/merge_points/merge-action-groups.md +++ b/docs/merge_points/merge-action-groups.md @@ -1,3 +1,9 @@ +--- +title: Merge action groups +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-action-groups/ +status: 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..9bb64c692 100644 --- a/docs/merge_points/merge-data.md +++ b/docs/merge_points/merge-data.md @@ -1,3 +1,9 @@ +--- +title: Merge data +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-data/ +status: 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..2c4248744 100644 --- a/docs/merge_points/merge-pages.md +++ b/docs/merge_points/merge-pages.md @@ -1,3 +1,9 @@ +--- +title: Merge pages +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-pages/ +status: 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..3061eb265 100644 --- a/docs/merge_points/merge-sections.md +++ b/docs/merge_points/merge-sections.md @@ -1,3 +1,9 @@ +--- +title: Merge sections +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-sections/ +status: 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..6051d6808 100644 --- a/docs/merge_points/merge-tests.md +++ b/docs/merge_points/merge-tests.md @@ -1,3 +1,9 @@ +--- +title: Merge tests +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-tests/ +status: 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..01d6b6163 100644 --- a/docs/merging.md +++ b/docs/merging.md @@ -1,3 +1,9 @@ +--- +title: Merging +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merging/ +status: 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..2bae0c116 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -1,3 +1,9 @@ +--- +title: Metadata +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata/ +status: 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..961e1425c 100644 --- a/docs/mftf-tests-packaging.md +++ b/docs/mftf-tests-packaging.md @@ -1,3 +1,9 @@ +--- +title: MFTF functional test modules and packaging +redirect_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/mftf-tests-packaging/ +status: migrated +--- +