SuiteObject.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\Suite\Objects;

use Magento\FunctionalTestingFramework\Test\Objects\TestHookObject;
use Magento\FunctionalTestingFramework\Test\Objects\TestObject;

class SuiteObject
{
    private $name;

    private $includeTests = [];

    private $excludeTests = [];

    private $hooks;

    public function __construct($name, $includeTests, $excludeTests, $hooks)
    {
        $this->name = $name;
        $this->includeTests = $includeTests;
        $this->excludeTests = $excludeTests;
        $this->hooks = $hooks;
    }

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

    public function getTests()
    {
        return $this->resolveTests($this->includeTests, $this->excludeTests);
    }

    private function resolveTests($includeTests, $excludeTests)
    {
        $finalTestList = $includeTests;
        $matchingTests = array_intersect(array_keys($includeTests), array_keys($excludeTests));

        // filter out tests for exclusion here
        foreach ($matchingTests as $testName) {
            unset($finalTestList[$testName]);
        }

        if (empty($finalTestList)) {
            trigger_error(
                "Current suite configuration for " .
                $this->name . " contains no tests.",
                E_USER_WARNING
            );
        }

        return $finalTestList;
    }

    public function requiresGroupFile()
    {
        return !empty($this->hooks);
    }

    public function getHooks()
    {
        return $this->hooks;
    }

    public function getBeforeHook()
    {
        return $this->hooks['before'] ?? null;
    }

    public function getAfterHook()
    {
        return $this->hooks['after'] ?? null;
    }
}