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.

Note that mftf commands replace the robo commands that were used in previous releases.

Command format

In the project root directory (where you have installed the framework as a composer dependency), run commands using the following format:

vendor/bin/mftf command [options] [<arguments>] [--remove|-r]

Useful commands

Use the following commands to run commonly performed tasks.

Apply the configuration parameters

vendor/bin/mftf build:project

Upgrade the project

vendor/bin/mftf build:project --upgrade

Upgrades the existing MFTF tests after the MFTF major upgrade.

Generate all tests

vendor/bin/mftf generate:tests

Generate tests by test name

vendor/bin/mftf generate:tests AdminLoginTest StorefrontPersistedCustomerLoginTest

Generate test by test and suite name

vendor/bin/mftf generate:tests LoginSuite:AdminLoginTest

Generate and run the tests for a specified group

vendor/bin/mftf run:group product -r

This command cleans up the previously generated tests; generates and runs tests for the product group (where group="product").

Generate and run particular tests

vendor/bin/mftf run:test AdminLoginTest StorefrontPersistedCustomerLoginTest -r

This command cleans up the previously generated tests; generates and runs the LoginAsAdminTest and LoginAsCustomerTest tests.

Generate and run particular test in a specific suite’s context

vendor/bin/mftf run:test LoginSuite:AdminLoginTest -r

This command cleans up previously generated tests; generates and run AdminLoginTest within the context of the LoginSuite.

Generate and run a testManifest.txt file

vendor/bin/mftf run:manifest path/to/your/testManifest.txt

This command runs all tests specified in a testManifest.txt file. When you generate tests, a testManifest.txt file is also generated for you. You can pass this file directly to the run:manifest command and it will execute all listed tests. You can also create your own file in the same format to execute a subset of tests. Note: This command does not generate tests.

Generate and run previously failed tests

vendor/bin/mftf run:failed

This command cleans up the previously generated tests; generates and runs the tests listed in dev/tests/acceptance/tests/_output/failed. For more details about failed, refer to Reporting.

Generate documentation for action groups

vendor/bin/mftf generate:docs

This command generates documentation for action groups.

Reference

`build:project`

Description

Clone the example configuration files and build the Codeception project.

Usage

vendor/bin/mftf build:project [--upgrade] [config_param_options]

Options

Option	Description
`-u`, `--upgrade`	Upgrades existing MFTF tests according to requirements of the last major release. Specifying this flag upgrades only those tests in the default location. Example: `build:project --upgrade`.

You can include options to set configuration parameter values for your environment since the project build process also sets up the environment.

vendor/bin/mftf build:project --MAGENTO_BASE_URL=http://magento.local/ --MAGENTO_BACKEND_NAME=admin214365

`doctor`

Description

Diagnose MFTF configuration and setup. Currently this command will check the following:

Verify admin credentials are valid. Allowing MFTF authenticates and runs API requests to Magento through cURL
Verify that Selenium is up and running and available for MFTF
Verify that new session of browser can open Magento admin and store front urls
Verify that MFTF can run MagentoCLI commands

Usage

vendor/bin/mftf doctor

Options

`generate:tests`

Description

Perform XML schema validation and generate PHP code from the tests defined in XML files. The path is set in the TESTS_MODULE_PATH configuration parameter.

Usage

vendor/bin/mftf generate:tests [option] [<test name>] [<test name>] [--remove]

Options

Option	Description
`--config=[<default> or <singleRun> or <parallel>]`	Creates a single manifest file with a list of all tests. The default location is `tests/functional/Magento/FunctionalTest/_generated/testManifest.txt`. You can split the list into multiple groups using `--config=parallel`; the groups will be generated in `_generated/groups/` like `_generated/groups/group1.txt, group2.txt, ...`. Available values: `default` (default), `singleRun`(same as `default`), and `parallel`. Example: `generate:tests --config=parallel`.
`--filter`	Option to filter tests to be generated. Template: ‘<filterName>:<filterValue>’. Existing filter types: severity, includeGroup, excludeGroup. Existing severity values: BLOCKER, CRITICAL, MAJOR, AVERAGE, MINOR. Example: `vendor/bin/mftf generate:tests --filter=severity:CRITICAL --filter=severity:BLOCKER --filter=includeGroup:customer`
`--force`	Forces test generation, regardless of the module merge order defined in the Magento instance. Example: `generate:tests --force`.
`-i,--time`	Set time in minutes to determine the group size when `--config=parallel` is used. The default value is `10`. Example: `generate:tests --config=parallel --time=15`
`--tests`	Defines the test configuration as a JSON string.
`--allow-skipped`	Allows MFTF to generate and run tests marked with `<skip>.`
`--debug or --debug=[<none>]`	Performs schema validations on XML files. DEFAULT: `generate:tests` implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. DEVELOPER: `--debug` performs per-file validation and returns additional debug information (such as the filename where an error occurred) when test generation fails because of an invalid XML schema. This option takes extra processing time. Use it after test generation has failed once. NONE: `--debug=none` skips debugging during test generation. Added for backward compatibility, it will be removed in the next MAJOR release.
`-r,--remove`	Removes the existing generated suites and tests cleaning up the `_generated` directory before the actual run. For example, `generate:tests SampleTest --remove` cleans up the entire `_generated` directory and generates `SampleTest` only.

Examples of the JSON configuration

The configuration to generate a single test with no suites:

{  
   "tests":[
      "general_test1"  //Generate the "general_test1" test.
      ],
   "suites": null
}

The configuration to generate a single test in the suite:

{  
   "tests": null,       // No tests outside the suite configuration will be generated.
   "suites":{  
      "sample":[        // The suite that contains the test.
         "suite_test1"  // The test to be generated.
      ]
   }
}

Complex configuration to generate a few non-suite tests, a single test in a suite, and an entire suite:

{  
   "tests":[  
      "general_test1",
      "general_test2",
      "general_test3"
   ],
   "suites":{           //Go to suites.
      "sample":[        //Go to the "sample" suite.
         "suite_test1"  //Generate the "suite_test1" test.
      ],
      "sample2":[]      //Generate all tests in the "sample2" suite.
   }
}

The command that encodes this complex configuration:

vendor/bin/mftf generate:tests --tests '{"tests":["general_test1","general_test2","general_test3"],"suites":{"sample":["suite_test1"],"sample2":null}}'

Note that the strings must be escaped and surrounded in quotes.

`generate:suite`

Description

Generates one or more suites based on XML declarations.

Usage

vendor/bin/mftf generate:suite <suite name> [<suite name>] [--remove]

Options

Option	Description
`-r,--remove`	Removes the existing generated suites and tests cleaning up the `_generated` directory before the actual run. For example, `vendor/bin/mftf generate:suite WYSIWYG --remove` cleans up the entire `_generated` directory and generates `WYSIWYG` only.

Example

vendor/bin/mftf generate:suite suite1 suite2

`generate:urn-catalog`

Description

Generates a URN catalog, enabling PhpStorm to recognize and highlight URNs. It also enables auto-completion in PhpStorm.

Usage

vendor/bin/mftf generate:urn-catalog [--force] [<path to the directory with misc.xml>]

misc.xml is typically located in <project root>/.idea/.

Options

Option	Description
`-f, --force`	Creates the `misc.xml` file if it does not exist in the given `path`.

Example

vendor/bin/mftf generate:urn-catalog .idea/

`generate:docs`

Description

Generates documentation that lists all action groups available in the codebase. The default path is <projectRoot>/dev/tests/docs/documentation.md.

Usage

vendor/bin/mftf generate:docs [--clean] [--output=/path/to/alternate/dir]

Options

Option	Description
`-c, --clean`	Overwrites previously existing documentation
`-o, --output`	Changes the default output directory to a user specified directory

Example

vendor/bin/mftf generate:docs --clean

`reset`

Description

Cleans any configuration files and generated artifacts from the environment. The .env file is not affected.

Usage

vendor/bin/mftf reset [--hard]

Options

Option	Description
`--hard`	Forces a reset of the configuration files.

Example

vendor/bin/mftf reset --hard

`run:group`

Generates and executes the listed groups of tests using Codeception.

Usage

vendor/bin/mftf run:group [--skip-generate|--remove] [--] <group1> [<group2>]

Options

Option	Description
`-k, --skip-generate`	Skips generating from the source XML. Instead, the command executes previously-generated groups of tests.
`-r, --remove`	Removes previously generated suites and tests before the actual generation and run.
`--debug or --debug=[<none>]`	Performs schema validations on XML files. `run:group` implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. `--debug` performs per-file validation and returns additional debug information (such as the filename where an error occurred). `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.

Examples

Clean up after the last test run; generate from XML and execute the tests with the annotations group="group1" and group="group2":

vendor/bin/mftf -r -- run:group group1 group2

Execute previously generated tests with the annotations group="group1" and group="group2", skipping the regeneration of the test:

vendor/bin/mftf run:group -k -- group1 group2

`run:test`

Generates and executes tests by name using Codeception.

Usage

vendor/bin/mftf run:test [--skip-generate|--remove] [--] <name1> [<name2>]

Options

Option	Description
`-k, --skip-generate`	Skips generating from the source XML. Instead, the command executes previously-generated groups of tests.
`-r, --remove`	Remove previously generated suites and tests.
`--debug or --debug=[<none>]`	Performs schema validations on XML files. `run:test` implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. `--debug` performs per-file validation and returns additional debug information (such as the filename where an error occurred). `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.

Examples

Generate the LoginCustomerTest and StorefrontCreateCustomerTest tests from XML and execute all the generated tests:

vendor/bin/mftf run:test LoginCustomerTest StorefrontCreateCustomerTest

`run:manifest`

Runs a testManifest.txt file.

This command runs all tests specified in a testManifest.xml file. It does not generate tests for you. You must do that as first.

Usage

vendor/bin/mftf run:manifest path/to/your/testManifest.txt

Example testManifest.xml file

Each line should contain either: one test path or one group (-g) reference.

tests/functional/tests/MFTF/_generated/default/AdminLoginTestCest.php
-g PaypalTestSuite
tests/functional/tests/MFTF/_generated/default/SomeOtherTestCest.php
tests/functional/tests/MFTF/_generated/default/ThirdTestCest.php
-g SomeOtherSuite

`run:failed`

Regenerates and reruns tests that previously failed.

This command cleans up previously generated tests. It generates and runs the tests listed in dev/tests/acceptance/tests/_output/failed. For more details about failed, refer to Reporting.

Usage

vendor/bin/mftf run:failed

Options

Option Description

--debug or --debug=[<none>] Performs schema validations on XML files. run:failed implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. --debug performs per-file validation and returns additional debug information (such as the filename where an error occurred). Use it after test run has failed once. --debug=none skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.

Option	Description
`--debug or --debug=[<none>]`	Performs schema validations on XML files. `run:failed` implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. `--debug` performs per-file validation and returns additional debug information (such as the filename where an error occurred). Use it after test run has failed once. `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.

Examples

Run the tests that failed in the previous run:

vendor/bin/mftf run:failed

`setup:env`

Updates the configuration parameter values in the [.env] file. Creates the .env file if it does not exist.

Usage

vendor/bin/mftf setup:env [config_param_option1=<value>] [config_param_option2=<value>]

config_param is a configuration parameter from the .env file. The command consumes the parameters in a format of options assigned with values, for example --MAGENTO_BASE_URL=http://magento.local/. If you specify a parameter that the .env file does not contain, the command returns an error.

You can also update configuration parameter values when you use the build:project command.

Examples

To change values for the MAGENTO_BASE_URL and BROWSER:

vendor/bin/mftf setup:env --MAGENTO_BASE_URL=http://magento.local/ --BROWSER=firefox

To create a .env file with example parameters:

vendor/bin/mftf setup:env

The example parameters are taken from the etc/config/.env.example file.

`static-checks`

Runs all or specific MFTF static-checks on the test codebase that MFTF is currently attached to. If no script name argument is specified, all existing static check scripts will run.

Usage

vendor/bin/mftf static-checks [<names>]...

Examples

To check what existing static check scripts are available

vendor/bin/mftf static-checks --help

To run all existing static check scripts

vendor/bin/mftf static-checks

To run specific static check scripts

vendor/bin/mftf static-checks testDependencies

vendor/bin/mftf static-checks actionGroupArguments

vendor/bin/mftf static-checks testDependencies actionGroupArguments

Existing static checks

Test Dependency: Checks that test dependencies do not violate Magento module’s composer dependencies.
Action Group Unused Arguments: Checks that action groups do not have unused arguments.

`upgrade:tests`

Applies all the MFTF major version upgrade scripts to test components in the given path (test.xml, data.xml, etc).

Usage

vendor/bin/mftf upgrade:tests <path>

<path> is the path that contains MFTF test components that need to be upgraded. The command searches recursively for any *.xml files to upgrade.

Examples

To upgrade all test components inside modules in the dev/tests/acceptance/tests/ directory:

vendor/bin/mftf upgrade:tests /Users/user/magento2/dev/tests/acceptance/tests/

To upgrade all test components inside the Catalog module:

vendor/bin/mftf upgrade:tests /Users/user/magento2/app/code/Magento/Catalog/Test/Mftf/

Nov 13th, 2021