class ProcessorIntegrationTest in Search API 8

Tests the admin UI for processors.

@group search_api

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\search_api\Functional\SearchApiBrowserTestBase
  - class \Drupal\Tests\search_api\Functional\ProcessorIntegrationTest uses PluginTestTrait, EntityReferenceTestTrait

Expanded class hierarchy of ProcessorIntegrationTest

File

tests/src/Functional/ProcessorIntegrationTest.php, line 21

Namespace

Drupal\Tests\search_api\Functional

View source

class ProcessorIntegrationTest extends SearchApiBrowserTestBase {
  use EntityReferenceTestTrait;
  use PluginTestTrait;

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

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->drupalLogin($this->adminUser);
    $this->indexId = 'test_index';
    $index = Index::create([
      'name' => 'Test index',
      'id' => $this->indexId,
      'status' => 1,
      'datasource_settings' => [
        'entity:node' => [],
        'entity:user' => [],
      ],
    ]);

    // Add a node and a taxonomy term reference, both of which could be used to
    // create a hierarchy.
    $this
      ->createEntityReferenceField('node', 'page', 'term_field', NULL, 'taxonomy_term', 'default', [], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $this
      ->createEntityReferenceField('node', 'page', 'parent_reference', NULL, 'node', 'default', [
      'target_bundles' => [
        'page' => 'page',
      ],
    ]);

    // Index the taxonomy and entity reference fields.
    $term_field = new Field($index, 'term_field');
    $term_field
      ->setType('integer');
    $term_field
      ->setPropertyPath('term_field');
    $term_field
      ->setDatasourceId('entity:node');
    $term_field
      ->setLabel('Terms');
    $index
      ->addField($term_field);
    $parent_reference = new Field($index, 'parent_reference');
    $parent_reference
      ->setType('integer');
    $parent_reference
      ->setPropertyPath('parent_reference');
    $parent_reference
      ->setDatasourceId('entity:node');
    $parent_reference
      ->setLabel('Terms');
    $index
      ->addField($parent_reference);
    $index
      ->save();
  }

  /**
   * Tests the admin UI for processors.
   *
   * Calls the other test methods in this class, named check*Integration(), to
   * avoid the overhead of having one test per processor.
   */
  public function testProcessorIntegration() {

    // Some processors are always enabled.
    $enabled = [
      'add_url',
      'aggregated_field',
      'language_with_fallback',
      'rendered_item',
    ];
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);

    // Ensure the hidden processors aren't displayed in the UI.
    $this
      ->loadProcessorsTab();
    $hidden = $enabled;
    foreach ($hidden as $processor_id) {
      $this
        ->assertSession()
        ->responseNotContains(Html::escape($processor_id));
    }
    $this
      ->checkLanguageWithFallbackIntegration();
    $this
      ->checkAggregatedFieldsIntegration();
    $this
      ->checkContentAccessIntegration();
    $enabled[] = 'content_access';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkEntityBundleBoostIntegration();
    $enabled[] = 'type_boost';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkHighlightIntegration();
    $enabled[] = 'highlight';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkHtmlFilterIntegration();
    $enabled[] = 'html_filter';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkIgnoreCaseIntegration();
    $enabled[] = 'ignorecase';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkIgnoreCharactersIntegration();
    $enabled[] = 'ignore_character';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkEntityStatusIntegration();
    $enabled[] = 'entity_status';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkNoUiIntegration();
    $enabled[] = 'search_api_test_no_ui';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkRoleFilterIntegration();
    $enabled[] = 'role_filter';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkRenderedItemIntegration();
    $this
      ->checkStopWordsIntegration();
    $enabled[] = 'stopwords';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkTokenizerIntegration();
    $enabled[] = 'tokenizer';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkTransliterationIntegration();
    $enabled[] = 'transliteration';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkAddHierarchyIntegration();
    $enabled[] = 'hierarchy';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkStemmerIntegration();
    $enabled[] = 'stemmer';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);
    $this
      ->checkNumberFieldBoostIntegration();
    $enabled[] = 'number_field_boost';
    sort($enabled);
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);

    // The 'add_url' processor is not available to be removed because it's
    // locked.
    $this
      ->checkUrlFieldIntegration();

    // Check the order of the displayed processors.
    $stages = [
      ProcessorInterface::STAGE_PREPROCESS_INDEX,
      ProcessorInterface::STAGE_PREPROCESS_QUERY,
      ProcessorInterface::STAGE_POSTPROCESS_QUERY,
    ];

    /** @var \Drupal\search_api\Processor\ProcessorInterface[] $processors */
    $processors = \Drupal::getContainer()
      ->get('search_api.plugin_helper')
      ->createProcessorPlugins($this
      ->loadIndex());
    $page = $this
      ->getSession()
      ->getPage();
    foreach ($stages as $stage) {

      // Since the order of processors with the same weight is undefined, we
      // can't just use $index->getProcessorsByStage() and assertEquals().
      $previous_weight = NULL;
      $class = 'search-api-stage-wrapper-' . Html::cleanCssIdentifier($stage);

      /** @var \Behat\Mink\Element\NodeElement $element */
      foreach ($page
        ->findAll('css', ".{$class} tr.draggable") as $element) {

        // Since processors are shown right away when checked in the form, they
        // are even included in the form when disabled – just hidden. We can
        // check the "style" attribute to identify them.
        if (preg_match('/\\bsearch-api-processor-weight--([-a-z0-9]+)\\b/', $element
          ->getAttribute('class'), $m)) {
          $processor_id = str_replace('-', '_', $m[1]);
          $weight = $processors[$processor_id]
            ->getWeight($stage);
          if ($previous_weight !== NULL) {
            $this
              ->assertGreaterThanOrEqual($previous_weight, $weight, "Correct order of processor {$processor_id} in stage {$stage}");
          }
          $previous_weight = $weight;
        }
      }
    }

    // Check whether disabling processors also works correctly.
    $this
      ->loadProcessorsTab();
    $edit = [
      'status[stopwords]' => FALSE,
    ];
    $this
      ->submitForm($edit, 'Save');
    $enabled = array_values(array_diff($enabled, [
      'stopwords',
    ]));
    $actual_processors = array_keys($this
      ->loadIndex()
      ->getProcessors());
    sort($actual_processors);
    $this
      ->assertEquals($enabled, $actual_processors);

    // After disabling some datasource, all related processors should be
    // disabled also.
    $this
      ->drupalGet('admin/config/search/search-api/index/' . $this->indexId . '/edit');
    $this
      ->submitForm([
      'datasources[entity:user]' => FALSE,
    ], 'Save');
    $processors = $this
      ->loadIndex()
      ->getProcessors();
    $this
      ->assertArrayNotHasKey('role_filter', $processors);
    $this
      ->drupalGet('admin/config/search/search-api/index/' . $this->indexId . '/processors');
    $this
      ->assertSession()
      ->pageTextNotContains('Role filter');
  }

  /**
   * Tests that processors discouraged by the backend are correctly hidden.
   *
   * @see https://www.drupal.org/node/2228739
   */
  public function testLimitProcessors() {
    $this
      ->loadProcessorsTab();
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('Highlight');
    $this
      ->assertSession()
      ->pageTextContains('Ignore character');
    $this
      ->assertSession()
      ->pageTextContains('Tokenizer');
    $this
      ->assertSession()
      ->pageTextContains('Stopwords');

    // Create a new server with the "search_api_test" backend.
    $server = Server::create([
      'id' => 'webtest_server',
      'name' => 'WebTest server',
      'description' => 'WebTest server',
      'backend' => 'search_api_test',
      'backend_config' => [],
    ]);
    $server
      ->save();
    $processors = [
      'highlight',
      'ignore_character',
      'tokenizer',
      'stopwords',
    ];
    $this
      ->setReturnValue('backend', 'getDiscouragedProcessors', $processors);

    // Use the newly created server.
    $settings_path = 'admin/config/search/search-api/index/' . $this->indexId . '/edit';
    $this
      ->drupalGet($settings_path);
    $this
      ->submitForm([
      'server' => 'webtest_server',
    ], 'Save');

    // Load the processors again and check that they are disabled now.
    $this
      ->loadProcessorsTab();
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('It is recommended not to use this processor with the selected server.');
    $this
      ->assertSession()
      ->elementExists('css', 'input[name="status[highlight]"][disabled="disabled"]');
    $this
      ->assertSession()
      ->elementExists('css', 'input[name="status[ignore_character]"][disabled="disabled"]');
    $this
      ->assertSession()
      ->elementExists('css', 'input[name="status[tokenizer]"][disabled="disabled"]');
    $this
      ->assertSession()
      ->elementExists('css', 'input[name="status[stopwords]"][disabled="disabled"]');
  }

  /**
   * Tests the integration of the "Language (with fallback)" processor.
   */
  protected function checkLanguageWithFallbackIntegration() {

    // Test that the processor is locked.
    $index = $this
      ->loadIndex();
    $index
      ->removeProcessor('language_with_fallback');
    $index
      ->save();
    $this
      ->assertTrue($this
      ->loadIndex()
      ->isValidProcessor('language_with_fallback'), 'The "Language (with fallback)" processor cannot be disabled.');

    // Add a language_with_fallback field.
    $options['query']['datasource'] = '';
    $this
      ->drupalGet($this
      ->getIndexPath('fields/add/nojs'), $options);

    // See \Drupal\search_api\Tests\IntegrationTest::addField().
    $this
      ->assertSession()
      ->responseContains('name="language_with_fallback"');
    $this
      ->submitForm([], 'language_with_fallback');
    $args['%label'] = 'Language (with fallback)';
    $this
      ->assertSession()
      ->responseContains(new FormattableMarkup('Field %label was added to the index.', $args));
  }

  /**
   * Tests the integration of the "Aggregated fields" processor.
   */
  public function checkAggregatedFieldsIntegration() {
    $index = $this
      ->loadIndex();
    $index
      ->removeProcessor('aggregated_field');
    $index
      ->save();
    $this
      ->assertTrue($this
      ->loadIndex()
      ->isValidProcessor('aggregated_field'), 'The "Aggregated fields" processor cannot be disabled.');
    $options['query']['datasource'] = '';
    $this
      ->drupalGet($this
      ->getIndexPath('fields/add/nojs'), $options);

    // See \Drupal\search_api\Tests\IntegrationTest::addField().
    $this
      ->assertSession()
      ->responseContains('name="aggregated_field"');
    $this
      ->submitForm([], 'aggregated_field');
    $args['%label'] = 'Aggregated field';
    $this
      ->assertSession()
      ->responseContains(new FormattableMarkup('Field %label was added to the index.', $args));
    $this
      ->assertSession()
      ->addressEquals($this
      ->getIndexPath('fields/edit/aggregated_field'));
    $edit = [
      'type' => 'first',
      'fields[entity:node/title]' => 'title',
      'fields[entity:node/type]' => 'type',
      'fields[entity:node/uid]' => 'uid',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->addressEquals($this
      ->getIndexPath('fields'));
    $this
      ->assertSession()
      ->responseContains('The field configuration was successfully saved.');
  }

  /**
   * Tests the UI for the "Content access" processor.
   */
  public function checkContentAccessIntegration() {
    $this
      ->enableProcessor('content_access');

    // Ensure the fields required for the "Content access" processor are now
    // indexed.
    $index = $this
      ->loadIndex();
    $index
      ->save();
    $content_access_fields = [
      'status' => [
        'datasource_id' => 'entity:node',
        'property_path' => 'status',
        'type' => 'boolean',
        'indexed_locked' => TRUE,
        'type_locked' => TRUE,
      ],
      'uid' => [
        'datasource_id' => 'entity:node',
        'property_path' => 'uid',
        'type' => 'integer',
        'indexed_locked' => TRUE,
        'type_locked' => TRUE,
      ],
      'node_grants' => [
        'property_path' => 'search_api_node_grants',
        'type' => 'string',
        'indexed_locked' => TRUE,
        'type_locked' => TRUE,
        'hidden' => TRUE,
      ],
    ];
    $index_fields = $index
      ->getFields();
    foreach ($content_access_fields as $field_id => $settings) {
      $this
        ->assertTrue(!empty($index_fields[$field_id]), "Field {$field_id} (required by \"Content access\" processor) is present.");
      $field_settings = $index_fields[$field_id]
        ->getSettings();
      unset($field_settings['label'], $field_settings['dependencies']);
      $this
        ->assertEquals($settings, $field_settings, "Field {$field_id} has the correct settings.");
    }
  }

  /**
   * Tests the UI for the "Type-specific boosting" processor.
   */
  public function checkEntityBundleBoostIntegration() {
    $configuration = [
      'boosts' => [
        'entity:node' => [
          'datasource_boost' => 3.0,
          'bundle_boosts' => [
            'article' => 5.0,
          ],
        ],
        'entity:user' => [
          'datasource_boost' => 1.0,
        ],
      ],
    ];
    $form_values = [
      'boosts' => [
        'entity:node' => [
          'datasource_boost' => Utility::formatBoostFactor(3),
          'bundle_boosts' => [
            'article' => Utility::formatBoostFactor(5),
          ],
        ],
        'entity:user' => [
          'datasource_boost' => Utility::formatBoostFactor(1),
        ],
      ],
    ];
    $form_values['boosts']['entity:node']['bundle_boosts']['page'] = '';
    $this
      ->editSettingsForm($configuration, 'type_boost', $form_values);
  }

  /**
   * Tests the UI for the "Highlight" processor.
   */
  public function checkHighlightIntegration() {
    $configuration = [
      'highlight' => 'never',
      'excerpt' => FALSE,
      'excerpt_length' => 128,
      'prefix' => '<em>',
      'suffix' => '</em>',
    ];
    $this
      ->editSettingsForm($configuration, 'highlight');
  }

  /**
   * Tests the UI for the "HTML filter" processor.
   */
  public function checkHtmlFilterIntegration() {
    $configuration = [
      'tags' => <<<TAGS
h1: 4
foo bar
TAGS
,
    ];
    $this
      ->checkValidationError($configuration, 'html_filter', 'Tags is not a valid YAML map.');
    $configuration = [
      'tags' => <<<TAGS
h1:
  - 1
  - 2
h2: foo
h3: -1
TAGS
,
    ];
    $errors = [
      new FormattableMarkup("Boost value for tag @tag can't be an array.", [
        '@tag' => '<h1>',
      ]),
      new FormattableMarkup('Boost value for tag @tag must be numeric.', [
        '@tag' => '<h2>',
      ]),
      new FormattableMarkup('Boost value for tag @tag must be non-negative.', [
        '@tag' => '<h3>',
      ]),
    ];
    $this
      ->checkValidationError($configuration, 'html_filter', $errors);
    $configuration = $form_values = [
      'all_fields' => TRUE,
      'title' => FALSE,
      'alt' => FALSE,
      'tags' => [
        'h1' => 10,
      ],
    ];
    $form_values['tags'] = 'h1: 10';
    $this
      ->editSettingsForm($configuration, 'html_filter', $form_values);
  }

  /**
   * Tests the UI for the "Ignore case" processor.
   */
  public function checkIgnoreCaseIntegration() {
    $this
      ->editSettingsForm([
      'all_fields' => TRUE,
    ], 'ignorecase');
  }

  /**
   * Tests the UI for the "Ignore characters" processor.
   */
  public function checkIgnoreCharactersIntegration() {
    $configuration = [
      'ignorable' => ':)',
    ];
    $this
      ->checkValidationError($configuration, 'ignore_character', 'The entered text is no valid regular expression.');
    $configuration = $form_values = [
      'all_fields' => TRUE,
      'ignorable' => '[¿¡!?,.]',
    ];
    $form_values['strip']['character_sets'] = [
      'Pc' => 'Pc',
      'Pd' => 'Pd',
      'Pe' => 'Pe',
      'Pf' => 'Pf',
      'Pi' => 'Pi',
      'Po' => 'Po',
      'Ps' => 'Ps',
      'Cc' => 'Cc',
      'Cf' => FALSE,
      'Co' => FALSE,
      'Mc' => FALSE,
      'Me' => FALSE,
      'Mn' => FALSE,
      'Sc' => FALSE,
      'Sk' => FALSE,
      'Sm' => FALSE,
      'So' => FALSE,
      'Zl' => FALSE,
      'Zp' => FALSE,
      'Zs' => FALSE,
    ];
    $configuration['ignorable_classes'] = array_filter($form_values['strip']['character_sets']);
    sort($configuration['ignorable_classes']);
    $this
      ->editSettingsForm($configuration, 'ignore_character', $form_values);
  }

  /**
   * Tests the UI for the "Entity status" processor.
   */
  public function checkEntityStatusIntegration() {
    $this
      ->enableProcessor('entity_status');
  }

  /**
   * Tests the "No UI" test processor.
   */
  public function checkNoUiIntegration() {
    $this
      ->loadProcessorsTab();
    $this
      ->assertSession()
      ->pageTextNotContains('No UI processor');

    // Ensure that the processor can still be enabled programmatically – and
    // stays enabled when submitting the processors form.
    $index = $this
      ->loadIndex();
    $processor = \Drupal::getContainer()
      ->get('search_api.plugin_helper')
      ->createProcessorPlugin($index, 'search_api_test_no_ui');
    $index
      ->addProcessor($processor)
      ->save();
  }

  /**
   * Tests the UI for the "Role filter" processor.
   */
  public function checkRoleFilterIntegration() {
    $this
      ->enableProcessor('role_filter');
    $configuration = [
      'default' => 1,
      'roles' => [
        'anonymous',
      ],
    ];
    $this
      ->editSettingsForm($configuration, 'role_filter');
  }

  /**
   * Tests the integration of the "Rendered item" processor.
   */
  public function checkRenderedItemIntegration() {
    $index = $this
      ->loadIndex();
    $index
      ->removeProcessor('rendered_item');
    $index
      ->save();
    $this
      ->assertTrue($this
      ->loadIndex()
      ->isValidProcessor('rendered_item'), 'The "Rendered item" processor cannot be disabled.');
    $options['query']['datasource'] = '';
    $this
      ->drupalGet($this
      ->getIndexPath('fields/add/nojs'), $options);

    // See \Drupal\search_api\Tests\IntegrationTest::addField().
    $this
      ->assertSession()
      ->responseContains('name="rendered_item"');
    $this
      ->submitForm([], 'rendered_item');
    $args['%label'] = 'Rendered HTML output';
    $this
      ->assertSession()
      ->responseContains(new FormattableMarkup('Field %label was added to the index.', $args));
    $this
      ->assertSession()
      ->addressEquals($this
      ->getIndexPath('fields/edit/rendered_item'));
    $edit = [
      'roles[]' => [
        'authenticated',
      ],
      'view_mode[entity:node][article]' => 'default',
      'view_mode[entity:node][page]' => 'teaser',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->addressEquals($this
      ->getIndexPath('fields'));
    $this
      ->assertSession()
      ->responseContains('The field configuration was successfully saved.');
  }

  /**
   * Tests the UI for the "Stopwords" processor.
   */
  public function checkStopWordsIntegration() {
    $configuration = [
      'all_fields' => TRUE,
      'stopwords' => [
        'the',
      ],
    ];
    $form_values = [
      'all_fields' => TRUE,
      'stopwords' => 'the',
    ];
    $this
      ->editSettingsForm($configuration, 'stopwords', $form_values);
  }

  /**
   * Tests the UI for the "Tokenizer" processor.
   */
  public function checkTokenizerIntegration() {
    $configuration = [
      'spaces' => '[:foobar:]',
    ];
    $this
      ->checkValidationError($configuration, 'tokenizer', 'The entered text is no valid PCRE character class.');
    $configuration = [
      'all_fields' => TRUE,
      'spaces' => '',
      'overlap_cjk' => FALSE,
      'minimum_word_size' => 2,
    ];
    $this
      ->editSettingsForm($configuration, 'tokenizer');
  }

  /**
   * Tests the UI for the "Transliteration" processor.
   */
  public function checkTransliterationIntegration() {
    $this
      ->editSettingsForm([
      'all_fields' => TRUE,
    ], 'transliteration');
  }

  /**
   * Tests the hierarchy processor.
   */
  protected function checkAddHierarchyIntegration() {
    $configuration = [
      'fields' => [
        'term_field' => 'taxonomy_term-parent',
        'parent_reference' => 'node-parent_reference',
      ],
    ];
    $edit = [
      'fields' => [
        'term_field' => [
          'status' => 1,
        ],
        'parent_reference' => [
          'status' => 1,
        ],
      ],
    ];
    $this
      ->editSettingsForm($configuration, 'hierarchy', $edit, TRUE, FALSE);
  }

  /**
   * Tests the UI for the "Stemmer" processor.
   */
  public function checkStemmerIntegration() {
    $this
      ->enableProcessor('stemmer');
    $configuration = [
      'all_fields' => TRUE,
      'exceptions' => [
        'indian' => 'india',
      ],
    ];
    $form_values = [
      'all_fields' => TRUE,
      'exceptions' => 'indian=india',
    ];
    $this
      ->editSettingsForm($configuration, 'stemmer', $form_values);
  }

  /**
   * Tests the UI for the "Number field-based boosting" processor.
   */
  public function checkNumberFieldBoostIntegration() {
    $this
      ->enableProcessor('number_field_boost');
    $configuration = [
      'boosts' => [
        'term_field' => [
          'boost_factor' => 8.0,
          'aggregation' => 'avg',
        ],
      ],
    ];
    $form_values = [
      'boosts' => [
        'term_field' => [
          'boost_factor' => Utility::formatBoostFactor(8),
          'aggregation' => 'avg',
        ],
        'parent_reference' => [
          'boost_factor' => Utility::formatBoostFactor(0),
          'aggregation' => 'sum',
        ],
      ],
    ];
    unset($configuration['boosts']['parent_reference']);
    $this
      ->editSettingsForm($configuration, 'number_field_boost', $form_values);
  }

  /**
   * Tests the integration of the "URL field" processor.
   */
  public function checkUrlFieldIntegration() {
    $index = $this
      ->loadIndex();
    $index
      ->removeProcessor('add_url');
    $index
      ->save();
    $this
      ->assertTrue($this
      ->loadIndex()
      ->isValidProcessor('add_url'), 'The "Add URL" processor cannot be disabled.');
  }

  /**
   * Tests that a processor can be enabled.
   *
   * @param string $processor_id
   *   The ID of the processor to enable.
   */
  protected function enableProcessor($processor_id) {
    $this
      ->loadProcessorsTab();
    $edit = [
      "status[{$processor_id}]" => 1,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertTrue($this
      ->loadIndex()
      ->isValidProcessor($processor_id), "Successfully enabled the '{$processor_id}' processor.'");
  }

  /**
   * Enables a processor with a given configuration.
   *
   * @param array $configuration
   *   The configuration to set for the processor.
   * @param string $processor_id
   *   The ID of the processor to edit.
   * @param array|null $form_values
   *   (optional) The processor configuration to set, as it appears in the form.
   *   Only relevant if the processor does some processing on the form values
   *   before storing them, like parsing YAML or cleaning up checkboxes values.
   *   Defaults to using $configuration as-is.
   * @param bool $enable
   *   (optional) If TRUE, explicitly enable the processor. If FALSE, it should
   *   already be enabled.
   * @param bool $unset_fields
   *   (optional) If TRUE, the "fields" property will be removed from the
   *   actual configuration prior to comparing with the given configuration.
   */
  protected function editSettingsForm(array $configuration, $processor_id, array $form_values = NULL, $enable = TRUE, $unset_fields = TRUE) {
    $this
      ->loadProcessorsTab();
    $edit = $this
      ->getFormValues($form_values ?? $configuration, "processors[{$processor_id}][settings]");
    if ($enable) {
      $edit["status[{$processor_id}]"] = 1;
    }
    $this
      ->submitForm($edit, 'Save');
    $processor = $this
      ->loadIndex()
      ->getProcessor($processor_id);
    $this
      ->assertInstanceOf(ProcessorInterface::class, $processor, "Successfully enabled the '{$processor_id}' processor.'");
    if ($processor) {
      $actual_configuration = $processor
        ->getConfiguration();
      unset($actual_configuration['weights']);
      if ($unset_fields) {
        unset($actual_configuration['fields']);
      }
      $configuration += $processor
        ->defaultConfiguration();
      $this
        ->assertEquals($configuration, $actual_configuration, "Processor configuration for processor '{$processor_id}' was set correctly.");
    }
  }

  /**
   * Makes sure that the given form values will fail when submitted.
   *
   * @param array $form_values
   *   The form values, relative to the processor form.
   * @param string $processor_id
   *   The processor's ID.
   * @param string[]|string $messages
   *   Either the expected error message or an array of expected error messages.
   */
  protected function checkValidationError(array $form_values, $processor_id, $messages) {
    $this
      ->loadProcessorsTab();
    $edit = $this
      ->getFormValues($form_values, "processors[{$processor_id}][settings]");
    $edit["status[{$processor_id}]"] = 1;
    $this
      ->submitForm($edit, 'Save');
    if (!is_array($messages)) {
      $messages = [
        $messages,
      ];
    }
    foreach ($messages as $message) {
      $this
        ->assertSession()
        ->responseContains($message);
    }
    $this
      ->assertSession()
      ->pageTextNotContains('The indexing workflow was successfully edited.');
    $this
      ->assertSession()
      ->pageTextNotContains('No values were changed.');
    $this
      ->loadProcessorsTab(TRUE);
  }

  /**
   * Converts a configuration array into an array of form values.
   *
   * @param array $configuration
   *   The configuration to convert.
   * @param string $prefix
   *   The common prefix for all form values.
   *
   * @return string[]
   *   An array of form values ready for submission.
   */
  protected function getFormValues(array $configuration, $prefix) {
    $edit = [];
    foreach ($configuration as $key => $value) {
      $key = $prefix . "[{$key}]";
      if (is_array($value)) {

        // Handling of numerically indexed and associative arrays needs to be
        // different.
        if ($value == array_values($value)) {
          $key .= '[]';
          $edit[$key] = $value;
        }
        else {
          $edit += $this
            ->getFormValues($value, $key);
        }
      }
      else {
        $edit[$key] = $value;
      }
    }
    return $edit;
  }

  /**
   * Loads the test index's "Processors" tab in the test browser, if necessary.
   *
   * @param bool $force
   *   (optional) If TRUE, even load the tab if we are already on it.
   */
  protected function loadProcessorsTab($force = FALSE) {
    $settings_path = 'admin/config/search/search-api/index/' . $this->indexId . '/processors';
    if ($force || $this
      ->getAbsoluteUrl($settings_path) != $this
      ->getUrl()) {
      $this
        ->drupalGet($settings_path);
    }
  }

  /**
   * Loads the search index used by this test.
   *
   * @return \Drupal\search_api\IndexInterface
   *   The search index used by this test.
   */
  protected function loadIndex() {
    $index_storage = \Drupal::entityTypeManager()
      ->getStorage('search_api_index');
    $index_storage
      ->resetCache([
      $this->indexId,
    ]);
    return $index_storage
      ->load($this->indexId);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.	1
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.	1
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.	1
AssertLegacyTrait::assertResponse	protected	function	Asserts the page responds with the specified response code.	1
AssertLegacyTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.	1
AssertLegacyTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent	protected	function	Gets the current raw content.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::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
EntityReferenceTestTrait::createEntityReferenceField	protected	function	Creates a field of an entity reference field storage on the specified bundle.
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::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.
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.
PluginTestTrait::getCalledMethods	protected	function	Retrieves the methods called on a given plugin.
PluginTestTrait::getMethodArguments	protected	function	Retrieves the arguments of a certain method called on the given plugin.
PluginTestTrait::setError	protected	function	Sets an exception to be thrown on calls to the given method.
PluginTestTrait::setMethodOverride	protected	function	Overrides a method for a certain plugin.
PluginTestTrait::setReturnValue	protected	function	Sets the return value for a certain method on a test plugin.
ProcessorIntegrationTest::$modules	public static	property	Modules to enable for this test. Overrides SearchApiBrowserTestBase::$modules
ProcessorIntegrationTest::checkAddHierarchyIntegration	protected	function	Tests the hierarchy processor.
ProcessorIntegrationTest::checkAggregatedFieldsIntegration	public	function	Tests the integration of the "Aggregated fields" processor.
ProcessorIntegrationTest::checkContentAccessIntegration	public	function	Tests the UI for the "Content access" processor.
ProcessorIntegrationTest::checkEntityBundleBoostIntegration	public	function	Tests the UI for the "Type-specific boosting" processor.
ProcessorIntegrationTest::checkEntityStatusIntegration	public	function	Tests the UI for the "Entity status" processor.
ProcessorIntegrationTest::checkHighlightIntegration	public	function	Tests the UI for the "Highlight" processor.
ProcessorIntegrationTest::checkHtmlFilterIntegration	public	function	Tests the UI for the "HTML filter" processor.
ProcessorIntegrationTest::checkIgnoreCaseIntegration	public	function	Tests the UI for the "Ignore case" processor.
ProcessorIntegrationTest::checkIgnoreCharactersIntegration	public	function	Tests the UI for the "Ignore characters" processor.
ProcessorIntegrationTest::checkLanguageWithFallbackIntegration	protected	function	Tests the integration of the "Language (with fallback)" processor.
ProcessorIntegrationTest::checkNoUiIntegration	public	function	Tests the "No UI" test processor.
ProcessorIntegrationTest::checkNumberFieldBoostIntegration	public	function	Tests the UI for the "Number field-based boosting" processor.
ProcessorIntegrationTest::checkRenderedItemIntegration	public	function	Tests the integration of the "Rendered item" processor.
ProcessorIntegrationTest::checkRoleFilterIntegration	public	function	Tests the UI for the "Role filter" processor.
ProcessorIntegrationTest::checkStemmerIntegration	public	function	Tests the UI for the "Stemmer" processor.
ProcessorIntegrationTest::checkStopWordsIntegration	public	function	Tests the UI for the "Stopwords" processor.
ProcessorIntegrationTest::checkTokenizerIntegration	public	function	Tests the UI for the "Tokenizer" processor.
ProcessorIntegrationTest::checkTransliterationIntegration	public	function	Tests the UI for the "Transliteration" processor.
ProcessorIntegrationTest::checkUrlFieldIntegration	public	function	Tests the integration of the "URL field" processor.
ProcessorIntegrationTest::checkValidationError	protected	function	Makes sure that the given form values will fail when submitted.
ProcessorIntegrationTest::editSettingsForm	protected	function	Enables a processor with a given configuration.
ProcessorIntegrationTest::enableProcessor	protected	function	Tests that a processor can be enabled.
ProcessorIntegrationTest::getFormValues	protected	function	Converts a configuration array into an array of form values.
ProcessorIntegrationTest::loadIndex	protected	function	Loads the search index used by this test.
ProcessorIntegrationTest::loadProcessorsTab	protected	function	Loads the test index's "Processors" tab in the test browser, if necessary.
ProcessorIntegrationTest::setUp	public	function	Overrides SearchApiBrowserTestBase::setUp
ProcessorIntegrationTest::testLimitProcessors	public	function	Tests that processors discouraged by the backend are correctly hidden.
ProcessorIntegrationTest::testProcessorIntegration	public	function	Tests the admin UI for processors.
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
SearchApiBrowserTestBase::$additionalBundles	protected static	property	Set this to TRUE to include "item" and "article" bundles for test entities.	2
SearchApiBrowserTestBase::$adminUser	protected	property	An admin user used for this test.
SearchApiBrowserTestBase::$adminUserPermissions	protected	property	The permissions of the admin user.
SearchApiBrowserTestBase::$anonymousUser	protected	property	The anonymous user used for this test.
SearchApiBrowserTestBase::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
SearchApiBrowserTestBase::$indexId	protected	property	The ID of the search index used for this test.
SearchApiBrowserTestBase::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited. Overrides UiHelperTrait::$maximumMetaRefreshCount
SearchApiBrowserTestBase::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet(). Overrides UiHelperTrait::$metaRefreshCount
SearchApiBrowserTestBase::$unauthorizedUser	protected	property	A user without Search API admin permission.
SearchApiBrowserTestBase::$urlGenerator	protected	property	The URL generator.
SearchApiBrowserTestBase::executeTasks	protected	function	Executes all pending Search API tasks.
SearchApiBrowserTestBase::getIndexPath	protected	function	Returns the system path for the test index.
SearchApiBrowserTestBase::getTestIndex	public	function	Creates or loads an index.
SearchApiBrowserTestBase::getTestServer	public	function	Creates or loads a server.
SearchApiBrowserTestBase::initConfig	protected	function	Initialize various configurations post-installation. Overrides FunctionalTestSetupTrait::initConfig
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::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.

You are here

class ProcessorIntegrationTest in Search API 8

Hierarchy

File

Namespace

Members

API Navigation