reverted: --- b/core/modules/field/tests/src/Kernel/FieldDefinitionAvailabilityTest.php +++ /dev/null @@ -1,121 +0,0 @@ -origin === 'core' - && empty($module->info['hidden']) - && $module->status == FALSE - && $module->info['package'] !== 'Testing' - && is_readable($module->getPath() . '/src/Entity')); - }); - - $dependencies = NestedArray::mergeDeepArray(array_map(function (Extension $module) { - return array_keys($module->requires); - }, $modules)); - - $modules = array_unique(NestedArray::mergeDeep(array_keys($modules), $dependencies)); - $modules = array_diff($modules, static::$modules); - - $this->enableModules($modules); - - /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_formatter_manager */ - $field_formatter_manager = \Drupal::service('plugin.manager.field.formatter'); - - /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_widget_manager */ - $field_widget_manager = \Drupal::service('plugin.manager.field.widget'); - - /** @var \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager */ - $entity_field_manager = \Drupal::service('entity_field.manager'); - - /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */ - $entity_type_manager = \Drupal::service('entity_type.manager'); - - /** @var \Drupal\Core\Field\BaseFieldDefinition[][] $field_definitions */ - $field_definitions = []; - - /** @var \Drupal\Core\Entity\EntityTypeInterface[] $content_entity_types */ - $content_entity_types = array_filter($entity_type_manager->getDefinitions(), function (EntityTypeInterface $entity_type) { - return $entity_type instanceof ContentEntityTypeInterface; - }); - - foreach ($content_entity_types as $entity_type_id => $entity_type_definition) { - $field_definitions[$entity_type_id] = $entity_field_manager->getBaseFieldDefinitions($entity_type_id); - } - - foreach ($field_definitions as $entity_type_id => $definitions) { - foreach ($definitions as $field_id => $field_definition) { - $this->checkDisplayOption($entity_type_id, $field_id, $field_definition, $field_formatter_manager, 'view'); - $this->checkDisplayOption($entity_type_id, $field_id, $field_definition, $field_widget_manager, 'form'); - } - } - } - - /** - * Helper method that tries to load plugin definitions. - * - * @param string $entity_type_id - * Id of entity type. Required by message. - * @param string $field_id - * Id of field. Required by message. - * @param \Drupal\Core\Field\BaseFieldDefinition $field_definition - * Field definition that provide display options. - * @param \Drupal\Component\Plugin\Discovery\DiscoveryInterface $plugin_manager - * Plugin manager that will try to provide plugin definition. - * @param string $display_context - * Defines which display options should be loaded. - */ - protected function checkDisplayOption($entity_type_id, $field_id, BaseFieldDefinition $field_definition, DiscoveryInterface $plugin_manager, $display_context) { - $form_display_options = $field_definition->getDisplayOptions($display_context); - if (!empty($form_display_options) && !empty($form_display_options['type'])) { - try { - $plugin_manager->getDefinition($form_display_options['type']); - } - catch (PluginNotFoundException $e) { - $this->fail(sprintf( - 'PluginNotFoundException here for "%s" field %s display options of "%s" entity type. Original message: %s', - $field_id, - $display_context, - $entity_type_id, - $e->getMessage() - )); - } - } - } - -} only in patch2: unchanged: --- a/core/modules/field/tests/src/Kernel/FieldDefinitionIntegrityTest.php +++ b/core/modules/field/tests/src/Kernel/FieldDefinitionIntegrityTest.php @@ -2,8 +2,13 @@ namespace Drupal\Tests\field\Kernel; +use Drupal\Component\Plugin\Discovery\DiscoveryInterface; +use Drupal\Component\Plugin\Exception\PluginNotFoundException; use Drupal\Component\Utility\NestedArray; +use Drupal\Core\Entity\ContentEntityTypeInterface; +use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Extension\Extension; +use Drupal\Core\Field\BaseFieldDefinition; use Drupal\KernelTests\KernelTestBase; /** @@ -14,6 +19,8 @@ class FieldDefinitionIntegrityTest extends KernelTestBase { /** + * Modules to enable. + * * @var array */ public static $modules = ['system']; @@ -24,8 +31,7 @@ class FieldDefinitionIntegrityTest extends KernelTestBase { public function testFieldPluginDefinitionIntegrity() { // Enable all core modules that provide field plugins, and their // dependencies. - $modules = system_rebuild_module_data(); - $modules = array_filter($modules, function (Extension $module) { + $this->enableModulesByFilter(function (Extension $module) { // Filter contrib, hidden, already enabled modules and modules in the // Testing package. if ($module->origin === 'core' @@ -37,22 +43,15 @@ public function testFieldPluginDefinitionIntegrity() { } return FALSE; }); - // Gather the dependencies of the modules. - $dependencies = NestedArray::mergeDeepArray(array_map(function (Extension $module) { - return array_keys($module->requires); - }, $modules)); - $modules = array_unique(NestedArray::mergeDeep(array_keys($modules), $dependencies)); - - $this->enableModules($modules); /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_type_manager */ - $field_type_manager = \Drupal::service('plugin.manager.field.field_type'); + $field_type_manager = $this->container->get('plugin.manager.field.field_type'); /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_type_manager */ - $field_formatter_manager = \Drupal::service('plugin.manager.field.formatter'); + $field_formatter_manager = $this->container->get('plugin.manager.field.formatter'); /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_type_manager */ - $field_widget_manager = \Drupal::service('plugin.manager.field.widget'); + $field_widget_manager = $this->container->get('plugin.manager.field.widget'); // Load the IDs of all available field type plugins. $available_field_type_ids = []; @@ -76,46 +75,138 @@ public function testFieldPluginDefinitionIntegrity() { foreach ($field_type_manager->getDefinitions() as $definition) { // Test default field widgets. if (isset($definition['default_widget'])) { - if (in_array($definition['default_widget'], $available_field_widget_ids)) { - $this->pass(sprintf('Field type %s uses an existing field widget by default.', $definition['id'])); - } - else { - $this->fail(sprintf('Field type %s uses a non-existent field widget by default: %s', $definition['id'], $definition['default_widget'])); - } + $this->assertTrue( + in_array($definition['default_widget'], $available_field_widget_ids), + sprintf('Field type %s uses an existing field widget by default.', $definition['id']) + ); } // Test default field formatters. if (isset($definition['default_formatter'])) { - if (in_array($definition['default_formatter'], $available_field_formatter_ids)) { - $this->pass(sprintf('Field type %s uses an existing field formatter by default.', $definition['id'])); - } - else { - $this->fail(sprintf('Field type %s uses a non-existent field formatter by default: %s', $definition['id'], $definition['default_formatter'])); - } + $this->assertTrue( + in_array($definition['default_formatter'], $available_field_formatter_ids), + sprintf('Field type %s uses an existing field formatter by default.', $definition['id']) + ); } } // Test the field widget plugins. foreach ($field_widget_manager->getDefinitions() as $definition) { $missing_field_type_ids = array_diff($definition['field_types'], $available_field_type_ids); - if ($missing_field_type_ids) { - $this->fail(sprintf('Field widget %s integrates with non-existent field types: %s', $definition['id'], implode(', ', $missing_field_type_ids))); - } - else { - $this->pass(sprintf('Field widget %s integrates with existing field types.', $definition['id'])); - } + $this->assertFalse( + $missing_field_type_ids, + sprintf('Field widget %s integrates with existing field types.', $definition['id']) + ); } // Test the field formatter plugins. foreach ($field_formatter_manager->getDefinitions() as $definition) { $missing_field_type_ids = array_diff($definition['field_types'], $available_field_type_ids); - if ($missing_field_type_ids) { - $this->fail(sprintf('Field formatter %s integrates with non-existent field types: %s', $definition['id'], implode(', ', $missing_field_type_ids))); + $this->assertFalse( + $missing_field_type_ids, + sprintf('Field formatter %s integrates with existing field types.', $definition['id']) + ); + } + } + + /** + * Tests to load field plugin definitions used in core's existing entities. + */ + public function testFieldPluginDefinitionAvailability() { + $this->enableModulesByFilter(function (Extension $module) { + // Filter contrib, hidden, already enabled modules and modules in the + // Testing package. + return ($module->origin === 'core' + && empty($module->info['hidden']) + && $module->status == FALSE + && $module->info['package'] !== 'Testing' + && is_readable($module->getPath() . '/src/Entity')); + }); + + /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_type_manager */ + $field_formatter_manager = $this->container->get('plugin.manager.field.formatter'); + + /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_type_manager */ + $field_widget_manager = $this->container->get('plugin.manager.field.widget'); + + /** @var \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager */ + $entity_field_manager = $this->container->get('entity_field.manager'); + + /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */ + $entity_type_manager = $this->container->get('entity_type.manager'); + + /** @var \Drupal\Core\Field\BaseFieldDefinition[][] $field_definitions */ + $field_definitions = []; + + /** @var \Drupal\Core\Entity\EntityTypeInterface[] $content_entity_types */ + $content_entity_types = array_filter($entity_type_manager->getDefinitions(), function (EntityTypeInterface $entity_type) { + return $entity_type instanceof ContentEntityTypeInterface; + }); + + foreach ($content_entity_types as $entity_type_id => $entity_type_definition) { + $field_definitions[$entity_type_id] = $entity_field_manager->getBaseFieldDefinitions($entity_type_id); + } + + foreach ($field_definitions as $entity_type_id => $definitions) { + foreach ($definitions as $field_id => $field_definition) { + $this->checkDisplayOption($entity_type_id, $field_id, $field_definition, $field_formatter_manager, 'view'); + $this->checkDisplayOption($entity_type_id, $field_id, $field_definition, $field_widget_manager, 'form'); + } + } + } + + /** + * Helper method that tries to load plugin definitions. + * + * @param string $entity_type_id + * Id of entity type. Required by message. + * @param string $field_id + * Id of field. Required by message. + * @param \Drupal\Core\Field\BaseFieldDefinition $field_definition + * Field definition that provide display options. + * @param \Drupal\Component\Plugin\Discovery\DiscoveryInterface $plugin_manager + * Plugin manager that will try to provide plugin definition. + * @param string $display_context + * Defines which display options should be loaded. + */ + protected function checkDisplayOption($entity_type_id, $field_id, BaseFieldDefinition $field_definition, DiscoveryInterface $plugin_manager, $display_context) { + $display_options = $field_definition->getDisplayOptions($display_context); + if (!empty($display_options) && !empty($display_options['type'])) { + try { + $plugin_manager->getDefinition($display_options['type']); } - else { - $this->pass(sprintf('Field formatter %s integrates with existing field types.', $definition['id'])); + catch (PluginNotFoundException $e) { + $this->fail(sprintf( + 'PluginNotFoundException here for "%s" field %s display options of "%s" entity type. Original message: %s', + $field_id, + $display_context, + $entity_type_id, + $e->getMessage() + )); } } } + /** + * Enable modules and them dependencies by defined filter. + * + * @param callable $filter_callback + * Callback function that get \Drupal\Core\Extension\Extension object + * as the first argument. + * + * @see \Drupal\Core\Extension\Extension + * @see array_filter(); + */ + protected function enableModulesByFilter(callable $filter_callback) { + $modules = system_rebuild_module_data(); + $modules = array_filter($modules, $filter_callback); + // Gather the dependencies of the modules. + $dependencies = NestedArray::mergeDeepArray(array_map(function (Extension $module) { + return array_keys($module->requires); + }, $modules)); + $modules = array_unique(NestedArray::mergeDeep(array_keys($modules), $dependencies)); + + $this->enableModules($modules); + } + }