You are here

Home » API reference » Facets 8 » IntegrationTest.php

class IntegrationTest in Facets 8

Same name in this branch
  1. 8 tests/src/Functional/IntegrationTest.php \Drupal\Tests\facets\Functional\IntegrationTest
  2. 8 modules/facets_summary/tests/src/Functional/IntegrationTest.php \Drupal\Tests\facets_summary\Functional\IntegrationTest

Tests the overall functionality of the Facets summary admin UI.

@group facets

Hierarchy

Expanded class hierarchy of IntegrationTest

File

modules/facets_summary/tests/src/Functional/IntegrationTest.php, line 14

Namespace

Drupal\Tests\facets_summary\Functional
View source 
class IntegrationTest extends FacetsTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'facets_summary',
  ];

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->setUpExampleStructure();
    $this
      ->insertExampleContent();
    $this
      ->assertEquals(5, $this
      ->indexItems($this->indexId), '5 items were indexed.');

    // Make absolutely sure the ::$blocks variable doesn't pass information
    // along between tests.
    $this->blocks = NULL;
  }

  /**
   * Tests the overall functionality of the Facets summary admin UI.
   */
  public function testFramework() {
    $this
      ->drupalGet('admin/config/search/facets');
    $this
      ->assertSession()
      ->pageTextNotContains('Facets Summary');
    $values = [
      'name' => 'Owl',
      'id' => 'owl',
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/add-facet-summary', $values, 'Save');
    $this
      ->drupalPostForm(NULL, [], 'Save');
    $this
      ->drupalGet('admin/config/search/facets');
    $this
      ->assertSession()
      ->pageTextContains('Facets Summary');
    $this
      ->assertSession()
      ->pageTextContains('Owl');
    $this
      ->drupalGet('admin/config/search/facets/facet-summary/owl/edit');
    $this
      ->assertSession()
      ->pageTextContains('No facets found.');
    $this
      ->createFacet('Llama', 'llama');
    $this
      ->drupalGet('admin/config/search/facets');
    $this
      ->assertSession()
      ->pageTextContains('Llama');

    // Go back to the facet summary and check that the facets are not checked by
    // default and that they show up in the list here.
    $this
      ->drupalGet('admin/config/search/facets/facet-summary/owl/edit');
    $this
      ->assertSession()
      ->pageTextNotContains('No facets found.');
    $this
      ->assertSession()
      ->pageTextContains('Llama');
    $this
      ->assertSession()
      ->checkboxNotChecked('edit-facets-llama-checked');

    // Post the form and check that no facets are checked after saving the form.
    $this
      ->drupalPostForm(NULL, [], 'Save');
    $this
      ->assertSession()
      ->checkboxNotChecked('edit-facets-llama-checked');

    // Enable a facet and check it's status after saving.
    $this
      ->drupalPostForm(NULL, [
      'facets[llama][checked]' => TRUE,
    ], 'Save');
    $this
      ->assertSession()
      ->checkboxChecked('edit-facets-llama-checked');
    $this
      ->configureShowCountProcessor();
    $this
      ->configureResetFacetsProcessor();
  }

  /**
   * Tests with multiple facets.
   *
   * Includes a regression test for #2841357
   */
  public function testMultipleFacets() {

    // Create facets.
    $this
      ->createFacet('Giraffe', 'giraffe', 'keywords');

    // Clear all the caches between building the 2 facets - because things fail
    // otherwise.
    $this
      ->resetAll();
    $this
      ->createFacet('Llama', 'llama');

    // Add a summary.
    $values = [
      'name' => 'Owlß',
      'id' => 'owl',
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/add-facet-summary', $values, 'Save');
    $this
      ->drupalPostForm(NULL, [], 'Save');

    // Edit the summary and enable the giraffe's.
    $summaries = [
      'facets[giraffe][checked]' => TRUE,
      'facets[giraffe][label]' => 'Summary giraffe',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/facet-summary/owl/edit', $summaries, 'Save');
    $block = [
      'region' => 'footer',
      'id' => str_replace('_', '-', 'owl'),
      'weight' => 50,
    ];
    $block = $this
      ->drupalPlaceBlock('facets_summary_block:owl', $block);
    $this
      ->drupalGet('search-api-test-fulltext');
    $this
      ->assertSession()
      ->pageTextContains('Displaying 5 search results');
    $this
      ->assertSession()
      ->pageTextContains($block
      ->label());
    $this
      ->assertFacetBlocksAppear();
    $this
      ->clickLink('apple');
    $list_items = $this
      ->getSession()
      ->getPage()
      ->findById('block-' . $block
      ->id())
      ->findAll('css', 'li');
    $this
      ->assertCount(1, $list_items);
    $this
      ->clickLink('item');
    $list_items = $this
      ->getSession()
      ->getPage()
      ->findById('block-' . $block
      ->id())
      ->findAll('css', 'li');
    $this
      ->assertCount(1, $list_items);

    // Edit the summary and enable the giraffe's.
    $summaries = [
      'facets[giraffe][checked]' => TRUE,
      'facets[giraffe][label]' => 'Summary giraffe',
      'facets[llama][checked]' => TRUE,
      'facets[llama][label]' => 'Summary llama',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/facet-summary/owl/edit', $summaries, 'Save');
    $this
      ->drupalGet('search-api-test-fulltext');
    $this
      ->assertSession()
      ->pageTextContains('Displaying 5 search results');
    $this
      ->assertSession()
      ->pageTextContains($block
      ->label());
    $this
      ->assertFacetBlocksAppear();
    $this
      ->clickLink('apple');
    $list_items = $this
      ->getSession()
      ->getPage()
      ->findById('block-' . $block
      ->id())
      ->findAll('css', 'li');
    $this
      ->assertCount(1, $list_items);
    $this
      ->clickLink('item');
    $list_items = $this
      ->getSession()
      ->getPage()
      ->findById('block-' . $block
      ->id())
      ->findAll('css', 'li');
    $this
      ->assertCount(2, $list_items);
    $this
      ->checkShowCountProcessor();
    $this
      ->checkResetFacetsProcessor();
  }

  /**
   * Tests "Show a summary of all selected facets".
   *
   * Regression test for https://www.drupal.org/node/2878851.
   */
  public function testShowSummary() {

    // Create facets.
    $this
      ->createFacet('Giraffe', 'giraffe', 'keywords');

    // Clear all the caches between building the 2 facets - because things fail
    // otherwise.
    $this
      ->resetAll();
    $this
      ->createFacet('Llama', 'llama');

    // Add a summary.
    $values = [
      'name' => 'Owlß',
      'id' => 'owl',
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/add-facet-summary', $values, 'Save');

    // Edit the summary and enable the facets.
    $summaries = [
      'facets[giraffe][checked]' => TRUE,
      'facets[giraffe][label]' => 'Summary giraffe',
      'facets[llama][checked]' => TRUE,
      'facets[llama][label]' => 'Summary llama',
      'facets_summary_settings[show_summary][status]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $summaries, 'Save');
    $block = [
      'region' => 'footer',
      'id' => str_replace('_', '-', 'owl'),
      'weight' => 50,
    ];
    $block = $this
      ->drupalPlaceBlock('facets_summary_block:owl', $block);
    $this
      ->drupalGet('search-api-test-fulltext');
    $this
      ->assertText('Displaying 5 search results');
    $this
      ->clickLink('item');

    /** @var \Behat\Mink\Element\NodeElement[] $list_items */
    $list_items = $this
      ->getSession()
      ->getPage()
      ->findById('block-' . $block
      ->id())
      ->findAll('css', 'li');
    $this
      ->assertCount(2, $list_items);
    $this
      ->assertEquals('Summary llama: item', $list_items[0]
      ->getText());
    $this
      ->assertEquals('(-) item', $list_items[1]
      ->getText());
  }

  /**
   * Check that the disabling of the cache works.
   */
  public function testViewsCacheDisable() {

    // Load the view, verify cache settings.
    $view = Views::getView('search_api_test_view');
    $view
      ->setDisplay('page_1');
    $current_cache = $view->display_handler
      ->getOption('cache');
    $this
      ->assertEquals('none', $current_cache['type']);
    $view->display_handler
      ->setOption('cache', [
      'type' => 'tag',
    ]);
    $view
      ->save();
    $current_cache = $view->display_handler
      ->getOption('cache');
    $this
      ->assertEquals('tag', $current_cache['type']);

    // Create a facet and check for the cache disabled message.
    $id = "western_screech_owl";
    $name = "Western screech owl";
    $values = [
      'name' => $name,
      'id' => $id,
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/add-facet-summary', $values, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Caching of view Search API Test Fulltext search view has been disabled.');

    // Check the view's cache settings again to see if they've been updated.
    $view = Views::getView('search_api_test_view');
    $view
      ->setDisplay('page_1');
    $current_cache = $view->display_handler
      ->getOption('cache');
    $this
      ->assertEquals('none', $current_cache['type']);
  }

  /**
   * Tests counts for summaries.
   *
   * @see https://www.drupal.org/node/2873523
   */
  public function testCount() {

    // Create facets.
    $this
      ->createFacet('Otter', 'otter', 'keywords');

    // Clear all the caches between building the 2 facets - because things fail
    // otherwise.
    $this
      ->resetAll();
    $this
      ->createFacet('Wolverine', 'wolverine');

    // Make sure the numbers are shown with the facets.
    $edit = [
      'widget' => 'links',
      'widget_config[show_numbers]' => '1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/otter/edit', $edit, 'Save');
    $this
      ->drupalPostForm('admin/config/search/facets/wolverine/edit', $edit, 'Save');

    // Add a summary.
    $values = [
      'name' => 'Mustelidae',
      'id' => 'mustelidae',
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/add-facet-summary', $values, 'Save');

    // Configure the summary to hide the count.
    $summaries = [
      'facets[otter][checked]' => TRUE,
      'facets[otter][label]' => 'Summary giraffe',
      'facets[otter][show_count]' => FALSE,
      'facets[wolverine][checked]' => TRUE,
      'facets[wolverine][label]' => 'Summary llama',
      'facets[wolverine][show_count]' => FALSE,
    ];
    $this
      ->drupalPostForm(NULL, $summaries, 'Save');

    // Place the block.
    $block = [
      'region' => 'footer',
      'id' => str_replace('_', '-', 'owl'),
      'weight' => 50,
    ];
    $summary_block = $this
      ->drupalPlaceBlock('facets_summary_block:mustelidae', $block);
    $this
      ->drupalGet('search-api-test-fulltext');
    $webAssert = $this
      ->assertSession();
    $webAssert
      ->pageTextContains('Displaying 5 search results');
    $this
      ->assertFacetBlocksAppear();
    $webAssert
      ->pageTextContains($summary_block
      ->label());
    $this
      ->assertFacetLabel('article (2)');
    $this
      ->assertFacetLabel('apple (2)');
    $summaries = [
      'facets[otter][show_count]' => TRUE,
      'facets[wolverine][show_count]' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/facet-summary/mustelidae/edit', $summaries, 'Save');
    $this
      ->drupalGet('search-api-test-fulltext');
    $webAssert = $this
      ->assertSession();
    $webAssert
      ->pageTextContains('Displaying 5 search results');
    $this
      ->assertFacetBlocksAppear();
    $webAssert
      ->pageTextContains($summary_block
      ->label());
    $this
      ->assertFacetLabel('article (2)');
    $this
      ->assertFacetLabel('apple (2)');
  }

  /**
   * Tests for deleting a block.
   */
  public function testBlockDelete() {
    $name = 'Owl';
    $id = 'owl';
    $values = [
      'name' => $name,
      'id' => $id,
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/add-facet-summary', $values, 'Save');
    $this
      ->drupalPostForm(NULL, [], 'Save');
    $block_settings = [
      'region' => 'footer',
      'id' => $id,
    ];
    $block = $this
      ->drupalPlaceBlock('facets_summary_block:' . $id, $block_settings);
    $this
      ->drupalGet('admin/structure/block');
    $this
      ->assertSession()
      ->pageTextContains($block
      ->label());
    $this
      ->drupalGet('admin/structure/block/library/classy');
    $this
      ->assertSession()
      ->pageTextContains($name);

    // Check for the warning message that additional config entities will be
    // deleted if the facet summary is removed.
    $this
      ->drupalGet('admin/config/search/facets/facet-summary/' . $id . '/delete');
    $this
      ->assertSession()
      ->pageTextContains('The listed configuration will be deleted.');
    $this
      ->assertSession()
      ->pageTextContains($block
      ->label());
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->drupalGet('admin/structure/block/library/classy');
    $this
      ->assertSession()
      ->pageTextNotContains($name);
  }

  /**
   * Tests configuring show_count processor.
   */
  protected function configureShowCountProcessor() {
    $this
      ->assertSession()
      ->checkboxNotChecked('edit-facets-summary-settings-show-count-status');
    $this
      ->drupalPostForm(NULL, [
      'facets_summary_settings[show_count][status]' => TRUE,
    ], 'Save');
    $this
      ->assertSession()
      ->checkboxChecked('edit-facets-summary-settings-show-count-status');
    $this
      ->assertSession()
      ->pageTextContains(t('Facets Summary Owl has been updated.'));
  }

  /**
   * Tests configuring reset facets processor.
   */
  protected function configureResetFacetsProcessor() {
    $this
      ->assertSession()
      ->checkboxNotChecked('edit-facets-summary-settings-reset-facets-status');
    $this
      ->drupalPostForm(NULL, [
      'facets_summary_settings[reset_facets][status]' => TRUE,
    ], 'Save');
    $this
      ->assertSession()
      ->checkboxChecked('edit-facets-summary-settings-reset-facets-status');
    $this
      ->assertSession()
      ->pageTextContains(t('Facets Summary Owl has been updated.'));
    $this
      ->assertSession()
      ->fieldExists('facets_summary_settings[reset_facets][settings][link_text]');
    $this
      ->drupalPostForm(NULL, [
      'facets_summary_settings[reset_facets][settings][link_text]' => 'Reset facets',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains(t('Facets Summary Owl has been updated.'));
    $this
      ->assertSession()
      ->fieldValueEquals('facets_summary_settings[reset_facets][settings][link_text]', 'Reset facets');
  }

  /**
   * Tests show_count processor.
   */
  protected function checkShowCountProcessor() {

    // Create new facets summary.
    FacetsSummary::create([
      'id' => 'show_count',
      'name' => 'Show count summary',
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
      'facets' => [
        'giraffe' => [
          'checked' => 1,
          'label' => 'Giraffe',
          'separator' => ',',
          'weight' => 0,
          'show_count' => 0,
        ],
        'llama' => [
          'checked' => 1,
          'label' => 'Llama',
          'separator' => ',',
          'weight' => 0,
          'show_count' => 0,
        ],
      ],
      'processor_configs' => [
        'show_count' => [
          'processor_id' => 'show_count',
          'weights' => [
            'build' => -10,
          ],
        ],
      ],
    ])
      ->save();

    // Clear the cache after the new facet summary entity was created.
    $this
      ->resetAll();

    // Place a block and test show_count processor.
    $blockConfig = [
      'region' => 'footer',
      'id' => 'show-count',
      'label' => 'show-count-block',
    ];
    $this
      ->drupalPlaceBlock('facets_summary_block:show_count', $blockConfig);
    $this
      ->drupalGet('search-api-test-fulltext');
    $this
      ->assertSession()
      ->pageTextContains('5 results found');
    $this
      ->clickLink('apple');
    $this
      ->assertSession()
      ->pageTextContains('2 results found');
    $this
      ->clickLink('item');
    $this
      ->assertSession()
      ->pageTextContains('1 result found');
  }

  /**
   * Tests reset facets processor.
   */
  protected function checkResetFacetsProcessor() {

    // Create new facets summary.
    FacetsSummary::create([
      'id' => 'reset_facets',
      'name' => t('Reset facets summary'),
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
      'facets' => [
        'giraffe' => [
          'checked' => 1,
          'label' => 'Giraffe',
          'separator' => ',',
          'weight' => 0,
          'show_count' => 0,
        ],
        'llama' => [
          'checked' => 1,
          'label' => 'Llama',
          'separator' => ',',
          'weight' => 0,
          'show_count' => 0,
        ],
      ],
      'processor_configs' => [
        'reset_facets' => [
          'processor_id' => 'reset_facets',
          'weights' => [
            'build' => -10,
          ],
          'settings' => [
            'link_text' => 'Reset facets',
          ],
        ],
      ],
    ])
      ->save();

    // Clear the cache after the new facet summary entity was created.
    $this
      ->resetAll();

    // Place a block and test reset facets processor.
    $blockConfig = [
      'label' => 'Reset block',
      'region' => 'footer',
      'id' => 'reset-facets',
    ];
    $this
      ->drupalPlaceBlock('facets_summary_block:reset_facets', $blockConfig);
    $this
      ->drupalGet('search-api-test-fulltext');
    $this
      ->assertSession()
      ->addressEquals('/search-api-test-fulltext');
    $this
      ->assertSession()
      ->pageTextContains('Displaying 5 search results');
    $this
      ->assertSession()
      ->pageTextNotContains('Reset facets');
    $this
      ->clickLink('apple');
    $this
      ->assertSession()
      ->pageTextContains('Displaying 2 search results');
    $this
      ->assertSession()
      ->pageTextContains('Reset facets');
    $this
      ->clickLink('Reset facets');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->addressEquals('/search-api-test-fulltext');
    $this
      ->assertSession()
      ->pageTextContains('Displaying 5 search results');
    $this
      ->assertSession()
      ->pageTextNotContains('Reset facets');
  }

  /**
   * Tests  first facet doesn't have any item in for a particular filter.
   */
  public function testEmptyFacetLinks() {

    // Create facets.
    $this
      ->createFacet('Kepler-442b', 'category', 'category');

    // Clear all the caches between building the 2 facets - because things fail
    // otherwise.
    $this
      ->createFacet('Kepler-438b', 'keywords', 'keywords');
    $this
      ->resetAll();

    // Create a new item, make sure it doesn't have a "keywords" property at
    // all.
    $entity_test_storage = \Drupal::entityTypeManager()
      ->getStorage('entity_test_mulrev_changed');
    $this->entities[] = $entity_test_storage
      ->create([
      'name' => 'Test with no category',
      'body' => 'test test',
      'type' => 'item',
      'keywords' => [
        'rotten orange',
      ],
    ])
      ->save();
    $this
      ->indexItems($this->indexId);

    // Add a facets summary entity.
    $values = [
      'name' => 'Kepler planets',
      'id' => 'kepler',
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/add-facet-summary', $values, 'Save');

    // Place the block.
    $block = [
      'region' => 'footer',
      'id' => 'kplanets',
      'weight' => -10,
    ];
    $summary_block = $this
      ->drupalPlaceBlock('facets_summary_block:kepler', $block);

    // Enable the facets for the summary.
    $summaries = [
      'facets[category][checked]' => TRUE,
      'facets[category][weight]' => 0,
      'facets[keywords][checked]' => TRUE,
      'facets[keywords][weight]' => 1,
      'facets_summary_settings[reset_facets][status]' => 1,
      'facets_summary_settings[reset_facets][settings][link_text]' => 'Reset',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/facet-summary/kepler/edit', $summaries, 'Save');

    // Go to the search view, and check that the summary, as well as the facets
    // are shown on the page.
    $this
      ->drupalGet('search-api-test-fulltext');
    $web_assert = $this
      ->assertSession();
    $web_assert
      ->pageTextContains('Displaying 6 search results');
    $this
      ->assertFacetBlocksAppear();
    $web_assert
      ->pageTextContains($summary_block
      ->label());

    // Filter on the item type.
    $this
      ->clickLink('rotten orange');
    $web_assert
      ->pageTextContains('Test with no category');
  }

  /**
   * Tests the reset facet link.
   *
   * @see https://www.drupal.org/project/facets/issues/2960137
   */
  public function testResetFacetLink() {
    $this
      ->createFacet('Brasserie d\'Orval', 'orval', 'category');
    $this
      ->resetAll();

    // Add a facets summary entity.
    $values = [
      'name' => 'Trappist beers',
      'id' => 'trappist',
      'facet_source_id' => 'search_api:views_page__search_api_test_view__page_1',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/add-facet-summary', $values, 'Save');

    // Place the block.
    $block = [
      'region' => 'footer',
      'id' => 'trappist',
      'weight' => -10,
    ];
    $summary_block = $this
      ->drupalPlaceBlock('facets_summary_block:trappist', $block);

    // Enable the facets for the summary.
    $summaries = [
      'facets[orval][checked]' => TRUE,
      'facets[orval][weight]' => 0,
      'facets_summary_settings[reset_facets][status]' => 1,
      'facets_summary_settings[reset_facets][settings][link_text]' => 'Reset',
    ];
    $this
      ->drupalPostForm('admin/config/search/facets/facet-summary/trappist/edit', $summaries, 'Save');

    // Go to the search view, and check that the summary, as well as the facets
    // are shown on the page.
    $this
      ->drupalGet('search-api-test-fulltext');
    $web_assert = $this
      ->assertSession();
    $web_assert
      ->pageTextContains('Displaying 5 search results');
    $this
      ->assertFacetBlocksAppear();
    $web_assert
      ->pageTextContains($summary_block
      ->label());
    $links = $this
      ->xpath('//a[normalize-space(text())=:label]', [
      ':label' => 'Reset',
    ]);
    $this
      ->assertEmpty($links);
    $this
      ->clickLink('article_category');
    $links = $this
      ->xpath('//a[normalize-space(text())=:label]', [
      ':label' => 'Reset',
    ]);
    $this
      ->assertNotEmpty($links);
  }

}

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
BlockTestTrait::$blocks protected property The block entities used by this test.
BlockTestTrait::createBlock protected function Creates a facet block by id.
BlockTestTrait::createFacet protected function Add a facet trough the UI.
BlockTestTrait::deleteBlock protected function Deletes a facet block by id.
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::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
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::$minkDefaultDriverClass protected property 1
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::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::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. 1
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::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
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
ExampleContentTrait::$entities protected property The generated test entities, keyed by ID.
ExampleContentTrait::indexItems protected function Indexes all (unindexed) items on the specified index.
ExampleContentTrait::insertExampleContent protected function Creates several test entities. 2
ExampleContentTrait::setUpExampleStructure protected function Sets up the necessary bundles on the test entity type.
FacetsTestBase::$adminUser protected property An admin user used for this test.
FacetsTestBase::$anonymousUser protected property The anonymous user used for this test.
FacetsTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme 1
FacetsTestBase::$indexId protected property A search index ID.
FacetsTestBase::$unauthorizedUser protected property A user without Search / Facet admin permission.
FacetsTestBase::clearIndex protected function Clears the test index.
FacetsTestBase::getIndex protected function Retrieves the search index used by this test.
FacetsTestBase::getTestIndex public function Creates or deletes an index.
FacetsTestBase::getTestServer public function Creates or deletes a server.
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::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
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.
IntegrationTest::$modules public static property Modules to enable for this test. Overrides FacetsTestBase::$modules
IntegrationTest::checkResetFacetsProcessor protected function Tests reset facets processor.
IntegrationTest::checkShowCountProcessor protected function Tests show_count processor.
IntegrationTest::configureResetFacetsProcessor protected function Tests configuring reset facets processor.
IntegrationTest::configureShowCountProcessor protected function Tests configuring show_count processor.
IntegrationTest::setUp public function Overrides FacetsTestBase::setUp
IntegrationTest::testBlockDelete public function Tests for deleting a block.
IntegrationTest::testCount public function Tests counts for summaries.
IntegrationTest::testEmptyFacetLinks public function Tests first facet doesn't have any item in for a particular filter.
IntegrationTest::testFramework public function Tests the overall functionality of the Facets summary admin UI.
IntegrationTest::testMultipleFacets public function Tests with multiple facets.
IntegrationTest::testResetFacetLink public function Tests the reset facet link.
IntegrationTest::testShowSummary public function Tests "Show a summary of all selected facets".
IntegrationTest::testViewsCacheDisable public function Check that the disabling of the cache works.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TestHelperTrait::assertFacetBlocksAppear protected function Asserts that a facet block appears.
TestHelperTrait::assertFacetLabel protected function Passes if a facet with the specified label is found and is a link.
TestHelperTrait::assertNoFacetBlocksAppear protected function Asserts that a facet block does not appear.
TestHelperTrait::assertStringPosition protected function Asserts that a string is found before another string in the source.
TestHelperTrait::checkClickedFacetUrl protected function Checks that the url after clicking a facet is as expected.
TestHelperTrait::checkFacetIsActive protected function Check if a facet is active by providing a label for it.
TestHelperTrait::checkFacetIsNotActive protected function Check if a facet is not active by providing a label for it.
TestHelperTrait::clickPartialLink protected function Click a link by partial name.
TestHelperTrait::convertNameToMachineName protected function Convert facet name to machine name.
TestHelperTrait::findFacetLink protected function Use xpath to find a facet link.
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::assertSession public function Returns WebAssert object. 1
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.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.