You are here

Home » API reference » Layout Builder Component Attributes 1.1.x » ComponentAttributeTest.php

class ComponentAttributeTest in Layout Builder Component Attributes 1.1.x

Same name and namespace in other branches
  1. 1.2.x tests/src/FunctionalJavascript/ComponentAttributeTest.php \Drupal\Tests\layout_builder_component_attributes\FunctionalJavascript\ComponentAttributeTest
  2. 1.0.x tests/src/FunctionalJavascript/ComponentAttributeTest.php \Drupal\Tests\layout_builder_component_attributes\FunctionalJavascript\ComponentAttributeTest

Class ComponentAttributeTest.

@group layout_builder_component_attributes

Hierarchy

Expanded class hierarchy of ComponentAttributeTest

File

tests/src/FunctionalJavascript/ComponentAttributeTest.php, line 14

Namespace

Drupal\Tests\layout_builder_component_attributes\FunctionalJavascript
View source 
class ComponentAttributeTest extends WebDriverTestBase {
  use BlockCreationTrait;
  use ContextualLinkClickTrait;

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

  /**
   * Path prefix for the field UI for the test bundle.
   *
   * @var string
   */
  const FIELD_UI_PREFIX = 'admin/structure/types/manage/bundle_with_section_field';

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'block',
    'layout_builder',
    'layout_builder_component_attributes',
    'layout_builder_component_attributes_test',
    'node',
    'contextual',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->createContentType([
      'type' => 'bundle_with_section_field',
    ]);

    // Create an authenticated user.
    $this->auth_user = $this
      ->drupalCreateUser([
      'access administration pages',
      'access contextual links',
      'administer node display',
      'administer node fields',
      'configure any layout',
    ]);

    // Create an admin user.
    $this->admin_user = $this
      ->drupalCreateUser([
      'access administration pages',
      'access contextual links',
      'administer node display',
      'administer node fields',
      'bypass node access',
      'configure any layout',
      'manage layout builder component attributes',
    ]);
    $this
      ->drupalLogin($this->admin_user);

    // Enable layout builder.
    $this
      ->drupalPostForm(static::FIELD_UI_PREFIX . '/display/default', [
      'layout[enabled]' => TRUE,
    ], 'Save');
    $this
      ->drupalPlaceBlock('system_messages_block');
  }

  /**
   * Tests permissions are enforced.
   */
  public function testManageComponentAttributesFormPermissions() {
    $this
      ->getSession()
      ->resizeWindow(1200, 2000);
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalLogin($this->auth_user);
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
    $this
      ->resetLayoutBuilderLayout();
    $this
      ->assertNotEmpty($page
      ->findAll('xpath', '//*[contains(@class, "layout-builder-block")]//ul[contains(@class, "contextual-links")]', 'Contextual links are rendered.'));
    $this
      ->assertEmpty($page
      ->findAll('xpath', '//*[contains(@class, "layout-builder-block")]//ul[contains(@class, "contextual-links")]//a[contains(text(), "Manage attributes")]', 'Manage attributes link is not rendered.'));
    $this
      ->drupalLogin($this->admin_user);
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');

    // Wait for contextual links to load.
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertNotEmpty($page
      ->findAll('xpath', '//*[contains(@class, "layout-builder-block")]//ul[contains(@class, "contextual-links")]//a[contains(text(), "Manage attributes")]', 'Manage attributes link is rendered'));
  }

  /**
   * Tests Manage Component Attributes Form.
   */
  public function testManageComponentAttributesForm() {
    $this
      ->getSession()
      ->resizeWindow(1200, 2000);
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
    $this
      ->resetLayoutBuilderLayout();
    $this
      ->clickContextualLink('.layout-builder-block', 'Manage attributes');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Test validation, one field at a time.
    // Block Attributes.
    $page
      ->find('xpath', '//details[contains(@id, "edit-block-attributes")]')
      ->click();
    $page
      ->fillField('block_attributes[id]', '(block-id-test');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_attributes[id]', 'block-id-test');
    $page
      ->fillField('block_attributes[class]', '*block-class1 block-class2');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_attributes[class]', 'block-class1 block-class2');
    $page
      ->fillField('block_attributes[style]', 'color blue;');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_attributes[style]', 'color: blue;');
    $page
      ->fillField('block_attributes[data]', 'data-block-test' . PHP_EOL . 'ata-block-test2|test-value');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_attributes[data]', 'data-block-test' . PHP_EOL . 'data-block-test2|test-value');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Block Title Attributes.
    $this
      ->clickContextualLink('.layout-builder-block', 'Manage attributes');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->find('xpath', '//details[contains(@id, "edit-block-title-attributes")]')
      ->click();
    $page
      ->fillField('block_title_attributes[id]', '(block-title-id-test');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_title_attributes[id]', 'block-title-id-test');
    $page
      ->fillField('block_title_attributes[class]', '*block-title-class1 block-title-class2');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_title_attributes[class]', 'block-title-class1 block-title-class2');
    $page
      ->fillField('block_title_attributes[style]', 'color white;');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_title_attributes[style]', 'color: white;');
    $page
      ->fillField('block_title_attributes[data]', 'data-block-title-test' . PHP_EOL . 'ata-block-title-test2|test-value-title');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_title_attributes[data]', 'data-block-title-test' . PHP_EOL . 'data-block-title-test2|test-value-title');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Block Content Attributes.
    $this
      ->clickContextualLink('.layout-builder-block', 'Manage attributes');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->find('xpath', '//details[contains(@id, "edit-block-content-attributes")]')
      ->click();
    $page
      ->fillField('block_content_attributes[id]', '(block-content-id-test');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_content_attributes[id]', 'block-content-id-test');
    $page
      ->fillField('block_content_attributes[class]', '*block-content-class1 block-content-class2');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_content_attributes[class]', 'block-content-class1 block-content-class2');
    $page
      ->fillField('block_content_attributes[style]', 'color red;');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_content_attributes[style]', 'color: red;');
    $page
      ->fillField('block_content_attributes[data]', 'data-block-content-test' . PHP_EOL . 'ata-block-content-test2|test-value-content');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSettingsTrayOpen();
    $page
      ->fillField('block_content_attributes[data]', 'data-block-content-test' . PHP_EOL . 'data-block-content-test2|test-value-content');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save layout');

    // Verify correct rendering of attributes.
    $this
      ->drupalGet('node/add/bundle_with_section_field');
    $page
      ->fillField('Title', 'Test Node Title');
    $page
      ->pressButton('Save');
    $this
      ->drupalGet('node/1');

    // Verify Block Attributes.
    $element = $page
      ->find('xpath', '//*[@id="block-id-test"]');
    $this
      ->assertNotEmpty($element, "Block ID rendered");
    $this
      ->assertTrue($element
      ->hasClass('block-class1'), "Block class rendered");
    $this
      ->assertTrue($element
      ->hasClass('block-class2'), "Block class rendered");
    $style = $element
      ->getAttribute('style');
    $this
      ->assertSame('color: blue;', $style, "Style attribute rendered");
    $this
      ->assertTrue($element
      ->hasAttribute('data-block-test'), "Data attribute rendered");
    $data1 = $element
      ->getAttribute('data-block-test');
    $this
      ->assertEmpty($data1, "Data attribute has no value");
    $this
      ->assertTrue($element
      ->hasAttribute('data-block-test2'), "Data attribute rendered");
    $data2 = $element
      ->getAttribute('data-block-test2');
    $this
      ->assertSame($data2, 'test-value', "Data attribute has expected value");

    // Verify Block Title Attributes.
    $element = $page
      ->find('xpath', '//*[@id="block-title-id-test"]');
    $this
      ->assertNotEmpty($element, "Block ID rendered");
    $this
      ->assertTrue($element
      ->hasClass('block-title-class1'), "Block class rendered");
    $this
      ->assertTrue($element
      ->hasClass('block-title-class2'), "Block class rendered");
    $style = $element
      ->getAttribute('style');
    $this
      ->assertSame('color: white;', $style, "Style attribute rendered");
    $this
      ->assertTrue($element
      ->hasAttribute('data-block-title-test'), "Data attribute rendered");
    $data1 = $element
      ->getAttribute('data-block-title-test');
    $this
      ->assertEmpty($data1, "Data attribute has no value");
    $this
      ->assertTrue($element
      ->hasAttribute('data-block-title-test2'), "Data attribute rendered");
    $data2 = $element
      ->getAttribute('data-block-title-test2');
    $this
      ->assertSame($data2, 'test-value-title', "Data attribute has expected value");

    // Verify Block Content Attributes.
    $element = $page
      ->find('xpath', '//*[@id="block-content-id-test"]');
    $this
      ->assertNotEmpty($element, "Block ID rendered");
    $this
      ->assertTrue($element
      ->hasClass('block-content-class1'), "Block class rendered");
    $this
      ->assertTrue($element
      ->hasClass('block-content-class2'), "Block class rendered");
    $style = $element
      ->getAttribute('style');
    $this
      ->assertSame('color: red;', $style, "Style attribute rendered");
    $this
      ->assertTrue($element
      ->hasAttribute('data-block-content-test'), "Data attribute rendered");
    $data1 = $element
      ->getAttribute('data-block-content-test');
    $this
      ->assertEmpty($data1, "Data attribute has no value");
    $this
      ->assertTrue($element
      ->hasAttribute('data-block-content-test2'), "Data attribute rendered");
    $data2 = $element
      ->getAttribute('data-block-content-test2');
    $this
      ->assertSame($data2, 'test-value-content', "Data attribute has expected value");
  }

  /**
   * Tests allowed attributes (both form render and page render).
   */
  public function testAllowedAttributes() {
    $this
      ->getSession()
      ->resizeWindow(1200, 2000);
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Initially, populate all fields. This also verifies they are rendered.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
    $this
      ->resetLayoutBuilderLayout();
    $this
      ->clickContextualLink('.layout-builder-block', 'Manage attributes');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->find('xpath', '//details[contains(@id, "edit-block-attributes")]')
      ->click();
    $page
      ->fillField('block_attributes[id]', 'block-id-test');
    $page
      ->fillField('block_attributes[class]', 'block-class-test');
    $page
      ->fillField('block_attributes[style]', 'color: blue;');
    $page
      ->fillField('block_attributes[data]', 'data-block-test|test-value');
    $page
      ->find('xpath', '//details[contains(@id, "edit-block-title-attributes")]')
      ->click();
    $page
      ->fillField('block_title_attributes[id]', 'block-title-id-test');
    $page
      ->fillField('block_title_attributes[class]', 'block-title-class-test');
    $page
      ->fillField('block_title_attributes[style]', 'color: white;');
    $page
      ->fillField('block_title_attributes[data]', 'data-block-title-test|test-value-title');
    $page
      ->find('xpath', '//details[contains(@id, "edit-block-content-attributes")]')
      ->click();
    $page
      ->fillField('block_content_attributes[id]', 'block-content-id-test');
    $page
      ->fillField('block_content_attributes[class]', 'block-content-class-test');
    $page
      ->fillField('block_content_attributes[style]', 'color: red;');
    $page
      ->fillField('block_content_attributes[data]', 'data-block-content-test|test-value-content');
    $page
      ->pressButton('Update');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save layout');

    // Verify Block Attributes.
    $attributes = [
      'id' => 'block-id-test',
      'class' => 'block-class-test',
      'style' => 'color: blue;',
      'data-block-test' => 'test-value',
    ];
    $this
      ->verifyAllowedAttributes('block_attributes', $attributes);

    // Verify Block Title Attributes.
    $attributes = [
      'id' => 'block-title-id-test',
      'class' => 'block-title-class-test',
      'style' => 'color: white;',
      'data-block-title-test' => 'test-value-title',
    ];
    $this
      ->verifyAllowedAttributes('block_title_attributes', $attributes);

    // Verify Block Content Attributes.
    $attributes = [
      'id' => 'block-content-id-test',
      'class' => 'block-content-class-test',
      'style' => 'color: red;',
      'data-block-content-test' => 'test-value-content',
    ];
    $this
      ->verifyAllowedAttributes('block_content_attributes', $attributes);
  }

  /**
   * Verifies form rendering and on-page rendering of allowed attributes.
   *
   * @param string $group
   *   A group of fields: 'block_attributes', 'block_title_attributes',
   *   or 'block_content_attributes'.
   * @param array $attributes
   *   An array of attributes with the attribute name as the key and a test
   *   value as the value. Only one data-* attribute can be passed per group.
   */
  private function verifyAllowedAttributes($group, array $attributes) {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();

    // Create an array to keep track of attributes' statuses during test loops.
    // Initially, set all attributes as allowed.
    $attribute_fields = [];
    foreach ($attributes as $attribute => $test_value) {

      // Replace 'data-*' attribute with 'data' to match expected FAPI key.
      if (substr($attribute, 0, 5) === "data-") {
        $attribute = 'data';
      }
      $attribute_fields[$attribute] = TRUE;
    }

    // Load config.
    $config = \Drupal::service('config.factory')
      ->getEditable('layout_builder_component_attributes.settings');

    // Load contextual menu and observe all fields are rendered.
    $this
      ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
    $this
      ->clickContextualLink('.layout-builder-block', 'Manage attributes');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Loop through fields.
    foreach ($attribute_fields as $attribute => $attribute_status) {
      $this
        ->assertTrue($page
        ->hasField($group . '[' . $attribute . ']'), "Attribute field " . $attribute . " is rendered for " . $group . " group");
    }

    // Loop through attributes and disable one attribute per time.
    foreach ($attribute_fields as $attribute => $attribute_status) {
      $attribute_fields[$attribute] = FALSE;
      $config
        ->set('allowed_' . $group, $attribute_fields)
        ->save();
      $this
        ->drupalGet(static::FIELD_UI_PREFIX . '/display/default/layout');
      $this
        ->clickContextualLink('.layout-builder-block', 'Manage attributes');
      $assert_session
        ->assertWaitOnAjaxRequest();

      // Verify only fields for allowed attributes are rendered.
      foreach ($attribute_fields as $attribute_inner => $attribute_status) {
        if ($attribute_fields[$attribute_inner]) {
          $this
            ->assertTrue($page
            ->hasField($group . '[' . $attribute_inner . ']'), "Attribute field " . $attribute_inner . " is rendered for " . $group . " group");
        }
        else {
          $this
            ->assertFalse($page
            ->hasField($group . '[' . $attribute_inner . ']'), "Attribute field " . $attribute_inner . " is not rendered for " . $group . " group");
        }
      }

      // Create and load a test node.
      $page
        ->pressButton('Update');
      $assert_session
        ->assertWaitOnAjaxRequest();
      $page
        ->pressButton('Save layout');
      $this
        ->drupalGet('node/add/bundle_with_section_field');
      $page
        ->fillField('Title', 'Test Node Title');
      $page
        ->pressButton('Save');
      $this
        ->drupalGet('node/1');

      // Load page and verify only allowed attributes are rendered in markup.
      foreach ($attributes as $attribute_inner => $test_value) {

        // Replace 'data-*' attribute with 'data' to match expected FAPI key.
        $attribute_field = substr($attribute_inner, 0, 5) === "data-" ? 'data' : $attribute_inner;
        if ($attribute_fields[$attribute_field]) {
          $element = $page
            ->find('xpath', '//*[contains(@' . $attribute_inner . ', "' . $test_value . '")]');
          $this
            ->assertNotEmpty($element, "Attribute " . $attribute_inner . " rendered in " . $group . " group");
        }
        else {
          $element = $page
            ->find('xpath', '//*[contains(@' . $attribute_inner . ', "' . $test_value . '")]');
          $this
            ->assertEmpty($element, "Attribute " . $attribute_inner . " not rendered in " . $group . " group");
        }
      }
    }

    // After last loop, verify details element is no longer rendered.
    $element = $page
      ->find('xpath', '//details[contains(@id, "edit-' . $group . '")]');
    $this
      ->assertEmpty($element, "Details element not rendered");
  }

  /**
   * Helper method to assert the settings tray is open.
   */
  private function assertSettingsTrayOpen() {
    $page = $this
      ->getSession()
      ->getPage();

    // Due to https://www.drupal.org/project/drupal/issues/2897377, validation
    // in the settings tray fails silently, so check that the form did not
    // submit and close instead of checking for the error message. When the
    // validation issue is fixed, this method can be removed and actual
    // error messages can be checked.
    $element = $page
      ->find('xpath', '//form[contains(@id, "layout-builder-manage-attributes-form")]');
    $this
      ->assertNotNull($element);
  }

  /**
   * Helper method to reset a Layout Builder page.
   *
   * This method removes the default section and blocks before creating a new
   * section and adding a single block, which simplifies testing.
   */
  private function resetLayoutBuilderLayout() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $page
      ->clickLink('Remove Section 1');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Remove');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Assert that there are no sections on the page.
    $assert_session
      ->pageTextNotContains('Remove Section 1');
    $assert_session
      ->pageTextNotContains('Add block');

    // Add back a section and a component.
    $page
      ->clickLink('Add section');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->clickLink('One column');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Add section');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->clickLink('Add block');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->clickLink('Powered by Drupal');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->checkField('Display title');
    $page
      ->pressButton('Add block');
    $assert_session
      ->assertWaitOnAjaxRequest();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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 Mink default driver params.
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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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::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::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
ComponentAttributeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ComponentAttributeTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
ComponentAttributeTest::assertSettingsTrayOpen private function Helper method to assert the settings tray is open.
ComponentAttributeTest::FIELD_UI_PREFIX constant Path prefix for the field UI for the test bundle.
ComponentAttributeTest::resetLayoutBuilderLayout private function Helper method to reset a Layout Builder page.
ComponentAttributeTest::setUp protected function Overrides BrowserTestBase::setUp
ComponentAttributeTest::testAllowedAttributes public function Tests allowed attributes (both form render and page render).
ComponentAttributeTest::testManageComponentAttributesForm public function Tests Manage Component Attributes Form.
ComponentAttributeTest::testManageComponentAttributesFormPermissions public function Tests permissions are enforced.
ComponentAttributeTest::verifyAllowedAttributes private function Verifies form rendering and on-page rendering of allowed attributes.
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
ContextualLinkClickTrait::clickContextualLink protected function Clicks a contextual link. 1
ContextualLinkClickTrait::toggleContextualTriggerVisibility protected function Toggles the visibility of a contextual trigger.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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::$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. 1
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. 20
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. 1
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
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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. 1
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.
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. 1
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. 1
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 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
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::$failOnJavascriptConsoleErrors protected property Determines if a test should fail on JavaScript console errors. 3
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass 1
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
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
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.