Skip to content

Commit f89a7da

Browse files
jeff-matthewsjeff-matthews
committed
Added migration metadata to docs
1 parent daa50d5 commit f89a7da

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+272
-22
lines changed

‎docs/backward-incompatible-changes.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/backward-incompatible-changes/
3+
layout: migrated
4+
---
5+
16
# MFTF 3.0.0 backward incompatible changes
27

38
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.

‎docs/best-practices.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/best-practices/
3+
layout: migrated
4+
---
5+
16
# Best practices
27

38
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`:
8590
Use a corresponding [`<deleteData>`] test step in your [`<after>`] block when using a [`<createData>`] action in a [`<before>`] block.
8691
2. Make specific data entries under test to be unique.
8792
Enable data uniqueness where data values are required to be unique in a database by test design.
88-
Use `unique=”suffix”` or `unique=”prefix”` to append or prepend a unique value to the [entity] attribute.
93+
Use `unique="suffix"` or `unique="prefix"` to append or prepend a unique value to the [entity] attribute.
8994
This ensures that tests using the entity can be repeated.
9095
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.
9196
Create a new data entity for your test if you are not sure.

‎docs/commands/codeception.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/codeception/
3+
layout: migrated
4+
---
5+
16
# CLI commands: vendor/bin/codecept
27

38
<div class="bs-callout bs-callout-warning" markdown="1">

‎docs/commands/mftf.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf/
3+
layout: migrated
4+
---
5+
16
# CLI commands: vendor/bin/mftf
27

38
The Magento Functional Testing Framework (MFTF) introduces the command line interface (CLI) tool `vendor/bin/mftf` to facilitate your interaction with the framework.

‎docs/configuration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/configuration/
3+
layout: migrated
4+
---
5+
16
# Configuration
27

38
The `*.env` file provides additional configuration for the Magento Functional Testing Framework (MFTF).

‎docs/configure-2fa.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/two-factor-authentication/
3+
layout: migrated
4+
---
5+
16
# Configuring MFTF for Two-Factor Authentication (2FA)
27

38
Using two-factor authentication (2FA) with MFTF is possible with some configurations settings in Magento.

‎docs/credentials.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/credentials/
3+
layout: migrated
4+
---
5+
16
# Credentials
27

38
When you test functionality that involves external services such as UPS, FedEx, PayPal, or SignifyD,

‎docs/custom-helpers.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/custom-helpers/
3+
layout: migrated
4+
---
5+
16
# Custom Helpers
27

38
<div class="bs-callout-warning">
@@ -37,7 +42,7 @@ This functionality is used to select text on the page and cannot be accomplished
3742
```php
3843
<?php
3944
/**
40-
* Copyright © Magento, Inc. All rights reserved.
45+
* Copyright &copy; Magento, Inc. All rights reserved.
4146
* See COPYING.txt for license details.
4247
*/
4348

‎docs/data.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/data/
3+
layout: migrated
4+
---
5+
16
# Input testing data
27

38
MFTF enables you to specify and use `<data>` entities defined in XML. Default `<data>` entities are provided for use and as templates for entity creation and manipulation.

‎docs/debugging.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/debugging/
3+
layout: migrated
4+
---
5+
16
# Debugging
27

38
Debugging within the Magento Functional Testing Framework is helpful in identifying test bugs by allowing you to pause execution so that you may:

‎docs/extending.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/extending/
3+
layout: migrated
4+
---
5+
16
# Extending
27

38
There are cases when you need to create many tests that are very similar to each other.

‎docs/getting-started.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started/
3+
layout: migrated
4+
---
5+
16
# Getting started
27

38
<div class="bs-callout bs-callout-info" markdown="1">

‎docs/guides/action-groups.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/action-group-best-practices/
3+
layout: migrated
4+
---
5+
16
# Action Group Best Practices
27

38
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.

‎docs/guides/cicd.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/cicd/
3+
layout: migrated
4+
---
5+
16
# How to use MFTF in CICD
27

38
To integrate MFTF tests into your CICD pipeline, it is best to start with the conceptual flow of the pipeline code.

‎docs/guides/git-vs-composer-install.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/git-vs-composer-install/
3+
layout: migrated
4+
---
5+
16
# Git vs Composer installation of Magento with MFTF
27

38
Depending on how you plan to use Magnto code, there are different options for installing Magento.

‎docs/guides/selectors.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors/
3+
layout: migrated
4+
---
5+
16
# How To write good selectors
27

38
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
213218
Example:
214219
215220
```xpath
216-
//div[@class=’form-group’]//input[@id='user-message']
221+
//div[@class='form-group']//input[@id='user-message']
217222
```
218223
219224
In the `GOOD` example above, all `<div class='form-group'/>` elements in the DOM are matched first. Then all `<input id='user-message'/>` with `<div class='form-group'/>` 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:
247252
```html
248253
<tr>
249254
<td>
250-
<a href=“#”>Edit</a>
255+
<a href="#">Edit</a>
251256
</td>
252257
<td>
253258
<div>Unique Value</div>

‎docs/guides/test-isolation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/test-isolation/
3+
layout: migrated
4+
---
5+
16
# Test Isolation
27

38
Because MFTF is a framework for testing a highly customizable and ever changing application, MFTF tests need to be properly isolated.

‎docs/guides/test-modularity.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/test-modularity/
3+
layout: migrated
4+
---
5+
16
# Test Modularity
27

38
One of MFTF's most distinguishing functionalities is the framework's modularity.

‎docs/guides/using-suites.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/using-suites/
3+
layout: migrated
4+
---
5+
16
# Using suites
27

38
With an increasing number of MFTF tests, it is important to have a mechanism to organize and consolidate them for ease-of-use.

‎docs/interactive-pause.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/interactive-pause/
3+
layout: migrated
4+
---
5+
16
# Interactive Pause
27

38
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.

‎docs/introduction.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/
3+
layout: migrated
4+
---
5+
16
# Introduction to the Magento Functional Testing Framework
27

38
<div class="bs-callout bs-callout-info" markdown="1">

‎docs/merge_points/extend-action-groups.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-action-groups/
3+
layout: migrated
4+
---
5+
16
# Extend action groups
27

38
Extending an action group doesn't affect the existing action group.

‎docs/merge_points/extend-data.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-data/
3+
layout: migrated
4+
---
5+
16
# Extend data entities
27

38
Extending a data entity does not affect the existing data entity.

‎docs/merge_points/extend-tests.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-tests/
3+
layout: migrated
4+
---
5+
16
# Extend tests
27

38
Tests can be extended to cover the needs of your extension.

‎docs/merge_points/introduction.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/
3+
layout: migrated
4+
---
5+
16
# Merge Points for testing extensions in MFTF
27

38
The Magento Functional Testing Framework (MFTF) allows great flexibility when writing XML tests for extensions.

‎docs/merge_points/merge-action-groups.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-action-groups/
3+
layout: migrated
4+
---
5+
16
# Merge action groups
27

38
An action group is a set of individual actions working together as a group.

‎docs/merge_points/merge-data.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-data/
3+
layout: migrated
4+
---
5+
16
# Merge data
27

38
Data objects can be merged to cover the needs of your extension.

‎docs/merge_points/merge-pages.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-pages/
3+
layout: migrated
4+
---
5+
16
# Merge pages
27

38
Sections can be merged into pages to cover your extension.

‎docs/merge_points/merge-sections.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-sections/
3+
layout: migrated
4+
---
5+
16
# Merge sections
27

38
Sections can be merged together to cover your extension.

‎docs/merge_points/merge-tests.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-tests/
3+
layout: migrated
4+
---
5+
16
# Merge tests
27

38
Tests can be merged to create a new test that covers new extension capabilities.

‎docs/merging.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/merging/
3+
layout: migrated
4+
---
5+
16
# Merging
27

38
MFTF allows you to merge test components defined in XML files, such as:

‎docs/metadata.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata/
3+
layout: migrated
4+
---
5+
16
# Metadata
27

38
In this topic we talk about handling entities that you need in your tests (such as categories, products, wish lists, and similar) using MFTF.

‎docs/mftf-tests-packaging.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/mftf-tests-packaging/
3+
layout: migrated
4+
---
5+
16
<style>
27
.mftf-dl {
38
margin-bottom: 2.5em;

‎docs/page.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/page/
3+
layout: migrated
4+
---
5+
16
# Page structure
27

38
MFTF uses a modified concept of [PageObjects], which models the testing areas of your page as objects within the code.

‎docs/reporting.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/reporting/
3+
layout: migrated
4+
---
5+
16
# Reporting
27

38
The Magento Functional Testing Framework provides two types of reporting:

‎docs/section.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/section/
3+
layout: migrated
4+
---
5+
16
# Section structure
27

38
A `<section>` is a reusable part of a [`<page>`](./page.html) and is the standard file for defining UI elements on a page used in a test.

‎docs/section/locator-functions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/section/locator-functions/
3+
layout: migrated
4+
---
5+
16
# Locator functions
27

38
## Define Locator::functions in elements

‎docs/section/parameterized-selectors.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/section/parameterized-selectors/
3+
layout: migrated
4+
---
5+
16
# Parameterized selectors
27

38
Use the following examples to create and use parameterized selectors in the MFTF.

‎docs/selectors.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors/
3+
layout: migrated
4+
---
5+
16
## Selectors
27

38
These guidelines should help you to write high quality selectors.

‎docs/suite.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
migrated_to: https://developer.adobe.com/commerce/testing/functional-testing-framework/suite/
3+
layout: migrated
4+
---
5+
16
# Suites
27

38
Suites are essentially groups of tests that run in specific conditions (preconditions and postconditions).

0 commit comments

Comments
 (0)