Issue #2868035 by Wim Leers, vaplas, dawehner, larowlan: Test that all core content+config entity types have functional REST test coverage
xjm
parent
752fd5a721
commit
435bae86a1
|
|
@ -0,0 +1,163 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\Tests\rest\Functional\EntityResource;
|
||||
|
||||
use Drupal\Tests\BrowserTestBase;
|
||||
|
||||
/**
|
||||
* Checks that all core content/config entity types have REST test coverage.
|
||||
*
|
||||
* Every entity type must have test coverage for:
|
||||
* - every format in core (json + hal_json)
|
||||
* - every authentication provider in core (anon, cookie, basic_auth)
|
||||
*
|
||||
* @todo Also require XML after https://www.drupal.org/node/2800873 lands.
|
||||
*
|
||||
* @group rest
|
||||
*/
|
||||
class EntityResourceRestTestCoverageTest extends BrowserTestBase {
|
||||
|
||||
/**
|
||||
* Entity definitions array.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $definitions;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
|
||||
$all_modules = system_rebuild_module_data();
|
||||
$stable_core_modules = array_filter($all_modules, function ($module) {
|
||||
// Filter out contrib, hidden, testing, and experimental modules. We also
|
||||
// don't need to enable modules that are already enabled.
|
||||
return
|
||||
$module->origin === 'core' &&
|
||||
empty($module->info['hidden']) &&
|
||||
$module->status == FALSE &&
|
||||
$module->info['package'] !== 'Testing' &&
|
||||
$module->info['package'] !== 'Core (Experimental)';
|
||||
});
|
||||
|
||||
$this->container->get('module_installer')->install(array_keys($stable_core_modules));
|
||||
$this->rebuildContainer();
|
||||
|
||||
$this->definitions = $this->container->get('entity_type.manager')->getDefinitions();
|
||||
|
||||
// Remove definitions for which the REST resource plugin definition was
|
||||
// removed via hook_rest_resource_alter(). Entity types which are never
|
||||
// exposed via REST also don't need test coverage.
|
||||
$resource_plugin_ids = array_keys($this->container->get('plugin.manager.rest')->getDefinitions());
|
||||
foreach (array_keys($this->definitions) as $entity_type_id) {
|
||||
if (!in_array("entity:$entity_type_id", $resource_plugin_ids, TRUE)) {
|
||||
unset($this->definitions[$entity_type_id]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that all core content/config entity types have REST test coverage.
|
||||
*/
|
||||
public function testEntityTypeRestTestCoverage() {
|
||||
$default_test_locations = [
|
||||
// Test coverage for formats provided by the 'serialization' module.
|
||||
'serialization' => [
|
||||
'possible paths' => [
|
||||
'\Drupal\Tests\rest\Functional\EntityResource\CLASS\CLASS',
|
||||
],
|
||||
'class suffix' => [
|
||||
'JsonAnonTest',
|
||||
'JsonBasicAuthTest',
|
||||
'JsonCookieTest',
|
||||
],
|
||||
],
|
||||
// Test coverage for formats provided by the 'hal' module.
|
||||
'hal' => [
|
||||
'possible paths' => [
|
||||
'\Drupal\Tests\hal\Functional\EntityResource\CLASS\CLASS',
|
||||
],
|
||||
'class suffix' => [
|
||||
'HalJsonAnonTest',
|
||||
'HalJsonBasicAuthTest',
|
||||
'HalJsonCookieTest',
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
$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];
|
||||
|
||||
// The test class can live either in the REST/HAL module, or in the module
|
||||
// providing the entity type.
|
||||
$tests = $default_test_locations;
|
||||
$tests['serialization']['possible paths'][] = '\Drupal\Tests\\' . $module_name . '\Functional\Rest\CLASS';
|
||||
$tests['hal']['possible paths'][] = '\Drupal\Tests\\' . $module_name . '\Functional\Hal\CLASS';
|
||||
|
||||
foreach ($tests as $module => $info) {
|
||||
$possible_paths = $info['possible paths'];
|
||||
foreach ($info['class suffix'] as $postfix) {
|
||||
do {
|
||||
$path = array_shift($possible_paths);
|
||||
$class = str_replace('CLASS', $class_name, $path . $postfix);
|
||||
if (class_exists($class)) {
|
||||
continue 3;
|
||||
}
|
||||
} while (!empty($possible_paths));
|
||||
$problems[] = "$entity_type_id: $class_name ($class_name_full)";
|
||||
break 2;
|
||||
}
|
||||
}
|
||||
}
|
||||
$all = count($this->definitions);
|
||||
$good = $all - count($problems);
|
||||
// @todo Remove this in https://www.drupal.org/node/2843139. Having this
|
||||
// work-around in here until then means we can ensure we don't add more
|
||||
// entity types without adding REST test coverage.
|
||||
if ($problems === ['file: File (Drupal\file\Entity\File)']) {
|
||||
$problems = [];
|
||||
}
|
||||
elseif ($problems === []) {
|
||||
$this->fail('Drupal\file\Entity\File now supports REST test coverage. The work-around for it to pass until that test coverage was added should now be removed.');
|
||||
}
|
||||
$this->assertSame([], $problems, $this->getLlamaMessage($good, $all));
|
||||
}
|
||||
|
||||
/**
|
||||
* Message from Llama.
|
||||
*
|
||||
* @param int $g
|
||||
* A count of entities with test coverage.
|
||||
* @param int $a
|
||||
* A count of all entities.
|
||||
*
|
||||
* @return string
|
||||
* An information about progress of REST test coverage.
|
||||
*/
|
||||
protected function getLlamaMessage($g, $a) {
|
||||
return "
|
||||
☼
|
||||
________________________
|
||||
/ Hi! \\
|
||||
| It's llame to not have |
|
||||
| complete REST tests! |
|
||||
| |
|
||||
| Progress: $g/$a. |
|
||||
| ________________________/
|
||||
|/
|
||||
// o
|
||||
l'>
|
||||
ll
|
||||
llama
|
||||
|| ||
|
||||
'' ''
|
||||
";
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue