function TestCoverageTest::testEntityTypeRestTestCoverage

Same name in other branches
  1. 9 core/modules/jsonapi/tests/src/Kernel/TestCoverageTest.php \Drupal\Tests\jsonapi\Kernel\TestCoverageTest::testEntityTypeRestTestCoverage()
  2. 8.9.x core/modules/jsonapi/tests/src/Functional/TestCoverageTest.php \Drupal\Tests\jsonapi\Functional\TestCoverageTest::testEntityTypeRestTestCoverage()
  3. 10 core/modules/jsonapi/tests/src/Kernel/TestCoverageTest.php \Drupal\Tests\jsonapi\Kernel\TestCoverageTest::testEntityTypeRestTestCoverage()

Tests that all core entity types have JSON:API test coverage.

File

core/modules/jsonapi/tests/src/Kernel/TestCoverageTest.php, line 64

Class

TestCoverageTest
Checks that all core content/config entity types have JSON:API test coverage.

Namespace

Drupal\Tests\jsonapi\Kernel

Code

public function testEntityTypeRestTestCoverage() : void {
    $problems = [];
    foreach ($this->definitions as $entity_type_id => $info) {
        $class_name_full = $info->getClass();
        $parts = explode('\\', $class_name_full);
        $class_name = end($parts);
        $module_name = $parts[1];
        $possible_paths = [
            'Drupal\\Tests\\jsonapi\\Functional\\CLASSTest',
            '\\Drupal\\Tests\\' . $module_name . '\\Functional\\Jsonapi\\CLASSTest',
            // For entities defined in the system module with Jsonapi tests in
            // another module.
'\\Drupal\\Tests\\' . $info->id() . '\\Functional\\Jsonapi\\CLASSTest',
        ];
        foreach ($possible_paths as $path) {
            $missing_tests = [];
            $class = str_replace('CLASS', $class_name, $path);
            if (class_exists($class)) {
                break;
            }
            $missing_tests[] = $class;
        }
        if (!empty($missing_tests)) {
            $missing_tests_list = implode(', ', $missing_tests);
            $problems[] = "{$entity_type_id}: {$class_name} ({$class_name_full}) (expected tests: {$missing_tests_list})";
        }
        else {
            $config_entity = is_subclass_of($class_name_full, ConfigEntityInterface::class);
            $config_test = is_subclass_of($class, ConfigEntityResourceTestBase::class);
            if ($config_entity && !$config_test) {
                $problems[] = "{$entity_type_id}: {$class_name} is a config entity, but the test is for content entities.";
            }
            elseif (!$config_entity && $config_test) {
                $problems[] = "{$entity_type_id}: {$class_name} is a content entity, but the test is for config entities.";
            }
        }
    }
    $this->assertSame([], $problems);
}

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