AllTestsRunner.php

<?php
/**
 * Copyright © OXID eSales AG. All rights reserved.
 * See LICENSE file for license details.
 */

use PHPUnit\Framework\TestCase;

/**
 * This class is used as a base class to run all CE|PE|EE edition tests.
 */
class AllTestsRunner extends TestCase
{

    /** @var array Default test suites */
    protected static $testSuites = array();

    /** @var array Run these tests before any other */
    protected static $priorityTests = array();

    /** @var OxidEsales\TestingLibrary\TestConfig */
    protected static $testConfig;

    /** @var string Filter for php test files. */
    protected static $phpFileFilter = '*Test\.php';

    /** @var string Filter for phpt test files. */
    protected static $phptFileFilter = '*Test\.phpt';

    /** @var array Lower cased test paths. Used to check if test file was not already added. */
    protected static $testFiles = array();

    /**
     * Forms test suite
     *
     * @return \PHPUnit\Framework\TestSuite
     */
    public static function suite()
    {
        $aTestDirectories = static::_getTestDirectories();

        $oSuite = new \PHPUnit\Framework\TestSuite('PHPUnit');

        static::_addPriorityTests($oSuite, static::$priorityTests, $aTestDirectories);

        foreach ($aTestDirectories as $sDirectory) {
            $aTestFiles = array_merge(
                glob("$sDirectory/" . static::$phpFileFilter),
                glob("$sDirectory/" . static::$phptFileFilter)
            );

            if (empty($aTestFiles)) {
                continue;
            }

            $printer = new \OxidEsales\TestingLibrary\Printer();
            $printer->write( "Adding unit tests from $sDirectory\n");

            $aTestFiles = array_diff($aTestFiles, static::$priorityTests);
            $oSuite = static::_addFilesToSuite($oSuite, $aTestFiles);
        }

        return $oSuite;
    }

    /**
     * Adds tests with highest priority.
     *
     * @param TestSuite $oSuite
     * @param array                       $aPriorityTests
     * @param array                       $aTestDirectories
     */
    public static function _addPriorityTests($oSuite, $aPriorityTests, $aTestDirectories)
    {
        if (!empty($aPriorityTests)) {
            $aTestsToInclude = array();
            foreach ($aPriorityTests as $sTestFile) {
                $sFolder = dirname($sTestFile);
                $aDirectories = array_filter($aTestDirectories, function($sTestDirectory) use ($sFolder){
                    return (substr($sTestDirectory, -strlen($sFolder)) === $sFolder);
                });
                if (!empty($aDirectories)) {
                    $fullPath = array_shift($aDirectories) .'/'. basename($sTestFile);
                    if (file_exists($fullPath)) {
                        $aTestsToInclude[] = $fullPath;
                    }
                }
            }
            static::_addFilesToSuite($oSuite, $aTestsToInclude);
        }
    }

    /**
     * Returns array of directories, which should be tested
     *
     * @return array
     */
    protected static function _getTestDirectories()
    {
        $aTestDirectories = array();
        $aTestSuites = getenv('TEST_DIRS')? explode(',', getenv('TEST_DIRS')) : static::$testSuites;

        $testConfig = static::getTestConfig();
        foreach ($aTestSuites as $sSuite) {
            $aTestDirectories[] = $testConfig->getCurrentTestSuite() ."/$sSuite";
        }

        return array_merge($aTestDirectories, static::_getDirectoryTree($aTestDirectories));
    }

    /**
     * Scans given tests directories and returns formed directory tree
     *
     * @param array $aDirectories
     *
     * @return array
     */
    protected static function _getDirectoryTree($aDirectories)
    {
        $aTree = array();

        foreach ($aDirectories as $sDirectory) {
            $aTree = array_merge($aTree, array_diff(glob($sDirectory . "/*", GLOB_ONLYDIR), array('.', '..')));
        }

        if (!empty($aTree)) {
            $aTree = array_merge($aTree, static::_getDirectoryTree($aTree));
        }

        return $aTree;
    }

    /**
     * Adds files to test suite
     *
     * @param TestSuite $oSuite
     * @param array                       $aTestFiles
     *
     * @return TestSuite
     */
    protected static function _addFilesToSuite($oSuite, $aTestFiles)
    {
        foreach ($aTestFiles as $sFilename) {
            $sFilter = getenv('PREG_FILTER');
            if (!$sFilter || preg_match("&$sFilter&i", $sFilename)) {
                $loweredFilename = strtolower($sFilename);
                if (!in_array($loweredFilename, self::$testFiles)) {
                    $oSuite->addTestFile($sFilename);
                    self::$testFiles[] = $loweredFilename;
                }
            }
        }

        return $oSuite;
    }

    /**
     * Returns Test configuration.
     *
     * @return OxidEsales\TestingLibrary\TestConfig
     */
    protected static function getTestConfig()
    {
        if (is_null(static::$testConfig)) {
            static::$testConfig = new OxidEsales\TestingLibrary\TestConfig();
        }

        return static::$testConfig;
    }
}