You are here

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

class EmailActivationTest in Search API Saved Searches 8

Tests whether activation mails are sent correctly.

@group search_api_saved_searches

Hierarchy

Expanded class hierarchy of EmailActivationTest

See also

\Drupal\search_api_saved_searches\Plugin\search_api_saved_searches\notification\Email

File

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

Namespace

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

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

  /**
   * The users used for this test.
   *
   * 0 is the anonymous user, 1 is an admin user, 2 is a normal registered user.
   *
   * @var \Drupal\user\Entity\User[]
   */
  protected $users = [];

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

    // Create user accounts.
    $this->users[0] = User::create([
      'uid' => 0,
      'name' => '',
    ]);
    $this->users[0]
      ->save();
    $this->users[1] = $this
      ->createUser([
      SavedSearchAccessControlHandler::ADMIN_PERMISSION,
    ]);
    $this->users[2] = $this
      ->createUser();

    // Use the state system collector mail backend.
    $this
      ->config('system.mail')
      ->set('interface.default', 'test_mail_collector')
      ->save();

    // Set some more site settings used in the test.
    $this
      ->config('system.site')
      ->set('name', 'Saved Searches Test')
      ->set('mail', 'admin@example.net')
      ->save();
    $this
      ->config('user.settings')
      ->set('anonymous', 'Chuck Norris')
      ->save();

    // Add proper activation mail title and body to the default saved search
    // type.
    $title = '[user:display-name], activate your saved search "[search-api-saved-search:label]" at [site:name]';
    $body = <<<END
[user:display-name],

A saved search on [site:name] with this e-mail address was created.
To activate this saved search, click the following link:

[search-api-saved-search:activate-url]
[foo:bar]

--  [site:name] team
END;
    $type = SavedSearchType::load('default');
    $type
      ->getNotificationPlugin('email')
      ->setConfiguration([
      'activate' => [
        'send' => TRUE,
        'title' => $title,
        'body' => $body,
      ],
    ]);
    $type
      ->save();

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

  /**
   * Tests whether activation mails are sent correctly.
   *
   * @param int $current_user
   *   The index in $this->users of the user to set as the current user.
   * @param int $owner
   *   The index in $this->users of the user to set as the owner of the created
   *   saved search.
   * @param string|null $mail_address
   *   The mail address to set for the saved search, or NULL to use the mail
   *   address of the owner.
   * @param bool $status
   *   The status to set for the saved search.
   * @param bool $expected_status
   *   The expected status of the saved search after saving.
   * @param bool $mail_expected
   *   Whether an activation mail is expected to be sent.
   *
   * @dataProvider activationMailDataProvider
   */
  public function testActivationMail($current_user, $owner, $mail_address, $status, $expected_status, $mail_expected) {
    $current_user = $this->users[$current_user];
    $owner = $this->users[$owner];
    $this
      ->setCurrentUser($current_user);
    if ($mail_address === NULL) {
      $mail_address = $owner
        ->getEmail();
    }
    $search = SavedSearch::create([
      'type' => 'default',
      'status' => $status,
      'uid' => $owner
        ->id(),
      'label' => 'Test search 1',
      'mail' => $mail_address,
    ]);
    $this
      ->assertEquals(SAVED_NEW, $search
      ->save());
    $this
      ->sendMails();
    $this
      ->assertEquals($expected_status, $search
      ->get('status')->value);
    $activation_url = $search
      ->toUrl('activate', [
      'absolute' => TRUE,
    ])
      ->toString();
    $this
      ->assertNotEmpty(preg_match('#/saved-search/(\\d+)/activate\\?token=([^&]+)$#', $activation_url, $match));
    $this
      ->assertEquals($search
      ->id(), $match[1]);
    $this
      ->assertEquals(urlencode($search
      ->getAccessToken('activate')), $match[2]);
    $captured_emails = \Drupal::state()
      ->get('system.test_mail_collector');
    if (!$mail_expected) {
      $this
        ->assertEmpty($captured_emails);
      return;
    }
    $this
      ->assertNotEmpty($captured_emails);
    $mail = end($captured_emails);
    $title = '[user:display-name], activate your saved search "[search-api-saved-search:label]" at [site:name]';
    $body = <<<END
[user:display-name],

A saved search on [site:name] with this e-mail address was created.
To activate this saved search, click the following link:

[search-api-saved-search:activate-url]
[foo:bar]

--  [site:name] team
END;
    $this
      ->assertEquals("Saved Searches Test <admin@example.net>", $mail['headers']['From'], 'Message is sent from the site email account.');
    $this
      ->assertEquals($mail_address, $mail['to'], 'Message sent to correct address.');
    $replacements = [
      '[user:display-name]' => $owner
        ->getDisplayName(),
      '[site:name]' => 'Saved Searches Test',
      '[search-api-saved-search:label]' => 'Test search 1',
      '[search-api-saved-search:activate-url]' => $activation_url,
      '[foo:bar]' => '',
    ];
    $title = strtr($title, $replacements);
    $body = strtr($body, $replacements);
    $this
      ->assertEquals($title, $mail['subject']);
    $this
      ->assertEquals($body, trim($mail['body']));
  }

  /**
   * Provides data for testActivationMail().
   *
   * @return array
   *   Arrays of call arguments for testActivationMail().
   *
   * @see \Drupal\Tests\search_api_saved_searches\Kernel\EmailActivationTest::testActivationMail()
   */
  public function activationMailDataProvider() {
    return [
      'already disabled' => [
        0,
        0,
        'foo@example.net',
        FALSE,
        FALSE,
        FALSE,
      ],
      'admin-created' => [
        1,
        0,
        'foo@example.net',
        TRUE,
        TRUE,
        FALSE,
      ],
      'own mail' => [
        2,
        2,
        NULL,
        TRUE,
        TRUE,
        FALSE,
      ],
      'other mail' => [
        2,
        2,
        'foo@example.net',
        TRUE,
        FALSE,
        TRUE,
      ],
      'anonymous user' => [
        0,
        0,
        'foo@example.net',
        TRUE,
        FALSE,
        TRUE,
      ],
    ];
  }

  /**
   * Tests that updating of saved searches is handled correctly.
   *
   * An email should only be triggered when the saved search is already active
   * and its e-mail address changes.
   */
  public function testSavedSearchUpdate() {
    $search = SavedSearch::create([
      'type' => 'default',
      'label' => 'Test search 1',
      'mail' => 'foo@example.net',
    ]);
    $this
      ->assertEquals(SAVED_NEW, $search
      ->save());
    $this
      ->sendMails();

    // Assert that the search was deactivated.
    $this
      ->assertFalse($search
      ->get('status')->value);

    // Assert an e-mail was sent but just save it here and empty the mail
    // storage.
    $captured_emails = \Drupal::state()
      ->get('system.test_mail_collector');
    $this
      ->assertNotEmpty($captured_emails);
    $first_mail = reset($captured_emails);
    \Drupal::state()
      ->delete('system.test_mail_collector');

    // Changing the mail address of the saved search at this point shouldn't
    // trigger another mail (since the saved search isn't active yet).
    $result = $search
      ->set('mail', 'bar@example.net')
      ->save();
    $this
      ->sendMails();
    $this
      ->assertEquals(SAVED_UPDATED, $result);
    $captured_emails = \Drupal::state()
      ->get('system.test_mail_collector');
    $this
      ->assertEmpty($captured_emails);
    $this
      ->assertFalse($search
      ->get('status')->value);

    // Activate the saved search.
    $controller = new SavedSearchController();
    $response = $controller
      ->activateSearch($search, $search
      ->getAccessToken('activate'));
    $this
      ->assertInstanceOf(RedirectResponse::class, $response);
    $this
      ->assertTrue($search
      ->get('status')->value);

    // Now that the saved search is active, the mail address can't be changed
    // without activating the saved search again. (Since the token stays the
    // same, this should produce exactly the same mail as the first time –
    // except for the recipient's mail address, of course.)
    $result = $search
      ->set('mail', 'test@example.net')
      ->save();
    $this
      ->sendMails();
    $this
      ->assertEquals(SAVED_UPDATED, $result);
    $captured_emails = \Drupal::state()
      ->get('system.test_mail_collector');
    $this
      ->assertNotEmpty($captured_emails);
    $first_mail['to'] = 'test@example.net';
    $this
      ->assertEquals($first_mail, reset($captured_emails));
    $this
      ->assertFalse($search
      ->get('status')->value);
  }

  /**
   * Tests that activation will be skipped if the "E-mail" plugin is disabled.
   */
  public function testEmailPluginDisabled() {
    $type = SavedSearchType::load('default');
    $type
      ->removeNotificationPlugin('email');
    $type
      ->save();

    // Save a new search.
    $search = SavedSearch::create([
      'type' => 'default',
      'label' => 'Test search 1',
    ]);
    $this
      ->assertEquals(SAVED_NEW, $search
      ->save());
    $this
      ->sendMails();

    // Saved search should be active, no mail should have been sent.
    $this
      ->assertTrue($search
      ->get('status')->value);
    $captured_emails = \Drupal::state()
      ->get('system.test_mail_collector');
    $this
      ->assertEmpty($captured_emails);
  }

  /**
   * Tests that activation will be skipped if the "Send" option is disabled.
   */
  public function testActivationEmailDisabled() {
    $type = SavedSearchType::load('default');
    $type
      ->getNotificationPlugin('email')
      ->setConfiguration([
      'activate' => [
        'send' => FALSE,
        'title' => 'Test',
        'body' => 'Test',
      ],
    ]);
    $type
      ->save();

    // Save a new search.
    $search = SavedSearch::create([
      'type' => 'default',
      'label' => 'Test search 1',
      'mail' => 'foo@example.net',
    ]);
    $this
      ->assertEquals(SAVED_NEW, $search
      ->save());
    $this
      ->sendMails();

    // Saved search should be active, no mail should have been sent.
    $this
      ->assertTrue($search
      ->get('status')->value);
    $captured_emails = \Drupal::state()
      ->get('system.test_mail_collector');
    $this
      ->assertEmpty($captured_emails);
  }

  /**
   * Sends all queued mails.
   */
  protected function sendMails() {
    $this->container
      ->get('search_api_saved_searches.email_queue')
      ->destruct();
  }

}

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.
EmailActivationTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
EmailActivationTest::$users protected property The users used for this test.
EmailActivationTest::activationMailDataProvider public function Provides data for testActivationMail().
EmailActivationTest::sendMails protected function Sends all queued mails.
EmailActivationTest::setUp protected function Overrides KernelTestBase::setUp
EmailActivationTest::testActivationEmailDisabled public function Tests that activation will be skipped if the "Send" option is disabled.
EmailActivationTest::testActivationMail public function Tests whether activation mails are sent correctly.
EmailActivationTest::testEmailPluginDisabled public function Tests that activation will be skipped if the "E-mail" plugin is disabled.
EmailActivationTest::testSavedSearchUpdate public function Tests that updating of saved searches is handled correctly.
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.
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.