class UserMailNotifyTest in Drupal 9

Same name and namespace in other branches

8 core/modules/user/tests/src/Kernel/UserMailNotifyTest.php \Drupal\Tests\user\Kernel\UserMailNotifyTest

Tests _user_mail_notify() use of user.settings.notify.*.

@group user

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
  - class \Drupal\Tests\user\Kernel\UserMailNotifyTest uses AssertMailTrait

Expanded class hierarchy of UserMailNotifyTest

File

core/modules/user/tests/src/Kernel/UserMailNotifyTest.php, line 15

Namespace

Drupal\Tests\user\Kernel

View source

class UserMailNotifyTest extends EntityKernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'locale',
    'language',
  ];
  use AssertMailTrait {
    getMails as drupalGetMails;
  }

  /**
   * Data provider for user mail testing.
   *
   * @return array
   */
  public function userMailsProvider() {
    return [
      'cancel confirm notification' => [
        'cancel_confirm',
        [
          'cancel_confirm',
        ],
      ],
      'password reset notification' => [
        'password_reset',
        [
          'password_reset',
        ],
      ],
      'status activated notification' => [
        'status_activated',
        [
          'status_activated',
        ],
      ],
      'status blocked notification' => [
        'status_blocked',
        [
          'status_blocked',
        ],
      ],
      'status canceled notification' => [
        'status_canceled',
        [
          'status_canceled',
        ],
      ],
      'register admin created notification' => [
        'register_admin_created',
        [
          'register_admin_created',
        ],
      ],
      'register no approval required notification' => [
        'register_no_approval_required',
        [
          'register_no_approval_required',
        ],
      ],
      'register pending approval notification' => [
        'register_pending_approval',
        [
          'register_pending_approval',
          'register_pending_approval_admin',
        ],
      ],
    ];
  }

  /**
   * Tests mails are sent when notify.$op is TRUE.
   *
   * @param string $op
   *   The operation being performed on the account.
   * @param array $mail_keys
   *   The mail keys to test for.
   *
   * @dataProvider userMailsProvider
   */
  public function testUserMailsSent($op, array $mail_keys) {
    $this
      ->config('user.settings')
      ->set('notify.' . $op, TRUE)
      ->save();
    $return = _user_mail_notify($op, $this
      ->createUser());
    $this
      ->assertTrue($return);
    foreach ($mail_keys as $key) {
      $filter = [
        'key' => $key,
      ];
      $this
        ->assertNotEmpty($this
        ->getMails($filter));
    }
    $this
      ->assertSameSize($mail_keys, $this
      ->getMails());
  }

  /**
   * Tests mails are not sent when notify.$op is FALSE.
   *
   * @param string $op
   *   The operation being performed on the account.
   *
   * @dataProvider userMailsProvider
   */
  public function testUserMailsNotSent($op) {
    $this
      ->config('user.settings')
      ->set('notify.' . $op, FALSE)
      ->save();
    $return = _user_mail_notify($op, $this
      ->createUser());
    $this
      ->assertNull($return);
    $this
      ->assertEmpty($this
      ->getMails());
  }

  /**
   * Tests the deprecated $langcode argument to _user_mail_notify().
   *
   * @group legacy
   */
  public function testUserMailNotifyLangcodeDeprecation() {
    $account = $this
      ->createUser();
    $this
      ->expectDeprecation('Specifying the notification language using the $langcode parameter is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Omit the parameter. See https://www.drupal.org/node/3187082');
    _user_mail_notify('password_reset', $account, $account
      ->getPreferredLangcode());
  }

  /**
   * Tests recovery email content and token langcode is aligned.
   */
  public function testUserRecoveryMailLanguage() {

    // Install locale schema.
    $this
      ->installSchema('locale', [
      'locales_source',
      'locales_target',
      'locales_location',
    ]);

    // Add new language for translation purpose.
    ConfigurableLanguage::createFromLangcode('zh-hant')
      ->save();
    ConfigurableLanguage::createFromLangcode('fr')
      ->save();

    // Install configs.
    $this
      ->installConfig([
      'language',
      'locale',
      'user',
    ]);
    locale_system_set_config_langcodes();
    $langcodes = array_keys(\Drupal::languageManager()
      ->getLanguages());
    $names = Locale::config()
      ->getComponentNames();
    Locale::config()
      ->updateConfigTranslations($names, $langcodes);
    $this
      ->config('user.settings')
      ->set('notify.password_reset', TRUE)
      ->save();

    // Set language prefix.
    $config = $this
      ->config('language.negotiation');
    $config
      ->set('url.prefixes', [
      'en' => 'en',
      'zh-hant' => 'zh',
      'fr' => 'fr',
    ])
      ->save();

    // Reset services to apply change.
    \Drupal::service('kernel')
      ->rebuildContainer();

    // Update zh-hant password_reset config with custom translation.
    $configLanguageOverride = $this->container
      ->get('language_manager')
      ->getLanguageConfigOverride('zh-hant', 'user.mail');
    $configLanguageOverride
      ->set('password_reset.subject', 'hant subject [user:display-name]')
      ->save();
    $configLanguageOverride
      ->set('password_reset.body', 'hant body [user:display-name] and token link [user:one-time-login-url]')
      ->save();

    // Update fr password_reset config with custom translation.
    $configLanguageOverride = $this->container
      ->get('language_manager')
      ->getLanguageConfigOverride('fr', 'user.mail');
    $configLanguageOverride
      ->set('password_reset.subject', 'fr subject [user:display-name]')
      ->save();
    $configLanguageOverride
      ->set('password_reset.body', 'fr body [user:display-name] and token link [user:one-time-login-url]')
      ->save();

    // Current language is 'en'.
    $currentLanguage = $this->container
      ->get('language_manager')
      ->getCurrentLanguage()
      ->getId();
    $this
      ->assertSame('en', $currentLanguage);

    // Set preferred_langcode to 'zh-hant'.
    $user = $this
      ->createUser();
    $user
      ->set('preferred_langcode', 'zh-hant')
      ->save();
    $preferredLangcode = $user
      ->getPreferredLangcode();
    $this
      ->assertSame('zh-hant', $preferredLangcode);

    // Recovery email should respect user preferred langcode by default if
    // langcode not set.
    $params['account'] = $user;
    $default_email = \Drupal::service('plugin.manager.mail')
      ->mail('user', 'password_reset', $user
      ->getEmail(), $preferredLangcode, $params);
    $this
      ->assertTrue($default_email['result']);

    // Assert for zh.
    $this
      ->assertMailString('subject', 'hant subject', 1);
    $this
      ->assertMailString('body', 'hant body', 1);
    $this
      ->assertMailString('body', 'zh/user/reset', 1);

    // Recovery email should be fr when langcode specified.
    $french_email = \Drupal::service('plugin.manager.mail')
      ->mail('user', 'password_reset', $user
      ->getEmail(), 'fr', $params);
    $this
      ->assertTrue($french_email['result']);

    // Assert for fr.
    $this
      ->assertMailString('subject', 'fr subject', 1);
    $this
      ->assertMailString('body', 'fr body', 1);
    $this
      ->assertMailString('body', 'fr/user/reset', 1);
  }

}

Members

Name	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.
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
AssertMailTrait::assertMail	protected	function	Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern	protected	function	Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString	protected	function	Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails	protected	function	Gets an array containing all emails sent during this test case. Aliased as: drupalGetMails
AssertMailTrait::verboseEmail Deprecated	protected	function	Outputs to verbose the most recent $count emails sent.
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.
EntityKernelTestBase::$entityTypeManager	protected	property	The entity type manager service.	1
EntityKernelTestBase::$generatedIds	protected	property	A list of generated identifiers.
EntityKernelTestBase::$state	protected	property	The state service.
EntityKernelTestBase::createUser	protected	function	Creates a user.
EntityKernelTestBase::generateRandomEntityId	protected	function	Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo	protected	function	Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule	protected	function	Installs a module and refreshes services.
EntityKernelTestBase::refreshServices	protected	function	Refresh services.	1
EntityKernelTestBase::reloadEntity	protected	function	Reloads the given entity from the storage and returns it.
EntityKernelTestBase::setUp	protected	function	Overrides KernelTestBase::setUp	66
EntityKernelTestBase::uninstallModule	protected	function	Uninstalls a module and refreshes services.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
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.	3
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::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	24
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		4
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser
UserMailNotifyTest::$modules	protected static	property	Modules to enable. Overrides EntityKernelTestBase::$modules
UserMailNotifyTest::testUserMailNotifyLangcodeDeprecation	public	function	Tests the deprecated $langcode argument to _user_mail_notify().
UserMailNotifyTest::testUserMailsNotSent	public	function	Tests mails are not sent when notify.$op is FALSE.
UserMailNotifyTest::testUserMailsSent	public	function	Tests mails are sent when notify.$op is TRUE.
UserMailNotifyTest::testUserRecoveryMailLanguage	public	function	Tests recovery email content and token langcode is aligned.
UserMailNotifyTest::userMailsProvider	public	function	Data provider for user mail testing.

You are here

class UserMailNotifyTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation