You are here

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

class SavedSearchCrudTest in Search API Saved Searches 8

Tests CRUD functionality for saved searches.

@group search_api_saved_searches @coversDefaultClass \Drupal\search_api_saved_searches\Entity\SavedSearch

Hierarchy

Expanded class hierarchy of SavedSearchCrudTest

File

tests/src/Kernel/SavedSearchCrudTest.php, line 20

Namespace

Drupal\Tests\search_api_saved_searches\Kernel
View source 
class SavedSearchCrudTest extends KernelTestBase {
  use UserCreationTrait;

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

  /**
   * A mock "new results check" service.
   *
   * @var \PHPUnit\Framework\MockObject\MockObject|\Drupal\search_api_saved_searches\Service\NewResultsCheck
   */
  protected $newResultsCheck;

  /**
   * Log of method calls to the "new results check" service.
   *
   * @var object
   */
  protected $newResultsCheckMethodCalls;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('search_api_saved_search');
    $this
      ->installEntitySchema('search_api_task');
    $this
      ->installConfig('search_api_saved_searches');
    $this
      ->installSchema('system', [
      'key_value_expire',
      'sequences',
    ]);
    $this
      ->installSchema('search_api_saved_searches', 'search_api_saved_searches_old_results');
    $this->newResultsCheck = $this
      ->createMock(NewResultsCheck::class);

    // Using an object instead of an array gives us automatic pass-by-reference.
    $method_log = (object) [];
    $this->newResultsCheck
      ->method('getNewResults')
      ->willReturnCallback(function (SavedSearchInterface $search) use ($method_log) {
      $method_log->getNewResults[] = [
        $search
          ->id(),
      ];
    });
    $this->newResultsCheck
      ->method('saveKnownResults')
      ->willReturnCallback(function (SavedSearchInterface $search) use ($method_log) {
      $method_log->saveKnownResults[] = [
        $search
          ->id(),
      ];
    });
    $this->newResultsCheckMethodCalls = $method_log;
    $this->container
      ->set('search_api_saved_searches.new_results_check', $this->newResultsCheck);
  }

  /**
   * Tests creation of a new saved search.
   *
   * @param string|null $set_label
   *   The label to set when creating the saved search.
   * @param string|array|null $keys
   *   The fulltext keywords to set on the query.
   * @param string $expected_label
   *   The expected label set on the created saved search.
   *
   * @covers ::preCreate
   * @covers ::postCreate
   *
   * @dataProvider postCreateDataProvider
   */
  public function testPostCreate($set_label, $keys, $expected_label) {
    $query = Index::create()
      ->query();
    $query
      ->keys($keys);
    $values = [
      'type' => 'default',
      'query' => $query,
    ];
    if ($set_label !== NULL) {
      $values['label'] = $set_label;
    }
    $search = SavedSearch::create($values);
    $this
      ->assertEquals($expected_label, $search
      ->label());
  }

  /**
   * Provides data for testPostCreate().
   *
   * @return array
   *   Arrays of call arguments for testPostCreate().
   *
   * @see \Drupal\Tests\search_api_saved_searches\Kernel\SavedSearchCrudTest::testPostCreate()
   */
  public function postCreateDataProvider() {
    return [
      'existing label' => [
        'Foobar',
        'lorem',
        'Foobar',
      ],
      'with keys' => [
        NULL,
        'lorem',
        'lorem',
      ],
      'without keys' => [
        NULL,
        NULL,
        'Saved search',
      ],
      'with complex keys' => [
        NULL,
        [
          '#conjunction' => 'AND',
          'foo',
          'bar',
        ],
        'Saved search',
      ],
    ];
  }

  /**
   * Tests the pre-save hook for new saved searches.
   *
   * @param int $notify_interval
   *   The notification interval to set.
   * @param int $last_executed
   *   The "Last executed" timestamp to set.
   * @param string|null $index_id
   *   The index ID to set.
   * @param int|null $expected_next_execution
   *   The expected "next_execution" field value for the saved search.
   * @param string $expected_index_id
   *   The expected "index_id" field value for the saved search.
   *
   * @covers ::preCreate
   * @covers ::preSave
   *
   * @dataProvider preSaveDataProvider
   */
  public function testPreSave($notify_interval, $last_executed, $index_id, $expected_next_execution, $expected_index_id) {
    $query = Index::create([
      'id' => 'test',
    ])
      ->query();
    $values = [
      'type' => 'default',
      'query' => $query,
      'notify_interval' => $notify_interval,
      'last_executed' => $last_executed,
    ];
    if ($index_id !== NULL) {
      $values['index_id'] = $index_id;
    }
    $search = SavedSearch::create($values);
    $search
      ->save();
    $this
      ->assertNotNull($search
      ->id());
    $this
      ->assertEquals($expected_next_execution, $search
      ->get('next_execution')->value);
    $this
      ->assertEquals($expected_index_id, $search
      ->get('index_id')->value);
    $search = SavedSearch::load($search
      ->id());
    $this
      ->assertEquals($expected_next_execution, $search
      ->get('next_execution')->value);
    $this
      ->assertEquals($expected_index_id, $search
      ->get('index_id')->value);

    // Test that saving again leads to expected results.
    $last_executed += 10;
    if ($expected_next_execution !== NULL) {
      $expected_next_execution += 10;
    }
    $search
      ->set('last_executed', $last_executed);
    $search
      ->save();
    $this
      ->assertEquals($expected_next_execution, $search
      ->get('next_execution')->value);
  }

  /**
   * Provides data for testPreSave().
   *
   * @return array
   *   Arrays of call arguments for testPreSave().
   *
   * @see \Drupal\Tests\search_api_saved_searches\Kernel\SavedSearchCrudTest::testPreSave()
   */
  public function preSaveDataProvider() {
    return [
      'with notifications, index_id set' => [
        10,
        1234567890,
        'foobar',
        1234567890 + 10,
        'foobar',
      ],
      'with instant notifications' => [
        0,
        1234567890,
        'foobar',
        1234567890,
        'foobar',
      ],
      'without notifications, index_id not set' => [
        -1,
        1234567890,
        NULL,
        NULL,
        'test',
      ],
    ];
  }

  /**
   * Tests the post-save hook for new saved searches.
   *
   * @param bool $set_date_field
   *   Whether to set a date field to use for the saved search.
   * @param bool $set_query
   *   Whether to set a query on the saved search.
   * @param bool $expect_check
   *   Whether a call to
   *   \Drupal\search_api_saved_searches\NewResultsCheck::getNewResults() is
   *   expected.
   *
   * @covers ::preCreate
   * @covers ::postSave
   *
   * @dataProvider postSaveDataProvider
   */
  public function testPostSave($set_date_field, $set_query, $expect_check) {
    $index_id = 'test';
    if ($set_date_field) {
      $options['date_field'][$index_id] = 'created';
      SavedSearchType::load('default')
        ->set('options', $options)
        ->save();
    }
    $values = [
      'type' => 'default',
    ];
    if ($set_query) {
      $query = Index::create([
        'id' => $index_id,
      ])
        ->query();
      $values['query'] = $query;
    }
    $search = SavedSearch::create($values);
    $search
      ->save();
    $method_log = $this->newResultsCheckMethodCalls;
    if ($expect_check) {
      $this
        ->assertEquals([
        [
          $search
            ->id(),
        ],
      ], $method_log->saveKnownResults);
      $this
        ->assertObjectNotHasAttribute('getNewResults', $method_log);
    }
    else {
      $this
        ->assertObjectNotHasAttribute('saveKnownResults', $method_log);
      $this
        ->assertObjectNotHasAttribute('getNewResults', $method_log);
    }

    // Re-saving should never trigger a "new results" check.
    unset($method_log->getNewResults);
    $search
      ->save();
    $this
      ->assertObjectNotHasAttribute('getNewResults', $method_log);
  }

  /**
   * Provides data for testPostSave().
   *
   * @return array
   *   Arrays of call arguments for testPostSave().
   *
   * @see \Drupal\Tests\search_api_saved_searches\Kernel\SavedSearchCrudTest::testPostSave()
   */
  public function postSaveDataProvider() {
    return [
      'with date field' => [
        TRUE,
        TRUE,
        FALSE,
      ],
      'without query' => [
        FALSE,
        FALSE,
        FALSE,
      ],
      'expect check' => [
        FALSE,
        TRUE,
        TRUE,
      ],
    ];
  }

  /**
   * Tests the correct deletion of saved searches.
   *
   * @covers ::postDelete
   */
  public function testPostDelete() {
    $search = SavedSearch::create([
      'type' => 'default',
    ]);
    $search
      ->save();
    \Drupal::database()
      ->insert('search_api_saved_searches_old_results')
      ->fields([
      'search_id' => $search
        ->id(),
      'search_type' => 'default',
      'item_id' => '1',
    ])
      ->execute();

    // Verify that the result was inserted.
    $count = \Drupal::database()
      ->select('search_api_saved_searches_old_results', 't')
      ->countQuery()
      ->execute()
      ->fetchField();
    $this
      ->assertEquals(1, $count);
    $search
      ->delete();

    // Verify that the search can't be loaded anymore.
    $search = SavedSearch::load($search
      ->id());
    $this
      ->assertNull($search);

    // Verify that the saved result was deleted.
    $count = \Drupal::database()
      ->select('search_api_saved_searches_old_results', 't')
      ->countQuery()
      ->execute()
      ->fetchField();
    $this
      ->assertEquals(0, $count);
  }

  /**
   * Tests the correct reaction to the deletion of a search index.
   */
  public function testIndexDelete() {
    $index_id = 'test';
    $index = Index::create([
      'id' => $index_id,
    ]);

    // Act as if the index was already saved, to make things easier.
    $index
      ->enforceIsNew(FALSE);
    $search = SavedSearch::create([
      'type' => 'default',
      'index_id' => $index_id,
    ]);
    $search
      ->save();

    // Verify that the search can be loaded.
    $search = SavedSearch::load($search
      ->id());
    $this
      ->assertNotNull($search);
    $index
      ->delete();

    // Verify that the search was deleted.
    $search = SavedSearch::load($search
      ->id());
    $this
      ->assertNull($search);
  }

  /**
   * Tests whether the correct owner is set by default for a new saved search.
   */
  public function testDefaultOwner() {

    // Create the anonymous user. For that, we need the default roles.
    $anonymous = User::create([
      'uid' => 0,
      'name' => '',
    ]);
    $anonymous
      ->save();

    // Create a saved search as anonymous.
    $values = [
      'type' => 'default',
    ];
    $search = SavedSearch::create($values);
    $owner = $search
      ->getOwner();
    $this
      ->assertNotNull($owner);
    $this
      ->assertEquals(0, $owner
      ->id());
    $this
      ->assertEquals(0, $search
      ->getOwnerId());

    // Log in new user.
    $user = $this
      ->createUser();
    $uid = $user
      ->id();
    $this
      ->setCurrentUser($user);

    // Create a saved search as a registered user.
    $search = SavedSearch::create($values);
    $owner = $search
      ->getOwner();
    $this
      ->assertNotNull($owner);
    $this
      ->assertEquals($uid, $owner
      ->id());
    $this
      ->assertEquals($uid, $search
      ->getOwnerId());
  }

}

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.
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.
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.
SavedSearchCrudTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
SavedSearchCrudTest::$newResultsCheck protected property A mock "new results check" service.
SavedSearchCrudTest::$newResultsCheckMethodCalls protected property Log of method calls to the "new results check" service.
SavedSearchCrudTest::postCreateDataProvider public function Provides data for testPostCreate().
SavedSearchCrudTest::postSaveDataProvider public function Provides data for testPostSave().
SavedSearchCrudTest::preSaveDataProvider public function Provides data for testPreSave().
SavedSearchCrudTest::setUp protected function Overrides KernelTestBase::setUp
SavedSearchCrudTest::testDefaultOwner public function Tests whether the correct owner is set by default for a new saved search.
SavedSearchCrudTest::testIndexDelete public function Tests the correct reaction to the deletion of a search index.
SavedSearchCrudTest::testPostCreate public function Tests creation of a new saved search.
SavedSearchCrudTest::testPostDelete public function Tests the correct deletion of saved searches.
SavedSearchCrudTest::testPostSave public function Tests the post-save hook for new saved searches.
SavedSearchCrudTest::testPreSave public function Tests the pre-save hook for new saved searches.
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.
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.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
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.