class TokenTest in Drupal 9

@coversDefaultClass \Drupal\Core\Utility\Token @group Utility

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\Utility\TokenTest

File

core/tests/Drupal/Tests/Core/Utility/TokenTest.php, line 18

Namespace

Drupal\Tests\Core\Utility

class TokenTest extends UnitTestCase {

  /**
   * The cache used for testing.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $cache;

  /**
   * The language manager used for testing.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $languageManager;

  /**
   * The module handler service used for testing.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $moduleHandler;

  /**
   * The language interface used for testing.
   *
   * @var \Drupal\Core\Language\LanguageInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $language;

  /**
   * The token service under test.
   *
   * @var \Drupal\Core\Utility\Token|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $token;

  /**
   * The cache tags invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $cacheTagsInvalidator;

  /**
   * The cache contexts manager.
   *
   * @var \Drupal\Core\Cache\Context\CacheContextsManager
   */
  protected $cacheContextManager;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $renderer;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    $this->cache = $this
      ->createMock('\\Drupal\\Core\\Cache\\CacheBackendInterface');
    $this->languageManager = $this
      ->createMock('Drupal\\Core\\Language\\LanguageManagerInterface');
    $this->moduleHandler = $this
      ->createMock('\\Drupal\\Core\\Extension\\ModuleHandlerInterface');
    $this->language = $this
      ->createMock('\\Drupal\\Core\\Language\\LanguageInterface');
    $this->cacheTagsInvalidator = $this
      ->createMock('\\Drupal\\Core\\Cache\\CacheTagsInvalidatorInterface');
    $this->renderer = $this
      ->createMock('Drupal\\Core\\Render\\RendererInterface');
    $this->token = new Token($this->moduleHandler, $this->cache, $this->languageManager, $this->cacheTagsInvalidator, $this->renderer);
    $container = new ContainerBuilder();
    $this->cacheContextManager = new CacheContextsManager($container, [
      'current_user',
      'custom_context',
    ]);
    $container
      ->set('cache_contexts_manager', $this->cacheContextManager);
    \Drupal::setContainer($container);
  }

  /**
   * @covers ::getInfo
   */
  public function testGetInfo() {
    $token_info = [
      'types' => [
        'foo' => [
          'name' => $this
            ->randomMachineName(),
        ],
      ],
    ];
    $this->language
      ->expects($this
      ->atLeastOnce())
      ->method('getId')
      ->will($this
      ->returnValue($this
      ->randomMachineName()));
    $this->languageManager
      ->expects($this
      ->once())
      ->method('getCurrentLanguage')
      ->with(LanguageInterface::TYPE_CONTENT)
      ->will($this
      ->returnValue($this->language));

    // The persistent cache must only be hit once, after which the info is
    // cached statically.
    $this->cache
      ->expects($this
      ->once())
      ->method('get');
    $this->cache
      ->expects($this
      ->once())
      ->method('set')
      ->with('token_info:' . $this->language
      ->getId(), $token_info);
    $this->moduleHandler
      ->expects($this
      ->once())
      ->method('invokeAll')
      ->with('token_info')
      ->will($this
      ->returnValue($token_info));
    $this->moduleHandler
      ->expects($this
      ->once())
      ->method('alter')
      ->with('token_info', $token_info);

    // Get the information for the first time. The cache should be checked, the
    // hooks invoked, and the info should be set to the cache should.
    $this->token
      ->getInfo();

    // Get the information for the second time. The data must be returned from
    // the static cache, so the persistent cache must not be accessed and the
    // hooks must not be invoked.
    $this->token
      ->getInfo();
  }

  /**
   * @covers ::replace
   */
  public function testReplaceWithBubbleableMetadataObject() {
    $this->moduleHandler
      ->expects($this
      ->any())
      ->method('invokeAll')
      ->willReturn([
      '[node:title]' => 'hello world',
    ]);
    $bubbleable_metadata = new BubbleableMetadata();
    $bubbleable_metadata
      ->setCacheContexts([
      'current_user',
    ]);
    $bubbleable_metadata
      ->setCacheMaxAge(12);
    $node = $this
      ->prophesize('Drupal\\node\\NodeInterface');
    $node
      ->getCacheTags()
      ->willReturn([
      'node:1',
    ]);
    $node
      ->getCacheContexts()
      ->willReturn([
      'custom_context',
    ]);
    $node
      ->getCacheMaxAge()
      ->willReturn(10);
    $node = $node
      ->reveal();
    $result = $this->token
      ->replace('[node:title]', [
      'node' => $node,
    ], [], $bubbleable_metadata);
    $this
      ->assertEquals('hello world', $result);
    $this
      ->assertEquals([
      'node:1',
    ], $bubbleable_metadata
      ->getCacheTags());
    $this
      ->assertEquals([
      'current_user',
      'custom_context',
    ], $bubbleable_metadata
      ->getCacheContexts());
    $this
      ->assertEquals(10, $bubbleable_metadata
      ->getCacheMaxAge());
  }

  /**
   * @covers ::replace
   */
  public function testReplaceWithHookTokensWithBubbleableMetadata() {
    $this->moduleHandler
      ->expects($this
      ->any())
      ->method('invokeAll')
      ->willReturnCallback(function ($hook_name, $args) {
      $cacheable_metadata = $args[4];
      $cacheable_metadata
        ->addCacheContexts([
        'custom_context',
      ]);
      $cacheable_metadata
        ->addCacheTags([
        'node:1',
      ]);
      $cacheable_metadata
        ->setCacheMaxAge(10);
      return [
        '[node:title]' => 'hello world',
      ];
    });
    $node = $this
      ->prophesize('Drupal\\node\\NodeInterface');
    $node
      ->getCacheContexts()
      ->willReturn([]);
    $node
      ->getCacheTags()
      ->willReturn([]);
    $node
      ->getCacheMaxAge()
      ->willReturn(14);
    $node = $node
      ->reveal();
    $bubbleable_metadata = new BubbleableMetadata();
    $bubbleable_metadata
      ->setCacheContexts([
      'current_user',
    ]);
    $bubbleable_metadata
      ->setCacheMaxAge(12);
    $result = $this->token
      ->replace('[node:title]', [
      'node' => $node,
    ], [], $bubbleable_metadata);
    $this
      ->assertEquals('hello world', $result);
    $this
      ->assertEquals([
      'node:1',
    ], $bubbleable_metadata
      ->getCacheTags());
    $this
      ->assertEquals([
      'current_user',
      'custom_context',
    ], $bubbleable_metadata
      ->getCacheContexts());
    $this
      ->assertEquals(10, $bubbleable_metadata
      ->getCacheMaxAge());
  }

  /**
   * @covers ::replace
   * @covers ::replace
   */
  public function testReplaceWithHookTokensAlterWithBubbleableMetadata() {
    $this->moduleHandler
      ->expects($this
      ->any())
      ->method('invokeAll')
      ->willReturn([]);
    $this->moduleHandler
      ->expects($this
      ->any())
      ->method('alter')
      ->willReturnCallback(function ($hook_name, array &$replacements, array $context, BubbleableMetadata $bubbleable_metadata) {
      $replacements['[node:title]'] = 'hello world';
      $bubbleable_metadata
        ->addCacheContexts([
        'custom_context',
      ]);
      $bubbleable_metadata
        ->addCacheTags([
        'node:1',
      ]);
      $bubbleable_metadata
        ->setCacheMaxAge(10);
    });
    $node = $this
      ->prophesize('Drupal\\node\\NodeInterface');
    $node
      ->getCacheContexts()
      ->willReturn([]);
    $node
      ->getCacheTags()
      ->willReturn([]);
    $node
      ->getCacheMaxAge()
      ->willReturn(14);
    $node = $node
      ->reveal();
    $bubbleable_metadata = new BubbleableMetadata();
    $bubbleable_metadata
      ->setCacheContexts([
      'current_user',
    ]);
    $bubbleable_metadata
      ->setCacheMaxAge(12);
    $result = $this->token
      ->replace('[node:title]', [
      'node' => $node,
    ], [], $bubbleable_metadata);
    $this
      ->assertEquals('hello world', $result);
    $this
      ->assertEquals([
      'node:1',
    ], $bubbleable_metadata
      ->getCacheTags());
    $this
      ->assertEquals([
      'current_user',
      'custom_context',
    ], $bubbleable_metadata
      ->getCacheContexts());
    $this
      ->assertEquals(10, $bubbleable_metadata
      ->getCacheMaxAge());
  }

  /**
   * @covers ::resetInfo
   */
  public function testResetInfo() {
    $this->cacheTagsInvalidator
      ->expects($this
      ->once())
      ->method('invalidateTags')
      ->with([
      'token_info',
    ]);
    $this->token
      ->resetInfo();
  }

  /**
   * @covers ::replace
   * @dataProvider providerTestReplaceEscaping
   */
  public function testReplaceEscaping($string, array $tokens, $expected) {
    $this->moduleHandler
      ->expects($this
      ->any())
      ->method('invokeAll')
      ->willReturnCallback(function ($type, $args) {
      return $args[2]['tokens'];
    });
    $result = $this->token
      ->replace($string, [
      'tokens' => $tokens,
    ]);
    $this
      ->assertIsString($result);
    $this
      ->assertEquals($expected, $result);
  }
  public function providerTestReplaceEscaping() {
    $data = [];

    // No tokens. The first argument to Token::replace() should not be escaped.
    $data['no-tokens'] = [
      'muh',
      [],
      'muh',
    ];
    $data['html-in-string'] = [
      '<h1>Giraffe</h1>',
      [],
      '<h1>Giraffe</h1>',
    ];
    $data['html-in-string-quote'] = [
      '<h1>Giraffe"</h1>',
      [],
      '<h1>Giraffe"</h1>',
    ];
    $data['simple-placeholder-with-plain-text'] = [
      '<h1>[token:meh]</h1>',
      [
        '[token:meh]' => 'Giraffe"',
      ],
      '<h1>' . Html::escape('Giraffe"') . '</h1>',
    ];
    $data['simple-placeholder-with-safe-html'] = [
      '<h1>[token:meh]</h1>',
      [
        '[token:meh]' => Markup::create('<em>Emphasized</em>'),
      ],
      '<h1><em>Emphasized</em></h1>',
    ];
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	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.
TokenTest::$cache	protected	property	The cache used for testing.
TokenTest::$cacheContextManager	protected	property	The cache contexts manager.
TokenTest::$cacheTagsInvalidator	protected	property	The cache tags invalidator.
TokenTest::$language	protected	property	The language interface used for testing.
TokenTest::$languageManager	protected	property	The language manager used for testing.
TokenTest::$moduleHandler	protected	property	The module handler service used for testing.
TokenTest::$renderer	protected	property	The renderer.
TokenTest::$token	protected	property	The token service under test.
TokenTest::providerTestReplaceEscaping	public	function
TokenTest::setUp	protected	function	Overrides UnitTestCase::setUp
TokenTest::testGetInfo	public	function	@covers ::getInfo
TokenTest::testReplaceEscaping	public	function	@covers ::replace @dataProvider providerTestReplaceEscaping
TokenTest::testReplaceWithBubbleableMetadataObject	public	function	@covers ::replace
TokenTest::testReplaceWithHookTokensAlterWithBubbleableMetadata	public	function	@covers ::replace @covers ::replace
TokenTest::testReplaceWithHookTokensWithBubbleableMetadata	public	function	@covers ::replace
TokenTest::testResetInfo	public	function	@covers ::resetInfo
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::setUpBeforeClass	public static	function