RoboFile Class Reference

Inheritance diagram for RoboFile:

Public Member Functions
	buildProject ()
	generateTests (array $tests, $opts=[ 'config'=> null, 'force'=> false, 'nodes'=> null, 'lines'=> null, 'tests'=> null])
	generateSuite (array $args)
	group (array $args)
	allure1Generate ()
	allure2Generate ()
	allure1Open ()
	allure2Open ()
	allure1Report ()
	allure2Report ()

Detailed Description

This is project's console commands configuration for Robo task runner.

@codingStandardsIgnoreStart

See also

http://robo.li/

Definition at line 14 of file RoboFile.php.

Member Function Documentation

allure1Generate()

allure1Generate

(

)

Generate the HTML for the Allure report based on the Test XML output - Allure v1.4.X

Returns

\Robo\Result

Definition at line 96 of file RoboFile.php.

    {
        return $this->_exec('allure generate tests'. DIRECTORY_SEPARATOR .'_output'. DIRECTORY_SEPARATOR .'allure-results'. DIRECTORY_SEPARATOR .' -o tests'. DIRECTORY_SEPARATOR .'_output'. DIRECTORY_SEPARATOR .'allure-report'. DIRECTORY_SEPARATOR .'');
    }

allure1Open()

allure1Open

(

)

Open the HTML Allure report - Allure v1.4.X

Returns

\Robo\Result

Definition at line 116 of file RoboFile.php.

    {
        return $this->_exec('allure report open --report-dir tests'. DIRECTORY_SEPARATOR .'_output'. DIRECTORY_SEPARATOR .'allure-report'. DIRECTORY_SEPARATOR .'');
    }

allure1Report()

allure1Report

(

)

Generate and open the HTML Allure report - Allure v1.4.X

Returns

\Robo\Result

Definition at line 136 of file RoboFile.php.

    {
        $result1 = $this->allure1Generate();

        if ($result1->wasSuccessful()) {
            return $this->allure1Open();
        } else {
            return $result1;
        }
    }

allure2Generate()

allure2Generate

(

)

Generate the HTML for the Allure report based on the Test XML output - Allure v2.3.X

Returns

\Robo\Result

Definition at line 106 of file RoboFile.php.

    {
        return $this->_exec('allure generate tests'. DIRECTORY_SEPARATOR .'_output'. DIRECTORY_SEPARATOR .'allure-results'. DIRECTORY_SEPARATOR .' --output tests'. DIRECTORY_SEPARATOR .'_output'. DIRECTORY_SEPARATOR .'allure-report'. DIRECTORY_SEPARATOR .' --clean');
    }

allure2Open()

allure2Open

(

)

Open the HTML Allure report - Allure v2.3.X

Returns

\Robo\Result

Definition at line 126 of file RoboFile.php.

    {
        return $this->_exec('allure open --port 0 tests'. DIRECTORY_SEPARATOR .'_output'. DIRECTORY_SEPARATOR .'allure-report'. DIRECTORY_SEPARATOR .'');
    }

allure2Report()

allure2Report

(

)

Generate and open the HTML Allure report - Allure v2.3.X

Returns

\Robo\Result

Definition at line 152 of file RoboFile.php.

    {
        $result1 = $this->allure2Generate();

        if ($result1->wasSuccessful()) {
            return $this->allure2Open();
        } else {
            return $result1;
        }
    }

buildProject()

buildProject

(

)

Duplicate the Example configuration files for the Project. Build the Codeception project.

Returns

void

Definition at line 24 of file RoboFile.php.

    {
        passthru($this->getBaseCmd("build:project"));
    }

generateSuite()

generateSuite

(

array

$args

)

Generate a suite based on name(s) passed in as args.

Parameters

array

$args

Exceptions

Exception

Returns

\Robo\Result

Definition at line 69 of file RoboFile.php.

    {
        if (empty($args)) {
            throw new Exception("Please provide suite name(s) after generate:suite command");
        }
        $baseCmd = $this->getBaseCmd("generate:suite");
        return $this->taskExec($baseCmd)->args($args)->run();
    }

generateTests()

generateTests	(	array	$tests,
			$opts = [ 'config' =,
		null	,
		'force'	,
		false	,
		'nodes'	,
		null	,
		'lines'	,
		null	,
		'tests'	,
		null]
	)

Generate all Tests in PHP OR Generate set of tests via passing array of tests

Parameters

array	$tests
array	$opts

Returns

\Robo\Result

Definition at line 36 of file RoboFile.php.

    {
        $baseCmd = $this->getBaseCmd("generate:tests");

        $mftfArgNames = ['config', 'nodes', 'lines', 'tests'];
        // append arguments to the end of the command
        foreach ($opts as $argName => $argValue) {
            if (in_array($argName, $mftfArgNames) && $argValue !== null) {
                $baseCmd .= " --$argName $argValue";
            }
        }

        // use a separate conditional for the force flag (casting bool to string in php is hard)
        if ($opts['force']) {
            $baseCmd .= ' --force';
        }

        return $this->taskExec($baseCmd)->args($tests)->run();
    }

group()

group

(

array

$args

)

Run all Tests with the specified @group tag'.

Parameters

array

$args

Returns

\Robo\Result

Definition at line 84 of file RoboFile.php.

    {
        $args = array_merge($args, ['-k']);
        $baseCmd = $this->getBaseCmd("run:group");
        return $this->taskExec($baseCmd)->args($args)->run();
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/acceptance/RoboFile.php