class PluginDependencyTraitTest

@coversDefaultClass \Drupal\Core\Plugin\PluginDependencyTrait
@group Plugin

Hierarchy

Expanded class hierarchy of PluginDependencyTraitTest

File

View on git.drupalcode.org

core/tests/Drupal/Tests/Core/Plugin/PluginDependencyTraitTest.php, line 19

Namespace

Drupal\Tests\Core\Plugin
View source 
class PluginDependencyTraitTest extends UnitTestCase {
  
  /**
   * @covers ::getPluginDependencies
   *
   * @dataProvider providerTestPluginDependencies
   */
  public function testGetPluginDependencies(ProphecyInterface $plugin, $definition, array $expected) {
    $test_class = new TestPluginDependency();
    $module_handler = $this->prophesize(ModuleHandlerInterface::class);
    $module_handler->moduleExists('test_module1')
      ->willReturn(TRUE);
    $module_handler->moduleExists('test_theme1')
      ->willReturn(FALSE);
    $test_class->setModuleHandler($module_handler->reveal());
    $theme_handler = $this->prophesize(ThemeHandlerInterface::class);
    $theme_handler->themeExists('test_module1')
      ->willReturn(FALSE);
    $theme_handler->themeExists('test_theme1')
      ->willReturn(TRUE);
    $test_class->setThemeHandler($theme_handler->reveal());
    $plugin->getPluginDefinition()
      ->willReturn($definition);
    $actual = $test_class->getPluginDependencies($plugin->reveal());
    $this->assertEquals($expected, $actual);
    $this->assertEmpty($test_class->getDependencies());
  }
  
  /**
   * @covers ::calculatePluginDependencies
   *
   * @dataProvider providerTestPluginDependencies
   *
   * @param \Prophecy\Prophecy\ProphecyInterface $plugin
   *   A prophecy of a plugin instance.
   * @param mixed $definition
   *   A plugin definition.
   * @param array $expected
   *   The expected dependencies.
   */
  public function testCalculatePluginDependencies(ProphecyInterface $plugin, $definition, array $expected) {
    $test_class = new TestPluginDependency();
    $module_handler = $this->prophesize(ModuleHandlerInterface::class);
    $module_handler->moduleExists('test_module1')
      ->willReturn(TRUE);
    $module_handler->moduleExists('test_theme1')
      ->willReturn(FALSE);
    $test_class->setModuleHandler($module_handler->reveal());
    $theme_handler = $this->prophesize(ThemeHandlerInterface::class);
    $theme_handler->themeExists('test_module1')
      ->willReturn(FALSE);
    $theme_handler->themeExists('test_theme1')
      ->willReturn(TRUE);
    $test_class->setThemeHandler($theme_handler->reveal());
    $plugin->getPluginDefinition()
      ->willReturn($definition);
    $test_class->calculatePluginDependencies($plugin->reveal());
    $this->assertEquals($expected, $test_class->getDependencies());
  }
  
  /**
   * Provides test data for plugin dependencies.
   */
  public function providerTestPluginDependencies() {
    $data = [];
    $plugin = $this->prophesize(PluginInspectionInterface::class);
    $dependent_plugin = $this->prophesize(PluginInspectionInterface::class)
      ->willImplement(DependentPluginInterface::class);
    $dependent_plugin->calculateDependencies()
      ->willReturn([
      'module' => [
        'test_module2',
      ],
    ]);
    $data['dependent_plugin_from_module'] = [
      $dependent_plugin,
      [
        'provider' => 'test_module1',
      ],
      [
        'module' => [
          'test_module1',
          'test_module2',
        ],
      ],
    ];
    $data['dependent_plugin_from_core'] = [
      $dependent_plugin,
      [
        'provider' => 'core',
      ],
      [
        'module' => [
          'core',
          'test_module2',
        ],
      ],
    ];
    $data['dependent_plugin_from_theme'] = [
      $dependent_plugin,
      [
        'provider' => 'test_theme1',
      ],
      [
        'module' => [
          'test_module2',
        ],
        'theme' => [
          'test_theme1',
        ],
      ],
    ];
    $data['array_with_config_dependencies'] = [
      $plugin,
      [
        'provider' => 'test_module1',
        'config_dependencies' => [
          'module' => [
            'test_module2',
          ],
        ],
      ],
      [
        'module' => [
          'test_module1',
          'test_module2',
        ],
      ],
    ];
    $definition = $this->prophesize(PluginDefinitionInterface::class);
    $definition->getProvider()
      ->willReturn('test_module1');
    $data['object_definition'] = [
      $plugin,
      $definition->reveal(),
      [
        'module' => [
          'test_module1',
        ],
      ],
    ];
    $dependent_definition = $this->prophesize(PluginDefinitionInterface::class)
      ->willImplement(DependentPluginDefinitionInterface::class);
    $dependent_definition->getProvider()
      ->willReturn('test_module1');
    $dependent_definition->getConfigDependencies()
      ->willReturn([
      'module' => [
        'test_module2',
      ],
    ]);
    $data['dependent_object_definition'] = [
      $plugin,
      $dependent_definition->reveal(),
      [
        'module' => [
          'test_module1',
          'test_module2',
        ],
      ],
    ];
    return $data;
  }

}

Members

Title Deprecated Modifiers Object type Summary Overrides
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
PluginDependencyTraitTest::providerTestPluginDependencies public function Provides test data for plugin dependencies.
PluginDependencyTraitTest::testCalculatePluginDependencies public function @covers ::calculatePluginDependencies[[api-linebreak]]
PluginDependencyTraitTest::testGetPluginDependencies public function @covers ::getPluginDependencies[[api-linebreak]]
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
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 338
UnitTestCase::setUpBeforeClass public static function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.