class HookCollectorPassTest

Same name in this branch
  1. 11.x core/tests/Drupal/KernelTests/Core/Hook/HookCollectorPassTest.php \Drupal\KernelTests\Core\Hook\HookCollectorPassTest
  2. 11.x core/modules/system/tests/src/Functional/Hook/HookCollectorPassTest.php \Drupal\Tests\system\Functional\Hook\HookCollectorPassTest

@coversDefaultClass \Drupal\Core\Hook\HookCollectorPass
@group Hook

Hierarchy

Expanded class hierarchy of HookCollectorPassTest

File

core/tests/Drupal/Tests/Core/Hook/HookCollectorPassTest.php, line 20

Namespace

Drupal\Tests\Core\Hook
View source
class HookCollectorPassTest extends UnitTestCase {
  use GroupIncludesTestTrait;
  
  /**
   * @covers ::collectAllHookImplementations
   * @covers ::filterIterator
   */
  public function testCollectAllHookImplementations() : void {
    vfsStream::setup('drupal_root');
    $files = [
      'modules/test_module/test_module_info.yml',
      // This creates a submodule which is not installed.
'modules/test_module/test_sub_module/test_sub_module.info.yml',
    ];
    $file_data = [];
    foreach ($files as &$filename) {
      NestedArray::setValue($file_data, explode('/', $filename), '');
    }
    vfsStream::create($file_data);
    $module_filenames = [
      'test_module' => [
        'pathname' => 'vfs://drupal_root/modules/test_module/test_module_info.yml',
      ],
    ];
    // This directory, however, should be included.
    mkdir('vfs://drupal_root/modules/test_module/includes');
    file_put_contents('vfs://drupal_root/modules/test_module/includes/test_module.inc', <<<__EOF__
<?php

function test_module_test_hook();

__EOF__
);
    // This is the not installed submodule.
    file_put_contents('vfs://drupal_root/modules/test_module/test_sub_module/test_sub_module.module', <<<__EOF__
<?php

function test_module_should_be_skipped();

__EOF__
);
    $implementations['test_hook'][ProceduralCall::class]['test_module_test_hook'] = 'test_module';
    $includes = [
      'test_module_test_hook' => 'vfs://drupal_root/modules/test_module/includes/test_module.inc',
    ];
    $container = new ContainerBuilder();
    $container->setParameter('container.modules', $module_filenames);
    $container->setDefinition('module_handler', new Definition());
    (new HookCollectorPass())->process($container);
    $this->assertSame($implementations, $container->getParameter('hook_implementations_map'));
    $this->assertSame($includes, $container->getDefinition(ProceduralCall::class)
      ->getArguments()[0]);
  }
  
  /**
   * @covers ::process
   * @covers ::collectModuleHookImplementations
   */
  public function testGroupIncludes() : void {
    $module_filenames = self::setupGroupIncludes();
    $container = new ContainerBuilder();
    $container->setParameter('container.modules', $module_filenames);
    $container->setDefinition('module_handler', new Definition());
    (new HookCollectorPass())->process($container);
    $argument = $container->getDefinition('module_handler')
      ->getArgument('$groupIncludes');
    $this->assertSame(self::GROUP_INCLUDES, $argument);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
GroupIncludesTestTrait::GROUP_INCLUDES constant
GroupIncludesTestTrait::setupGroupIncludes public static function
HookCollectorPassTest::testCollectAllHookImplementations public function @covers ::collectAllHookImplementations[[api-linebreak]]
@covers ::filterIterator[[api-linebreak]]
HookCollectorPassTest::testGroupIncludes public function @covers ::process[[api-linebreak]]
@covers ::collectModuleHookImplementations[[api-linebreak]]
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
UnitTestCase::$root protected property The app root.
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::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.
UnitTestCase::setUp protected function 375
UnitTestCase::setupMockIterator protected function Set up a traversable class mock to return specific items when iterated.

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