ModuleHandlerDeprecatedHookTest.php

<?php

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

use Drupal\KernelTests\KernelTestBase;

/**
 * Test whether deprecated hook invocations trigger errors.
 *
 * @group Extension
 * @group legacy
 *
 * @coversDefaultClass Drupal\Core\Extension\ModuleHandler
 */
class ModuleHandlerDeprecatedHookTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'deprecation_test',
    ];
    
    /**
     * @covers ::invokeDeprecated
     */
    public function testInvokeDeprecated() : void {
        $this->expectDeprecation('The deprecated hook hook_deprecated_hook() is implemented in these functions: deprecation_test_deprecated_hook(). Use something else.');
        
        /** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
        $module_handler = $this->container
            ->get('module_handler');
        $arg = 'an_arg';
        $this->assertEquals($arg, $module_handler->invokeDeprecated('Use something else.', 'deprecation_test', 'deprecated_hook', [
            $arg,
        ]));
    }
    
    /**
     * @covers ::invokeAllDeprecated
     */
    public function testInvokeAllDeprecated() : void {
        $this->expectDeprecation('The deprecated hook hook_deprecated_hook() is implemented in these functions: deprecation_test_deprecated_hook(). Use something else.');
        
        /** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
        $module_handler = $this->container
            ->get('module_handler');
        $arg = 'an_arg';
        $this->assertEquals([
            $arg,
        ], $module_handler->invokeAllDeprecated('Use something else.', 'deprecated_hook', [
            $arg,
        ]));
    }
    
    /**
     * @covers ::alterDeprecated
     */
    public function testAlterDeprecated() : void {
        $this->expectDeprecation('The deprecated alter hook hook_deprecated_alter_alter() is implemented in these functions: deprecation_test_deprecated_alter_alter. Alter something else.');
        
        /** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
        $module_handler = $this->container
            ->get('module_handler');
        $data = [];
        $context1 = 'test1';
        $context2 = 'test2';
        $module_handler->alterDeprecated('Alter something else.', 'deprecated_alter', $data, $context1, $context2);
        $this->assertEquals([
            $context1,
            $context2,
        ], $data);
    }

}