class RngMessageRules in RNG - Events and Registrations 8.2

Same name and namespace in other branches

8 tests/src/Kernel/RngMessageRules.php \Drupal\Tests\rng\Kernel\RngMessageRules
3.x tests/src/Kernel/RngMessageRules.php \Drupal\Tests\rng\Kernel\RngMessageRules

Tests RNG message rules are executed.

@group rng

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\rng\Kernel\RngKernelTestBase uses RngTestTrait
  - class \Drupal\Tests\rng\Kernel\RngMessageRules uses UserCreationTrait

Expanded class hierarchy of RngMessageRules

File

tests/src/Kernel/RngMessageRules.php, line 17

Namespace

Drupal\Tests\rng\Kernel

View source

class RngMessageRules extends RngKernelTestBase {
  use UserCreationTrait;

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

  /**
   * @var \Drupal\rng\EventMetaInterface
   */
  protected $eventMeta;

  /**
   * @var \Drupal\rng\Entity\RuleInterface
   */
  protected $rule;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test');
    $this
      ->installEntitySchema('registration');
    $this
      ->installEntitySchema('registrant');
    $this
      ->installEntitySchema('rng_rule');
    $this
      ->installEntitySchema('rng_rule_component');
    $this
      ->installEntitySchema('courier_template_collection');
    $this
      ->installEntitySchema('courier_message_queue_item');
    $this
      ->installEntitySchema('courier_email');
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('system', [
      'sequences',
    ]);
    $this
      ->installConfig('courier');

    // Test trait needs.
    $this->registrationType = $this
      ->createRegistrationType();
    $this->eventType = $this
      ->createEventType('entity_test', 'entity_test');
    $this->eventMeta = $this
      ->createEvent();
    $event = $this->eventMeta
      ->getEvent();
    $this->rule = $this
      ->createMessageRule($event);
  }

  /**
   * Create a rule and associated components.
   *
   * @param $event
   *   An event entity.
   *
   * @return \Drupal\rng\RuleInterface
   *   An unsaved rule entity.
   */
  protected function createMessageRule($event) {

    /** @var \Drupal\courier\Service\CourierManagerInterface $courier_manager */
    $courier_manager = $this->container
      ->get('courier.manager');

    /** @var \Drupal\Core\Action\ActionManager $action_manager */
    $action_manager = $this->container
      ->get('plugin.manager.action');
    $template_collection = TemplateCollection::create();
    $template_collection
      ->save();
    $courier_manager
      ->addTemplates($template_collection);
    $template_collection
      ->save();
    $templates = $template_collection
      ->getTemplates();

    /** @var \Drupal\courier\EmailInterface $courier_email */
    $courier_email = $templates[0];
    $courier_email
      ->setSubject($this
      ->randomMachineName());
    $courier_email
      ->setBody('Greetings, [identity:label]');
    $courier_email
      ->save();
    $rule = Rule::create([
      'event' => [
        'entity' => $event,
      ],
    ]);
    $rule
      ->setIsActive(TRUE);
    $actionPlugin = $action_manager
      ->createInstance('rng_courier_message');
    $configuration = $actionPlugin
      ->getConfiguration();
    $configuration['template_collection'] = $template_collection
      ->id();
    $action = RuleComponent::create([])
      ->setPluginId($actionPlugin
      ->getPluginId())
      ->setConfiguration($configuration)
      ->setType('action');
    $rule
      ->addComponent($action);
    return $rule;
  }

  /**
   * Test messages are sent on registration creation.
   */
  public function testRngRegistrationCreateMessages() {
    $this->rule
      ->set('trigger_id', 'entity:registration:new');
    $this->rule
      ->save();

    /** @var \Drupal\rng\RngEntityModelInterface $rngEntityModel */
    $rngEntityModel = $this->container
      ->get('rng.entity.model');
    $this
      ->assertEquals(0, count($rngEntityModel
      ->getOperationRecords()), 'There are zero entity operations recorded.');
    $this
      ->assertEquals(0, $this
      ->countMessagesInQueue(), 'There are zero messages in queue.');
    $event = $this->eventMeta
      ->getEvent();
    $identity = $this
      ->createUser();
    $registration = Registration::create([
      'type' => $this->registrationType
        ->id(),
    ]);
    $registration
      ->setEvent($event)
      ->addIdentity($identity)
      ->save();
    $this
      ->terminateRequest();
    $this
      ->assertEquals(1, count($rngEntityModel
      ->getOperationRecords()), 'There is one entity operation recorded.');
    $this
      ->assertEquals(1, $this
      ->countMessagesInQueue(), 'There is one message in queue.');
  }

  /**
   * Test messages are sent on registration update.
   */
  public function testRngRegistrationUpdateMessages() {
    $this->rule
      ->set('trigger_id', 'entity:registration:update');
    $this->rule
      ->save();

    /** @var \Drupal\rng\RngEntityModelInterface $rngEntityModel */
    $rngEntityModel = $this->container
      ->get('rng.entity.model');
    $event = $this->eventMeta
      ->getEvent();
    $this
      ->assertEquals(0, count($rngEntityModel
      ->getOperationRecords()), 'There are zero entity operations recorded.');
    $identity = $this
      ->createUser();
    $registration = Registration::create([
      'type' => $this->registrationType
        ->id(),
    ]);
    $registration
      ->setEvent($event)
      ->addIdentity($identity)
      ->save();
    $this
      ->terminateRequest();
    $this
      ->assertEquals(1, count($rngEntityModel
      ->getOperationRecords()), 'There is one entity operation recorded.');
    $this
      ->assertEquals(0, $this
      ->countMessagesInQueue(), 'There are zero messages in queue.');
    $registration
      ->save();
    $this
      ->terminateRequest();

    // Two operations, insert and update.
    $this
      ->assertEquals(2, count($rngEntityModel
      ->getOperationRecords()), 'There is two entity operations recorded.');
    $this
      ->assertEquals(1, $this
      ->countMessagesInQueue(), 'There is one message in queue.');
  }

  /**
   * Simulate request termination.
   */
  protected function terminateRequest() {
    $request = $this->container
      ->get('request_stack')
      ->getCurrentRequest();
    $kernel = $this->container
      ->get('kernel');
    $response = new Response();
    $kernel
      ->terminate($request, $response);
  }

  /**
   * Count number of messages in Courier queue.
   *
   * @return int
   */
  protected function countMessagesInQueue() {
    return \Drupal::entityTypeManager()
      ->getStorage('courier_message_queue_item')
      ->getQuery()
      ->count()
      ->execute();
  }

}

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.
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.
RngKernelTestBase::$eventManager	protected	property	The RNG event manager.	4
RngMessageRules::$eventMeta	protected	property
RngMessageRules::$modules	public static	property	Modules to enable. Overrides RngKernelTestBase::$modules
RngMessageRules::$rule	protected	property
RngMessageRules::countMessagesInQueue	protected	function	Count number of messages in Courier queue.
RngMessageRules::createMessageRule	protected	function	Create a rule and associated components.
RngMessageRules::setUp	protected	function	Overrides RngKernelTestBase::setUp
RngMessageRules::terminateRequest	protected	function	Simulate request termination.
RngMessageRules::testRngRegistrationCreateMessages	public	function	Test messages are sent on registration creation.
RngMessageRules::testRngRegistrationUpdateMessages	public	function	Test messages are sent on registration update.
RngTestTrait::createEvent	protected	function	Create an event.
RngTestTrait::createEventType	protected	function	Creates an event type config.
RngTestTrait::createRegistration	protected	function	Create a registration and add an identity as a registrant.	1
RngTestTrait::createRegistrationType	protected	function	Create and save a registration type entity.
RngTestTrait::createUserRoleRules	protected	function	Create rules for an event type.
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.

You are here

class RngMessageRules in RNG - Events and Registrations 8.2

Hierarchy

File

Namespace

Members

API Navigation