You are here

Home » API reference » Search API 8 » AddHierarchyTest.php

class AddHierarchyTest in Search API 8

Tests the "Hierarchy" processor.

@group search_api

@coversDefaultClass \Drupal\search_api\Plugin\search_api\processor\AddHierarchy

Hierarchy

Expanded class hierarchy of AddHierarchyTest

See also

\Drupal\search_api\Plugin\search_api\processor\AddHierarchy

File

tests/src/Kernel/Processor/AddHierarchyTest.php, line 23

Namespace

Drupal\Tests\search_api\Kernel\Processor
View source 
class AddHierarchyTest extends ProcessorTestBase {
  use NodeCreationTrait;
  use EntityReferenceTestTrait;
  use ResultsTrait;
  use TaxonomyTestTrait;

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

  /**
   * A hierarchy to test.
   *
   * @var string[][]
   */
  protected static $hierarchy = [
    'fruit' => [
      'apple',
      'pear',
    ],
    'vegetable' => [
      'radish',
      'turnip',
    ],
  ];

  /**
   * The nodes created for testing.
   *
   * @var \Drupal\node\NodeInterface[]
   */
  protected $nodes = [];

  /**
   * Hierarchical taxonomy terms.
   *
   * This is keyed by "type.item", for example: "fruit.pear".
   *
   * @var \Drupal\taxonomy\TermInterface[]
   */
  protected $terms = [];

  /**
   * Vocabulary to test with when using taxonomy for the hierarchy.
   *
   * @var \Drupal\taxonomy\Entity\Vocabulary
   */
  protected $vocabulary;

  /**
   * {@inheritdoc}
   */
  public function setUp($processor = NULL) {
    parent::setUp();
    $this
      ->installConfig([
      'filter',
    ]);
    $this
      ->installEntitySchema('taxonomy_term');
    $this
      ->createTaxonomyHierarchy();

    // Create a node type for testing.
    $type = NodeType::create([
      'type' => 'page',
      'name' => 'page',
    ]);
    $type
      ->save();

    // Add the taxonomy field to page type.
    $this
      ->createEntityReferenceField('node', 'page', 'term_field', NULL, 'taxonomy_term', 'default', [], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);

    // Add a generic entity reference field.
    $this
      ->createEntityReferenceField('node', 'page', 'parent_reference', NULL, 'node', 'default', []);

    // Index the taxonomy field.
    $term_field = new Field($this->index, 'term_field');
    $term_field
      ->setType('integer');
    $term_field
      ->setPropertyPath('term_field');
    $term_field
      ->setDatasourceId('entity:node');
    $term_field
      ->setLabel('Terms');
    $this->index
      ->addField($term_field);

    // Index the entity reference field.
    $reference_field = new Field($this->index, 'parent_reference');
    $reference_field
      ->setType('integer');
    $reference_field
      ->setPropertyPath('parent_reference');
    $reference_field
      ->setDatasourceId('entity:node');
    $reference_field
      ->setLabel('Parent page');
    $this->index
      ->addField($reference_field);

    // Add the "Index hierarchy" processor only now (not in parent method) since
    // it can only be enabled once there are actually hierarchical fields.
    $this->processor = \Drupal::getContainer()
      ->get('search_api.plugin_helper')
      ->createProcessorPlugin($this->index, 'hierarchy');
    $this->index
      ->addProcessor($this->processor);

    // Add the node datasource to the index.
    $datasources = \Drupal::getContainer()
      ->get('search_api.plugin_helper')
      ->createDatasourcePlugins($this->index, [
      'entity:node',
    ]);
    $this->index
      ->setDatasources($datasources);
    $this->index
      ->save();
    $this->container
      ->get('search_api.index_task_manager')
      ->addItemsAll($this->index);
    $index_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('search_api_index');
    $index_storage
      ->resetCache([
      $this->index
        ->id(),
    ]);
    $this->index = $index_storage
      ->load($this->index
      ->id());
  }

  /**
   * Helper function to create the hierarchy with taxonomy terms.
   */
  protected function createTaxonomyHierarchy() {
    $this->vocabulary = $this
      ->createVocabulary();
    foreach (static::$hierarchy as $type => $items) {

      // Add the 'type' item, and nest items underneath.
      $this->terms[$type] = $type_term = $this
        ->createTerm($this->vocabulary, [
        'name' => $type,
      ]);
      foreach ($items as $item) {
        $this->terms["{$type}.{$item}"] = $this
          ->createTerm($this->vocabulary, [
          'name' => $item,
          'parent' => $type_term,
        ]);
      }
    }
  }

  /**
   * Tests taxonomy-based hierarchy indexing.
   *
   * @covers ::preprocessIndexItems
   */
  public function testPreprocessIndexItemsTaxonomy() {

    // Add hierarchical terms to 3 nodes.
    foreach ([
      'vegetable.turnip',
      'vegetable',
      'fruit.pear',
    ] as $i => $term) {
      $this->nodes[$i] = $this
        ->createNode([
        'type' => 'page',
        'term_field' => [
          'target_id' => $this->terms[$term]
            ->id(),
        ],
      ]);
    }
    $this->index
      ->reindex();
    $this
      ->indexItems();

    // By default, hierarchy is not indexed, so a search for 'vegetable' should
    // only return node 2.
    $query = new Query($this->index);
    $query
      ->addCondition('term_field', $this->terms['vegetable']
      ->id());
    $result = $query
      ->execute();
    $expected = [
      'node' => [
        1,
      ],
    ];
    $this
      ->assertResults($result, $expected);

    // Enable hierarchical indexing.
    $processor = $this->index
      ->getProcessor('hierarchy');
    $processor
      ->setConfiguration([
      'fields' => [
        'term_field' => 'taxonomy_term-parent',
      ],
    ]);
    $this->index
      ->save();
    $this
      ->indexItems();

    // Query for "vegetable" should return 2 items:
    // Node 1 is "vegetable.turnip" and node 2 is just "vegetable".
    $query = new Query($this->index);
    $query
      ->addCondition('term_field', $this->terms['vegetable']
      ->id());
    $result = $query
      ->execute();
    $expected = [
      'node' => [
        0,
        1,
      ],
    ];
    $this
      ->assertResults($result, $expected);

    // A search for just turnips should return node 1 only.
    $query = new Query($this->index);
    $query
      ->addCondition('term_field', $this->terms['vegetable.turnip']
      ->id());
    $result = $query
      ->execute();
    $expected = [
      'node' => [
        0,
      ],
    ];
    $this
      ->assertResults($result, $expected);

    // Also add a term with multiple parents.
    $this->terms['avocado'] = $this
      ->createTerm($this->vocabulary, [
      'name' => 'Avocado',
      'parent' => [
        $this->terms['fruit']
          ->id(),
        $this->terms['vegetable']
          ->id(),
      ],
    ]);
    $this->nodes[3] = $this
      ->createNode([
      'type' => 'page',
      'term_field' => [
        'target_id' => $this->terms['avocado']
          ->id(),
      ],
    ]);
    $this->index
      ->reindex();
    $this
      ->indexItems();

    // Searching for 'fruit' or 'vegetable' should return this new node.
    $query = new Query($this->index);
    $query
      ->addCondition('term_field', $this->terms['fruit']
      ->id());
    $result = $query
      ->execute();
    $expected = [
      'node' => [
        2,
        3,
      ],
    ];
    $this
      ->assertResults($result, $expected);
    $query = new Query($this->index);
    $query
      ->addCondition('term_field', $this->terms['vegetable']
      ->id());
    $result = $query
      ->execute();
    $expected = [
      'node' => [
        0,
        1,
        3,
      ],
    ];
    $this
      ->assertResults($result, $expected);
  }

  /**
   * Tests adding values to Fulltext fields.
   *
   * @see https://www.drupal.org/node/3059312
   *
   * @covers ::preprocessIndexItems
   */
  public function testRegression3059312() {

    // Add hierarchical terms to 3 nodes.
    foreach ([
      'vegetable.turnip',
      'vegetable',
      'fruit.pear',
    ] as $i => $term) {
      $this->nodes[$i] = $this
        ->createNode([
        'type' => 'page',
        'term_field' => [
          'target_id' => $this->terms[$term]
            ->id(),
        ],
      ]);
    }

    // Also add a term with multiple parents.
    $this->terms['avocado'] = $this
      ->createTerm($this->vocabulary, [
      'name' => 'Avocado',
      'parent' => [
        $this->terms['fruit']
          ->id(),
        $this->terms['vegetable']
          ->id(),
      ],
    ]);
    $this->nodes[3] = $this
      ->createNode([
      'type' => 'page',
      'term_field' => [
        'target_id' => $this->terms['avocado']
          ->id(),
      ],
    ]);

    // Enable hierarchical indexing.
    $processor = $this->index
      ->getProcessor('hierarchy');
    $processor
      ->setConfiguration([
      'fields' => [
        'term_field' => 'taxonomy_term-parent',
      ],
    ]);

    // Set the field type to "Fulltext".
    $this->index
      ->getField('term_field')
      ->setType('text');
    $this->index
      ->save();
    $this
      ->indexItems();
    $query = new Query($this->index);
    $query
      ->addCondition('term_field', $this->terms['fruit']
      ->id());
    $result = $query
      ->execute();
    $expected = [
      'node' => [
        2,
        3,
      ],
    ];
    $this
      ->assertResults($result, $expected);
  }

  /**
   * Tests non-taxonomy-based hierarchy.
   *
   * @covers ::preprocessIndexItems
   * @covers ::addHierarchyValues
   */
  public function testPreprocessIndexItems() {

    // Setup the nodes to follow the hierarchy.
    foreach (static::$hierarchy as $type => $items) {
      $this->nodes[] = $type_node = $this
        ->createNode([
        'title' => $type,
      ]);
      foreach ($items as $item) {
        $this->nodes[] = $this
          ->createNode([
          'title' => $item,
          'parent_reference' => [
            'target_id' => $type_node
              ->id(),
          ],
        ]);
      }
    }

    // Add a third tier of hierarchy for specific types of radishes.
    foreach ([
      'Cherry Belle',
      'Snow Belle',
      'Daikon',
    ] as $item) {
      $this->nodes[] = $this
        ->createNode([
        'title' => $item,
        'parent_reference' => [
          'target_id' => $this->nodes[5]
            ->id(),
        ],
      ]);
    }
    $this->index
      ->reindex();
    $this
      ->indexItems();

    // Initially hierarchy is excluded, so "vegetable" should only return nodes
    // 5 and 6.
    $query = new Query($this->index);
    $query
      ->addCondition('parent_reference', $this->nodes[3]
      ->id());
    $result = $query
      ->execute();
    $expected = [
      'node' => [
        4,
        5,
      ],
    ];
    $this
      ->assertResults($result, $expected);

    // Enable hierarchical indexing.
    $processor = $this->index
      ->getProcessor('hierarchy');
    $processor
      ->setConfiguration([
      'fields' => [
        'parent_reference' => 'node-parent_reference',
      ],
    ]);
    $this->index
      ->save();
    $this
      ->indexItems();

    // A search for "vegetable" should now include the hierarchy.
    $query = new Query($this->index);
    $query
      ->addCondition('parent_reference', $this->nodes[3]
      ->id());
    $result = $query
      ->execute();
    $expected = [
      'node' => [
        4,
        5,
        6,
        7,
        8,
      ],
    ];
    $this
      ->assertResults($result, $expected);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddHierarchyTest::$hierarchy protected static property A hierarchy to test.
AddHierarchyTest::$modules public static property Modules to enable. Overrides ProcessorTestBase::$modules
AddHierarchyTest::$nodes protected property The nodes created for testing.
AddHierarchyTest::$terms protected property Hierarchical taxonomy terms.
AddHierarchyTest::$vocabulary protected property Vocabulary to test with when using taxonomy for the hierarchy.
AddHierarchyTest::createTaxonomyHierarchy protected function Helper function to create the hierarchy with taxonomy terms.
AddHierarchyTest::setUp public function Performs setup tasks before each individual test method is run. Overrides ProcessorTestBase::setUp
AddHierarchyTest::testPreprocessIndexItems public function Tests non-taxonomy-based hierarchy.
AddHierarchyTest::testPreprocessIndexItemsTaxonomy public function Tests taxonomy-based hierarchy indexing.
AddHierarchyTest::testRegression3059312 public function Tests adding values to Fulltext fields.
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
NodeCreationTrait::createNode protected function Creates a node based on default settings.
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
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.
ProcessorTestBase::$index protected property The search index used for this test.
ProcessorTestBase::$processor protected property The processor used for this test. 2
ProcessorTestBase::$server protected property The search server used for this test.
ProcessorTestBase::generateItem protected function Generates a single test item.
ProcessorTestBase::generateItems protected function Generates some test items.
ProcessorTestBase::indexItems protected function Indexes all (unindexed) items.
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.
ResultsTrait::assertResults protected function Asserts that the search results contain the expected IDs.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TaxonomyTestTrait::createTerm public function Returns a new term with random properties given a vocabulary.
TaxonomyTestTrait::createVocabulary public function Returns a new vocabulary with random properties.
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.