You are here

Home » API reference » JSON:API Search API 8 » IndexFacetsTest.php

final class IndexFacetsTest in JSON:API Search API 8

Tests searching with facets.

@group jsonapi_search_api_facets @group jsonapi_search_api @requires module facets

Hierarchy

Expanded class hierarchy of IndexFacetsTest

File

modules/jsonapi_search_api_facets/tests/src/Functional/IndexFacetsTest.php, line 24

Namespace

Drupal\Tests\jsonapi_search_api_facets\Functional
View source 
final class IndexFacetsTest extends BrowserTestBase {
  use ExampleContentTrait;
  use JsonApiRequestTestTrait;

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

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'node',
    'entity_test',
    'search_api',
    'search_api_test_db',
    'jsonapi_search_api',
    'jsonapi_search_api_facets',
  ];

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

    // Set up example structure and content and populate the test index with
    // that content.
    $this
      ->setUpExampleStructure();
    $this
      ->insertExampleContent();
    $index = Index::load('database_search_index');
    assert($index instanceof IndexInterface);
    $this->container
      ->get('search_api.index_task_manager')
      ->addItemsAll($index);
    $index
      ->indexItems();
    $this->container
      ->get('router.builder')
      ->rebuildIfNeeded();
    $this
      ->grantPermissions(Role::load(Role::ANONYMOUS_ID), [
      'view test entity',
    ]);
    FacetSource::create([
      'id' => 'jsonapi_search_api_facets__database_search_index',
      'name' => 'jsonapi_search_api_facets:database_search_index',
    ])
      ->save();
  }

  /**
   * Creates a facet.
   *
   * @param string $field_name
   *   The index field name.
   * @param string $name
   *   The facet name.
   * @param string $url_alias
   *   The facet URL alias.
   * @param string $query_operator
   *   The query operator, 'or' or 'and'.
   * @param bool $show_numbers
   *   Whether to show numbers.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  private function createFacet(string $field_name, string $name, string $url_alias, string $query_operator, bool $show_numbers) : void {
    assert($query_operator === 'and' || $query_operator === 'or', '$query_operator must be `or` or `and`');
    Facet::create([
      'id' => $field_name,
      'name' => $name,
      'url_alias' => $url_alias,
      'query_operator' => $query_operator,
      'field_identifier' => $field_name,
      'facet_source_id' => 'jsonapi_search_api_facets:database_search_index',
      'widget' => [
        'type' => 'jsonapi_search_api',
        'config' => [
          'show_numbers' => $show_numbers,
        ],
      ],
      'empty_behavior' => [
        'behavior' => 'none',
      ],
      'processor_configs' => [
        'url_processor_handler' => [
          'processor_id' => 'url_processor_handler',
          'weights' => [
            'pre_query' => -10,
            'build' => -10,
          ],
          'settings' => [],
        ],
      ],
    ])
      ->save();
  }

  /**
   * Asserts the URL filter parameters for a facet term.
   *
   * @param array $facet_term
   *   The facet term.
   * @param array $expected_filters
   *   The expected filter query parameters.
   */
  private function assertUrlFilterParams(array $facet_term, array $expected_filters) {
    $this
      ->assertArrayHasKey('url', $facet_term);
    $filter_params = [];
    parse_str(parse_url($facet_term['url'], PHP_URL_QUERY), $filter_params);

    // Make expanded filters are sorted, so we don't fail on ordering.
    foreach ($expected_filters as $filter_name => $expected_filter) {
      if (is_array($expected_filter)) {
        sort($expected_filters[$filter_name]['condition']['value']);
      }
    }
    foreach ($filter_params['filter'] as $filter_name => $expected_filter) {
      if (is_array($expected_filter)) {
        sort($filter_params['filter'][$filter_name]['condition']['value']);
      }
    }
    $this
      ->assertEquals([
      'filter' => $expected_filters,
    ], $filter_params, var_export($filter_params, TRUE));
  }

  /**
   * Test facet data.
   *
   * @dataProvider dataForFacets
   */
  public function testWithFacets(array $faceted_fields, bool $show_numbers, array $facet_query, int $expected_filtered_count) {
    foreach ($faceted_fields as $field_name => $faceted_field) {
      $query_operator = $faceted_field['query_operator'] ?? 'or';
      $facet_filter_path = $faceted_field['alias'] ?? $field_name;
      $this
        ->createFacet($field_name, $faceted_field['name'], $facet_filter_path, $query_operator, $show_numbers);
    }
    $url = Url::fromRoute('jsonapi_search_api.index_database_search_index');
    $data = $this
      ->doRequest($url);
    $this
      ->assertArrayHasKey('facets', $data['meta']);
    foreach ($data['meta']['facets'] as $facet) {
      $this
        ->assertArrayHasKey($facet['id'], $faceted_fields);
      $faceted_field_info = $faceted_fields[$facet['id']];
      $this
        ->assertEquals($faceted_field_info['name'], $facet['label'], var_export($facet, TRUE));
      $first_term = $facet['terms'][0];
      $this
        ->assertUrlFilterParams($first_term, [
        $facet['path'] => $first_term['values']['value'],
      ]);
      $this
        ->assertEquals($show_numbers, isset($first_term['values']['count']), var_export($facet, TRUE));
    }
    $url
      ->setOption('query', [
      'filter' => $facet_query,
    ]);
    $data = $this
      ->doRequest($url);
    $this
      ->assertCount($expected_filtered_count, $data['data'], var_export($data, TRUE));

    // Check that applied facets are marked as active.
    $filter_condition_paths = [];
    foreach ($facet_query as $filter_name => $filter_condition) {
      $filter_condition_paths[] = is_array($filter_condition) ? $filter_condition['condition']['path'] : $filter_name;
    }
    $applied_facets = array_filter($data['meta']['facets'], static function (array $facet) use ($filter_condition_paths) {
      return in_array($facet['path'], $filter_condition_paths, TRUE);
    });
    $this
      ->assertCount(count($filter_condition_paths), $applied_facets);
    foreach ($applied_facets as $facet) {
      $active_terms = array_filter($facet['terms'], static function (array $term) {
        return $term['values']['active'] === TRUE;
      });
      $this
        ->assertNotCount(0, $active_terms, var_export($facet['terms'], TRUE));
      $first_term = $facet['terms'][0];
      $expected_filter_query = $facet_query;

      // Remove the current facet condition from the existing filters, so that
      // we may assert it has been updated.
      foreach ($expected_filter_query as $filter_name => $filter_condition) {
        $filter_condition_path = is_array($filter_condition) ? $filter_condition['condition']['path'] : $filter_name;
        if ($filter_condition_path === $facet['path']) {
          unset($expected_filter_query[$filter_name]);
        }
      }

      // The facet URL should contain the active terms, and the first time.
      // The first term may be an active term, so we filter it out when
      // determing the values.
      $expected_filter_query_facets = $active_terms;
      $expected_filter_query_facets[] = $first_term;
      $expected_filter_query_values = array_unique(array_values(array_map(static function (array $item) {
        return $item['values']['value'];
      }, $expected_filter_query_facets)));
      if (count($expected_filter_query_values) > 1) {
        $expected_filter_query[strtr('!field-facet', [
          '!field' => $facet['path'],
        ])] = [
          'condition' => [
            'path' => $facet['path'],
            'operator' => 'IN',
            'value' => $expected_filter_query_values,
          ],
        ];
      }
      else {
        $expected_filter_query[$facet['path']] = $first_term['values']['value'];
      }
      $this
        ->assertUrlFilterParams($first_term, $expected_filter_query);
    }
  }

  /**
   * Tests facets are rendeted properly when empty.
   */
  public function testEmptyFacets() {
    $this
      ->createFacet('keywords', 'Keywords', 'keywords', 'or', FALSE);
    $this
      ->createFacet('category', 'Category', 'category', 'or', FALSE);
    $url = Url::fromRoute('jsonapi_search_api.index_database_search_index', [], [
      'query' => [
        'filter' => [
          'name' => 'does not exist',
        ],
      ],
    ]);
    $data = $this
      ->doRequest($url);
    $this
      ->assertCount(0, $data['data']);
    $this
      ->assertArrayHasKey('facets', $data['meta'], var_export($data, TRUE));
    $facet_ids = array_map(static function (array $facet) {
      return $facet['id'];
    }, $data['meta']['facets']);
    $this
      ->assertEquals([
      'category',
      'keywords',
    ], $facet_ids);
    foreach ($data['meta']['facets'] as $facet) {
      $this
        ->assertEquals([
        'id',
        'label',
        'path',
        'terms',
      ], array_keys($facet));
      $this
        ->assertCount(0, $facet['terms'], var_export($facet, TRUE));
    }
  }

  /**
   * Tests that existing filters are preserved in facet term URLs.
   */
  public function testWithExistingFilter() {
    $this
      ->createFacet('keywords', 'Keywords', 'keywords', 'or', FALSE);
    $filter = [
      'category' => 'item_category',
      'keywords-facet' => [
        'condition' => [
          'path' => 'keywords',
          'operator' => 'IN',
          'value' => [
            'grape',
            'strawberry',
          ],
        ],
      ],
    ];
    $url = Url::fromRoute('jsonapi_search_api.index_database_search_index', [], [
      'query' => [
        'filter' => $filter,
      ],
    ]);
    $data = $this
      ->doRequest($url);
    $this
      ->assertCount(1, $data['data']);
    $keywords_facet = $data['meta']['facets'][0];
    $first_term = reset($keywords_facet['terms']);
    $first_term_url_query = [];
    parse_str(parse_url($first_term['url'], PHP_URL_QUERY), $first_term_url_query);
    $this
      ->assertEquals($filter, $first_term_url_query['filter']);
  }

  /**
   * Daa provider for the test.
   *
   * @return \Generator
   *   The test data.
   */
  public function dataForFacets() : \Generator {

    // Baseline with no query filter.
    (yield [
      [
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'or',
        ],
      ],
      FALSE,
      [],
      5,
    ]);
    (yield [
      [
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'or',
        ],
      ],
      FALSE,
      [
        'keywords' => 'grape',
      ],
      3,
    ]);
    (yield [
      [
        'keywords' => [
          'name' => 'Keywords',
          'alias' => 'f_keywords',
          'query_operator' => 'or',
        ],
      ],
      FALSE,
      [
        'f_keywords' => 'grape',
      ],
      3,
    ]);
    (yield [
      [
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'or',
        ],
      ],
      FALSE,
      [
        'keywords-filter' => [
          'condition' => [
            'path' => 'keywords',
            'operator' => 'IN',
            'value' => [
              'grape',
              'strawberry',
            ],
          ],
        ],
      ],
      3,
    ]);
    (yield [
      [
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'and',
        ],
      ],
      FALSE,
      [
        'keywords' => 'grape',
      ],
      3,
    ]);
    (yield [
      [
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'and',
        ],
      ],
      FALSE,
      [
        'keywords-filter' => [
          'condition' => [
            'path' => 'keywords',
            'operator' => 'IN',
            'value' => [
              'grape',
              'strawberry',
              'banana',
            ],
          ],
        ],
      ],
      1,
    ]);
    (yield [
      [
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'or',
        ],
      ],
      TRUE,
      [
        'keywords' => 'apple',
      ],
      2,
    ]);
    (yield [
      [
        'category' => [
          'name' => 'Category',
          'query_operator' => 'or',
        ],
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'or',
        ],
      ],
      FALSE,
      [
        'keywords' => 'apple',
        'category' => 'item_category',
      ],
      1,
    ]);
    (yield [
      [
        'category' => [
          'name' => 'Category',
          'query_operator' => 'and',
        ],
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'and',
        ],
      ],
      FALSE,
      [
        'keywords' => 'grape',
        'category' => 'item_category',
      ],
      1,
    ]);
    (yield [
      [
        'category' => [
          'name' => 'Category',
          'query_operator' => 'or',
        ],
        'keywords' => [
          'name' => 'Keywords',
          'query_operator' => 'or',
        ],
      ],
      FALSE,
      [
        'keywords' => 'banana',
        'category' => 'article_category',
      ],
      1,
    ]);
  }

  /**
   * Do a request.
   *
   * @param \Drupal\Core\Url $url
   *   The URL.
   *
   * @return array
   *   The decoded response JSON.
   */
  private function doRequest(Url $url) {
    $request_options = [];
    $request_options[RequestOptions::HEADERS]['Accept'] = 'application/vnd.api+json';
    $response = $this
      ->request('GET', $url, $request_options);
    $this
      ->assertSame(200, $response
      ->getStatusCode(), var_export(Json::decode((string) $response
      ->getBody()), TRUE));
    return Json::decode((string) $response
      ->getBody());
  }

}

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::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::$ids protected property The Search API item IDs of the generated entities.
ExampleContentTrait::addTestEntity protected function Creates and saves a test entity with the given values.
ExampleContentTrait::getItemIds protected function Returns the item IDs for the given entity IDs. 1
ExampleContentTrait::indexItems protected function Indexes all (unindexed) items on the specified index.
ExampleContentTrait::insertExampleContent protected function Creates several test entities.
ExampleContentTrait::removeTestEntity protected function Deletes the test entity with the given ID.
ExampleContentTrait::setUpExampleStructure protected function Sets up the necessary bundles on the test entity type.
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.
IndexFacetsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
IndexFacetsTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
IndexFacetsTest::assertUrlFilterParams private function Asserts the URL filter parameters for a facet term.
IndexFacetsTest::createFacet private function Creates a facet.
IndexFacetsTest::dataForFacets public function Daa provider for the test.
IndexFacetsTest::doRequest private function Do a request.
IndexFacetsTest::setUp protected function Overrides BrowserTestBase::setUp
IndexFacetsTest::testEmptyFacets public function Tests facets are rendeted properly when empty.
IndexFacetsTest::testWithExistingFilter public function Tests that existing filters are preserved in facet term URLs.
IndexFacetsTest::testWithFacets public function Test facet data.
JsonApiRequestTestTrait::decorateWithXdebugCookie protected function Adds the Xdebug cookie to the request options.
JsonApiRequestTestTrait::request protected function Performs a HTTP request. Wraps the Guzzle HTTP client.
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.
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.