You are here

class RestIntegrationTest in Facets 8

Tests the integration of REST-views and facets.

@group facets

Hierarchy

Expanded class hierarchy of RestIntegrationTest

File

modules/facets_rest/tests/src/Functional/RestIntegrationTest.php, line 14

Namespace

Drupal\Tests\facets_rest\Functional
View source
class RestIntegrationTest extends FacetsTestBase {

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

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();

    // Create the users used for the tests.
    $this->adminUser = $this
      ->drupalCreateUser([
      'administer search_api',
      'administer facets',
      'access administration pages',
      'administer nodes',
      'access content overview',
      'administer content types',
      'administer blocks',
      'administer views',
    ]);
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->setUpExampleStructure();
    $this
      ->insertExampleContent();
    $this
      ->assertEquals(5, $this
      ->indexItems($this->indexId), '5 items were indexed.');
  }

  /**
   * {@inheritdoc}
   */
  protected function installModulesFromClassProperty(ContainerInterface $container) {

    // This will just set the Drupal state to include the necessary bundles for
    // our test entity type. Otherwise, fields from those bundles won't be found
    // and thus removed from the test index. (We can't do it in setUp(), before
    // calling the parent method, since the container isn't set up at that
    // point.)
    $bundles = [
      'entity_test_mulrev_changed' => [
        'label' => 'Entity Test Bundle',
      ],
      'item' => [
        'label' => 'item',
      ],
      'article' => [
        'label' => 'article',
      ],
    ];
    \Drupal::state()
      ->set('entity_test_mulrev_changed.bundles', $bundles);
    parent::installModulesFromClassProperty($container);
  }

  /**
   * Tests that the facet results are correct.
   */
  public function testRestResults() {
    global $base_url;
    $get_options = [
      'query' => [
        '_format' => 'json',
      ],
    ];
    $result = $this
      ->drupalGet('/facets-rest', $get_options);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $json_decoded = json_decode($result, TRUE);
    $this
      ->assertArrayHasKey('search_results', $json_decoded);
    $this
      ->assertArrayHasKey('facets', $json_decoded);
    $this
      ->assertEmpty($json_decoded['facets']);

    // Add a new facet to filter by content type.
    $this
      ->createFacet('Type', 'type', 'type', 'rest_export_1', 'views_rest__search_api_rest_test_view');

    // Use the array widget.
    $facet_edit_page = '/admin/config/search/facets/type/edit';
    $this
      ->drupalGet($facet_edit_page);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->drupalPostForm(NULL, [
      'widget' => 'array',
    ], 'Configure widget');
    $values['widget'] = 'array';
    $values['widget_config[show_numbers]'] = TRUE;
    $values['facet_sorting[count_widget_order][status]'] = TRUE;
    $values['facet_sorting[count_widget_order][settings][sort]'] = 'ASC';
    $values['facet_sorting[display_value_widget_order][status]'] = FALSE;
    $values['facet_sorting[active_widget_order][status]'] = FALSE;
    $values['facet_settings[query_operator]'] = 'or';
    $values['facet_settings[only_visible_when_facet_source_is_visible]'] = TRUE;
    $this
      ->drupalPostForm(NULL, $values, 'Save');

    // Add a new facet to filter by keywords.
    $this
      ->createFacet('Keywords', 'keywords', 'keywords', 'rest_export_1', 'views_rest__search_api_rest_test_view');

    // Use the array widget.
    $facet_edit_page = '/admin/config/search/facets/keywords/edit';
    $this
      ->drupalGet($facet_edit_page);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->drupalPostForm(NULL, [
      'widget' => 'array',
    ], 'Configure widget');
    $values['widget'] = 'array';
    $values['widget_config[show_numbers]'] = TRUE;
    $values['facet_sorting[count_widget_order][status]'] = TRUE;
    $values['facet_sorting[count_widget_order][settings][sort]'] = 'ASC';
    $values['facet_sorting[display_value_widget_order][status]'] = FALSE;
    $values['facet_sorting[active_widget_order][status]'] = FALSE;
    $values['facet_settings[query_operator]'] = 'or';
    $values['facet_settings[only_visible_when_facet_source_is_visible]'] = TRUE;
    $this
      ->drupalPostForm(NULL, $values, 'Save');

    // Get the output from the rest view and decode it into an array.
    $result = $this
      ->drupalGet('/facets-rest', $get_options);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $json_decoded = json_decode($result);
    $this
      ->assertEquals(5, count($json_decoded->search_results));

    // Verify the facet "Type".
    $results = [
      'article' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=type%3Aarticle',
        ],
        'count' => 2,
      ],
      'item' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=type%3Aitem',
        ],
        'count' => 3,
      ],
    ];
    foreach ($json_decoded->facets[1][0]->type as $result) {
      $value = $result->values->value;
      $this
        ->assertEquals($result->values->count, $results[$value]['count']);
      foreach ($results[$value]['url'] as $url_part) {
        $this
          ->assertNotFalse(strpos($result->url, $url_part));
      }
    }

    // Verify the facet "Keywords".
    $results = [
      'banana' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Abanana',
        ],
        'count' => 1,
      ],
      'strawberry' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Astrawberry',
        ],
        'count' => 2,
      ],
      'apple' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Aapple',
        ],
        'count' => 2,
      ],
      'orange' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Aorange',
        ],
        'count' => 3,
      ],
      'grape' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Agrape',
        ],
        'count' => 3,
      ],
    ];
    foreach ($json_decoded->facets[0][0]->keywords as $result) {
      $value = $result->values->value;
      $this
        ->assertEquals($result->values->count, $results[$value]['count']);
      foreach ($results[$value]['url'] as $url_part) {
        $this
          ->assertNotFalse(strpos($result->url, $url_part));
      }
    }

    // Filter and verify that the results are correct.
    $json = $this
      ->drupalGet($base_url . '/facets-rest?f%5B0%5D=type%3Aitem', $get_options);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $json_decoded = json_decode($json);
    $this
      ->assertEquals(3, count($json_decoded->search_results));
    $results = [
      'article' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=type%3Aarticle&f%5B1%5D=type%3Aitem',
        ],
        'count' => 2,
      ],
      'item' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
        ],
        'count' => 3,
      ],
      'banana' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Abanana&f%5B1%5D=type%3Aitem',
        ],
        'count' => 0,
      ],
      'strawberry' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Astrawberry&f%5B1%5D=type%3Aitem',
        ],
        'count' => 0,
      ],
      'apple' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Aapple&f%5B1%5D=type%3Aitem',
        ],
        'count' => 1,
      ],
      'orange' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Aorange&f%5B1%5D=type%3Aitem',
        ],
        'count' => 2,
      ],
      'grape' => [
        'url' => [
          $base_url,
          '/facets-rest',
          '_format=json',
          'f%5B0%5D=keywords%3Agrape&f%5B1%5D=type%3Aitem',
        ],
        'count' => 1,
      ],
    ];
    foreach ($json_decoded->facets[1][0]->type as $result) {
      $value = $result->values->value;
      $this
        ->assertEquals($results[$value]['count'], $result->values->count);
      foreach ($results[$value]['url'] as $url_part) {
        $this
          ->assertContains($url_part, $result->url);
      }
    }
    foreach ($json_decoded->facets[0][0]->keywords as $result) {
      $value = $result->values->value;
      $this
        ->assertEquals($results[$value]['count'], $result->values->count);
      foreach ($results[$value]['url'] as $url_part) {
        $this
          ->assertContains($url_part, $result->url);
      }
    }
  }

  /**
   * Tests that the system raises an error when selecting the wrong widget.
   */
  public function testWidgetSelection() {
    $id = 'type';

    // Add a new facet to filter by content type.
    $this
      ->createFacet('Type', $id, 'type', 'rest_export_1', 'views_rest__search_api_rest_test_view');

    // Use the array widget.
    $facet_edit_page = '/admin/config/search/facets/' . $id . '/edit';
    $this
      ->drupalGet($facet_edit_page);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->drupalPostForm(NULL, [
      'widget' => 'checkbox',
    ], 'Configure widget');
    $this
      ->assertSession()
      ->pageTextContains('The Facet source is a Rest export. Please select a raw widget.');
    $this
      ->drupalPostForm(NULL, [
      'widget' => 'array',
    ], 'Configure widget');
    $this
      ->assertSession()
      ->pageTextNotContains('The Facet source is a Rest export. Please select a raw widget.');
  }

  /**
   * Tests urls on the same path.
   */
  public function testSamePath() {
    $get_options = [
      'query' => [
        '_format' => 'json',
      ],
    ];
    $id = 'type';
    $this
      ->createFacet('Type', $id . '_rest', 'type', 'rest_export_1', 'views_rest__search_api_rest_test_view', FALSE);
    $this
      ->createFacet('Type', $id, 'type', 'page_1', 'views_page__search_api_rest_test_view');
    $values['widget'] = 'array';
    $values['widget_config[show_numbers]'] = TRUE;
    $values['facet_settings[url_alias]'] = 'type';
    $values['facet_settings[only_visible_when_facet_source_is_visible]'] = TRUE;
    $this
      ->drupalPostForm('/admin/config/search/facets/type_rest/edit', [
      'widget' => 'array',
    ], 'Configure widget');
    $this
      ->drupalPostForm(NULL, $values, 'Save');
    $this
      ->drupalGet('facets-page');
    $this
      ->clickLink('item');
    $this
      ->assertSession()
      ->pageTextContains('Displaying 3 search results');
    $pageUrl = $this
      ->getSession()
      ->getCurrentUrl();
    $restUrl = str_replace('facets-page', 'facets-rest', $pageUrl);
    $result = $this
      ->drupalGet($restUrl, $get_options);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $json_decoded = json_decode($result);
    $this
      ->assertEquals(3, count($json_decoded->search_results));
  }

  /**
   * Tests hiding of facets from rest views.
   */
  public function testHideFacets() {
    $get_options = [
      'query' => [
        '_format' => 'json',
      ],
    ];
    $id = 'type_rest';
    $this
      ->createFacet('Type', $id, 'type', 'rest_export_1', 'views_rest__search_api_rest_test_view', FALSE);
    $facet = Facet::load($id);
    $facet
      ->setWidget('array', [
      'show_numbers' => TRUE,
    ]);
    $facet
      ->save();
    $result = $this
      ->drupalGet('facets-rest', $get_options);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $json_decoded = json_decode($result, TRUE);
    $this
      ->assertArrayHasKey('facets', $json_decoded);
    $this
      ->assertArrayHasKey('search_results', $json_decoded);
    $this
      ->drupalGet('admin/structure/views/nojs/display/search_api_rest_test_view/rest_export_1/style_options');
    $this
      ->drupalPostForm(NULL, [
      'style_options[show_facets]' => FALSE,
    ], 'Apply');
    $this
      ->drupalPostForm(NULL, [], 'Save');
    $result = $this
      ->drupalGet('facets-rest', $get_options);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $json_decoded = json_decode($result, TRUE);
    $this
      ->assertArrayNotHasKey('facets', $json_decoded);
    $this
      ->assertArrayNotHasKey('search_results', $json_decoded);
  }

}

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::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
RestIntegrationTest::$modules public static property Modules to enable for this test. Overrides FacetsTestBase::$modules
RestIntegrationTest::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
RestIntegrationTest::setUp public function Overrides FacetsTestBase::setUp
RestIntegrationTest::testHideFacets public function Tests hiding of facets from rest views.
RestIntegrationTest::testRestResults public function Tests that the facet results are correct.
RestIntegrationTest::testSamePath public function Tests urls on the same path.
RestIntegrationTest::testWidgetSelection public function Tests that the system raises an error when selecting the wrong widget.
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.