class CourierSystemTest in Courier 2.x

Same name and namespace in other branches

8 courier_system/tests/src/Kernel/CourierSystemTest.php \Drupal\Tests\courier_system\Kernel\CourierSystemTest

Tests Courier system.

@group courier_system

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\Tests\courier\Kernel\CourierKernelTestBase
  - class \Drupal\Tests\courier_system\Kernel\CourierSystemTest uses AssertMailTrait

Expanded class hierarchy of CourierSystemTest

File

courier_system/tests/src/Kernel/CourierSystemTest.php, line 15

Namespace

Drupal\Tests\courier_system\Kernel

View source

class CourierSystemTest extends CourierKernelTestBase {
  use AssertMailTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'user',
    'system',
    'courier_system',
  ];

  /**
   * Cron.
   *
   * @var \Drupal\Core\CronInterface
   */
  protected $cron;

  /**
   * List of supported mail ID's.
   *
   * @var array
   */
  protected $mailIds;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig([
      'courier',
      'courier_system',
    ]);
    $this
      ->installSchema('system', [
      'sequences',
    ]);
    $this
      ->installEntitySchema('courier_message_queue_item');
    $this
      ->installEntitySchema('courier_template_collection');
    $this
      ->installEntitySchema('courier_email');
    $this
      ->installEntitySchema('user');
    $this
      ->config('system.mail')
      ->set('interface.default', 'test_mail_collector')
      ->save();
    $this->cron = $this->container
      ->get('cron');
    $this->mailIds = [
      'register_admin_created',
      'register_no_approval_required',
      'register_pending_approval',
      'password_reset',
      'status_activated',
      'status_blocked',
      'cancel_confirm',
      'status_canceled',
    ];
  }

  /**
   * Test courier system override is off.
   */
  public function testNonOverride() {
    foreach ($this->mailIds as $id) {
      $this
        ->config('user.settings')
        ->set('notify.' . $id, TRUE)
        ->save();
      $default_body = $this
        ->randomMachineName();

      // Override the user.module template.
      $this
        ->config('user.mail')
        ->set($id . '.body', $default_body)
        ->save();

      // Turn off Courier override.
      $this
        ->config('courier_system.settings')
        ->set('override.user_' . $id, FALSE)
        ->save();
      $body = $this
        ->randomMachineName();
      $this
        ->createGlobalTemplateCollection('courier_system.user_' . $id, $body);

      // Simulate.
      _user_mail_notify($id, $this
        ->createUser());
      $this->cron
        ->run();

      // Email depth is two emails since some triggers will send email for user
      // and admin.
      $this
        ->assertMailString('body', $default_body, 2, 'Body found in non override for ' . $id);
    }
  }

  /**
   * Test courier system override is on.
   */
  public function testOverride() {
    foreach ($this->mailIds as $id) {

      // Turn on the email.
      $this
        ->config('user.settings')
        ->set('notify.' . $id, TRUE)
        ->save();
      $default_body = $this
        ->randomMachineName();

      // Override the user.module template.
      $this
        ->config('user.mail')
        ->set($id . '.body', $default_body)
        ->save();

      // Turn on Courier override.
      $this
        ->config('courier_system.settings')
        ->set('override.user_' . $id, TRUE)
        ->save();
      $body = $this
        ->randomMachineName();
      $this
        ->createGlobalTemplateCollection('courier_system.user_' . $id, $body);

      // Simulate.
      _user_mail_notify($id, $this
        ->createUser());
      $this->cron
        ->run();
      $this
        ->assertMailString('body', $body, 2, 'Body found in override for ' . $id);
    }
  }

  /**
   * Create a random user for testing.
   *
   * @return \Drupal\user\UserInterface
   *   A user entity.
   */
  protected function createUser() {
    $mail = $this
      ->randomMachineName() . '@' . $this
      ->randomMachineName();
    $account = User::create([
      'name' => $this
        ->randomMachineName(),
      'mail' => $mail,
    ]);
    $account
      ->save();
    return $account;
  }

  /**
   * Create a global template collection and change its email body.
   *
   * @param int $id
   *   The ID for the new global template collection.
   * @param string $email_body
   *   Change the email template body.
   *
   * @return \Drupal\courier\Entity\GlobalTemplateCollectionInterface
   */
  protected function createGlobalTemplateCollection($id, $email_body) {
    $gtc = GlobalTemplateCollection::create([
      'id' => $id,
    ]);
    $gtc
      ->save();
    $gtc
      ->getTemplateCollection()
      ->getTemplate('courier_email')
      ->setSubject($this
      ->randomMachineName())
      ->setBody($email_body)
      ->save();
    return $gtc;
  }

}

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.
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.
CourierSystemTest::$cron	protected	property	Cron.
CourierSystemTest::$mailIds	protected	property	List of supported mail ID's.
CourierSystemTest::$modules	public static	property	Modules to enable. Overrides CourierKernelTestBase::$modules
CourierSystemTest::createGlobalTemplateCollection	protected	function	Create a global template collection and change its email body.
CourierSystemTest::createUser	protected	function	Create a random user for testing.
CourierSystemTest::setUp	protected	function	Overrides KernelTestBase::setUp
CourierSystemTest::testNonOverride	public	function	Test courier system override is off.
CourierSystemTest::testOverride	public	function	Test courier system override is on.
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.

You are here

class CourierSystemTest in Courier 2.x

Hierarchy

File

Namespace

Members

API Navigation