function EntityResourceRestTestCoverageTest::testEntityTypeRestTestCoverage

Tests that all core content/config entity types have REST test coverage.

File

core/modules/rest/tests/src/Kernel/EntityResource/EntityResourceRestTestCoverageTest.php, line 70

Class

EntityResourceRestTestCoverageTest

Checks that all core content/config entity types have REST test coverage.

Namespace

Code

public function testEntityTypeRestTestCoverage() : void {
    $tests = [
        // Test coverage for formats provided by the 'serialization' module.
'serialization' => [
            'path' => '\\Drupal\\Tests\\PROVIDER\\Functional\\Rest\\CLASS',
            'class suffix' => [
                'JsonAnonTest',
                'JsonBasicAuthTest',
                'JsonCookieTest',
                'XmlAnonTest',
                'XmlBasicAuthTest',
                'XmlCookieTest',
            ],
        ],
    ];
    $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];
        foreach ($tests as $module => $info) {
            $path = $info['path'];
            $missing_tests = [];
            foreach ($info['class suffix'] as $postfix) {
                $class = str_replace([
                    'PROVIDER',
                    'CLASS',
                ], [
                    $module_name,
                    $class_name,
                ], $path . $postfix);
                $class_alternative = str_replace("\\Drupal\\Tests\\{$module_name}\\Functional", '\\Drupal\\FunctionalTests', $class);
                // For entities defined in the system module with Jsonapi tests in
                // another module.
                $class_entity_in_system_alternative = str_replace([
                    'PROVIDER',
                    'CLASS',
                ], [
                    $entity_type_id,
                    $class_name,
                ], $path . $postfix);
                if (class_exists($class) || class_exists($class_alternative) || class_exists($class_entity_in_system_alternative)) {
                    continue;
                }
                $missing_tests[] = $postfix;
            }
            if (!empty($missing_tests)) {
                $missing_tests_list = implode(', ', array_map(function ($missing_test) use ($class_name) {
                    return $class_name . $missing_test;
                }, $missing_tests));
                $which_normalization = $module === 'serialization' ? 'default' : $module;
                $problems[] = "{$entity_type_id}: {$class_name} ({$class_name_full}), {$which_normalization} normalization (expected tests: {$missing_tests_list})";
            }
        }
        $config_entity = is_subclass_of($class_name_full, ConfigEntityInterface::class);
        $config_test = is_subclass_of($class, ConfigEntityResourceTestBase::class) || is_subclass_of($class_alternative, ConfigEntityResourceTestBase::class) || is_subclass_of($class_entity_in_system_alternative, 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);
}