You are here

class Select2BoxesTests in Select2 Boxes 8

Class for testing Select2Boxes.

@group Select2Boxes

Hierarchy

Expanded class hierarchy of Select2BoxesTests

File

tests/src/FunctionalJavascript/Select2BoxesTests.php, line 13

Namespace

Drupal\Tests\select2boxes\FunctionalJavascript
View source
class Select2BoxesTests extends Select2BoxesTestsBase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalLogin($this->user);
  }

  /**
   * Tests whether the widgets plugins exist and are accessible.
   *
   * @todo This test should be a kernel/unit test which runs much faster.
   */
  public function testWidgetsPlugins() {

    // Check if the plugin manager service exists.
    $this
      ->assertTrue(\Drupal::hasService('plugin.manager.field.widget'));

    /** @var \Drupal\Core\Field\WidgetPluginManager $plugin_manager */
    $plugin_manager = \Drupal::service('plugin.manager.field.widget');

    // Check each plugin if it has definition under a plugin manager service.
    foreach (static::$pluginIds as $widget) {
      $this
        ->assertTrue($plugin_manager
        ->hasDefinition($widget));
    }
  }

  /**
   * Check whether all widgets exist in the field widgets settings.
   */
  public function testWidgetsAdminExistence() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Check for entity reference field widgets.
    $page
      ->hasSelect('edit-fields-field-tags-type');
    $assert_session
      ->optionExists('edit-fields-field-tags-type', static::$pluginIds[1]);
    $assert_session
      ->optionExists('edit-fields-field-tags-type', static::$pluginIds[2]);

    // Check if the newly created field exists in the list.
    $page
      ->hasSelect('edit-fields-field-test-list-type');

    // Check for list field widgets.
    $assert_session
      ->optionExists('edit-fields-field-test-list-type', static::$pluginIds[0]);

    // Set the Select2Boxes widgets for both fields and submit the form.
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_test_list][type]"]')
      ->setValue(static::$pluginIds[0]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_tags][type]"]')
      ->setValue(static::$pluginIds[1]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');

    // Check if the submission has been successful.
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');
  }

  /**
   * Test single widget for entity reference fields.
   */
  public function testSingleWidget() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Set single widget for the Tags field.
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_tags][type]"]')
      ->setValue(static::$pluginIds[1]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');

    // Check if the submission has been successful.
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Now let's check the widgets style on a node creation page.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');

    // Check if all required html attributes are existing for the entity
    // reference field.
    $select = $assert_session
      ->selectExists('edit-field-tags');
    $assert_session
      ->elementAttributeExists('css', '#edit-field-tags', 'data-jquery-once-autocomplete');
    $assert_session
      ->elementAttributeExists('css', '#edit-field-tags', 'data-select2-autocomplete-list-widget');
    $this
      ->assertTrue($select
      ->hasClass('select2-widget'));
  }

  /**
   * Test multiple widget for entity reference fields.
   */
  public function testMultipleWidget() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Set multiple widget for the Tags field.
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_tags][type]"]')
      ->setValue(static::$pluginIds[2]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');

    // Check if the submission has been successful.
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Now let's check the node creation page.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');
    $select = $assert_session
      ->selectExists('edit-field-tags');

    // Check if all required html attributes are exist
    // for the entity reference field.
    $assert_session
      ->elementAttributeExists('css', '#edit-field-tags', 'data-jquery-once-autocomplete');
    $assert_session
      ->elementAttributeExists('css', '#edit-field-tags', 'data-select2-multiple');
    $assert_session
      ->elementAttributeExists('css', '#edit-field-tags', 'data-autocomplete-path');
    $assert_session
      ->elementAttributeExists('css', '#edit-field-tags', 'data-field-name');
    $this
      ->assertTrue($select
      ->hasClass('select2-widget'));
    $this
      ->assertTrue($select
      ->hasClass('select2-boxes-widget'));

    // Generate dummy terms.
    $terms = $this
      ->generateDummyTerms('tags', 10);

    // Generate one node for testing.
    $nodes = $this
      ->generateDummyContent(1);

    /** @var \Drupal\node\Entity\Node $node */
    $node = reset($nodes);
    $node
      ->set('field_tags', $terms[random_int(0, 9)]
      ->id())
      ->save();

    // Go to the node's edit page.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');

    // Check that the select element exists.
    $select = $assert_session
      ->selectExists('edit-field-tags');

    // Check that only the selected tag item has been rendered as a dropdown
    // option.
    $this
      ->assertCount(1, $this
      ->getOptions($select));
  }

  /**
   * Test widget for a list type of fields.
   */
  public function testListWidget() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Set list widget for the Test list field.
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_test_list][type]"]')
      ->setValue(static::$pluginIds[0]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');

    // Check if the submission has been successful.
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Now let's check the node creation page.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');

    // Check that the select element exists.
    $select = $assert_session
      ->selectExists('edit-field-test-list');

    // Check if all required html attributes are exist
    // for the list field.
    $assert_session
      ->elementAttributeExists('css', '#edit-field-test-list', 'data-jquery-once-autocomplete');
    $assert_session
      ->elementAttributeExists('css', '#edit-field-test-list', 'data-select2-autocomplete-list-widget');
    $this
      ->assertTrue($select
      ->hasClass('select2-widget'));
  }

  /**
   * Test preloading functionality for the multiple entity reference widgets.
   */
  public function testPreloading() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Firstly generate fake vocabulary terms.
    $this
      ->generateDummyTerms('tags', 10);

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Set multiple widget for the Tags field.
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_tags][type]"]')
      ->setValue(static::$pluginIds[2]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');

    // Check for the summary text about preloading option.
    $assert_session
      ->pageTextContains('Preloading disabled');

    // Open the settings form for the Tags field.
    $this
      ->click('input[name="field_tags_settings_edit"]');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Enable preloading via checking the checkbox field.
    $this
      ->click('input[name="fields[field_tags][settings_edit_form][third_party_settings][select2boxes][enable_preload]"]');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Set 5 rows to be preloaded.
    $page
      ->fillField('fields[field_tags][settings_edit_form][third_party_settings][select2boxes][preload_count]', '5');

    // Submit the settings form.
    $this
      ->click('input[name="field_tags_plugin_settings_update"]');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Check for summary text updates,
    // according to the specified number of preload entries.
    $assert_session
      ->pageTextContains('Number of preloaded entries: 5');

    // Submit the entity form display settings.
    $page
      ->pressButton('Save');

    // Check if the submission has been successful.
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Go to the node's creation form.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');

    // Trigger the opening dropdown via click on the search input field.
    $this
      ->click('input[class="select2-search__field"]');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Find the list of results element on the page.
    $fake_select = $assert_session
      ->elementExists('css', '#select2-edit-field-tags-results');

    // Check if the number of results is equals to the 5 rows
    // (as was specified in the widget settings).
    $this
      ->assertCount(5, $fake_select
      ->findAll('xpath', '//li'));
  }

  /**
   * Test limited search option functionality.
   */
  public function testLimitedSearch() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Set list widget for the Test list field.
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_test_list][type]"]')
      ->setValue(static::$pluginIds[0]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');

    // Check if the submission has been successful.
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Enable limited search option.
    $this
      ->drupalGet('admin/config/user-interface/select2boxes');

    // Specify minimum length search to a BIGGER value
    // than we have in our "Allowed values" settings for the field.
    $edit = [
      'limited_search' => '1',
      'minimum_search_length' => '4',
    ];
    $this
      ->submitForm($edit, 'Save configuration');
    $assert_session
      ->pageTextContains('The configuration options have been saved.');

    // Go to the node's creation form.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');

    // Trigger opening dropdown.
    $this
      ->getSession()
      ->executeScript("jQuery('select[name=\"field_test_list\"]').select2('open');");

    // Check for NON-existing search input field.
    $search_input = $assert_session
      ->elementExists('xpath', '//span[contains(@class, \'select2-search--dropdown\')]');
    $this
      ->assertNotNull($search_input);
    $this
      ->assertTrue($search_input
      ->hasClass('select2-search--hide'));
    $this
      ->drupalGet('admin/config/user-interface/select2boxes');

    // Specify minimum length search to the SAME value
    // than we have in our "Allowed values" settings for the field.
    $edit = [
      'limited_search' => '1',
      'minimum_search_length' => '3',
    ];
    $this
      ->submitForm($edit, 'Save configuration');
    $assert_session
      ->pageTextContains('The configuration options have been saved.');

    // Go to the node's creation form.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');

    // Trigger opening dropdown.
    $this
      ->getSession()
      ->executeScript("jQuery('select[name=\"field_test_list\"]').select2('open');");

    // Check for EXISTING search input field.
    $search_input = $assert_session
      ->elementExists('xpath', '//span[contains(@class, \'select2-search--dropdown\')]');
    $this
      ->assertFalse($search_input
      ->hasClass('select2-search--hide'));
  }

  /**
   * Test entity auto-creation with limited search enabled.
   */
  public function testEntityAutoCreationWithLimitedSearch() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('admin/config/user-interface/select2boxes');
    $this
      ->submitForm([
      'limited_search' => '1',
      'minimum_search_length' => '4',
    ], 'Save configuration');
    $assert_session
      ->pageTextContains('The configuration options have been saved.');

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Set single widget for the Tags entity reference field.
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_tags][type]"]')
      ->setValue(static::$pluginIds[1]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');

    // Go to the node's creation form.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');

    // Trigger opening dropdown.
    $this
      ->getSession()
      ->executeScript("jQuery('select[name=\"field_tags\"]').select2('open');");

    // Check for EXISTING search input field.
    $search_input = $assert_session
      ->elementExists('xpath', '//span[contains(@class, \'select2-search--dropdown\')]');
    $this
      ->assertFalse($search_input
      ->hasClass('select2-search--hide'));
  }

  /**
   * Test unlimited preloading behavior.
   */
  public function testUnlimitedPreloading() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Firstly generate fake vocabulary terms.
    $this
      ->generateDummyTerms('tags', 10);

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Set multiple widget for the Tags field.
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_tags][type]"]')
      ->setValue(static::$pluginIds[2]);
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Check for the summary text about preloading option.
    $assert_session
      ->pageTextContains('Preloading disabled');

    // Open the settings form for the Tags field.
    $this
      ->click('input[name="field_tags_settings_edit"]');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Enable preloading via checking the checkbox field.
    $this
      ->click('input[name="fields[field_tags][settings_edit_form][third_party_settings][select2boxes][enable_preload]"]');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Do not specify the preload count value!
    // Submit the settings form.
    $this
      ->click('input[name="field_tags_plugin_settings_update"]');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Check for summary text updates,
    // according to the NON-specified number of preload entries.
    $assert_session
      ->pageTextContains('Number of preloaded entries: all');

    // Submit the entity form display settings.
    $page
      ->pressButton('Save');

    // Check if the submission has been successful.
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');

    // Go to the node's creation form.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');

    // Trigger the opening dropdown via click on the search input field.
    $this
      ->click('input[class="select2-search__field"]');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Find the list of results element on the page.
    $fake_select = $assert_session
      ->elementExists('css', '#select2-edit-field-tags-results');

    // Check if the number of results is equals to the 10 rows (as was
    // generated).
    $this
      ->assertCount(10, $fake_select
      ->findAll('xpath', '//li'));
  }

  /**
   * Test globally enabled select2 widgets.
   */
  public function testGlobalSelect2Widgets() {
    $assert_session = $this
      ->assertSession();

    // Enable select2 widgets globally.
    $this
      ->drupalGet('admin/config/user-interface/select2boxes');
    $this
      ->submitForm([
      'select2_global' => TRUE,
    ], 'Save configuration');
    $assert_session
      ->pageTextContains('The configuration options have been saved.');

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Get all <select> elements on a page.
    $selects = $assert_session
      ->elementExists('xpath', '//select');

    // Check if all of them are having appropriate class and attribute values.
    foreach ($selects as $select) {

      /** @var \Behat\Mink\Element\NodeElement $select */
      $this
        ->assertTrue($select
        ->hasClass('select2-widget'));
      $this
        ->assertTrue($select
        ->hasAttribute('data-jquery-once-autocomplete'));
      $this
        ->assertTrue($select
        ->hasAttribute('data-select2-autocomplete-list-widget'));
    }
    $this
      ->drupalGet('admin/config/user-interface/select2boxes');
    $this
      ->submitForm([
      'select2_global' => FALSE,
    ], 'Save configuration');
    $assert_session
      ->pageTextContains('The configuration options have been saved.');

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Get all <select> elements on a page.
    $selects = $assert_session
      ->elementExists('xpath', '//select');

    // Check if all of them are NOT having
    // appropriate class and attribute values.
    foreach ($selects as $select) {

      /** @var \Behat\Mink\Element\NodeElement $select */
      $this
        ->assertFalse($select
        ->hasClass('select2-widget'));
      $this
        ->assertFalse($select
        ->hasAttribute('data-jquery-once-autocomplete'));
      $this
        ->assertFalse($select
        ->hasAttribute('data-select2-autocomplete-list-widget'));
    }
  }

  /**
   * Test globally enabled select2 widgets with limited search.
   */
  public function testGlobalSelect2WidgetsWithLimitedSearch() {
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('admin/config/user-interface/select2boxes');
    $this
      ->submitForm([
      'select2_global' => TRUE,
      'limited_search' => TRUE,
      'minimum_search_length' => '3',
    ], 'Save configuration');
    $assert_session
      ->pageTextContains('The configuration options have been saved.');

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Trigger opening dropdown.
    $this
      ->getSession()
      ->executeScript("jQuery('select[name=\"fields[status][type]\"]').select2('open');");

    // Check for NON-existing search input field.
    $search_input = $assert_session
      ->elementExists('xpath', '//span[contains(@class, \'select2-search--dropdown\')]');
    $this
      ->assertTrue($search_input
      ->hasClass('select2-search--hide'));
  }

  /**
   * Test globally enabled select2 widgets with disabling it for admin pages.
   */
  public function testGlobalSelect2WidgetsWithAdminPagesDisabled() {
    $assert_session = $this
      ->assertSession();

    // Enable select2 widgets globally.
    $this
      ->drupalGet('admin/config/user-interface/select2boxes');
    $this
      ->submitForm([
      'select2_global' => TRUE,
    ], 'Save configuration');
    $assert_session
      ->pageTextContains('The configuration options have been saved.');

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Get all <select> elements on a page.
    $selects = $assert_session
      ->elementExists('xpath', '//select');

    // Check if all of them are having appropriate class and attribute values.
    foreach ($selects as $select) {

      /** @var \Behat\Mink\Element\NodeElement $select */
      $this
        ->assertTrue($select
        ->hasClass('select2-widget'));
      $this
        ->assertTrue($select
        ->hasAttribute('data-jquery-once-autocomplete'));
      $this
        ->assertTrue($select
        ->hasAttribute('data-select2-autocomplete-list-widget'));
    }

    // Disable select2 widgets for admin pages.
    $this
      ->drupalGet('admin/config/user-interface/select2boxes');
    $this
      ->submitForm([
      'disable_for_admin_pages' => TRUE,
    ], 'Save configuration');
    $assert_session
      ->pageTextContains('The configuration options have been saved.');

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');

    // Get all <select> elements on a page.
    $selects = $assert_session
      ->elementExists('xpath', '//select');

    // Check if all of them are NOT having
    // appropriate class and attribute values.
    foreach ($selects as $select) {

      /** @var \Behat\Mink\Element\NodeElement $select */
      $this
        ->assertFalse($select
        ->hasClass('select2-widget'));
      $this
        ->assertFalse($select
        ->hasAttribute('data-jquery-once-autocomplete'));
      $this
        ->assertFalse($select
        ->hasAttribute('data-select2-autocomplete-list-widget'));
    }
  }

  /**
   * Test entity auto-creation with multiple vocabularies.
   */
  public function testEntityAutoCreationWithMultipleVocabularies() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Create new taxonomy vocabulary for testing.
    $voc = 'test_voc';
    Vocabulary::create([
      'vid' => $voc,
      'name' => $voc,
    ])
      ->save();

    // Check that the new taxonomy vocabulary has been created.
    $this
      ->assertNotNull(Vocabulary::load($voc));

    // Create new entity reference field field.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/fields/add-field');
    $page
      ->selectFieldOption('edit-new-storage-type', 'field_ui:entity_reference:taxonomy_term');
    $page
      ->fillField('edit-label', 'Test term');
    $page
      ->pressButton('Save and continue');
    $page
      ->fillField('edit-field-name', 'test_term');
    $page
      ->pressButton('Save and continue');
    $page
      ->selectFieldOption('edit-cardinality', '-1');
    $page
      ->pressButton('Save field settings');
    $page
      ->checkField('settings[handler_settings][auto_create]');
    $page
      ->checkField("settings[handler_settings][target_bundles][{$voc}]");
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->checkField('settings[handler_settings][target_bundles][tags]');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->fillField('settings[handler_settings][auto_create_bundle]', $voc);
    $page
      ->pressButton('Save settings');

    // Go the the "Manage Form Display" form.
    $this
      ->drupalGet('admin/structure/types/manage/select2boxes_test_content_type/form-display');
    $assert_session
      ->elementExists('xpath', '//select[@name="fields[field_test_term][type]"]')
      ->setValue(static::$pluginIds[2]);
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');

    // Go to the node's creation form.
    $this
      ->drupalGet('node/add/select2boxes_test_content_type');
    $page
      ->fillField('title[0][value]', 'TESTTITLE');
    $this
      ->getSession()
      ->executeScript("jQuery('#edit-field-test-term').next().find('input.select2-search__field').val('TESTTERM').trigger('keyup');");
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->selectFieldOption('field_test_term[]', 'TESTTERM');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $page
      ->pressButton('Save');
    $terms = Term::loadMultiple();
    $this
      ->assertNotEmpty($terms);

    /** @var \Drupal\taxonomy\Entity\Term $term */
    $term = reset($terms);
    $this
      ->assertEquals($voc, $term
      ->bundle());
  }

}

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
Select2BoxesTests::setUp protected function Overrides Select2BoxesTestsBase::setUp
Select2BoxesTests::testEntityAutoCreationWithLimitedSearch public function Test entity auto-creation with limited search enabled.
Select2BoxesTests::testEntityAutoCreationWithMultipleVocabularies public function Test entity auto-creation with multiple vocabularies.
Select2BoxesTests::testGlobalSelect2Widgets public function Test globally enabled select2 widgets.
Select2BoxesTests::testGlobalSelect2WidgetsWithAdminPagesDisabled public function Test globally enabled select2 widgets with disabling it for admin pages.
Select2BoxesTests::testGlobalSelect2WidgetsWithLimitedSearch public function Test globally enabled select2 widgets with limited search.
Select2BoxesTests::testLimitedSearch public function Test limited search option functionality.
Select2BoxesTests::testListWidget public function Test widget for a list type of fields.
Select2BoxesTests::testMultipleWidget public function Test multiple widget for entity reference fields.
Select2BoxesTests::testPreloading public function Test preloading functionality for the multiple entity reference widgets.
Select2BoxesTests::testSingleWidget public function Test single widget for entity reference fields.
Select2BoxesTests::testUnlimitedPreloading public function Test unlimited preloading behavior.
Select2BoxesTests::testWidgetsAdminExistence public function Check whether all widgets exist in the field widgets settings.
Select2BoxesTests::testWidgetsPlugins public function Tests whether the widgets plugins exist and are accessible.
Select2BoxesTestsBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
Select2BoxesTestsBase::$modules protected static property Modules that needs to be enabled. Overrides BrowserTestBase::$modules 1
Select2BoxesTestsBase::$pluginIds protected static property Plugin IDs list of the field widgets.
Select2BoxesTestsBase::$user protected property User with sufficient permissions to run all the tests.
Select2BoxesTestsBase::generateDummyContent protected function Generates a specified number of nodes of select2boxes_test_content_type.
Select2BoxesTestsBase::generateDummyTerms protected function Generates a specified number of terms within a specific vocabulary.
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. 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.