class Select2EntityReferenceWidgetTest in Select 2 8

Tests select2 entity reference widget.

@group select2

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\FunctionalJavascriptTests\WebDriverTestBase
    • class \Drupal\Tests\select2\FunctionalJavascript\Select2JavascriptTestBase uses Select2TestTrait
      • class \Drupal\Tests\select2\FunctionalJavascript\FieldWidget\Select2EntityReferenceWidgetTest uses TestFileCreationTrait

File

tests/src/FunctionalJavascript/FieldWidget/Select2EntityReferenceWidgetTest.php, line 19

Namespace

Drupal\Tests\select2\FunctionalJavascript\FieldWidget

class Select2EntityReferenceWidgetTest extends Select2JavascriptTestBase {
  use TestFileCreationTrait;

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

  /**
   * Test a single value widget.
   *
   * @dataProvider providerTestSingleValueWidget
   */
  public function testSingleValueWidget($autocomplete, $match_operator, $count, $autocreate) {
    $this
      ->createField('select2', 'node', 'test', 'entity_reference', [
      'target_type' => 'entity_test_mulrevpub',
    ], [
      'handler' => 'default:entity_test_mulrevpub',
      'handler_settings' => [
        'auto_create' => $autocreate,
      ],
    ], 'select2_entity_reference', [
      'autocomplete' => $autocomplete,
      'match_operator' => $match_operator,
      'match_limit' => 10,
    ]);
    EntityTestMulRevPub::create([
      'name' => 'foo',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'bar',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'bar foo',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'gaga',
    ])
      ->save();
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('/node/add/test');
    $page
      ->fillField('title[0][value]', 'Test node');
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--single');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('fo');
    $assert_session
      ->waitForElement('xpath', '//li[contains(@class, "select2-results__option") and text()="foo"]');
    $assert_session
      ->elementsCount('xpath', '//li[contains(@class, "select2-results__option")]', $count);
    $page
      ->find('xpath', '//li[contains(@class, "select2-results__option") and text()="foo"]')
      ->click();
    $page
      ->pressButton('Save');
    $node = $this
      ->getNodeByTitle('Test node', TRUE);
    $this
      ->assertEquals([
      [
        'target_id' => 1,
      ],
    ], $node->select2
      ->getValue());
    if ($autocreate) {
      $this
        ->drupalGet($node
        ->toUrl('edit-form'));
      $this
        ->click('.form-item-select2 .select2-selection.select2-selection--single');
      $page
        ->find('css', '.select2-search__field')
        ->setValue('Preview value');
      $assert_session
        ->waitForElement('css', '.select2-results__option--highlighted');
      $page
        ->find('css', '.select2-results__option--highlighted')
        ->click();
      $page
        ->pressButton('Preview');
      $page
        ->clickLink('Back to content editing');
      $page
        ->pressButton('Save');
      $node = $this
        ->getNodeByTitle('Test node', TRUE);
      $this
        ->assertEquals([
        [
          'target_id' => 5,
        ],
      ], $node->select2
        ->getValue());
      $this
        ->assertNotEmpty(EntityTestMulRevPub::load(5));
      $this
        ->drupalGet($node
        ->toUrl('edit-form'));
      $this
        ->click('.form-item-select2 .select2-selection.select2-selection--single');
      $page
        ->find('css', '.select2-search__field')
        ->setValue('New value');
      $assert_session
        ->waitForElement('css', '.select2-results__option--highlighted');
      $page
        ->find('css', '.select2-results__option--highlighted')
        ->click();
      $page
        ->pressButton('Save');
      $node = $this
        ->getNodeByTitle('Test node', TRUE);
      $this
        ->assertEquals([
        [
          'target_id' => 6,
        ],
      ], $node->select2
        ->getValue());
      $this
        ->assertNotEmpty(EntityTestMulRevPub::load(6));
    }
  }

  /**
   * Data provider for testSingleValueWidget().
   *
   * @return array
   *   The data.
   */
  public function providerTestSingleValueWidget() {
    return [
      [
        TRUE,
        'STARTS_WITH',
        2,
        TRUE,
      ],
      [
        FALSE,
        NULL,
        3,
        TRUE,
      ],
      [
        FALSE,
        NULL,
        2,
        FALSE,
      ],
      [
        TRUE,
        'STARTS_WITH',
        1,
        FALSE,
      ],
      [
        TRUE,
        'CONTAINS',
        2,
        FALSE,
      ],
    ];
  }

  /**
   * Test autocomplete in a multiple value field.
   *
   * @dataProvider providerTestMultiValueWidget
   */
  public function testMultipleValueWidget($autocomplete, $autocreate) {
    $this
      ->createField('select2', 'node', 'test', 'entity_reference', [
      'target_type' => 'entity_test_mulrevpub',
      'cardinality' => -1,
    ], [
      'handler' => 'default:entity_test_mulrevpub',
      'handler_settings' => [
        'auto_create' => $autocreate,
      ],
    ], 'select2_entity_reference', [
      'autocomplete' => $autocomplete,
    ]);
    EntityTestMulRevPub::create([
      'name' => 'foo',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'bar',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'gaga',
    ])
      ->save();
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('/node/add/test');
    $page
      ->fillField('title[0][value]', 'Test node');
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('fo');
    $assert_session
      ->waitForElement('xpath', '//li[contains(@class, "select2-results__option") and text()="foo"]');
    $page
      ->find('xpath', '//li[contains(@class, "select2-results__option") and text()="foo"]')
      ->click();
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('ga');
    $assert_session
      ->waitForElement('xpath', '//li[contains(@class, "select2-results__option") and text()="gaga"]');
    $page
      ->find('xpath', '//li[contains(@class, "select2-results__option") and text()="gaga"]')
      ->click();
    $page
      ->pressButton('Save');
    $node = $this
      ->getNodeByTitle('Test node', TRUE);
    $this
      ->assertEquals([
      [
        'target_id' => 1,
      ],
      [
        'target_id' => 3,
      ],
    ], $node->select2
      ->getValue());
    if ($autocreate) {
      $this
        ->drupalGet($node
        ->toUrl('edit-form'));
      $this
        ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
      $page
        ->find('css', '.select2-search__field')
        ->setValue('Preview value');
      $assert_session
        ->waitForElement('css', '.select2-results__option--highlighted');
      $page
        ->find('css', '.select2-results__option--highlighted')
        ->click();
      $page
        ->pressButton('Preview');
      $page
        ->clickLink('Back to content editing');
      $page
        ->pressButton('Save');
      $node = $this
        ->getNodeByTitle('Test node', TRUE);
      $this
        ->assertEquals([
        [
          'target_id' => 1,
        ],
        [
          'target_id' => 3,
        ],
        [
          'target_id' => 4,
        ],
      ], $node->select2
        ->getValue());
      $this
        ->assertNotEmpty(EntityTestMulRevPub::load(4));
      $this
        ->drupalGet($node
        ->toUrl('edit-form'));
      $this
        ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
      $page
        ->find('css', '.select2-search__field')
        ->setValue('New value');
      $assert_session
        ->waitForElement('css', '.select2-results__option--highlighted');
      $page
        ->find('css', '.select2-results__option--highlighted')
        ->click();
      $page
        ->pressButton('Save');
      $node = $this
        ->getNodeByTitle('Test node', TRUE);
      $this
        ->assertEquals([
        [
          'target_id' => 1,
        ],
        [
          'target_id' => 3,
        ],
        [
          'target_id' => 4,
        ],
        [
          'target_id' => 5,
        ],
      ], $node->select2
        ->getValue());
      $this
        ->assertNotEmpty(EntityTestMulRevPub::load(5));
    }
  }

  /**
   * Data provider for testMultipleValueWidget().
   *
   * @return array
   *   The data.
   */
  public function providerTestMultiValueWidget() {
    return [
      [
        TRUE,
        TRUE,
      ],
      [
        TRUE,
        FALSE,
      ],
      [
        FALSE,
        TRUE,
      ],
      [
        FALSE,
        FALSE,
      ],
    ];
  }

  /**
   * Test autocreation for a multi value field.
   */
  public function testMultipleAutocreation() {
    EntityTestBundle::create([
      'id' => 'test1',
      'label' => 'Test1 label',
      'description' => 'My test description',
    ])
      ->save();
    EntityTestBundle::create([
      'id' => 'test2',
      'label' => 'Test2 label',
      'description' => 'My test description',
    ])
      ->save();
    $this
      ->createField('select2', 'node', 'test', 'entity_reference', [
      'target_type' => 'entity_test_with_bundle',
      'cardinality' => -1,
    ], [
      'handler' => 'default:entity_test_with_bundle',
      'handler_settings' => [
        'target_bundles' => [
          'test1' => 'test1',
          'test2' => 'test2',
        ],
        'auto_create' => TRUE,
        'auto_create_bundle' => 'test2',
      ],
    ], 'select2_entity_reference');
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalGet('/node/add/test');
    $page
      ->fillField('title[0][value]', 'Test node');
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('New value 1');
    $page
      ->find('css', '.select2-results__option--highlighted')
      ->click();
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('New value 2');
    $page
      ->find('css', '.select2-results__option--highlighted')
      ->click();
    $page
      ->pressButton('Save');
    $node = $this
      ->getNodeByTitle('Test node', TRUE);
    $this
      ->assertEquals([
      [
        'target_id' => 1,
      ],
      [
        'target_id' => 2,
      ],
    ], $node->select2
      ->getValue());
    $entity = EntityTestWithBundle::load(1);
    $this
      ->assertNotEmpty($entity);
    $this
      ->assertSame('test2', $entity
      ->bundle());
    $entity = EntityTestWithBundle::load(2);
    $this
      ->assertNotEmpty($entity);
    $this
      ->assertSame('test2', $entity
      ->bundle());
    $field = FieldConfig::loadByName('node', 'test', 'select2');
    $field
      ->setSetting('handler_settings', [
      'target_bundles' => [
        'test1' => 'test1',
        'test2' => 'test2',
      ],
      'auto_create' => TRUE,
      'auto_create_bundle' => 'test1',
    ]);
    $field
      ->save();
    $this
      ->drupalGet($node
      ->toUrl('edit-form'));
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('New value 3');
    $page
      ->find('css', '.select2-results__option--highlighted')
      ->click();
    $page
      ->pressButton('Save');
    $entity = EntityTestWithBundle::load(3);
    $this
      ->assertNotEmpty($entity);
    $this
      ->assertSame('test1', $entity
      ->bundle());
  }

  /**
   * Test selecting options of different bundles.
   */
  public function testMultipleBundleSelection() {
    EntityTestBundle::create([
      'id' => 'test1',
      'label' => 'Test1 label',
      'description' => 'My test description',
    ])
      ->save();
    EntityTestBundle::create([
      'id' => 'test2',
      'label' => 'Test2 label',
      'description' => 'My test description',
    ])
      ->save();
    $this
      ->createField('select2', 'node', 'test', 'entity_reference', [
      'target_type' => 'entity_test_with_bundle',
      'cardinality' => -1,
    ], [
      'handler' => 'default:entity_test_with_bundle',
      'handler_settings' => [
        'target_bundles' => [
          'test1' => 'test1',
          'test2' => 'test2',
        ],
        'auto_create' => FALSE,
      ],
    ], 'select2_entity_reference');
    EntityTestWithBundle::create([
      'name' => 'foo',
      'type' => 'test1',
    ])
      ->save();
    EntityTestWithBundle::create([
      'name' => 'bar',
      'type' => 'test2',
    ])
      ->save();
    EntityTestWithBundle::create([
      'name' => 'gaga',
      'type' => 'test1',
    ])
      ->save();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalGet('/node/add/test');
    $page
      ->fillField('title[0][value]', 'Test node');
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('foo');
    $page
      ->find('css', '.select2-results__option--highlighted')
      ->click();
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('bar');
    $page
      ->find('css', '.select2-results__option--highlighted')
      ->click();
    $page
      ->pressButton('Save');
    $node = $this
      ->getNodeByTitle('Test node', TRUE);
    $this
      ->assertEquals([
      [
        'target_id' => 1,
      ],
      [
        'target_id' => 2,
      ],
    ], $node->select2
      ->getValue());
  }

  /**
   * Test that in-between ajax calls are not creating new entities.
   */
  public function testAjaxCallbacksInBetween() {
    $this->container
      ->get('module_installer')
      ->install([
      'file',
    ]);
    $this
      ->createField('select2', 'node', 'test', 'entity_reference', [
      'target_type' => 'entity_test_mulrevpub',
    ], [
      'handler' => 'default:entity_test_mulrevpub',
      'handler_settings' => [
        'auto_create' => FALSE,
      ],
    ], 'select2_entity_reference', [
      'autocomplete' => TRUE,
    ]);
    $this
      ->createField('file', 'node', 'test', 'file', [], [], 'file_generic', []);
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('/node/add/test');
    $page
      ->fillField('title[0][value]', 'Test node');
    $test_file = current($this
      ->getTestFiles('text'));
    $page
      ->attachFileToField("files[file_0]", \Drupal::service('file_system')
      ->realpath($test_file->uri));
    $assert_session
      ->waitForElement('named', [
      'id_or_name',
      'file_0_remove_button',
    ]);
    $assert_session
      ->elementNotExists('css', '.messages--error');
  }

  /**
   * Tests that the autocomplete ordering is alphabetically.
   */
  public function testAutocompleteOrdering() {
    $this
      ->createField('select2', 'node', 'test', 'entity_reference', [
      'target_type' => 'entity_test_mulrevpub',
    ], [
      'handler' => 'default:entity_test_mulrevpub',
      'handler_settings' => [
        'auto_create' => FALSE,
      ],
    ], 'select2_entity_reference', [
      'autocomplete' => TRUE,
      'match_operator' => 'CONTAINS',
      'match_limit' => 10,
    ]);
    EntityTestMulRevPub::create([
      'name' => 'foo',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'bar',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'bar foo',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'gaga',
    ])
      ->save();
    $this
      ->drupalGet('/node/add/test');
    $settings = Json::decode($this
      ->getSession()
      ->getPage()
      ->findField('select2')
      ->getAttribute('data-select2-config'));
    $url = Url::fromUserInput($settings['ajax']['url']);
    $url
      ->setAbsolute(TRUE);
    $url
      ->setRouteParameter('q', 'f');
    $response = \Drupal::httpClient()
      ->get($url
      ->toString());
    $results = Json::decode($response
      ->getBody()
      ->getContents())['results'];
    $expected = [
      [
        'id' => 3,
        'text' => 'bar foo',
      ],
      [
        'id' => 1,
        'text' => 'foo',
      ],
    ];
    $this
      ->assertSame($expected, $results);
  }

  /**
   * Tests that the autocomplete ordering is alphabetically.
   */
  public function testAutocompleteMatchLimit() {
    $this
      ->createField('select2', 'node', 'test', 'entity_reference', [
      'target_type' => 'entity_test_mulrevpub',
    ], [
      'handler' => 'default:entity_test_mulrevpub',
      'handler_settings' => [
        'auto_create' => FALSE,
      ],
    ], 'select2_entity_reference', [
      'autocomplete' => TRUE,
      'match_operator' => 'CONTAINS',
      'match_limit' => 3,
    ]);
    EntityTestMulRevPub::create([
      'name' => 'foo',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'foo bar',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'bar foo',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'foooo',
    ])
      ->save();
    $this
      ->drupalGet('/node/add/test');
    $settings = Json::decode($this
      ->getSession()
      ->getPage()
      ->findField('select2')
      ->getAttribute('data-select2-config'));
    $url = Url::fromUserInput($settings['ajax']['url']);
    $url
      ->setAbsolute(TRUE);
    $url
      ->setRouteParameter('q', 'f');
    $response = \Drupal::httpClient()
      ->get($url
      ->toString());
    $this
      ->assertCount(3, Json::decode($response
      ->getBody()
      ->getContents())['results']);
  }

  /**
   * Tests the autocomplete drag n drop.
   */
  public function testAutocompleteDragnDrop() {
    $this
      ->markTestSkipped('Testing drag and drop is currently not possible due to a bug in chromedriver. See https://www.drupal.org/node/3084730.');
    $this
      ->createField('select2', 'node', 'test', 'entity_reference', [
      'target_type' => 'entity_test_mulrevpub',
      'cardinality' => -1,
    ], [
      'handler' => 'default:entity_test_mulrevpub',
      'handler_settings' => [
        'auto_create' => FALSE,
      ],
    ], 'select2_entity_reference', [
      'autocomplete' => TRUE,
      'match_operator' => 'CONTAINS',
    ]);
    EntityTestMulRevPub::create([
      'name' => 'foo',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'bar',
    ])
      ->save();
    EntityTestMulRevPub::create([
      'name' => 'gaga',
    ])
      ->save();
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('/node/add/test');
    $page
      ->fillField('title[0][value]', 'Test node');
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('fo');
    $assert_session
      ->waitForElement('xpath', '//li[contains(@class, "select2-results__option") and text()="foo"]');
    $page
      ->find('xpath', '//li[contains(@class, "select2-results__option") and text()="foo"]')
      ->click();
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('ba');
    $assert_session
      ->waitForElement('xpath', '//li[contains(@class, "select2-results__option") and text()="bar"]');
    $page
      ->find('xpath', '//li[contains(@class, "select2-results__option") and text()="bar"]')
      ->click();
    $this
      ->click('.form-item-select2 .select2-selection.select2-selection--multiple');
    $page
      ->find('css', '.select2-search__field')
      ->setValue('ga');
    $assert_session
      ->waitForElement('xpath', '//li[contains(@class, "select2-results__option") and text()="gaga"]');
    $page
      ->find('xpath', '//li[contains(@class, "select2-results__option") and text()="gaga"]')
      ->click();
    $this
      ->dragDropElement($page
      ->find('xpath', '//li[contains(@class, "select2-selection__choice") and text()="gaga"]'), -100, 0);
    $this
      ->dragDropElement($page
      ->find('xpath', '//li[contains(@class, "select2-selection__choice") and text()="foo"]'), 50, 0);
    $page
      ->pressButton('Save');
    $node = $this
      ->getNodeByTitle('Test node', TRUE);
    $this
      ->assertEquals([
      [
        'target_id' => 3,
      ],
      [
        'target_id' => 2,
      ],
      [
        'target_id' => 1,
      ],
    ], $node->select2
      ->getValue());
  }

}

Members

Name	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
Select2EntityReferenceWidgetTest::$modules	protected static	property	Modules to enable. Overrides Select2JavascriptTestBase::$modules
Select2EntityReferenceWidgetTest::providerTestMultiValueWidget	public	function	Data provider for testMultipleValueWidget().
Select2EntityReferenceWidgetTest::providerTestSingleValueWidget	public	function	Data provider for testSingleValueWidget().
Select2EntityReferenceWidgetTest::testAjaxCallbacksInBetween	public	function	Test that in-between ajax calls are not creating new entities.
Select2EntityReferenceWidgetTest::testAutocompleteDragnDrop	public	function	Tests the autocomplete drag n drop.
Select2EntityReferenceWidgetTest::testAutocompleteMatchLimit	public	function	Tests that the autocomplete ordering is alphabetically.
Select2EntityReferenceWidgetTest::testAutocompleteOrdering	public	function	Tests that the autocomplete ordering is alphabetically.
Select2EntityReferenceWidgetTest::testMultipleAutocreation	public	function	Test autocreation for a multi value field.
Select2EntityReferenceWidgetTest::testMultipleBundleSelection	public	function	Test selecting options of different bundles.
Select2EntityReferenceWidgetTest::testMultipleValueWidget	public	function	Test autocomplete in a multiple value field.
Select2EntityReferenceWidgetTest::testSingleValueWidget	public	function	Test a single value widget.
Select2JavascriptTestBase::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
Select2JavascriptTestBase::dragDropElement	protected	function	Drag element in document with defined offset position.
Select2JavascriptTestBase::scrollElementInView	protected	function	Scroll element with defined css selector in middle of browser view.
Select2JavascriptTestBase::selectOption	protected	function	Selects an option in a select2 widget.
Select2JavascriptTestBase::setUp	public	function	Overrides BrowserTestBase::setUp
Select2TestTrait::createField	protected	function	Creates a new file field.
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.
TestFileCreationTrait::$generatedTestFiles	protected	property	Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles	protected	function	Compares two files based on size and file name.
TestFileCreationTrait::generateFile	public static	function	Generates a test file.
TestFileCreationTrait::getTestFiles	protected	function	Gets a list of files that can be used in tests.
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.