You are here

Home » API reference » Drupal 8 » TableDragTest.php

class TableDragTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/tests/Drupal/FunctionalJavascriptTests/TableDrag/TableDragTest.php \Drupal\FunctionalJavascriptTests\TableDrag\TableDragTest
  2. 10 core/tests/Drupal/FunctionalJavascriptTests/TableDrag/TableDragTest.php \Drupal\FunctionalJavascriptTests\TableDrag\TableDragTest

Tests draggable table.

@group javascript

Hierarchy

Expanded class hierarchy of TableDragTest

1 file declares its use of TableDragTest
ClaroTableDragTest.php in core/tests/Drupal/FunctionalJavascriptTests/Theme/ClaroTableDragTest.php

File

core/tests/Drupal/FunctionalJavascriptTests/TableDrag/TableDragTest.php, line 14

Namespace

Drupal\FunctionalJavascriptTests\TableDrag
View source 
class TableDragTest extends WebDriverTestBase {

  /**
   * Class used to verify that dragging operations are in execution.
   */
  const DRAGGING_CSS_CLASS = 'tabledrag-test-dragging';

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

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->state = $this->container
      ->get('state');
  }

  /**
   * Tests row weight switch.
   */
  public function testRowWeightSwitch() {
    $this->state
      ->set('tabledrag_test_table', array_flip(range(1, 3)));
    $this
      ->drupalGet('tabledrag_test');
    $session = $this
      ->getSession();
    $page = $session
      ->getPage();
    $weight_select1 = $page
      ->findField("table[1][weight]");
    $weight_select2 = $page
      ->findField("table[2][weight]");
    $weight_select3 = $page
      ->findField("table[3][weight]");

    // Check that rows weight selects are hidden.
    $this
      ->assertFalse($weight_select1
      ->isVisible());
    $this
      ->assertFalse($weight_select2
      ->isVisible());
    $this
      ->assertFalse($weight_select3
      ->isVisible());

    // Toggle row weight selects as visible.
    $this
      ->findWeightsToggle('Show row weights')
      ->click();

    // Check that rows weight selects are visible.
    $this
      ->assertTrue($weight_select1
      ->isVisible());
    $this
      ->assertTrue($weight_select2
      ->isVisible());
    $this
      ->assertTrue($weight_select3
      ->isVisible());

    // Toggle row weight selects back to hidden.
    $this
      ->findWeightsToggle('Hide row weights')
      ->click();

    // Check that rows weight selects are hidden again.
    $this
      ->assertFalse($weight_select1
      ->isVisible());
    $this
      ->assertFalse($weight_select2
      ->isVisible());
    $this
      ->assertFalse($weight_select3
      ->isVisible());
  }

  /**
   * Tests draggable table drag'n'drop.
   */
  public function testDragAndDrop() {
    $this->state
      ->set('tabledrag_test_table', array_flip(range(1, 3)));
    $this
      ->drupalGet('tabledrag_test');
    $session = $this
      ->getSession();
    $page = $session
      ->getPage();
    $weight_select1 = $page
      ->findField("table[1][weight]");
    $weight_select2 = $page
      ->findField("table[2][weight]");
    $weight_select3 = $page
      ->findField("table[3][weight]");

    // Check that initially the rows are in the correct order.
    $this
      ->assertOrder([
      'Row with id 1',
      'Row with id 2',
      'Row with id 3',
    ]);

    // Check that the 'unsaved changes' text is not present in the message area.
    $this
      ->assertSession()
      ->pageTextNotContains('You have unsaved changes.');
    $row1 = $this
      ->findRowById(1)
      ->find('css', 'a.tabledrag-handle');
    $row2 = $this
      ->findRowById(2)
      ->find('css', 'a.tabledrag-handle');
    $row3 = $this
      ->findRowById(3)
      ->find('css', 'a.tabledrag-handle');

    // Drag row1 over row2.
    $row1
      ->dragTo($row2);

    // Check that the 'unsaved changes' text was added in the message area.
    $this
      ->assertSession()
      ->waitForText('You have unsaved changes.');

    // Check that row1 and row2 were swapped.
    $this
      ->assertOrder([
      'Row with id 2',
      'Row with id 1',
      'Row with id 3',
    ]);

    // Check that weights were changed.
    $this
      ->assertGreaterThan($weight_select2
      ->getValue(), $weight_select1
      ->getValue());
    $this
      ->assertGreaterThan($weight_select2
      ->getValue(), $weight_select3
      ->getValue());
    $this
      ->assertGreaterThan($weight_select1
      ->getValue(), $weight_select3
      ->getValue());

    // Now move the last row (row3) in the second position. row1 should go last.
    $row3
      ->dragTo($row1);

    // Check that the order is: row2, row3 and row1.
    $this
      ->assertOrder([
      'Row with id 2',
      'Row with id 3',
      'Row with id 1',
    ]);
  }

  /**
   * Tests accessibility through keyboard of the tabledrag functionality.
   */
  public function testKeyboardAccessibility() {
    $this->state
      ->set('tabledrag_test_table', array_flip(range(1, 5)));
    $expected_table = [
      [
        'id' => 1,
        'weight' => 0,
        'parent' => '',
        'indentation' => 0,
        'changed' => FALSE,
      ],
      [
        'id' => 2,
        'weight' => 0,
        'parent' => '',
        'indentation' => 0,
        'changed' => FALSE,
      ],
      [
        'id' => 3,
        'weight' => 0,
        'parent' => '',
        'indentation' => 0,
        'changed' => FALSE,
      ],
      [
        'id' => 4,
        'weight' => 0,
        'parent' => '',
        'indentation' => 0,
        'changed' => FALSE,
      ],
      [
        'id' => 5,
        'weight' => 0,
        'parent' => '',
        'indentation' => 0,
        'changed' => FALSE,
      ],
    ];
    $this
      ->drupalGet('tabledrag_test');
    $this
      ->assertDraggableTable($expected_table);

    // Nest the row with id 2 as child of row 1.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(2), 'right');
    $expected_table[1] = [
      'id' => 2,
      'weight' => -10,
      'parent' => 1,
      'indentation' => 1,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);

    // Nest the row with id 3 as child of row 1.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(3), 'right');
    $expected_table[2] = [
      'id' => 3,
      'weight' => -9,
      'parent' => 1,
      'indentation' => 1,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);

    // Nest the row with id 3 as child of row 2.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(3), 'right');
    $expected_table[2] = [
      'id' => 3,
      'weight' => -10,
      'parent' => 2,
      'indentation' => 2,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);

    // Nesting should be allowed to maximum level 2.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(4), 'right', 4);
    $expected_table[3] = [
      'id' => 4,
      'weight' => -9,
      'parent' => 2,
      'indentation' => 2,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);

    // Re-order children of row 1.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(4), 'up');
    $expected_table[2] = [
      'id' => 4,
      'weight' => -10,
      'parent' => 2,
      'indentation' => 2,
      'changed' => TRUE,
    ];
    $expected_table[3] = [
      'id' => 3,
      'weight' => -9,
      'parent' => 2,
      'indentation' => 2,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);

    // Move back the row 3 to the 1st level.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(3), 'left');
    $expected_table[3] = [
      'id' => 3,
      'weight' => -9,
      'parent' => 1,
      'indentation' => 1,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(3), 'left');
    $expected_table[0] = [
      'id' => 1,
      'weight' => -10,
      'parent' => '',
      'indentation' => 0,
      'changed' => FALSE,
    ];
    $expected_table[3] = [
      'id' => 3,
      'weight' => -9,
      'parent' => '',
      'indentation' => 0,
      'changed' => TRUE,
    ];
    $expected_table[4] = [
      'id' => 5,
      'weight' => -8,
      'parent' => '',
      'indentation' => 0,
      'changed' => FALSE,
    ];
    $this
      ->assertDraggableTable($expected_table);

    // Move row 3 to the last position.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(3), 'down');
    $expected_table[3] = [
      'id' => 5,
      'weight' => -9,
      'parent' => '',
      'indentation' => 0,
      'changed' => FALSE,
    ];
    $expected_table[4] = [
      'id' => 3,
      'weight' => -8,
      'parent' => '',
      'indentation' => 0,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);

    // Nothing happens when trying to move the last row further down.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(3), 'down');
    $this
      ->assertDraggableTable($expected_table);

    // Nest row 3 under 5. The max depth allowed should be 1.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(3), 'right', 3);
    $expected_table[4] = [
      'id' => 3,
      'weight' => -10,
      'parent' => 5,
      'indentation' => 1,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);

    // The first row of the table cannot be nested.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(1), 'right');
    $this
      ->assertDraggableTable($expected_table);

    // Move a row which has nested children. The children should move with it,
    // with nesting preserved. Swap the order of the top-level rows by moving
    // row 1 to after row 3.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(1), 'down', 2);
    $expected_table[0] = [
      'id' => 5,
      'weight' => -10,
      'parent' => '',
      'indentation' => 0,
      'changed' => FALSE,
    ];
    $expected_table[3] = $expected_table[1];
    $expected_table[1] = $expected_table[4];
    $expected_table[4] = $expected_table[2];
    $expected_table[2] = [
      'id' => 1,
      'weight' => -9,
      'parent' => '',
      'indentation' => 0,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);
  }

  /**
   * Tests the root and leaf behaviors for rows.
   */
  public function testRootLeafDraggableRowsWithKeyboard() {
    $this->state
      ->set('tabledrag_test_table', [
      1 => [],
      2 => [
        'parent' => 1,
        'depth' => 1,
        'classes' => [
          'tabledrag-leaf',
        ],
      ],
      3 => [
        'parent' => 1,
        'depth' => 1,
      ],
      4 => [],
      5 => [
        'classes' => [
          'tabledrag-root',
        ],
      ],
    ]);
    $this
      ->drupalGet('tabledrag_test');
    $expected_table = [
      [
        'id' => 1,
        'weight' => 0,
        'parent' => '',
        'indentation' => 0,
        'changed' => FALSE,
      ],
      [
        'id' => 2,
        'weight' => 0,
        'parent' => 1,
        'indentation' => 1,
        'changed' => FALSE,
      ],
      [
        'id' => 3,
        'weight' => 0,
        'parent' => 1,
        'indentation' => 1,
        'changed' => FALSE,
      ],
      [
        'id' => 4,
        'weight' => 0,
        'parent' => '',
        'indentation' => 0,
        'changed' => FALSE,
      ],
      [
        'id' => 5,
        'weight' => 0,
        'parent' => '',
        'indentation' => 0,
        'changed' => FALSE,
      ],
    ];
    $this
      ->assertDraggableTable($expected_table);

    // Rows marked as root cannot be moved as children of another row.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(5), 'right');
    $this
      ->assertDraggableTable($expected_table);

    // Rows marked as leaf cannot have children. Trying to move the row #3
    // as child of #2 should have no results.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(3), 'right');
    $this
      ->assertDraggableTable($expected_table);

    // Leaf can be still swapped and moved to first level.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(2), 'down');
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(2), 'left');
    $expected_table[0]['weight'] = -10;
    $expected_table[1]['id'] = 3;
    $expected_table[1]['weight'] = -10;
    $expected_table[2] = [
      'id' => 2,
      'weight' => -9,
      'parent' => '',
      'indentation' => 0,
      'changed' => TRUE,
    ];
    $expected_table[3]['weight'] = -8;
    $expected_table[4]['weight'] = -7;
    $this
      ->assertDraggableTable($expected_table);

    // Root rows can have children.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(4), 'down');
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(4), 'right');
    $expected_table[3]['id'] = 5;
    $expected_table[4] = [
      'id' => 4,
      'weight' => -10,
      'parent' => 5,
      'indentation' => 1,
      'changed' => TRUE,
    ];
    $this
      ->assertDraggableTable($expected_table);
  }

  /**
   * Tests the warning that appears upon making changes to a tabledrag table.
   */
  public function testTableDragChangedWarning() {
    $this
      ->drupalGet('tabledrag_test');

    // By default no text is visible.
    $this
      ->assertSession()
      ->pageTextNotContains('You have unsaved changes.');

    // Try to make a non-allowed action, like moving further down the last row.
    // No changes happen, so no message should be shown.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(5), 'down');
    $this
      ->assertSession()
      ->pageTextNotContains('You have unsaved changes.');

    // Make a change. The message will appear.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(5), 'right');
    $this
      ->assertSession()
      ->pageTextContainsOnce('You have unsaved changes.');

    // Make another change, the text will stay visible and appear only once.
    $this
      ->moveRowWithKeyboard($this
      ->findRowById(2), 'up');
    $this
      ->assertSession()
      ->pageTextContainsOnce('You have unsaved changes.');
  }

  /**
   * Asserts that several pieces of markup are in a given order in the page.
   *
   * @param string[] $items
   *   An ordered list of strings.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   *   When any of the given string is not found.
   *
   * @todo Remove this and use the WebAssert method when #2817657 is done.
   */
  protected function assertOrder(array $items) {
    $session = $this
      ->getSession();
    $text = $session
      ->getPage()
      ->getHtml();
    $strings = [];
    foreach ($items as $item) {
      if (($pos = strpos($text, $item)) === FALSE) {
        throw new ExpectationException("Cannot find '{$item}' in the page", $session
          ->getDriver());
      }
      $strings[$pos] = $item;
    }
    ksort($strings);
    $this
      ->assertSame($items, array_values($strings), "Strings found on the page but incorrectly ordered.");
  }

  /**
   * Asserts the whole structure of the draggable test table.
   *
   * @param array $structure
   *   The table structure. Each entry represents a row and consists of:
   *   - id: the expected value for the ID hidden field.
   *   - weight: the expected row weight.
   *   - parent: the expected parent ID for the row.
   *   - indentation: how many indents the row should have.
   *   - changed: whether or not the row should have been marked as changed.
   */
  protected function assertDraggableTable(array $structure) {
    $rows = $this
      ->getSession()
      ->getPage()
      ->findAll('xpath', '//table[@id="tabledrag-test-table"]/tbody/tr');
    $this
      ->assertSession()
      ->elementsCount('xpath', '//table[@id="tabledrag-test-table"]/tbody/tr', count($structure));
    foreach ($structure as $delta => $expected) {
      $this
        ->assertTableRow($rows[$delta], $expected['id'], $expected['weight'], $expected['parent'], $expected['indentation'], $expected['changed']);
    }
  }

  /**
   * Asserts the values of a draggable row.
   *
   * @param \Behat\Mink\Element\NodeElement $row
   *   The row element to assert.
   * @param string $id
   *   The expected value for the ID hidden input of the row.
   * @param int $weight
   *   The expected weight of the row.
   * @param string $parent
   *   The expected parent ID.
   * @param int $indentation
   *   The expected indentation of the row.
   * @param bool $changed
   *   Whether or not the row should have been marked as changed.
   */
  protected function assertTableRow(NodeElement $row, $id, $weight, $parent = '', $indentation = 0, $changed = FALSE) {

    // Assert that the row position is correct by checking that the id
    // corresponds.
    $this
      ->assertSession()
      ->hiddenFieldValueEquals("table[{$id}][id]", $id, $row);
    $this
      ->assertSession()
      ->hiddenFieldValueEquals("table[{$id}][parent]", $parent, $row);
    $this
      ->assertSession()
      ->fieldValueEquals("table[{$id}][weight]", $weight, $row);
    $this
      ->assertSession()
      ->elementsCount('css', '.js-indentation.indentation', $indentation, $row);

    // A row is marked as changed when the related markup is present.
    $this
      ->assertSession()
      ->elementsCount('css', 'abbr.tabledrag-changed', (int) $changed, $row);
  }

  /**
   * Finds a row in the test table by the row ID.
   *
   * @param string $id
   *   The ID of the row.
   *
   * @return \Behat\Mink\Element\NodeElement
   *   The row element.
   */
  protected function findRowById($id) {
    $xpath = "//table[@id='tabledrag-test-table']/tbody/tr[.//input[@name='table[{$id}][id]']]";
    $row = $this
      ->getSession()
      ->getPage()
      ->find('xpath', $xpath);
    $this
      ->assertNotEmpty($row);
    return $row;
  }

  /**
   * Finds the show/hide weight toggle element.
   *
   * @param string $expected_text
   *   The expected text on the element.
   *
   * @return \Behat\Mink\Element\NodeElement
   *   The toggle element.
   */
  protected function findWeightsToggle($expected_text) {
    $toggle = $this
      ->getSession()
      ->getPage()
      ->findButton($expected_text);
    $this
      ->assertNotEmpty($toggle);
    return $toggle;
  }

  /**
   * Moves a row through the keyboard.
   *
   * @param \Behat\Mink\Element\NodeElement $row
   *   The row to move.
   * @param string $arrow
   *   The arrow button to use to move the row. Either one of 'left', 'right',
   *   'up' or 'down'.
   * @param int $repeat
   *   (optional) How many times to press the arrow button. Defaults to 1.
   */
  protected function moveRowWithKeyboard(NodeElement $row, $arrow, $repeat = 1) {
    $keys = [
      'left' => 37,
      'right' => 39,
      'up' => 38,
      'down' => 40,
    ];
    if (!isset($keys[$arrow])) {
      throw new \InvalidArgumentException('The arrow parameter must be one of "left", "right", "up" or "down".');
    }
    $key = $keys[$arrow];
    $handle = $row
      ->find('css', 'a.tabledrag-handle');
    $handle
      ->focus();
    for ($i = 0; $i < $repeat; $i++) {
      $this
        ->markRowHandleForDragging($handle);
      $handle
        ->keyDown($key);
      $handle
        ->keyUp($key);
      $this
        ->waitUntilDraggingCompleted($handle);
    }
    $handle
      ->blur();
  }

  /**
   * Marks a row handle for dragging.
   *
   * The handle is marked by adding a css class that is removed by an helper
   * js library once the dragging is over.
   *
   * @param \Behat\Mink\Element\NodeElement $handle
   *   The draggable row handle element.
   *
   * @throws \Exception
   *   Thrown when the class is not added successfully to the handle.
   */
  protected function markRowHandleForDragging(NodeElement $handle) {
    $class = self::DRAGGING_CSS_CLASS;
    $script = <<<JS
document.evaluate("{<span class="php-variable">$handle</span>
  -&gt;<span class="php-function-or-constant function member-of-variable">getXpath</span>()}", document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null)
  .singleNodeValue.classList.add('{<span class="php-variable">$class</span>}');
JS;
    $this
      ->getSession()
      ->executeScript($script);
    $has_class = $this
      ->getSession()
      ->getPage()
      ->waitFor(1, function () use ($handle, $class) {
      return $handle
        ->hasClass($class);
    });
    if (!$has_class) {
      throw new \Exception(sprintf('Dragging css class was not added on handle "%s".', $handle
        ->getXpath()));
    }
  }

  /**
   * Waits until the dragging operations are finished on a row handle.
   *
   * @param \Behat\Mink\Element\NodeElement $handle
   *   The draggable row handle element.
   *
   * @throws \Exception
   *   Thrown when the dragging operations are not completed on time.
   */
  protected function waitUntilDraggingCompleted(NodeElement $handle) {
    $class_removed = $this
      ->getSession()
      ->getPage()
      ->waitFor(1, function () use ($handle) {
      return !$handle
        ->hasClass($this::DRAGGING_CSS_CLASS);
    });
    if (!$class_removed) {
      throw new \Exception(sprintf('Dragging operations did not complete on time on handle %s', $handle
        ->getXpath()));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TableDragTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 1
TableDragTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
TableDragTest::$state protected property The state service.
TableDragTest::assertDraggableTable protected function Asserts the whole structure of the draggable test table.
TableDragTest::assertOrder protected function Asserts that several pieces of markup are in a given order in the page.
TableDragTest::assertTableRow protected function Asserts the values of a draggable row.
TableDragTest::DRAGGING_CSS_CLASS constant Class used to verify that dragging operations are in execution.
TableDragTest::findRowById protected function Finds a row in the test table by the row ID.
TableDragTest::findWeightsToggle protected function Finds the show/hide weight toggle element. 1
TableDragTest::markRowHandleForDragging protected function Marks a row handle for dragging.
TableDragTest::moveRowWithKeyboard protected function Moves a row through the keyboard.
TableDragTest::setUp protected function Overrides BrowserTestBase::setUp
TableDragTest::testDragAndDrop public function Tests draggable table drag'n'drop.
TableDragTest::testKeyboardAccessibility public function Tests accessibility through keyboard of the tabledrag functionality.
TableDragTest::testRootLeafDraggableRowsWithKeyboard public function Tests the root and leaf behaviors for rows.
TableDragTest::testRowWeightSwitch public function Tests row weight switch.
TableDragTest::testTableDragChangedWarning public function Tests the warning that appears upon making changes to a tabledrag table.
TableDragTest::waitUntilDraggingCompleted protected function Waits until the dragging operations are finished on a row handle.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.