Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\field\Kernel;
Chris@0: 
Chris@0: use Drupal\Core\Extension\Extension;
Chris@0: use Drupal\KernelTests\KernelTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests the integrity of field API plugin definitions.
Chris@0:  *
Chris@0:  * @group field
Chris@0:  */
Chris@0: class FieldDefinitionIntegrityTest extends KernelTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['system'];
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the integrity of field plugin definitions.
Chris@0:    */
Chris@0:   public function testFieldPluginDefinitionIntegrity() {
Chris@0: 
Chris@0:     // Enable all core modules that provide field plugins.
Chris@0:     $modules = system_rebuild_module_data();
Chris@0:     $modules = array_filter($modules, function (Extension $module) {
Chris@0:       // Filter contrib, hidden, already enabled modules and modules in the
Chris@0:       // Testing package.
Chris@0:       if ($module->origin === 'core'
Chris@0:         && empty($module->info['hidden'])
Chris@0:         && $module->status == FALSE
Chris@0:         && $module->info['package'] !== 'Testing'
Chris@0:         && is_readable($module->getPath() . '/src/Plugin/Field')) {
Chris@0:         return TRUE;
Chris@0:       }
Chris@0:       return FALSE;
Chris@0:     });
Chris@0:     $this->enableModules(array_keys($modules));
Chris@0: 
Chris@0:     /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_type_manager */
Chris@0:     $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
Chris@0: 
Chris@0:     /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_type_manager */
Chris@0:     $field_formatter_manager = \Drupal::service('plugin.manager.field.formatter');
Chris@0: 
Chris@0:     /** @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface $field_type_manager */
Chris@0:     $field_widget_manager = \Drupal::service('plugin.manager.field.widget');
Chris@0: 
Chris@0:     // Load the IDs of all available field type plugins.
Chris@0:     $available_field_type_ids = [];
Chris@0:     foreach ($field_type_manager->getDefinitions() as $definition) {
Chris@0:       $available_field_type_ids[] = $definition['id'];
Chris@0:     }
Chris@0: 
Chris@0:     // Load the IDs of all available field widget plugins.
Chris@0:     $available_field_widget_ids = [];
Chris@0:     foreach ($field_widget_manager->getDefinitions() as $definition) {
Chris@0:       $available_field_widget_ids[] = $definition['id'];
Chris@0:     }
Chris@0: 
Chris@0:     // Load the IDs of all available field formatter plugins.
Chris@0:     $available_field_formatter_ids = [];
Chris@0:     foreach ($field_formatter_manager->getDefinitions() as $definition) {
Chris@0:       $available_field_formatter_ids[] = $definition['id'];
Chris@0:     }
Chris@0: 
Chris@0:     // Test the field type plugins.
Chris@0:     foreach ($field_type_manager->getDefinitions() as $definition) {
Chris@0:       // Test default field widgets.
Chris@0:       if (isset($definition['default_widget'])) {
Chris@0:         if (in_array($definition['default_widget'], $available_field_widget_ids)) {
Chris@0:           $this->pass(sprintf('Field type %s uses an existing field widget by default.', $definition['id']));
Chris@0:         }
Chris@0:         else {
Chris@0:           $this->fail(sprintf('Field type %s uses a non-existent field widget by default: %s', $definition['id'], $definition['default_widget']));
Chris@0:         }
Chris@0:       }
Chris@0: 
Chris@0:       // Test default field formatters.
Chris@0:       if (isset($definition['default_formatter'])) {
Chris@0:         if (in_array($definition['default_formatter'], $available_field_formatter_ids)) {
Chris@0:           $this->pass(sprintf('Field type %s uses an existing field formatter by default.', $definition['id']));
Chris@0:         }
Chris@0:         else {
Chris@0:           $this->fail(sprintf('Field type %s uses a non-existent field formatter by default: %s', $definition['id'], $definition['default_formatter']));
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Test the field widget plugins.
Chris@0:     foreach ($field_widget_manager->getDefinitions() as $definition) {
Chris@0:       $missing_field_type_ids = array_diff($definition['field_types'], $available_field_type_ids);
Chris@0:       if ($missing_field_type_ids) {
Chris@0:         $this->fail(sprintf('Field widget %s integrates with non-existent field types: %s', $definition['id'], implode(', ', $missing_field_type_ids)));
Chris@0:       }
Chris@0:       else {
Chris@0:         $this->pass(sprintf('Field widget %s integrates with existing field types.', $definition['id']));
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     // Test the field formatter plugins.
Chris@0:     foreach ($field_formatter_manager->getDefinitions() as $definition) {
Chris@0:       $missing_field_type_ids = array_diff($definition['field_types'], $available_field_type_ids);
Chris@0:       if ($missing_field_type_ids) {
Chris@0:         $this->fail(sprintf('Field formatter %s integrates with non-existent field types: %s', $definition['id'], implode(', ', $missing_field_type_ids)));
Chris@0:       }
Chris@0:       else {
Chris@0:         $this->pass(sprintf('Field formatter %s integrates with existing field types.', $definition['id']));
Chris@0:       }
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }