class YamlDirectoryDiscoveryTest in Drupal 8

@coversDefaultClass \Drupal\Core\Plugin\Discovery\YamlDirectoryDiscovery

@group Plugin

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\Core\Plugin\Discovery\YamlDirectoryDiscoveryTest

File

core/tests/Drupal/Tests/Core/Plugin/Discovery/YamlDirectoryDiscoveryTest.php, line 16

Namespace

Drupal\Tests\Core\Plugin\Discovery

class YamlDirectoryDiscoveryTest extends UnitTestCase {

  /**
   * @covers ::getDefinitions
   */
  public function testGetDefinitions() {
    vfsStream::setup('modules', NULL, [
      'module_a' => [
        'subdir1' => [
          'plugin1.yml' => "id: plugin1\ntest_provider: module_a",
          'plugin2.yml' => "id: plugin2\ntest_provider: module_a",
        ],
        'subdir2' => [
          'plugin3.yml' => "id: plugin3\ntest_provider: module_a",
        ],
        'subdir3' => [],
      ],
      'module_b' => [
        'subdir1' => [
          'plugin4.yml' => "id: plugin4\ntest_provider: module_b",
        ],
      ],
    ]);
    $directories = [
      'module_a' => [
        vfsStream::url('modules/module_a/subdir1'),
        vfsStream::url('modules/module_a/subdir2'),
        // Empty directory.
        vfsStream::url('modules/module_a/subdir3'),
        // Directory does not exist.
        vfsStream::url('modules/module_a/subdir4'),
      ],
      'module_b' => vfsStream::url('modules/module_b/subdir1'),
    ];
    $discovery = new YamlDirectoryDiscovery($directories, 'test');
    $definitions = $discovery
      ->getDefinitions();
    $this
      ->assertIsArray($definitions);
    $this
      ->assertCount(4, $definitions);
    foreach ($definitions as $id => $definition) {
      foreach ([
        'id',
        'provider',
        ComponentYamlDirectoryDiscovery::FILE_KEY,
      ] as $key) {
        $this
          ->assertArrayHasKey($key, $definition);
      }
      $this
        ->assertEquals($id, $definition['id']);
      $this
        ->assertEquals($definition['test_provider'], $definition['provider']);
    }
  }

  /**
   * @covers ::getDefinitions
   */
  public function testGetDefinitionsWithTranslatableDefinitions() {
    vfsStream::setup('modules', NULL, [
      'module_a' => [
        'subdir1' => [
          'plugin1.yml' => "id: plugin1\ntest_provider: module_a\ntitle: 'test title'",
          'plugin2.yml' => "id: plugin2\ntest_provider: module_a\ntitle: 'test title'\ntitle_context: test-context",
        ],
      ],
    ]);
    $directories = [
      'module_a' => vfsStream::url('modules/module_a/subdir1'),
    ];
    $discovery = new YamlDirectoryDiscovery($directories, 'test');
    $discovery
      ->addTranslatableProperty('title', 'title_context');
    $definitions = $discovery
      ->getDefinitions();
    $this
      ->assertCount(2, $definitions);
    $plugin_1 = $definitions['plugin1'];
    $plugin_2 = $definitions['plugin2'];
    $this
      ->assertInstanceOf(TranslatableMarkup::class, $plugin_1['title']);
    $this
      ->assertEquals([], $plugin_1['title']
      ->getOptions());
    $this
      ->assertInstanceOf(TranslatableMarkup::class, $plugin_2['title']);
    $this
      ->assertEquals([
      'context' => 'test-context',
    ], $plugin_2['title']
      ->getOptions());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUp	protected	function		340
YamlDirectoryDiscoveryTest::testGetDefinitions	public	function	@covers ::getDefinitions
YamlDirectoryDiscoveryTest::testGetDefinitionsWithTranslatableDefinitions	public	function	@covers ::getDefinitions