TokenReplaceUnitTest.php in Zircon Profile 8

Contains \Drupal\system\Tests\System\TokenReplaceUnitTest.

Namespace

Drupal\system\Tests\System

File

core/modules/system/src/Tests/System/TokenReplaceUnitTest.php

<?php

/**
 * @file
 * Contains \Drupal\system\Tests\System\TokenReplaceUnitTest.
 */
namespace Drupal\system\Tests\System;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\Xss;
use Drupal\Core\Render\BubbleableMetadata;

/**
 * Generates text using placeholders for dummy content to check token
 * replacement.
 *
 * @group system
 */
class TokenReplaceUnitTest extends TokenReplaceUnitTestBase {

  /**
   * @inheritdoc
   */
  protected function setUp() {
    parent::setUp();

    // Set the site name to something other than an empty string.
    $this
      ->config('system.site')
      ->set('name', 'Drupal')
      ->save();
  }

  /**
   * Test whether token-replacement works in various contexts.
   */
  public function testSystemTokenRecognition() {

    // Generate prefixes and suffixes for the token context.
    $tests = array(
      array(
        'prefix' => 'this is the ',
        'suffix' => ' site',
      ),
      array(
        'prefix' => 'this is the',
        'suffix' => 'site',
      ),
      array(
        'prefix' => '[',
        'suffix' => ']',
      ),
      array(
        'prefix' => '',
        'suffix' => ']]]',
      ),
      array(
        'prefix' => '[[[',
        'suffix' => '',
      ),
      array(
        'prefix' => ':[:',
        'suffix' => '--]',
      ),
      array(
        'prefix' => '-[-',
        'suffix' => ':]:',
      ),
      array(
        'prefix' => '[:',
        'suffix' => ']',
      ),
      array(
        'prefix' => '[site:',
        'suffix' => ':name]',
      ),
      array(
        'prefix' => '[site:',
        'suffix' => ']',
      ),
    );

    // Check if the token is recognized in each of the contexts.
    foreach ($tests as $test) {
      $input = $test['prefix'] . '[site:name]' . $test['suffix'];
      $expected = $test['prefix'] . 'Drupal' . $test['suffix'];
      $output = $this->tokenService
        ->replace($input, array(), array(
        'langcode' => $this->interfaceLanguage
          ->getId(),
      ));
      $this
        ->assertTrue($output == $expected, format_string('Token recognized in string %string', array(
        '%string' => $input,
      )));
    }

    // Test token replacement when the string contains no tokens.
    $this
      ->assertEqual($this->tokenService
      ->replace('No tokens here.'), 'No tokens here.');
  }

  /**
   * Tests the clear parameter.
   */
  public function testClear() {

    // Valid token.
    $source = '[site:name]';

    // No user passed in, should be untouched.
    $source .= '[user:name]';

    // Non-existing token.
    $source .= '[bogus:token]';

    // Replace with the clear parameter, only the valid token should remain.
    $target = Html::escape($this
      ->config('system.site')
      ->get('name'));
    $result = $this->tokenService
      ->replace($source, array(), array(
      'langcode' => $this->interfaceLanguage
        ->getId(),
      'clear' => TRUE,
    ));
    $this
      ->assertEqual($target, $result, 'Valid tokens replaced while invalid tokens ignored.');
    $target .= '[user:name]';
    $target .= '[bogus:token]';
    $result = $this->tokenService
      ->replace($source, array(), array(
      'langcode' => $this->interfaceLanguage
        ->getId(),
    ));
    $this
      ->assertEqual($target, $result, 'Valid tokens replaced while invalid tokens ignored.');
  }

  /**
   * Tests the generation of all system site information tokens.
   */
  public function testSystemSiteTokenReplacement() {

    // The use of the \Drupal::url() method requires the url_alias table to exist.
    $this
      ->installSchema('system', 'url_alias');
    $url_options = array(
      'absolute' => TRUE,
      'language' => $this->interfaceLanguage,
    );
    $slogan = '<blink>Slogan</blink>';
    $safe_slogan = Xss::filterAdmin($slogan);

    // Set a few site variables.
    $config = $this
      ->config('system.site');
    $config
      ->set('name', '<strong>Drupal<strong>')
      ->set('slogan', $slogan)
      ->set('mail', '[e-mail]')
      ->save();

    // Generate and test tokens.
    $tests = array();
    $tests['[site:name]'] = Html::escape($config
      ->get('name'));
    $tests['[site:slogan]'] = $safe_slogan;
    $tests['[site:mail]'] = $config
      ->get('mail');
    $tests['[site:url]'] = \Drupal::url('<front>', [], $url_options);
    $tests['[site:url-brief]'] = preg_replace(array(
      '!^https?://!',
      '!/$!',
    ), '', \Drupal::url('<front>', [], $url_options));
    $tests['[site:login-url]'] = \Drupal::url('user.page', [], $url_options);
    $base_bubbleable_metadata = new BubbleableMetadata();
    $metadata_tests = [];
    $metadata_tests['[site:name]'] = BubbleableMetadata::createFromObject(\Drupal::config('system.site'));
    $metadata_tests['[site:slogan]'] = BubbleableMetadata::createFromObject(\Drupal::config('system.site'));
    $metadata_tests['[site:mail]'] = BubbleableMetadata::createFromObject(\Drupal::config('system.site'));
    $bubbleable_metadata = clone $base_bubbleable_metadata;
    $metadata_tests['[site:url]'] = $bubbleable_metadata
      ->addCacheContexts([
      'url.site',
    ]);
    $metadata_tests['[site:url-brief]'] = $bubbleable_metadata;
    $metadata_tests['[site:login-url]'] = $bubbleable_metadata;

    // Test to make sure that we generated something for each token.
    $this
      ->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.');
    foreach ($tests as $input => $expected) {
      $bubbleable_metadata = new BubbleableMetadata();
      $output = $this->tokenService
        ->replace($input, array(), array(
        'langcode' => $this->interfaceLanguage
          ->getId(),
      ), $bubbleable_metadata);
      $this
        ->assertEqual($output, $expected, new FormattableMarkup('System site information token %token replaced.', [
        '%token' => $input,
      ]));
      $this
        ->assertEqual($bubbleable_metadata, $metadata_tests[$input]);
    }
  }

  /**
   * Tests the generation of all system date tokens.
   */
  public function testSystemDateTokenReplacement() {

    // Set time to one hour before request.
    $date = REQUEST_TIME - 3600;

    // Generate and test tokens.
    $tests = array();
    $date_formatter = \Drupal::service('date.formatter');
    $tests['[date:short]'] = $date_formatter
      ->format($date, 'short', '', NULL, $this->interfaceLanguage
      ->getId());
    $tests['[date:medium]'] = $date_formatter
      ->format($date, 'medium', '', NULL, $this->interfaceLanguage
      ->getId());
    $tests['[date:long]'] = $date_formatter
      ->format($date, 'long', '', NULL, $this->interfaceLanguage
      ->getId());
    $tests['[date:custom:m/j/Y]'] = $date_formatter
      ->format($date, 'custom', 'm/j/Y', NULL, $this->interfaceLanguage
      ->getId());
    $tests['[date:since]'] = $date_formatter
      ->formatTimeDiffSince($date, array(
      'langcode' => $this->interfaceLanguage
        ->getId(),
    ));
    $tests['[date:raw]'] = Xss::filter($date);

    // Test to make sure that we generated something for each token.
    $this
      ->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.');
    foreach ($tests as $input => $expected) {
      $output = $this->tokenService
        ->replace($input, array(
        'date' => $date,
      ), array(
        'langcode' => $this->interfaceLanguage
          ->getId(),
      ));
      $this
        ->assertEqual($output, $expected, format_string('Date token %token replaced.', array(
        '%token' => $input,
      )));
    }
  }

}

Classes

Name	Description
TokenReplaceUnitTest	Generates text using placeholders for dummy content to check token replacement.