You are here

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

class UserCrudReactionTest in Search API Saved Searches 8

Verifies that the module reacts correctly to user CRUD operations.

@group search_api_saved_searches

Hierarchy

Expanded class hierarchy of UserCrudReactionTest

File

tests/src/Kernel/UserCrudReactionTest.php, line 16

Namespace

Drupal\Tests\search_api_saved_searches\Kernel
View source 
class UserCrudReactionTest extends KernelTestBase {

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

  /**
   * The test user used in these tests.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $testUser;

  /**
   * Saved searches created for testing.
   *
   * @var \Drupal\search_api_saved_searches\SavedSearchInterface[]
   */
  protected $savedSearches = [];

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

    // Add a test user that will become the owner of our saved searches.
    $this->testUser = User::create([
      'uid' => 5,
      'name' => 'test',
      'status' => TRUE,
      'mail' => 'test@example.com',
    ]);
    $this->testUser
      ->save();

    // Add a saved search for that user.
    $this->savedSearches[] = SavedSearch::create([
      'type' => 'default',
      'uid' => $this->testUser
        ->id(),
      'status' => TRUE,
      'notify_interval' => 3600 * 24,
      'mail' => $this->testUser
        ->getEmail(),
    ]);

    // Add some anonymously created saved searches.
    $this->savedSearches[] = SavedSearch::create([
      'type' => 'default',
      'uid' => 0,
      'status' => TRUE,
      'notify_interval' => 3600 * 24,
      'mail' => 'foo@example.com',
    ]);
    $this->savedSearches[] = SavedSearch::create([
      'type' => 'default',
      'uid' => 0,
      'status' => TRUE,
      'notify_interval' => 3600 * 24,
      'mail' => 'foo@example.com',
    ]);
    $this->savedSearches[] = SavedSearch::create([
      'type' => 'default',
      'uid' => 0,
      'status' => TRUE,
      'notify_interval' => 3600 * 24,
      'mail' => 'bar@example.com',
    ]);
    foreach ($this->savedSearches as $search) {
      $search
        ->save();
    }
  }

  /**
   * Verifies correct reaction to the creation of a new user.
   *
   * @see search_api_saved_searches_user_insert()
   */
  public function testUserInsert() {
    $account = User::create([
      'name' => 'foo',
      'status' => TRUE,
      'mail' => 'foo@example.com',
    ]);
    $account
      ->save();

    // Creating a new user claimed all anonymously created alerts with the same
    // e-mail address.
    $this
      ->reloadSavedSearches();
    $this
      ->assertEquals($account
      ->id(), $this->savedSearches[1]
      ->getOwnerId());
    $this
      ->assertEquals($account
      ->id(), $this->savedSearches[2]
      ->getOwnerId());
    $this
      ->assertEquals(0, $this->savedSearches[3]
      ->getOwnerId());
    User::create([
      'name' => 'bar',
      'status' => FALSE,
      'mail' => 'bar@example.com',
    ])
      ->save();

    // Creating an inactive user didn't affect any alerts.
    $this
      ->reloadSavedSearches();
    $this
      ->assertEquals($account
      ->id(), $this->savedSearches[1]
      ->getOwnerId());
    $this
      ->assertEquals($account
      ->id(), $this->savedSearches[2]
      ->getOwnerId());
    $this
      ->assertEquals(0, $this->savedSearches[3]
      ->getOwnerId());
  }

  /**
   * Verifies correct reaction to the activation of a user account.
   *
   * @see search_api_saved_searches_user_update()
   * @see _search_api_saved_searches_claim_anonymous_searches()
   */
  public function testUserActivate() {
    $account = User::create([
      'name' => 'foo',
      'status' => FALSE,
      'mail' => 'foo@example.com',
    ]);
    $account
      ->save();

    // Creating an inactive user didn't affect any alerts.
    $this
      ->reloadSavedSearches();
    $this
      ->assertEquals(0, $this->savedSearches[1]
      ->getOwnerId());
    $this
      ->assertEquals(0, $this->savedSearches[2]
      ->getOwnerId());
    $this
      ->assertEquals(0, $this->savedSearches[3]
      ->getOwnerId());
    $account
      ->activate()
      ->save();

    // Once activated, all anonymously created alerts with the same e-mail
    // address are moved to that user.
    $this
      ->reloadSavedSearches();
    $this
      ->assertEquals($account
      ->id(), $this->savedSearches[1]
      ->getOwnerId());
    $this
      ->assertEquals($account
      ->id(), $this->savedSearches[2]
      ->getOwnerId());
    $this
      ->assertEquals(0, $this->savedSearches[3]
      ->getOwnerId());
  }

  /**
   * Verifies correct reaction to the deactivation of a user account.
   *
   * @see search_api_saved_searches_user_update()
   * @see _search_api_saved_searches_deactivate_searches()
   */
  public function testUserDeactivate() {
    $this->testUser
      ->block()
      ->save();
    $this
      ->reloadSavedSearches();
    $search = array_shift($this->savedSearches);
    $this
      ->assertEquals(-1, $search
      ->get('notify_interval')->value);

    // Verify that the other alerts were unaffected.
    foreach ($this->savedSearches as $search) {
      $this
        ->assertEquals(3600 * 24, $search
        ->get('notify_interval')->value);
    }
  }

  /**
   * Verifies correct reaction to the deletion of a user account.
   *
   * @see search_api_saved_searches_user_delete()
   */
  public function testUserDelete() {
    $this->testUser
      ->delete();
    $this
      ->reloadSavedSearches();
    $search = array_shift($this->savedSearches);
    $this
      ->assertEmpty($search);

    // Verify that other alerts were unaffected.
    $this
      ->reloadSavedSearches();
    foreach ($this->savedSearches as $search) {
      $this
        ->assertNotEmpty($search);
    }
  }

  /**
   * Verifies correct reaction to the deletion of a search index.
   *
   * Since the underlying function called is the same as for user deletion (and
   * there are no other reactions to index CRUD events), this is tested as part
   * of this test case.
   *
   * @see search_api_saved_searches_search_api_index_delete()
   */
  public function testIndexDelete() {
    $this
      ->installConfig([
      'search_api',
    ]);
    $index = Index::create([
      'id' => 'test',
    ]);
    $index
      ->save();
    $this->savedSearches[0]
      ->set('index_id', 'test')
      ->save();
    $index
      ->delete();
    $this
      ->reloadSavedSearches();
    $this
      ->assertEmpty($this->savedSearches[0]);
    $this
      ->assertNotEmpty($this->savedSearches[1]);
  }

  /**
   * Verifies correct reaction to a user changing their mail address.
   *
   * Tested on behalf of the "E-Mail" notification plugin.
   *
   * @see search_api_saved_searches_user_update()
   * @see _search_api_saved_searches_adapt_mail()
   * @see \Drupal\search_api_saved_searches\Plugin\search_api_saved_searches\notification\Email
   */
  public function testUserMailChange() {

    // Add a second saved search type that doesn't use the "E-Mail" notification
    // plugin.
    SavedSearchType::create([
      'id' => 'non_default',
      'status' => TRUE,
      'label' => 'Non-default',
    ])
      ->save();

    // Add a saved search for the test user using a different mail address.
    $this->savedSearches[] = SavedSearch::create([
      'type' => 'default',
      'uid' => $this->testUser
        ->id(),
      'status' => TRUE,
      'notify_interval' => 3600 * 24,
      'mail' => 'foobar@example.com',
    ]);
    end($this->savedSearches)
      ->save();

    // Add a saved search with a different type.
    $this->savedSearches[] = SavedSearch::create([
      'type' => 'non_default',
      'uid' => $this->testUser
        ->id(),
      'status' => TRUE,
      'notify_interval' => 3600 * 24,
    ]);
    end($this->savedSearches)
      ->save();

    // Now change the user's e-mail address and see what happens.
    $this->testUser
      ->setEmail('test@example.net')
      ->save();
    $this
      ->reloadSavedSearches();
    $this
      ->assertEquals('test@example.net', $this->savedSearches[0]
      ->get('mail')->value);
    $this
      ->assertEquals('foobar@example.com', $this->savedSearches[4]
      ->get('mail')->value);
  }

  /**
   * Reloads the saved searches in $this->savedSearches.
   */
  protected function reloadSavedSearches() {
    foreach ($this->savedSearches as $i => $search) {
      $this->savedSearches[$i] = SavedSearch::load($search
        ->id());
    }
  }

}

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.
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.
UserCrudReactionTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
UserCrudReactionTest::$savedSearches protected property Saved searches created for testing.
UserCrudReactionTest::$testUser protected property The test user used in these tests.
UserCrudReactionTest::reloadSavedSearches protected function Reloads the saved searches in $this->savedSearches.
UserCrudReactionTest::setUp protected function Overrides KernelTestBase::setUp
UserCrudReactionTest::testIndexDelete public function Verifies correct reaction to the deletion of a search index.
UserCrudReactionTest::testUserActivate public function Verifies correct reaction to the activation of a user account.
UserCrudReactionTest::testUserDeactivate public function Verifies correct reaction to the deactivation of a user account.
UserCrudReactionTest::testUserDelete public function Verifies correct reaction to the deletion of a user account.
UserCrudReactionTest::testUserInsert public function Verifies correct reaction to the creation of a new user.
UserCrudReactionTest::testUserMailChange public function Verifies correct reaction to a user changing their mail address.