### Setup Environment Variables (Bash)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf
Updates configuration parameter values in the `.env` file or creates it if it doesn't exist. Parameters are passed as options with values, e.g., `--MAGENTO_BASE_URL=http://magento.local/`. If a parameter doesn't exist, an error is returned. Example parameters are sourced from `etc/config/.env.example`.
```bash
vendor/bin/mftf setup:env --MAGENTO_BASE_URL=http://magento.local/ --BROWSER=firefox
vendor/bin/mftf setup:env
```
--------------------------------
### Install Magento 2 Dependencies with Composer
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started
This section covers navigating to the Magento 2 directory, checking out a specific development branch, and installing the application's dependencies using Composer. Ensure Composer is installed and accessible in your PATH.
```bash
cd magento2/
git checkout 2.4-develop
composer install
```
--------------------------------
### Define Starting Test in XML
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-tests
This XML snippet defines a base test case for creating a simple product via the admin interface. It includes annotations, setup steps (before), cleanup steps (after), and a sequence of action groups to execute the test.
```xml
```
--------------------------------
### Build Project with MFTF CLI
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf
Builds the Codeception project by cloning example configuration files. The `--upgrade` option can be used to upgrade installed tests after a framework upgrade.
```bash
vendor/bin/mftf build:project
vendor/bin/mftf build:project --upgrade
```
--------------------------------
### MFTF Test Generation Example (testNames.txt)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf
An example format for a `testNames.txt` file used with the `generate:tests -p` command. It lists test names and suite names for targeted test generation.
```text
testName1
testName2
testNameN
suiteName:testInSuite
```
--------------------------------
### Run Codeception Tests
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/codeception
Executes the default test suites defined in the Codeception configuration. This is the most basic command to start your test execution.
```bash
vendor/bin/codecept run
```
--------------------------------
### Define Starting Test for Merging - XML
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-tests
This XML code defines a starting test case for merging. It includes annotations, setup steps (before), teardown steps (after), and action groups for logging in, filling a product form, and asserting product details. This serves as the base test to which new functionalities will be added.
```xml
```
--------------------------------
### Download and Run Selenium Server for Functional Testing
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started
Download the Selenium server standalone JAR file and run it to facilitate browser automation for functional tests. This example uses version 3.14.0 and specifies the ChromeDriver path.
```bash
curl -O http://selenium-release.storage.googleapis.com/3.14/selenium-server-standalone-3.14.0.jar
```
```bash
java -Dwebdriver.chrome.driver=chromedriver -jar selenium-server-standalone-3.14.0.jar
```
--------------------------------
### Basic Assertion Example with Variable Substitution
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/assertions
This example demonstrates a common assertion pattern where a value is first grabbed from a page and then asserted to match an expected string. It showcases the use of `stepKey` for referencing previous actions and embedding variables within assertion strings using `{$stepKey}`.
```xml
Some String
A long assert string {$stepKeyOfGrab} with an embedded variable reference.
```
--------------------------------
### Inline Alert Slot Example
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/best-practices
An example demonstrating the use of slots within an inline alert component, suggesting a pattern for content injection or customization.
```html
```
--------------------------------
### REST API Header Example (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
Provides an example of how to define a REST API header parameter using the '' tag. The 'param' attribute specifies the header name, and the content is the header value.
```xml
```
--------------------------------
### Build Efficient Selectors by Starting with Parent Context
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/tips-tricks
Illustrates the recommended approach for building selectors for form elements by starting with the parent context and then specifying the element's `name` attribute. This pattern `{{section_selector}} {{input_selector}}` or `{{section_selector}} {{button_selector}}` ensures accurate targeting and improves lookup efficiency.
```xml
```
```xml
```
--------------------------------
### Build Project with Options
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf
Builds the project and allows setting environment configuration parameters. The `--upgrade` option can be used to upgrade installed tests.
```bash
vendor/bin/mftf build:project --MAGENTO_BASE_URL=http://magento.local/ --MAGENTO_BACKEND_NAME=admin214365
vendor/bin/mftf build:project --upgrade
```
--------------------------------
### Example Suite Configuration (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/using-suites
An example of an XML suite definition for the Magento Functional Testing Framework. This suite, named 'WYSIWYGDisabledSuite', disables WYSIWYG before running tests from the 'Catalog' module and re-enables it afterward, excluding a specific incompatible test.
```xml
```
--------------------------------
### Use Descriptive stepKey Names in Tests (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/tips-tricks
Illustrates the importance of using descriptive `stepKey` names for better readability and clarity in test scripts. The 'Good' example shows the recommended practice of using meaningful names, while the 'Bad' example shows the less maintainable approach of using generic numbers.
```xml
```
--------------------------------
### Configure .credentials file for Functional Testing Framework
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/credentials
This snippet demonstrates how to set up and use the .credentials file for storing sensitive data in the Functional Testing Framework. It includes steps for copying the example file, adding it to .gitignore, and defining key-value pairs for credentials.
```bash
cd dev/tests/acceptance/
cp .credentials.example .credentials
```
```bash
git check-ignore .credentials
```
--------------------------------
### XML Example: Nested Assertion Syntax - Functional Testing Framework
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/backward-incompatible-changes
Demonstrates the nested assertion syntax required by the updated XSD schema. This example shows how to use `` with explicit actual and expected result types.
```xml
$billingAddressOrderPage
$shippingAddressOrderPage
```
--------------------------------
### Use Isolation for Selectors (CSS Example)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors
Explains the concept of 'isolation' in selector writing by targeting a parent element first, then a child. This example shows how to select a 'Sign In' button within a specific login form using a combined selector.
```css
#login-form .sign-in-button
```
--------------------------------
### Define Starting Action Group - XML
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/extend-action-groups
Defines a starting action group named 'AdminFillSimpleProductFormActionGroup' for filling out a simple product form. It includes arguments for category and product details, navigates to the product index page, fills various product fields, selects a category, opens the SEO section, fills the URL key, saves the product, and asserts the success message and field values.
```xml
```
--------------------------------
### Array with Primitive Items Example (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
Shows how to populate an array with primitive data type items. This XML structure represents the actual data assigned to an array, like a list of IDs.
```xml
- 1
- 2
```
--------------------------------
### Define Starting Page Structure (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/merge-points/merge-pages
This XML snippet defines the initial structure of a page, listing various sections that are part of its default configuration. It serves as the base for merging additional sections.
```xml
```
--------------------------------
### MFTF Action Group Declaration Example (Login)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/action-groups
This example demonstrates a complete action group declaration for logging into the Admin area in MFTF. It includes annotations for description, arguments with default values, and a sequence of actions like navigating to the page, filling fields, clicking login, and closing notifications. The `userInput` variables reference data values for test execution.
```xml
Login to Backend Admin using provided User Data. PLEASE NOTE: This Action Group does NOT validate that you are Logged In.
```
--------------------------------
### Example composer.json for Functional Test Module
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/mftf-tests-packaging
This JSON file demonstrates the required format for a functional test module's composer.json. It specifies the 'magento2-functional-test-module' type and lists module dependencies using the 'suggest' block with specific type and name formats.
```json
{
"name": "magento/module-configurable-product-catalog-search-functional-test",
"description": "test module for Magento_ConfigurableProduct and Magento_CatalogSearch",
"type": "magento2-functional-test-module",
"config": {
"sort-packages": true
},
"require": {
"magento/magento2-functional-testing-framework": ">=2.5"
},
"suggest": {
"magento/module-configurable-product": "type: magento2-module, name: Magento_ConfigurableProduct, version: *",
"magento/module-catalog-search": "type: magento2-module, name: Magento_CatalogSearch, version: *"
},
"license": [
"OSL-3.0",
"AFL-3.0"
]
}
```
--------------------------------
### Use Numbers in stepKey for Order Importance (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/tips-tricks
Provides an exception to the rule of using descriptive `stepKey` names. This example shows when it is appropriate to use numbers within `stepKeys`, specifically when the order of operations is critical, such as in testing sort order.
```xml
```
--------------------------------
### Automate customer sign-in steps (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/actions
This example demonstrates a sequence of actions to automate the customer sign-in process. It includes navigating to the sign-in page, filling in the email and password fields, and clicking the sign-in button. Each action uses specific selectors and input data, with `stepKey` attributes for referencing.
```xml
```
--------------------------------
### MFTF Category Operations Example (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
Illustrates how to define different operations (create, update, delete, get) for a 'category' data entity within an MFTF metadata file. This allows for comprehensive management of category data in tests.
```xml
...
...
...
...
```
--------------------------------
### Serve Allure Report (Bash)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/reporting
Serves the generated Allure HTML report in a temporary folder and automatically opens it in the default web browser. This provides immediate access to test results for review.
```bash
allure serve dev/tests/acceptance/tests/_output/allure-results/
```
--------------------------------
### Enable CLI Commands for Functional Testing Framework
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started
Copy the sample .htaccess file to enable the Functional Testing Framework to send CLI commands to your Adobe Commerce or Magento Open Source instance. This step is performed in the project root directory.
```bash
cp dev/tests/acceptance/.htaccess.sample dev/tests/acceptance/.htaccess
```
--------------------------------
### Install hoa/console for Interactive Pause
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/interactive-pause
This command installs the 'hoa/console' library, which is a prerequisite for the interactive pause feature to function correctly within the MFTF. Ensure you run this in your project's root directory.
```bash
composer require hoa/console
```
--------------------------------
### MFTF Section Example: Admin Category Sidebar
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/section
An example of an MFTF section definition in XML for the 'AdminCategorySidebarActionSection'. It demonstrates how to declare button elements with their types and selectors.
```xml
```
--------------------------------
### Build Tests Using Action Groups (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/tips-tricks
Demonstrates how to build tests using action groups, even for single actions. This approach enhances maintainability for extension developers by allowing updates to multiple tests through a single action group modification. The 'Good' example shows the recommended structure.
```xml
```
--------------------------------
### Array Containing Data Field Example (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
Demonstrates declaring an array that holds specific fields from other data types. This example shows an array of 'id' fields from the 'tax_rate' data type.
```xml
tax_rate.id
```
--------------------------------
### Inline Alert Warning Example
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/best-practices
A simple example of an inline alert with a warning variant, likely used for UI feedback or notifications within the framework's context.
```html
```
--------------------------------
### Serve Allure Test Reports
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started
Generate and serve visual representations of test reports using the Allure Framework. This command serves the artifacts located in the specified allure-results directory, making them accessible via a GUI.
```bash
allure serve dev/tests/acceptance/tests/_output/allure-results/
```
--------------------------------
### Run Codeception Tests with Functional Testing Framework
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf
A wrapper command that executes `vendor/bin/codecept run` for the functional suite. Tests must be generated prior to execution. Supports running all tests, specific suites, or individual test files with various options.
```bash
vendor/bin/mftf codecept:run [] --[]
```
```bash
# Run all tests in functional suite
vendor/bin/mftf codecept:run functional
```
```bash
# Run all tests in functional suite with options
vendor/bin/mftf codecept:run functional --verbose --steps --debug
```
```bash
# Run one test
vendor/bin/mftf codecept:run functional Magento/_generated/default/AdminCreateCmsPageTestCest.php --debug
```
--------------------------------
### Example of Bad CSS Selector
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors
This CSS selector is an example of what not to do. It relies on excessive hierarchical details, making it brittle and difficult to understand. If the DOM structure changes, this selector is likely to break.
```css
#html-body > section > div > div > div > div
```
--------------------------------
### Run MFTF Static Checks Help
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf
Displays help information for the MFTF static-checks command, outlining available subcommands and options. This is useful for understanding the full capabilities of the tool.
```bash
vendor/bin/mftf static-checks --help
```
--------------------------------
### Clone Adobe Commerce Repository
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/cicd
Clones the Adobe Commerce or Magento Open Source repository from GitHub. This is the first step to setting up an instance for testing.
```bash
git clone https://github.com/magento/magento2
```
--------------------------------
### XPath Parent Selector Examples
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors
The parent selector ('..') allows navigation up the DOM tree to select parent elements. These examples demonstrate how to select a parent or grandparent element based on text content or other attributes.
```xpath
//*[text()='Unique Value']/../..
```
```xpath
//div[text()='Unique Value']/../..//a
```
--------------------------------
### Run Codeception Tests with Filters (Bash)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/codeception
These bash commands demonstrate how to execute Codeception tests using the 'vendor/bin/codecept' CLI. They show how to run all tests, skip specific groups, or include specific groups while skipping others. The '-c' flag specifies the configuration file.
```bash
vendor/bin/codecept run functional -c dev/tests/acceptance/codeception.yml
```
```bash
vendor/bin/codecept run functional --skip-group skip -c dev/tests/acceptance/codeception.yml
```
```bash
vendor/bin/codecept run functional --group example --skip-group skip -c dev/tests/acceptance/codeception.yml
```
--------------------------------
### Explicit Page Declaration Example (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/page
An example of an explicit page object declaration in XML format. This defines the 'AdminCategoryPage' with its URL, module, area, and associated sections. This page can be referenced directly in tests using its declared URL.
```xml
```
--------------------------------
### Avoid Overly Specific Selectors (XPath Example)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors
Shows an overly specific XPath selector mirroring the CSS example above. Like its CSS counterpart, this XPath is fragile and prone to breaking due to minor structural modifications in the DOM.
```xpath
//*[@id='container']/*[@class='dashboard-advanced-reports']/*[@class='dashboard-advanced-reports-description']/*[@class='dashboard-advanced-reports-title']
```
--------------------------------
### Codeception `codecept run` Command Reference
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/codeception
Provides a comprehensive list of arguments and options for the `codecept run` command. This includes specifying suites, tests, overriding configurations, enabling extensions, and generating various report formats.
```bash
Full reference:
Arguments:
suite suite to be tested
test test to be run
Options:
-o, --override=OVERRIDE Override config values (multiple values allowed)
-e, --ext=EXT Run with extension enabled (multiple values allowed)
--report Show output in compact style
--html[=HTML] Generate html with results [default: "report.html"]
--xml[=XML] Generate JUnit XML Log [default: "report.xml"]
--phpunit-xml[=PHPUNIT-XML] Generate PhpUnit XML Log [default: "phpunit-report.xml"]
--tap[=TAP] Generate Tap Log [default: "report.tap.log"]
--json[=JSON] Generate Json Log [default: "report.json"]
--colors Use colors in output
--no-colors Force no colors in output (useful to override config file)
--silent Only outputs suite names and final results
--steps Show steps in output
-d, --debug Show debug and scenario output
--bootstrap[=BOOTSTRAP] Execute custom PHP script before running tests. Path can be absolute or relative to current working directory [default: false]
--no-redirect Do not redirect to Composer-installed version in vendor/codeception
--coverage[=COVERAGE] Run with code coverage
--coverage-html[=COVERAGE-HTML] Generate CodeCoverage HTML report in path
--coverage-xml[=COVERAGE-XML] Generate CodeCoverage XML report in file
--coverage-text[=COVERAGE-TEXT] Generate CodeCoverage text report in file
--coverage-crap4j[=COVERAGE-CRAP4J] Generate CodeCoverage report in Crap4J XML format
--coverage-phpunit[=COVERAGE-PHPUNIT] Generate CodeCoverage PHPUnit report in path
--no-exit Don't finish with exit code
-g, --group=GROUP Groups of tests to be executed (multiple values allowed)
-s, --skip=SKIP Skip selected suites (multiple values allowed)
-x, --skip-group=SKIP-GROUP Skip selected groups (multiple values allowed)
--env=ENV Run tests in selected environments. (multiple values allowed)
-f, --fail-fast Stop after first failure
--no-rebuild Do not rebuild actor classes on start
--seed=SEED Define random seed for shuffle setting
--no-artifacts Don't report about artifacts
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-c, --config[=CONFIG] Use custom path for config
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
```
--------------------------------
### Run Tests from Manifest File (Bash)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/commands/mftf
Executes all tests specified in a `testManifest.txt` file. This command requires a pre-existing manifest file and does not generate tests. It accepts a path to the manifest file as an argument.
```bash
vendor/bin/mftf run:manifest path/to/your/testManifest.txt
```
--------------------------------
### Example of Bad XPath Selector
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors
This XPath selector is also an example of poor practice due to its reliance on deep DOM hierarchy. Such selectors are prone to breaking with minor HTML changes and lack clarity regarding the intended target element.
```xpath
//*[@id='html-body']/section/div/div/div/div
```
--------------------------------
### Create Adobe Commerce Project with Composer
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/cicd
Creates a new Adobe Commerce or Magento Open Source project using Composer. This is an alternative method for setting up a testing instance.
```bash
composer create-project --repository=https://repo.magento.com/ magento/project-community-edition magento2ce
```
--------------------------------
### Extending LoginAsAdmin with Two-Factor Authentication Field
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/action-group-best-practices
This XML snippet shows another example of extending the `LoginAsAdmin` action group, this time to fill a Two-Factor Authentication input field. Similar to the CAPTCHA example, it uses `before="signIn"` to insert the action at the appropriate point in the sequence.
```xml
```
--------------------------------
### Configure Adobe Commerce Instance Settings
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/cicd
Sets essential configuration values for an Adobe Commerce or Magento Open Source instance. These commands adjust locale, admin sharing, form key usage, and WYSIWYG editor enablement.
```bash
bin/magento config:set general/locale/timezone America/Los_Angeles
bin/magento config:set admin/security/admin_account_sharing 1
bin/magento config:set admin/security/use_form_key 0
bin/magento config:set cms/wysiwyg/enabled disabled
```
--------------------------------
### Run All Functional Tests with Codeception
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started
Execute all generated functional tests using the Codeception runner. This command references the codeception.yml configuration file located in the acceptance directory.
```bash
vendor/bin/codecept run functional -c dev/tests/acceptance/codeception.yml
```
--------------------------------
### Absolute vs. Relative XPath Selectors
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors
Absolute XPath selectors ('/') start from the root of the document and specify a direct path, making them brittle. Relative XPath selectors ('//') search for elements anywhere in the DOM, starting from a specified element or the entire document if none is specified, offering more flexibility.
```xpath
/html/body/div[2]/div/div[2]/div[1]/div[2]/form/div/input
```
```xpath
//div[@class='form-group']//input[@id='user-message']
```
--------------------------------
### Open Allure Reports
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/reporting
Opens the generated Allure report in the default web browser. This command assumes a report has already been generated in the current directory's `allure-report/` folder.
```bash
allure open
```
--------------------------------
### XML: Example of Parameterized Selectors in Page Objects
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/best-practices
Demonstrates the correct way to handle parameterized selectors in page object definitions within the Functional Testing Framework. It shows how to define individual elements instead of using parameterized selectors for static elements.
```xml
```
--------------------------------
### Manual Test Steps in XML Format
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/test-prep
This XML snippet outlines the manual steps for creating and verifying a product in Adobe Commerce. It includes navigation, form filling, saving, and storefront verification. These steps serve as the basis for converting into an automated functional test.
```xml
```
--------------------------------
### Clone Magento 2 Repository using Git
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/getting-started
This snippet demonstrates how to clone the Magento 2 source code repository using either the HTTPS or SSH protocol. Ensure Git is installed and configured on your development environment.
```bash
git clone https://github.com/magento/magento2.git
```
```bash
git clone git@github.com:magento/magento2.git
```
--------------------------------
### Open Allure Report (Bash)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/reporting
Opens a previously generated Allure HTML report located in the specified directory within the default web browser. This command is useful for revisiting existing reports.
```bash
allure open dev/tests/acceptance/tests/_output/allure-report
```
--------------------------------
### Define and Use Parameterized Selectors in XML Tests
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/section/parameterized-selectors
This snippet demonstrates the step-by-step construction of an XML test case using parameterized selectors. It shows how to initialize a test, add a click action, and progressively define a parameterized selector by referencing sections, elements, and various parameter types like default category data, string literals, persisted data, and variables.
```xml
```
```xml
```
```xml
```
```xml
```
```xml
```
```xml
```
```xml
```
```xml
```
--------------------------------
### createData
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/actions
Creates an entity (for example, a category or product). To create an entity, the Functional Testing Framework makes a `POST` request to the Adobe Commerce or Magento Open Source API.
```APIDOC
## createData
### Description
Creates an entity (for example, a category or product). To create an entity, the Functional Testing Framework makes a `POST` request to the Adobe Commerce or Magento Open Source API according to the [data](/commerce/testing/functional-testing-framework/data) and [metadata](/commerce/testing/functional-testing-framework/metadata) of the entity to be created.
### Method
Not applicable (this is a custom action within the framework, not a direct HTTP method).
### Endpoint
Not applicable.
### Parameters
#### Path Parameters
None
#### Query Parameters
None
#### Request Body
This action is configured using XML attributes. It can optionally contain one or more `requiredEntity` child elements.
- **`entity`** (string) - Required - Type of entity to be created.
- **`storeCode`** (string) - Optional - ID of the store within which the data is created.
- **`stepKey`** (string) - Required - A unique identifier of the action.
- **`before`** (string) - Optional - `stepKey` of action that must be executed next.
- **`after`** (string) - Optional - `stepKey` of preceding action.
### Request Example
```xml
```
### Response
#### Success Response
This action does not return a specific response body. Its success is determined by the creation of the entity in the system.
#### Response Example
N/A
```
--------------------------------
### Array with Primitive Value Example (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
Demonstrates how to declare an array of primitive data types, such as integers, using the '' and '' tags. This structure is used for defining arrays in metadata.
```xml
integer
```
--------------------------------
### XML Description Annotation Example
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test/annotations
This XML snippet shows the usage of the `` annotation, which is an implementation of the Allure tag for extended test descriptions. It requires a 'value' attribute of type string.
```xml
```
--------------------------------
### Prioritize Critical Actions in Block (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/tips-tricks
Illustrates the best practice of performing non-browser driving actions, such as `magentoCLI` commands and data deletion, before UI-heavy actions within the `` block. This ensures critical setup or cleanup tasks are executed even if UI steps fail.
```xml
```
```xml
```
--------------------------------
### Array Containing Data Entities Example (XML)
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
Illustrates how to define an array that contains complex data entities. The '' tag specifies the data type of the entities within the array, such as 'product_option'.
```xml
product_option
```
--------------------------------
### Company ID JSON Payload Example
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
This JSON object represents the payload structure for creating a company ID, as defined by the 'CreateCompanyId' metadata. It contains a single key 'company_id' with an integer value.
```json
{
"company_id": 1
}
```
--------------------------------
### URL Construction and Authentication
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
Explains how URLs are constructed by concatenating environment base URLs with specific paths and outlines the available authentication methods for API requests.
```APIDOC
## URL Construction and Authentication
### Description
This section explains how URLs are constructed by concatenating environment base URLs with specific paths and outlines the available authentication methods for API requests.
### URL Construction
- `*url` - full URL is a concatenation of `*ENV.baseUrl` + `/rest/` + `*URL`. To reuse data of a required entity or returned response use a field key wrapped in curly braces such as `{sku}`. When the data to reuse is of a different type, declare also the type of data such as `{product.sku}`. Example: `"/V1/products/{product.sku}/media/{id}"`.
### Authentication
- `**auth` - available values:
- `adminOath` is used for REST API persistence in the Admin area with [OAuth-based authentication](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-oauth/).
- `adminFormKey` is used for HTML form persistence in the Admin area.
- `customerFormKey` is used for HTML form persistence in the Customer area.
- `anonymous` is used for REST API persistence without authorization.
```
--------------------------------
### Company Relation JSON Payload Example
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/metadata
This JSON object illustrates the payload for creating a company relation. It includes a 'relations' array, where each element is an object containing the 'company_id' of the child company to be associated with the parent.
```json
{
"relations": [
{
"company_id": 1
}
]
}
```
--------------------------------
### CSS Attribute Selectors
Source: https://developer.adobe.com/commerce/testing/functional-testing-framework/test-writing/selectors
Provides examples of CSS attribute selectors, which allow targeting elements based on their attributes and attribute values. This is useful for more specific element selection.
```CSS
[attribute]
[attribute=value]
[attribute~=value]
[attribute|=value]
[attribute^=value]
[attribute$=value]
[attribute*=value]
```