UiPatternsLibraryOverviewTest.php in UI Patterns 8

Namespace

Drupal\Tests\ui_patterns_library\FunctionalJavascript

File

modules/ui_patterns_library/tests/src/FunctionalJavascript/UiPatternsLibraryOverviewTest.php

<?php

namespace Drupal\Tests\ui_patterns_library\FunctionalJavascript;

use Drupal\Core\Serialization\Yaml;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;

/**
 * Test patterns overview page.
 *
 * @group ui_patterns_library
 */
class UiPatternsLibraryOverviewTest extends WebDriverTestBase {

  /**
   * Default theme.
   *
   * @var string
   */
  protected $defaultTheme = 'ui_patterns_library_theme_test';

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'ui_patterns',
    'ui_patterns_library',
    'ui_patterns_library_module_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $user = $this
      ->drupalCreateUser([
      'access patterns page',
    ]);
    $this
      ->drupalLogin($user);
  }

  /**
   * Tests overview page.
   */
  public function testOverviewPage() {
    $session = $this
      ->assertSession();
    $this
      ->drupalGet('/patterns');
    $session
      ->elementContains('css', 'h1', 'Pattern library');
    $session
      ->elementContains('css', 'h2', 'Available patterns');
    foreach ($this
      ->getExpectedPatterns() as $index => $pattern) {

      // Assert pattern anchor link.
      $this
        ->assertListLink($index + 1, $pattern['label'], $pattern['name']);

      // Assert pattern preview.
      $this
        ->assertPatternPreview($pattern);

      // Test view single page link.
      $session
        ->linkExists("View {$pattern['label']} as stand-alone");
      $link = $this
        ->getSession()
        ->getPage()
        ->findLink("View {$pattern['label']} as stand-alone");
      $this
        ->assertStringContainsString('/patterns/' . $pattern['name'], $link
        ->getAttribute('href'));
    }
  }

  /**
   * Tests overview page.
   */
  public function testSinglePages() {
    $session = $this
      ->assertSession();
    foreach ($this
      ->getExpectedPatterns() as $pattern) {
      $this
        ->drupalGet('/patterns/' . $pattern['name']);
      $session
        ->elementContains('css', 'h1', $pattern['label']);

      // Assert pattern preview.
      $this
        ->assertPatternPreview($pattern);
    }
  }

  /**
   * Test that libraries defined locally are loaded correctly.
   */
  public function testLocalLibraries() {
    $session = $this
      ->assertSession();
    $this
      ->drupalGet('/patterns/with_local_libraries');
    $session
      ->responseContains('href="/modules/custom/ui_patterns/modules/ui_patterns_library/tests/modules/ui_patterns_library_module_test/templates/with_local_libraries/css/library_one.css');
    $session
      ->responseContains('href="/modules/custom/ui_patterns/modules/ui_patterns_library/tests/modules/ui_patterns_library_module_test/templates/with_local_libraries/css/library_two.css');
    $session
      ->responseContains('src="/modules/custom/ui_patterns/modules/ui_patterns_library/tests/modules/ui_patterns_library_module_test/templates/with_local_libraries/js/library_two_1.js');
    $session
      ->responseContains('src="/modules/custom/ui_patterns/modules/ui_patterns_library/tests/modules/ui_patterns_library_module_test/templates/with_local_libraries/js/library_two_2.js');
    $session
      ->responseContains('src="/core/misc/tabledrag.js');
  }

  /**
   * Assert pattern preview display.
   *
   * @param array $pattern
   *   Expected pattern.
   */
  protected function assertPatternPreview(array $pattern) {
    $session = $this
      ->assertSession();

    // Assert pattern title and description.
    $root = '.pattern-preview__' . $pattern['name'];
    $session
      ->elementExists('css', $root);
    $session
      ->elementContains('css', "{$root} > h3.pattern-preview__label", $pattern['label']);
    $session
      ->elementContains('css', "{$root} > p.pattern-preview__description", $pattern['description']);

    // Assert metadata block.
    $this
      ->assertPatternFields($root, $pattern);
    if (!$pattern['has_variants']) {

      // Make sure no variant markup exists.
      $session
        ->elementNotExists('css', "{$root} > fieldset.pattern-preview__preview > .pattern-preview__variants");

      // Assert preview content when without variants.
      $session
        ->elementContains('css', "{$root} > fieldset.pattern-preview__preview > .pattern-preview__markup", $pattern['preview']);
    }
    else {

      // Assert that variant markup exists.
      $session
        ->elementExists('css', "{$root} > fieldset.pattern-preview__preview > .pattern-preview__variants");

      // Assert variant meta information and preview.
      foreach ($pattern['variants'] as $variant) {
        $this
          ->assertPatternVariant($root, $variant);
      }
    }
  }

  /**
   * Assert pattern table fields.
   *
   * @param string $root
   *   CSS selector of element containing the table.
   * @param array $pattern
   *   Expected pattern.
   *
   * @throws \Behat\Mink\Exception\ElementHtmlException
   */
  protected function assertPatternFields($root, array $pattern) {
    $session = $this
      ->assertSession();

    // Assert table header.
    foreach ([
      'Field',
      'Label',
      'Type',
      'Description',
    ] as $index => $item) {
      $child = $index + 1;
      $session
        ->elementContains('css', "{$root} > table.pattern-preview__fields > thead > tr > th:nth-child({$child})", $item);
    }

    // Assert field table rows.
    foreach ($pattern['fields'] as $index => $field) {
      $child = $index + 1;
      $row_root = "{$root} > table.pattern-preview__fields > tbody > tr:nth-child({$child})";
      $session
        ->elementContains('css', "{$row_root} > td:nth-child(1)", $field['name']);
      $session
        ->elementContains('css', "{$row_root} > td:nth-child(2)", $field['label']);
      $session
        ->elementContains('css', "{$row_root} > td:nth-child(3)", $field['type']);
      $session
        ->elementContains('css', "{$row_root} > td:nth-child(4)", $field['description']);
    }
  }

  /**
   * Assert pattern variant metadata and preview.
   *
   * @param string $root
   *   CSS selector of element containing the table.
   * @param array $variant
   *   Variant expected values.
   */
  protected function assertPatternVariant($root, array $variant) {
    $session = $this
      ->assertSession();
    $name = $variant['meta']['name'];

    // Assert table header.
    foreach ([
      'Variant',
      'Name',
      'Description',
    ] as $index => $item) {
      $child = $index + 1;
      $session
        ->elementContains('css', "{$root} table.pattern-preview__variants--{$name} > thead > tr > th:nth-child({$child})", $item);
    }

    // Assert variant meta table rows.
    $row_root = "{$root} table.pattern-preview__variants--{$name} > tbody > tr";
    $session
      ->elementContains('css', "{$row_root} > td:nth-child(1)", $variant['meta']['name']);
    $session
      ->elementContains('css', "{$row_root} > td:nth-child(2)", $variant['meta']['label']);
    $session
      ->elementContains('css', "{$row_root} > td:nth-child(3)", $variant['meta']['description']);

    // Assert variant preview.
    $session
      ->elementContains('css', "{$root} .pattern-preview__markup--variant_{$name}", $variant['preview']);
  }

  /**
   * Assert pattern overview list link.
   *
   * @param int $index
   *   Position on list.
   * @param string $label
   *   Pattern label.
   * @param string $name
   *   Pattern machine name.
   *
   * @throws \Behat\Mink\Exception\ElementHtmlException
   */
  protected function assertListLink($index, $label, $name) {
    $this
      ->assertSession()
      ->elementContains('css', "ul > li:nth-child({$index}) > a", $label);
    $this
      ->assertSession()
      ->elementAttributeContains('css', "ul > li:nth-child({$index}) > a", 'href', '#' . $name);
  }

  /**
   * Get expected patterns.
   */
  protected function getExpectedPatterns() {
    return Yaml::decode(file_get_contents(__DIR__ . '/../../fixtures/overview-page-patterns.yml'));
  }

}

Classes

Name	Description
UiPatternsLibraryOverviewTest	Test patterns overview page.