PhpUnitTestDiscoveryTest.php

<?php

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

use Drupal\Core\Test\TestDiscovery;
use Drupal\KernelTests\KernelTestBase;
use Symfony\Component\Process\Process;

/**
 * Tests equality of test discovery between run-tests.sh and PHPUnit CLI.
 *
 * Generate the list of tests for all the tests that PHPUnit can discover.
 * The goal here is to successfully generate the list, without any
 * duplicate namespace errors, deprecation errors or so forth. This keeps
 * us from committing tests which don't break under run-tests.sh, but do
 * break under the PHPUnit CLI test runner tool. We then cross check the
 * list thus generated, with the list generated by
 * \Drupal\Core\Test\TestDiscovery, which is used by run-tests.sh, to ensure
 * both methods will run the same tests,
 *
 * @group TestSuites
 * @group Test
 * @group #slow
 */
class PhpUnitTestDiscoveryTest extends KernelTestBase {
    
    /**
     * The filepath to the XML file to be used for dumping the test list.
     */
    private string $xmlOutputFile;
    
    /**
     * {@inheritdoc}
     */
    public function setUp() : void {
        parent::setUp();
        $xmlOutputFile = $this->container
            ->getParameter('app.root') . DIRECTORY_SEPARATOR . 'test-list.xml';
        touch($xmlOutputFile);
        $this->xmlOutputFile = realpath($xmlOutputFile);
    }
    
    /**
     * {@inheritdoc}
     */
    public function tearDown() : void {
        @unlink($this->xmlOutputFile);
        parent::tearDown();
    }
    
    /**
     * Tests equality of test discovery between run-tests.sh and PHPUnit CLI.
     */
    public function testPhpUnitTestDiscoveryEqualsInternal() : void {
        // PHPUnit's own test discovery.
        $process = new Process([
            'vendor/bin/phpunit',
            '--configuration',
            'core',
            '--list-tests-xml',
            $this->xmlOutputFile,
        ], $this->root);
        $process->setTimeout(300)
            ->setIdleTimeout(300)
            ->run();
        $this->assertEquals(0, $process->getExitCode(), 'COMMAND: ' . $process->getCommandLine() . "\n" . 'OUTPUT: ' . $process->getOutput() . "\n" . 'ERROR: ' . $process->getErrorOutput() . "\n");
        $phpUnitXmlList = new \DOMDocument();
        $phpUnitXmlList->loadXML(file_get_contents($this->xmlOutputFile));
        $phpUnitList = [];
        foreach ($phpUnitXmlList->getElementsByTagName('testCaseClass') as $node) {
            $phpUnitList[] = $node->getAttribute('name');
        }
        asort($phpUnitList);
        // Drupal's own test discovery, used by run-tests.sh.
        $testDiscovery = new TestDiscovery($this->container
            ->getParameter('app.root'), $this->container
            ->get('class_loader'));
        $internalList = [];
        foreach ($testDiscovery->getTestClasses() as $group) {
            foreach (array_keys($group) as $class) {
                $internalList[] = $class;
            }
        }
        $internalList = array_unique($internalList);
        asort($internalList);
        $this->assertEquals(array_values($phpUnitList), array_values($internalList));
    }

}