You are here

Home » API reference » Search API Saved Searches 8 » NewResultsCheckTest.php

class NewResultsCheckTest in Search API Saved Searches 8

Tests the functionality of "new results" checks.

@group search_api_saved_searches

@coversDefaultClass \Drupal\search_api_saved_searches\Service\NewResultsCheck

Hierarchy

Expanded class hierarchy of NewResultsCheckTest

File

tests/src/Kernel/NewResultsCheckTest.php, line 21

Namespace

Drupal\Tests\search_api_saved_searches\Kernel
View source 
class NewResultsCheckTest extends KernelTestBase {
  use ExampleContentTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'entity_test',
    'options',
    'search_api',
    'search_api_db',
    'search_api_saved_searches',
    'search_api_test',
    'search_api_test_db',
    'system',
    'user',
  ];

  /**
   * The search index used for testing.
   *
   * @var \Drupal\search_api\IndexInterface
   */
  protected $index;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('search_api_task');
    $this
      ->installEntitySchema('search_api_saved_search');
    $this
      ->installEntitySchema('entity_test_mulrev_changed');
    $this
      ->installSchema('search_api', [
      'search_api_item',
    ]);
    $this
      ->installSchema('search_api_saved_searches', [
      'search_api_saved_searches_old_results',
    ]);
    $this
      ->installConfig([
      'search_api',
      'search_api_test_db',
      'search_api_saved_searches',
    ]);

    // Report all log messages as errors.
    $logger = new TestLogger('');
    $this->container
      ->set('logger.factory', $logger);
    $this->container
      ->set('logger.channel.search_api', $logger);
    $this->container
      ->set('logger.channel.search_api_saved_searches', $logger);

    // Add anonymous user for having a saved search owner.
    User::create([
      'uid' => 0,
      'name' => '',
    ])
      ->save();
    $this
      ->setUpExampleStructure();
    $this
      ->insertExampleContent();
    $this->index = Index::load('database_search_index');
    $this->index
      ->indexItems();
  }

  /**
   * Tests whether new results are correctly retrieved.
   *
   * @param string|null $date_field
   *   The date field which the saved search type should be configured to use.
   * @param int[]|null $expected_new_results
   *   (optional) The expected new results' entity IDs, or NULL if the check is
   *   expected to not return any new results.
   * @param array $type_options
   *   (optional) Further options to set on the saved search type.
   * @param int|null $expected_result_count
   *   (optional) The expected number of new results, if different from the
   *   count of $expected_new_results.
   *
   * @dataProvider getNewResultsDataProvider
   *
   * @covers ::getNewResults
   */
  public function testGetNewResults($date_field, array $expected_new_results = NULL, array $type_options = [], int $expected_result_count = NULL) {

    // Use a test time service to easily manipulate the "created" date.
    $time = new TestTimeService();
    $this->container
      ->set('datetime.time', $time);
    if ($date_field || $type_options) {
      $type = SavedSearchType::load('default');
      $options = $type_options + $type
        ->getOptions();
      if ($date_field) {
        $options['date_field']['database_search_index'] = $date_field;
      }
      $type
        ->set('options', $options);
      $type
        ->save();
    }
    $query = $this->index
      ->query()
      ->addCondition('type', 'article')
      ->sort('id', QueryInterface::SORT_ASC);

    // Execute query to simulate normal workflow (and test for regressions of
    // #2955617/#2955617).
    $results = $query
      ->execute();
    $this
      ->assertEquals(2, $results
      ->getResultCount());
    $this
      ->assertEquals($this
      ->getItemIds([
      4,
      5,
    ]), array_keys($results
      ->getResultItems()));

    // An item added between search execution and saving the search shouldn't
    // matter for the "Determine by result IDs" approach (since the query
    // shouldn't be re-executed).
    $this
      ->addTestEntity(6, [
      'name' => 'test 6',
      'type' => 'article',
    ]);
    $this->index
      ->indexItems();
    $search = SavedSearch::create([
      'type' => 'default',
      'query' => $query,
    ]);
    $search
      ->save();
    $time
      ->advanceTime(10);

    // Add some more test entities, one of them with the wrong type to be
    // matched (9) and one with an old "created" timestamp to confuse the "date
    // field" detection method (8).
    // @todo Remove explicit "created" values once #2809515 gets fixed.
    $this
      ->addTestEntity(7, [
      'name' => 'test 7',
      'type' => 'article',
      'created' => $time
        ->getRequestTime(),
    ]);
    $time
      ->advanceTime(10);
    $this
      ->addTestEntity(8, [
      'name' => 'test 8',
      'type' => 'article',
      'created' => $time
        ->getRequestTime() - 86400,
    ]);
    $time
      ->advanceTime(10);
    $this
      ->addTestEntity(9, [
      'name' => 'test 9',
      'type' => 'item',
      'created' => $time
        ->getRequestTime(),
    ]);
    $time
      ->advanceTime(10);
    $this
      ->addTestEntity(10, [
      'name' => 'test 10',
      'type' => 'article',
      'created' => $time
        ->getRequestTime(),
    ]);
    $this->index
      ->indexItems();
    $search = SavedSearch::load($search
      ->id());
    $results = $this->container
      ->get('search_api_saved_searches.new_results_check')
      ->getNewResults($search);
    if ($expected_new_results === NULL) {
      $this
        ->assertNull($results);
    }
    else {
      $this
        ->assertNotNull($results);
      $this
        ->assertEquals($expected_result_count ?? count($expected_new_results), $results
        ->getResultCount());
      $this
        ->assertEquals($this
        ->getItemIds($expected_new_results), array_keys($results
        ->getResultItems()));
    }
  }

  /**
   * Returns test datasets for testGetNewResults().
   *
   * @return array
   *   Array of argument arrays for testGetNewResults().
   */
  public function getNewResultsDataProvider() {
    return [
      'id method' => [
        NULL,
        [
          6,
          7,
          8,
          10,
        ],
      ],
      'date field method' => [
        'created',
        [
          7,
          10,
        ],
      ],
      'max_results' => [
        NULL,
        [
          6,
          7,
        ],
        [
          'max_results' => 2,
        ],
        4,
      ],
      'date field with max_results' => [
        'created',
        [
          7,
        ],
        [
          'max_results' => 1,
        ],
        2,
      ],
      'query_limit' => [
        NULL,
        NULL,
        [
          'query_limit' => 2,
        ],
      ],
      'date field with query_limit' => [
        'created',
        [
          7,
          10,
        ],
        [
          'query_limit' => 2,
        ],
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
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.
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.
NewResultsCheckTest::$index protected property The search index used for testing.
NewResultsCheckTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
NewResultsCheckTest::getNewResultsDataProvider public function Returns test datasets for testGetNewResults().
NewResultsCheckTest::setUp protected function Overrides KernelTestBase::setUp
NewResultsCheckTest::testGetNewResults public function Tests whether new results are correctly retrieved.
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.
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.