You are here

FieldViewBuilderTest.php in Twig Tweak 3.1.x

Same filename and directory in other branches
  1. 3.x tests/src/Kernel/FieldViewBuilderTest.php

File

tests/src/Kernel/FieldViewBuilderTest.php
View source
<?php

namespace Drupal\Tests\twig_tweak\Kernel;

use Drupal\Core\Cache\Cache;
use Drupal\KernelTests\KernelTestBase;
use Drupal\Tests\user\Traits\UserCreationTrait;
use Drupal\node\Entity\Node;
use Drupal\node\Entity\NodeType;

/**
 * A test for FieldViewBuilder.
 *
 * @group twig_tweak
 */
final class FieldViewBuilderTest extends KernelTestBase {
  use UserCreationTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'twig_tweak',
    'twig_tweak_test',
    'user',
    'system',
    'node',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('node');
    $this
      ->setUpCurrentUser([
      'name' => 'User 1',
    ], [
      'access content',
    ]);
    NodeType::create([
      'type' => 'article',
    ])
      ->save();
  }

  /**
   * Test callback.
   */
  public function testFieldViewBuilder() : void {
    $view_builder = $this->container
      ->get('twig_tweak.field_view_builder');
    $values = [
      'type' => 'article',
      'title' => 'Public node',
    ];
    $public_node = Node::create($values);
    $public_node
      ->save();
    $values = [
      'type' => 'article',
      'title' => 'Private node',
    ];
    $private_node = Node::create($values);
    $private_node
      ->save();

    // -- Full mode.
    $build = $view_builder
      ->build($public_node, 'title');
    self::assertArrayHasKey(0, $build);
    $expected_cache = [
      'contexts' => [
        'user',
        'user.permissions',
      ],
      'tags' => [
        'node:1',
        'tag_from_twig_tweak_test_node_access',
      ],
      'max-age' => 50,
    ];
    self::assertSame($expected_cache, $build['#cache']);
    self::assertSame('<span>Public node</span>', $this
      ->renderPlain($build));

    // -- Custom mode.
    $build = $view_builder
      ->build($public_node, 'title', [
      'settings' => [
        'link_to_entity' => TRUE,
      ],
    ]);
    self::assertArrayHasKey(0, $build);
    $expected_cache = [
      'contexts' => [
        'user',
        'user.permissions',
      ],
      'tags' => [
        'node:1',
        'tag_from_twig_tweak_test_node_access',
      ],
      'max-age' => 50,
    ];
    self::assertSame($expected_cache, $build['#cache']);
    $expected_html = '<span><a href="/node/1" hreflang="en">Public node</a></span>';
    self::assertSame($expected_html, $this
      ->renderPlain($build));

    // -- Private node with access check.
    $build = $view_builder
      ->build($private_node, 'title');
    self::assertArrayNotHasKey(0, $build);
    $expected_cache = [
      'contexts' => [
        'user',
        'user.permissions',
      ],
      'tags' => [
        'node:2',
        'tag_from_twig_tweak_test_node_access',
      ],
      'max-age' => 50,
    ];
    self::assertSame($expected_cache, $build['#cache']);
    self::assertSame('', $this
      ->renderPlain($build));

    // -- Private node without access check.
    $build = $view_builder
      ->build($private_node, 'title', 'full', NULL, FALSE);
    self::assertArrayHasKey(0, $build);
    $expected_cache = [
      'contexts' => [],
      'tags' => [
        'node:2',
      ],
      'max-age' => Cache::PERMANENT,
    ];
    self::assertSame($expected_cache, $build['#cache']);
    self::assertSame('<span>Private node</span>', $this
      ->renderPlain($build));
  }

  /**
   * Renders a render array.
   */
  private function renderPlain(array $build) : string {
    $actual_html = $this->container
      ->get('renderer')
      ->renderPlain($build);
    $actual_html = preg_replace('#<footer>.+</footer>#s', '', $actual_html);
    $actual_html = preg_replace([
      '#\\s{2,}#',
      '#\\n#',
    ], '', $actual_html);
    return $actual_html;
  }

}

Classes

Namesort descending Description
FieldViewBuilderTest A test for FieldViewBuilder.