DrupalComponentTestListenerTrait.php

Same filename in other branches
  1. 9 core/tests/Drupal/Tests/Listeners/DrupalComponentTestListenerTrait.php
  2. 8.9.x core/tests/Drupal/Tests/Listeners/DrupalComponentTestListenerTrait.php
  3. 10 core/tests/Drupal/Tests/Listeners/DrupalComponentTestListenerTrait.php

Namespace

Drupal\Tests\Listeners

File

core/tests/Drupal/Tests/Listeners/DrupalComponentTestListenerTrait.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Tests\Listeners;

use Drupal\KernelTests\KernelTestBase;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\UnitTestCase;
use PHPUnit\Framework\AssertionFailedError;

/**
 * Ensures that no component tests are extending a core test base class.
 *
 * @internal
 */
trait DrupalComponentTestListenerTrait {
    
    /**
     * Reacts to the end of a test.
     *
     * @param \PHPUnit\Framework\Test $test
     *   The test object that has ended its test run.
     * @param float $time
     *   The time the test took.
     */
    protected function componentEndTest($test, $time) {
        
        /** @var \PHPUnit\Framework\Test $test */
        if (str_starts_with($test->toString(), 'Drupal\\Tests\\Component')) {
            if ($test instanceof BrowserTestBase || $test instanceof KernelTestBase || $test instanceof UnitTestCase) {
                $error = new AssertionFailedError('Component tests should not extend a core test base class.');
                $test->getTestResultObject()
                    ->addFailure($test, $error, $time);
            }
        }
    }

}

Traits

Title Deprecated Summary
DrupalComponentTestListenerTrait Ensures that no component tests are extending a core test base class.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.