SuiteGenerationTest Class Reference

Inheritance diagram for SuiteGenerationTest:

Public Member Functions
	setUp ()
	testSuiteGeneration1 ()
	testSuiteGenerationHooks ()
	tearDown ()
Public Member Functions inherited from MftfTestCase
	generateAndCompareTest ($testName)
	validateSchemaErrorWithTest ($fileContents, $objectType, $expectedError)

Static Public Member Functions
static	setUpBeforeClass ()
static	tearDownAfterClass ()

Data Fields
const	RESOURCES_DIR = TESTS_BP . DIRECTORY_SEPARATOR . 'verification' . DIRECTORY_SEPARATOR . 'Resources'
const	CONFIG_YML_FILE = TESTS_BP . DIRECTORY_SEPARATOR . SuiteGenerator::YAML_CODECEPTION_CONFIG_FILENAME
const	GENERATE_RESULT_DIR
Data Fields inherited from MftfTestCase
const	RESOURCES_PATH

Detailed Description

Definition at line 19 of file SuiteGenerationTest.php.

Member Function Documentation

setUp()

setUp

(

)

Definition at line 48 of file SuiteGenerationTest.php.

    {
        // copy config yml file to test dir
        $fileSystem = new \Symfony\Component\Filesystem\Filesystem();
        $fileSystem->copy(
            realpath(
                FW_BP
                . DIRECTORY_SEPARATOR
                . 'etc'
                . DIRECTORY_SEPARATOR
                . 'config'
                . DIRECTORY_SEPARATOR
                . 'codeception.dist.yml'
            ),
            self::CONFIG_YML_FILE
        );

        TestLoggingUtil::getInstance()->setMockLoggingUtil();
    }

setUpBeforeClass()

static setUpBeforeClass ( )

static

Set up config.yml for testing

Definition at line 40 of file SuiteGenerationTest.php.

    {
        // destroy _generated if it exists
        if (file_exists(self::GENERATE_RESULT_DIR)) {
            DirSetupUtil::rmdirRecursive(self::GENERATE_RESULT_DIR);
        }
    }

tearDown()

tearDown

(

)

revert any changes made to config.yml remove _generated directory

Definition at line 292 of file SuiteGenerationTest.php.

    {
        DirSetupUtil::rmdirRecursive(self::GENERATE_RESULT_DIR);

        // delete config yml file from test dir
        $fileSystem = new \Symfony\Component\Filesystem\Filesystem();
        $fileSystem->remove(
            self::CONFIG_YML_FILE
        );
    }

tearDownAfterClass()

static tearDownAfterClass ( )

static

Remove yml if created during tests and did not exist before

Definition at line 306 of file SuiteGenerationTest.php.

    {
        TestLoggingUtil::getInstance()->clearMockLoggingUtil();
    }

testSuiteGeneration1()

testSuiteGeneration1

(

)

Test basic generation of a suite

Definition at line 71 of file SuiteGenerationTest.php.

    {
        $groupName = 'functionalSuite1';

        $expectedContents = [
           'additionalTestCest.php',
           'additionalIncludeTest2Cest.php',
           'IncludeTest2Cest.php',
           'IncludeTestCest.php'
        ];

        // Generate the Suite
        SuiteGenerator::getInstance()->generateSuite($groupName);

        // Validate log message and add group name for later deletion
        TestLoggingUtil::getInstance()->validateMockLogStatement(
            'info',
            "suite generated",
            ['suite' => $groupName, 'relative_path' => "_generated" . DIRECTORY_SEPARATOR . $groupName]
        );

        self::$TEST_GROUPS[] = $groupName;

        // Validate Yaml file updated
        $yml = Yaml::parse(file_get_contents(self::CONFIG_YML_FILE));
        $this->assertArrayHasKey($groupName, $yml['groups']);

        $suiteResultBaseDir = self::GENERATE_RESULT_DIR .
            DIRECTORY_SEPARATOR .
            $groupName .
            DIRECTORY_SEPARATOR;

        // Validate tests have been generated
        $dirContents = array_diff(scandir($suiteResultBaseDir), ['..', '.']);

        foreach ($expectedContents as $expectedFile) {
            $this->assertTrue(in_array($expectedFile, $dirContents));
        }
    }

testSuiteGenerationHooks()

testSuiteGenerationHooks

(

)

Test hook groups generated during suite generation

Definition at line 172 of file SuiteGenerationTest.php.

    {
        $groupName = 'functionalSuiteHooks';

        $expectedContents = [
            'IncludeTestCest.php'
        ];

        // Generate the Suite
        SuiteGenerator::getInstance()->generateSuite($groupName);

        // Validate log message and add group name for later deletion
        TestLoggingUtil::getInstance()->validateMockLogStatement(
            'info',
            "suite generated",
            ['suite' => $groupName, 'relative_path' => "_generated" . DIRECTORY_SEPARATOR . $groupName]
        );
        self::$TEST_GROUPS[] = $groupName;

        // Validate Yaml file updated
        $yml = Yaml::parse(file_get_contents(self::CONFIG_YML_FILE));
        $this->assertArrayHasKey($groupName, $yml['groups']);

        $suiteResultBaseDir = self::GENERATE_RESULT_DIR .
            DIRECTORY_SEPARATOR .
            $groupName .
            DIRECTORY_SEPARATOR;

        // Validate tests have been generated
        $dirContents = array_diff(scandir($suiteResultBaseDir), ['..', '.']);

        foreach ($expectedContents as $expectedFile) {
            $this->assertTrue(in_array($expectedFile, $dirContents));
        }

        //assert group file created and contains correct contents
        $groupFile = PROJECT_ROOT .
            DIRECTORY_SEPARATOR .
            "src" .
            DIRECTORY_SEPARATOR .
            "Magento" .
            DIRECTORY_SEPARATOR .
            "FunctionalTestingFramework" .
            DIRECTORY_SEPARATOR .
            "Group" .
            DIRECTORY_SEPARATOR .
            $groupName .
            ".php";

        $this->assertTrue(file_exists($groupFile));
        $this->assertFileEquals(
            self::RESOURCES_PATH . DIRECTORY_SEPARATOR . $groupName . ".txt",
            $groupFile
        );
    }

Field Documentation

CONFIG_YML_FILE

const CONFIG_YML_FILE = TESTS_BP . DIRECTORY_SEPARATOR . SuiteGenerator::YAML_CODECEPTION_CONFIG_FILENAME

Definition at line 22 of file SuiteGenerationTest.php.

GENERATE_RESULT_DIR

const GENERATE_RESULT_DIR

Initial value:

= TESTS_BP .
        DIRECTORY_SEPARATOR .
        "verification" .
        DIRECTORY_SEPARATOR .
        "_generated" .
        DIRECTORY_SEPARATOR

Definition at line 23 of file SuiteGenerationTest.php.

RESOURCES_DIR

const RESOURCES_DIR = TESTS_BP . DIRECTORY_SEPARATOR . 'verification' . DIRECTORY_SEPARATOR . 'Resources'

Definition at line 21 of file SuiteGenerationTest.php.

---

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

• vendor/magento/magento2-functional-testing-framework/dev/tests/verification/Tests/SuiteGenerationTest.php