SuiteDataArrayBuilder.php

Go to the documentation of this file.

<?php
namespace tests\unit\Util;

use Magento\FunctionalTestingFramework\Suite\Util\SuiteObjectExtractor;
use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;

class SuiteDataArrayBuilder
{
    private $name;

    private $testActionBeforeName = 'testActionBefore';

    private $testActionAfterName = 'testActionAfter';

    private $beforeHook = [];

    private $afterHook = [];

    private $includes = [];

    private $excludes = [];

    public $testActionType = 'testAction';

    public function withName($name)
    {
        $this->name = $name;
        return $this;
    }

    public function includeTests($tests)
    {
        $this->includes = $this->appendEntriesToSuiteContents($this->includes, 'test', $tests);
        return $this;
    }

    public function excludeTests($tests)
    {
        $this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'test', $tests);
        return $this;
    }

    public function includeGroups($groups)
    {
        $this->includes = $this->appendEntriesToSuiteContents($this->includes, 'group', $groups);
        return $this;
    }

    public function excludeGroups($groups)
    {
        $this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'groups', $groups);
        return $this;
    }

    public function includeModules($modules)
    {
        $this->includes = $this->appendEntriesToSuiteContents($this->includes, 'module', $modules);
        return $this;
    }

    public function excludeModules($modules)
    {
        $this->excludes = $this->appendEntriesToSuiteContents($this->excludes, 'module', $modules);
        return $this;
    }

    private function appendEntriesToSuiteContents($currentContents, $type, $contents)
    {
        $newContents = $currentContents;
        foreach ($contents as $entry) {
            $newContents[$entry] = [
                SuiteObjectExtractor::NODE_NAME => $type,
                SuiteObjectExtractor::NAME => $entry
            ];
        }

        return $newContents;
    }

    public function withAfterHook($afterHook = null)
    {
        if ($afterHook == null) {
            $this->afterHook = [$this->testActionAfterName => [
                ActionObjectExtractor::NODE_NAME => $this->testActionType,
                ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionAfterName

            ]];
        } else {
            $this->afterHook = $afterHook;
        }

        return $this;
    }

    public function withBeforeHook($beforeHook = null)
    {
        if ($beforeHook == null) {
            $this->beforeHook = [$this->testActionBeforeName => [
                ActionObjectExtractor::NODE_NAME => $this->testActionType,
                ActionObjectExtractor::TEST_STEP_MERGE_KEY => $this->testActionBeforeName
            ]];
        } else {
            $this->beforeHook = $beforeHook;
        }

        return $this;
    }

    public function build()
    {
        return ['suites' => [
            $this->name => [
                SuiteObjectExtractor::NAME => $this->name,
                TestObjectExtractor::TEST_BEFORE_HOOK => $this->beforeHook,
                TestObjectExtractor::TEST_AFTER_HOOK => $this->afterHook,
                SuiteObjectExtractor::INCLUDE_TAG_NAME => $this->includes,
                SuiteObjectExtractor::EXCLUDE_TAG_NAME => $this->excludes
            ]
        ]];
    }
}