support-2.0.x-dev/modules/support_ticket/tests/Tests/SupportTicketTokenReplaceTest.php

<?php

namespace Drupal\support_ticket\Tests;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Html;
use Drupal\Core\Render\BubbleableMetadata;
use Drupal\system\Tests\System\TokenReplaceUnitTestBase;
use Drupal\support_ticket\Util\SupportTicketUtility;

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

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'field',
    'text',
    'comment',
    'views',
    'filter',
    'options',
    'support_ticket',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->installConfig(SupportTicketTokenReplaceTest::$modules);
    $this->installEntitySchema('comment');
    $this->installEntitySchema('support_ticket');

    $support_ticket_type = entity_create(
      'support_ticket_type',
      ['type' => 'test', 'name' => 'Test']
    );
    $support_ticket_type->save();
    SupportTicketUtility::supportTicketAddBodyField($support_ticket_type);

  }

  /**
   * Creates a support_ticket, then tests the tokens generated from it.
   */
  public function testSupportTicketTokenReplacement() {
    $url_options = [
      'absolute' => TRUE,
      'language' => $this->interfaceLanguage,
    ];

    // Create a user and a support_ticket.
    $account = $this->createUser();
    /* $support_ticket \Drupal\support_ticket\SupportTicketInterface */
    $support_ticket = entity_create('support_ticket', [
      'support_ticket_type' => 'test',
      'uid' => $account->id(),
      'title' => '<blink>Blinking Text</blink>',
      'body' => [
        [
          'value' => 'Regular SUPPORT TICKET body for the test.',
          'summary' => 'Fancy SUPPORT TICKET summary.',
          'format' => 'plain_text',
        ],
      ],
    ]);
    $support_ticket->save();

    // Generate and test tokens.
    $tests = [];
    $tests['[support_ticket:stid]'] = $support_ticket->id();
    $tests['[support_ticket:vid]'] = $support_ticket->getRevisionId();
    $tests['[support_ticket:type]'] = 'test';
    $tests['[support_ticket:type-name]'] = 'Test';
    $tests['[support_ticket:title]'] = Html::escape($support_ticket->getTitle());
    $tests['[support_ticket:body]'] = $support_ticket->body->processed;
    // $tests['[support_ticket:summary]'] =
    // $support_ticket->body->summary_processed;
    $tests['[support_ticket:langcode]'] = $support_ticket->language()->getId();
    $tests['[support_ticket:url]'] = $support_ticket->url('canonical', $url_options);
    $tests['[support_ticket:edit-url]'] = $support_ticket->url('edit-form', $url_options);
    $tests['[support_ticket:author]'] = $account->getUsername();
    $tests['[support_ticket:author:uid]'] = $support_ticket->getOwnerId();
    $tests['[support_ticket:author:name]'] = $account->getUsername();
    $tests['[support_ticket:created:since]'] = \Drupal::service('date.formatter')
      ->formatTimeDiffSince(
        $support_ticket->getCreatedTime(),
        ['langcode' => $this->interfaceLanguage->getId()]
      );
    $tests['[support_ticket:changed:since]'] = \Drupal::service('date.formatter')
      ->formatTimeDiffSince(
        $support_ticket->getChangedTime(),
        ['langcode' => $this->interfaceLanguage->getId()]
      );

    $base_bubbleable_metadata = BubbleableMetadata::createFromObject($support_ticket);

    $metadata_tests = [];
    $metadata_tests['[support_ticket:stid]'] = $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:vid]'] = $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:type]'] = $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:type-name]'] = $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:title]'] = $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:body]'] = $base_bubbleable_metadata;
    // $metadata_tests['[support_ticket:summary]'] = $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:langcode]'] = $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:url]'] = $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:edit-url]'] = $base_bubbleable_metadata;
    $bubbleable_metadata = clone $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:author]'] = $bubbleable_metadata->addCacheTags(['user:1']);
    $metadata_tests['[support_ticket:author:uid]'] = $bubbleable_metadata;
    $metadata_tests['[support_ticket:author:name]'] = $bubbleable_metadata;
    $bubbleable_metadata = clone $base_bubbleable_metadata;
    $metadata_tests['[support_ticket:created:since]'] = $bubbleable_metadata->setCacheMaxAge(0);
    $metadata_tests['[support_ticket:changed:since]'] = $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, ['support_ticket' => $support_ticket], ['langcode' => $this->interfaceLanguage->getId()], $bubbleable_metadata);
      $this->assertEqual($output, $expected, format_string('Support_ticket token %token replaced.', ['%token' => $input]));
      $this->assertEqual($bubbleable_metadata, $metadata_tests[$input]);
    }

    // Repeat for a support_ticket without a summary.
    $support_ticket = entity_create('support_ticket', [
      'support_ticket_type' => 'test',
      'uid' => $account->id(),
      'title' => '<blink>Blinking Text</blink>',
      'body' => [
        [
          'value' => 'A string that looks random like TR5c2I',
          'format' => 'plain_text',
        ],
      ],
    ]);
    $support_ticket->save();

    // Generate and test token - use full body as expected value.
    $tests = [];
    // @todo Find an appropriate way to do the rest of these tests.
    // $tests['[support_ticket:summary]'] = $support_ticket->body->processed;
    //
    // Test to make sure that we generated something for each token.
    $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated for support_ticket without a summary.');

    foreach ($tests as $input => $expected) {
      $output = $this->tokenService->replace($input, ['support_ticket' => $support_ticket], ['language' => $this->interfaceLanguage]);
      $this->assertEqual($output, $expected, new FormattableMarkup('Support_ticket token %token replaced for support_ticket without a summary.', ['%token' => $input]));
    }
  }

}