AnnotatedClassDiscoveryTest.php

<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\Plugin\Discovery;

use Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Tests that plugins are correctly discovered using annotated classes.
 *
 * @group Plugin
 */
class AnnotatedClassDiscoveryTest extends DiscoveryTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->expectedDefinitions = [
            'apple' => [
                'id' => 'apple',
                'label' => 'Apple',
                'color' => 'green',
                'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Apple',
                'provider' => 'plugin_test',
            ],
            'banana' => [
                'id' => 'banana',
                'label' => 'Banana',
                'color' => 'yellow',
                'uses' => [
                    'bread' => new TranslatableMarkup('Banana bread'),
                    'loaf' => [
                        'singular' => '@count loaf',
                        'plural' => '@count loaves',
                        'context' => NULL,
                    ],
                ],
                'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Banana',
                'provider' => 'plugin_test',
            ],
            'cherry' => [
                'id' => 'cherry',
                'label' => 'Cherry',
                'color' => 'red',
                'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Cherry',
                'provider' => 'plugin_test',
            ],
            'kale' => [
                'id' => 'kale',
                'label' => 'Kale',
                'color' => 'green',
                'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Kale',
                'provider' => 'plugin_test',
            ],
            'orange' => [
                'id' => 'orange',
                'label' => 'Orange',
                'color' => 'orange',
                'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\Orange',
                'provider' => 'plugin_test',
            ],
            'big_apple' => [
                'id' => 'big_apple',
                'label' => 'Big Apple',
                'color' => 'green',
                'class' => 'Drupal\\plugin_test_extended\\Plugin\\plugin_test\\fruit\\BigApple',
                'provider' => 'plugin_test_extended',
            ],
            'extending_non_installed_class' => [
                'id' => 'extending_non_installed_class',
                'label' => 'A plugin whose class is extending from a non-installed module class',
                'color' => 'pink',
                'class' => 'Drupal\\plugin_test\\Plugin\\plugin_test\\fruit\\ExtendingNonInstalledClass',
                'provider' => 'plugin_test',
            ],
        ];
        $base_directory = $this->root . '/core/modules/system/tests/modules/plugin_test/src';
        $base_directory2 = $this->root . '/core/modules/system/tests/modules/plugin_test_extended/src';
        $namespaces = new \ArrayObject([
            'Drupal\\plugin_test' => $base_directory,
            'Drupal\\plugin_test_extended' => $base_directory2,
        ]);
        $annotation_namespaces = [
            'Drupal\\plugin_test\\Plugin\\Annotation',
            'Drupal\\plugin_test_extended\\Plugin\\Annotation',
        ];
        $this->discovery = new AnnotatedClassDiscovery('Plugin/plugin_test/fruit', $namespaces, 'Drupal\\Component\\Annotation\\Plugin', $annotation_namespaces);
        $this->emptyDiscovery = new AnnotatedClassDiscovery('Plugin/non_existing_module/non_existing_plugin_type', $namespaces);
    }

}