function DefaultPluginManagerTest::testDefaultPluginManager

Tests annotations and attributes on the default plugin manager.

File

core/tests/Drupal/KernelTests/Core/Plugin/DefaultPluginManagerTest.php, line 28

Class

DefaultPluginManagerTest

Tests the default plugin manager.

Namespace

Code

public function testDefaultPluginManager() : void {
  $subdir = 'Plugin/plugin_test/custom_annotation';
  $base_directory = $this->root . '/core/modules/system/tests/modules/plugin_test/src';
  $namespaces = new \ArrayObject([
    'Drupal\\plugin_test' => $base_directory,
  ]);
  $module_handler = $this->container
    ->get('module_handler');
  // Ensure broken files exist as expected.
  try {
    $e = NULL;
    new \ReflectionClass('\\Drupal\\plugin_test\\Plugin\\plugin_test\\custom_annotation\\ExtendingNonInstalledClass');
  } catch (\Throwable $e) {
  } finally {
    $this->assertInstanceOf(\Throwable::class, $e);
    $this->assertSame('Class "Drupal\\non_installed_module\\NonExisting" not found', $e->getMessage());
  }
  // Ensure there is a class with the expected name. We cannot reflect on this
  // as it triggers a fatal error.
  $this->assertFileExists($base_directory . '/' . $subdir . '/UsingNonInstalledTraitClass.php');
  // Annotation only.
  $manager = new DefaultPluginManager($subdir, $namespaces, $module_handler, NULL, AnnotationPluginExample::class);
  $definitions = $manager->getDefinitions();
  $this->assertArrayHasKey('example_1', $definitions);
  $this->assertArrayHasKey('example_2', $definitions);
  $this->assertArrayNotHasKey('example_3', $definitions);
  $this->assertArrayNotHasKey('example_4', $definitions);
  $this->assertArrayNotHasKey('example_5', $definitions);
  // Annotations and attributes together.
  $manager = new DefaultPluginManager($subdir, $namespaces, $module_handler, NULL, AttributePluginExample::class, AnnotationPluginExample::class);
  $definitions = $manager->getDefinitions();
  $this->assertArrayHasKey('example_1', $definitions);
  $this->assertArrayHasKey('example_2', $definitions);
  $this->assertArrayHasKey('example_3', $definitions);
  $this->assertArrayHasKey('example_4', $definitions);
  $this->assertArrayHasKey('example_5', $definitions);
  // Attributes only.
  // \Drupal\Component\Plugin\Discovery\AttributeClassDiscovery does not
  // support parsing classes that cannot be reflected. Therefore, we use VFS
  // to create a directory remove plugin_test's plugins and remove the broken
  // plugins.
  vfsStream::setup('plugin_test');
  $dir = vfsStream::create([
    'src' => [
      'Plugin' => [
        'plugin_test' => [
          'custom_annotation' => [],
        ],
      ],
    ],
  ]);
  $plugin_directory = $dir->getChild('src/' . $subdir);
  vfsStream::copyFromFileSystem($base_directory . '/' . $subdir, $plugin_directory);
  $plugin_directory->removeChild('ExtendingNonInstalledClass.php');
  $plugin_directory->removeChild('UsingNonInstalledTraitClass.php');
  $namespaces = new \ArrayObject([
    'Drupal\\plugin_test' => vfsStream::url('plugin_test/src'),
  ]);
  $manager = new DefaultPluginManager($subdir, $namespaces, $module_handler, NULL, AttributePluginExample::class);
  $definitions = $manager->getDefinitions();
  $this->assertArrayNotHasKey('example_1', $definitions);
  $this->assertArrayNotHasKey('example_2', $definitions);
  $this->assertArrayHasKey('example_3', $definitions);
  $this->assertArrayHasKey('example_4', $definitions);
  $this->assertArrayHasKey('example_5', $definitions);
  $this->assertArrayNotHasKey('extending_non_installed_class', $definitions);
  $this->assertArrayNotHasKey('using_non_installed_trait', $definitions);
}