ActionObjectExtractorTest.php

Go to the documentation of this file.

<?php
namespace tests\unit\Magento\FunctionalTestFramework\Test\Util;

use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
use Magento\FunctionalTestingFramework\Util\MagentoTestCase;
use tests\unit\Util\TestLoggingUtil;

class ActionObjectExtractorTest extends MagentoTestCase
{
    private $testActionObjectExtractor;

    public function setUp()
    {
        $this->testActionObjectExtractor = new ActionObjectExtractor();
        TestLoggingUtil::getInstance()->setMockLoggingUtil();
    }

    public function testBasicActionObjectExtration()
    {
        $actionObjects = $this->testActionObjectExtractor->extractActions($this->createBasicActionObjectArray());
        $this->assertCount(1, $actionObjects);

        $firstElement = array_values($actionObjects)[0];
        $this->assertEquals('testAction1', $firstElement->getStepKey());
        $this->assertCount(1, $firstElement->getCustomActionAttributes());
    }

    public function testInvalidMergeOrderReference()
    {
        $invalidArray = $this->createBasicActionObjectArray('invalidTestAction1', 'invalidTestAction1');
        $this->expectException(\Magento\FunctionalTestingFramework\Exceptions\TestReferenceException::class);
        try {
            $this->testActionObjectExtractor->extractActions($invalidArray, 'TestWithSelfReferencingStepKey');
        } catch (\Exception $e) {
            TestLoggingUtil::getInstance()->validateMockLogStatmentRegex(
                'error',
                '/Line \d*: Invalid ordering configuration in test/',
                [
                    'test' => 'TestWithSelfReferencingStepKey',
                    'stepKey' => ['invalidTestAction1']
                ]
            );

            throw $e;
        }
    }

    public function testAmbiguousMergeOrderReference()
    {
        $ambiguousArray = $this->createBasicActionObjectArray('testAction1');
        $ambiguousArray = array_merge(
            $ambiguousArray,
            $this->createBasicActionObjectArray('testAction2', 'testAction1')
        );

        $ambiguousArray = array_merge(
            $ambiguousArray,
            $this->createBasicActionObjectArray('testAction3', null, 'testAction1')
        );

        $this->testActionObjectExtractor->extractActions($ambiguousArray, 'AmbiguousRefTest');
        TestLoggingUtil::getInstance()->validateMockLogStatement(
            'warning',
            'multiple actions referencing step key',
            [
                'test' => 'AmbiguousRefTest',
                'stepKey' => 'testAction1',
                'ref' => ['testAction2', 'testAction3']
            ]
        );
    }

    public function testEmptyStepKey()
    {
        $this->expectExceptionMessage("StepKeys cannot be empty.    Action='sampleAction'");
        $this->testActionObjectExtractor->extractActions($this->createBasicActionObjectArray(""));
    }

    private function createBasicActionObjectArray($stepKey = 'testAction1', $before = null, $after = null)
    {
        $baseArray = [
            $stepKey => [
                "nodeName" => "sampleAction",
                "stepKey" => $stepKey,
                "someAttribute" => "someAttributeValue"
            ]
        ];

        if ($before) {
            $baseArray[$stepKey] = array_merge($baseArray[$stepKey], ['before' => $before]);
        }

        if ($after) {
            $baseArray[$stepKey] = array_merge($baseArray[$stepKey], ['after' => $after]);
        }

        return $baseArray;
    }

    public static function tearDownAfterClass()
    {
        TestLoggingUtil::getInstance()->clearMockLoggingUtil();
    }
}