PhpUnitApiFindAllClassFilesTest.php

<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\Test;

use Drupal\Core\Test\PhpUnitTestDiscovery;
use Drupal\Core\Test\TestDiscovery;
use Drupal\KernelTests\KernelTestBase;
use Drupal\TestTools\PhpUnitCompatibility\RunnerVersion;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\IgnoreDeprecations;

/**
 * Tests ::findAllClassFiles() between TestDiscovery and PhpUnitTestDiscovery.
 *
 * PhpUnitTestDiscovery uses PHPUnit API to build the list of test classes,
 * while TestDiscovery uses Drupal legacy code.
 */
class PhpUnitApiFindAllClassFilesTest extends KernelTestBase {
    
    /**
     * Checks that Drupal legacy and PHPUnit API based discoveries are equal.
     */
    public function testEquality(?string $extension = NULL, ?string $directory = NULL) : void {
        $testDiscovery = new TestDiscovery($this->container
            ->getParameter('app.root'), $this->container
            ->get('class_loader'));
        $internalList = $testDiscovery->findAllClassFiles($extension, $directory);
        // Location of PHPUnit configuration file.
        $configurationFilePath = $this->container
            ->getParameter('app.root') . \DIRECTORY_SEPARATOR . 'core';
        // @todo once PHPUnit 10 is no longer used, remove the condition.
        // @see https://www.drupal.org/project/drupal/issues/3497116
        if (RunnerVersion::getMajor() >= 11) {
            $configurationFilePath .= \DIRECTORY_SEPARATOR . '.phpunit-next.xml';
        }
        $phpUnitTestDiscovery = new PhpUnitTestDiscovery($configurationFilePath);
        $phpUnitList = $phpUnitTestDiscovery->findAllClassFiles($extension, $directory);
        // Downgrade results to make them comparable, working around bugs and
        // additions.
        // 1. TestDiscovery discovers non-test classes that PHPUnit does not.
        $internalList = array_intersect_key($internalList, $phpUnitList);
        $this->assertEquals($internalList, $phpUnitList);
    }
    
    /**
     * Provides test data to ::testEquality.
     */
    public static function argumentsProvider() : \Generator {
        (yield 'All tests' => []);
        (yield 'Extension: system' => [
            'extension' => 'system',
        ]);
        (yield 'Extension: system, directory' => [
            'extension' => 'system',
            'directory' => 'core/modules/system/tests/src',
        ]);
    }

}