Robo commands

This topic was updated due to the 2.2.0 MFTF release.

Robo is a task runner for PHP that allows you to alias long, complex command line interface (CLI) commands to simple commands.

Usage

Format

Assuming that you’re working in the magento2/dev/tests/acceptance directory in your terminal, run Robo commands using the following format:

vendor/bin/robo command [options] [arguments]

Or, if you added the path of the Robo executable file to the system PATH, then run Robo commands using the following format:

robo command [options] [arguments]

Example

• Original:

  allure generate tests/_output/allure-results/ -o tests/_output/allure-report/
  

• Robo:

  vendor/bin/robo allure1:generate
  

Useful commands

The following are the most popular commands used to interact with the MFTF. For more commands, see Reference or run in your terminal:

vendor/bin/robo

Codeception Robo Commands

List all available Robo commands

vendor/bin/robo

Duplicate the example configuration files used to customize the project

vendor/bin/robo clone:files

Build the Codeception project

vendor/bin/robo build:project

Generate all tests in PHP

vendor/bin/robo generate:tests

Generate the specified tests in PHP

vendor/bin/robo generate:tests testName01 testName02 testName03

Run all tests marked with the @group tag example, using the Chrome environment

vendor/bin/robo example

Run all functional tests located under the directory path provided

vendor/bin/robo folder <path/to/folder/with/tests>

Run all generated tests

The command runs all the generated tests. The generated test are stored in the acceptance/tests/functional/Magento/FunctionalTest/_generated directory.

vendor/bin/robo functional

Run tests with the specified group annotation

vendor/bin/robo group <group-value>

Run skipped tests

Typically, each test tagged by the <group value="skip"> annotation is ignored during test run. But in case you still need to run the skipped tests, run:

vendor/bin/robo group skip

Allure Robo commands

To determine which version of the Allure command you need to use run allure --version.

Generate the HTML for the Allure report based on the test XML output

Allure v1.x.x:

vendor/bin/robo allure1:generate

Allure v2.x.x:

vendor/bin/robo allure2:generate

Open the HTML Allure report

Allure v1.x.x:

vendor/bin/robo allure1:open

Allure v2.x.x:

vendor/bin/robo allure2:open

Generate and open the HTML Allure report

Allure v1.x.x:

vendor/bin/robo allure1:report

Allure v2.x.x:

vendor/bin/robo allure2:report

Reference

general

allure1

allure2

build

clone

generate

Generate PHP code from the tests defined in XML files.

Path to a directory with generated tests: tests/functional/Magento/FunctionalTest/_generated/.

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 contained 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 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 the above configuration:

vendor/bin/robo generate:tests --tests "{\r\n\"tests\":[\r\n\"general_test1\",\r\n\"general_test2\",\r\n\"general_test3\"\r\n],\r\n\"suites\":{\r\n\"sample\":[\r\n\"suite_test1\"\r\n],\r\n\"sample2\":null\r\n}\r\n}"

self