class SystemSendEmailTest

@coversDefaultClass \Drupal\rules\Plugin\RulesAction\SystemSendEmail @group RulesAction

Hierarchy

Expanded class hierarchy of SystemSendEmailTest

File

tests/src/Unit/Integration/RulesAction/SystemSendEmailTest.php, line 15

Namespace

Drupal\Tests\rules\Unit\Integration\RulesAction
View source
class SystemSendEmailTest extends RulesIntegrationTestBase {
    
    /**
     * @var \Drupal\Core\Logger\LoggerChannelInterface|\Prophecy\Prophecy\ProphecyInterface
     */
    protected $logger;
    
    /**
     * @var \Drupal\Core\Mail\MailManagerInterface|\Prophecy\Prophecy\ProphecyInterface
     */
    protected $mailManager;
    
    /**
     * The action to be tested.
     *
     * @var \Drupal\rules\Plugin\RulesAction\SystemSendEmail
     */
    protected $action;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->mailManager = $this->prophesize(MailManagerInterface::class);
        $this->container
            ->set('plugin.manager.mail', $this->mailManager
            ->reveal());
        // Mock the logger.factory service, make it return the Rules logger channel,
        // and register it in the container.
        $this->logger = $this->prophesize(LoggerChannelInterface::class);
        $logger_factory = $this->prophesize(LoggerChannelFactoryInterface::class);
        $logger_factory->get('rules')
            ->willReturn($this->logger
            ->reveal());
        $this->container
            ->set('logger.factory', $logger_factory->reveal());
        $this->action = $this->actionManager
            ->createInstance('rules_send_email');
    }
    
    /**
     * Tests the summary.
     *
     * @covers ::summary
     */
    public function testSummary() {
        $this->assertEquals('Send email', $this->action
            ->summary());
    }
    
    /**
     * Tests sending a mail to one recipient.
     *
     * @covers ::execute
     */
    public function testSendMailToOneRecipient() {
        $to = [
            'mail@example.com',
        ];
        $this->action
            ->setContextValue('to', $to)
            ->setContextValue('subject', 'subject')
            ->setContextValue('message', 'hello');
        $params = [
            'subject' => 'subject',
            'message' => 'hello',
        ];
        $this->mailManager
            ->mail('rules', 'rules_action_mail_' . $this->action
            ->getPluginId(), implode(', ', $to), LanguageInterface::LANGCODE_SITE_DEFAULT, $params, NULL)
            ->willReturn([
            'result' => TRUE,
        ])
            ->shouldBeCalledTimes(1);
        $this->action
            ->execute();
        $this->logger
            ->notice('Successfully sent email to %recipient', [
            '%recipient' => implode(', ', $to),
        ])
            ->shouldHaveBeenCalled();
    }
    
    /**
     * Tests sending a mail to two recipients.
     *
     * @covers ::execute
     */
    public function testSendMailToTwoRecipients() {
        $to = [
            'mail@example.com',
            'mail2@example.com',
        ];
        // Use a language other than the site default.
        $language = $this->prophesize(LanguageInterface::class);
        $language->getId()
            ->willReturn('da');
        $this->action
            ->setContextValue('to', $to)
            ->setContextValue('subject', 'subject')
            ->setContextValue('message', 'hello')
            ->setContextValue('language', $language->reveal());
        $params = [
            'subject' => 'subject',
            'message' => 'hello',
        ];
        $this->mailManager
            ->mail('rules', 'rules_action_mail_' . $this->action
            ->getPluginId(), implode(', ', $to), $language->reveal()
            ->getId(), $params, NULL)
            ->willReturn([
            'result' => TRUE,
        ])
            ->shouldBeCalledTimes(1);
        $this->action
            ->execute();
        $this->logger
            ->notice('Successfully sent email to %recipient', [
            '%recipient' => implode(', ', $to),
        ])
            ->shouldHaveBeenCalled();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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.
RulesIntegrationTestBase::$actionManager protected property
RulesIntegrationTestBase::$cacheBackend protected property
RulesIntegrationTestBase::$classResolver protected property The class resolver mock for the typed data manager.
RulesIntegrationTestBase::$conditionManager protected property
RulesIntegrationTestBase::$container protected property The Drupal service container.
RulesIntegrationTestBase::$dataFetcher protected property The data fetcher service.
RulesIntegrationTestBase::$dataFilterManager protected property The data filter manager.
RulesIntegrationTestBase::$enabledModules protected property Array object keyed with module names and TRUE as value.
RulesIntegrationTestBase::$entityFieldManager protected property
RulesIntegrationTestBase::$entityTypeBundleInfo protected property
RulesIntegrationTestBase::$entityTypeManager protected property
RulesIntegrationTestBase::$fieldTypeCategoryManager protected property The field type category info plugin manager.
RulesIntegrationTestBase::$messenger protected property The messenger service.
RulesIntegrationTestBase::$moduleHandler protected property
RulesIntegrationTestBase::$namespaces protected property All setup'ed namespaces.
RulesIntegrationTestBase::$placeholderResolver protected property The placeholder resolver service.
RulesIntegrationTestBase::$rulesDataProcessorManager protected property
RulesIntegrationTestBase::$rulesExpressionManager protected property
RulesIntegrationTestBase::$typedDataManager protected property
RulesIntegrationTestBase::constructModulePath protected function Determines the path to a module's class files.
RulesIntegrationTestBase::enableModule protected function Fakes the enabling of a module and adds its namespace for plugin loading.
RulesIntegrationTestBase::getTypedData protected function Returns a typed data object.
RulesIntegrationTestBase::prophesizeEntity protected function Helper method to mock irrelevant cache methods on entities.
SystemSendEmailTest::$action protected property The action to be tested.
SystemSendEmailTest::$logger protected property Overrides RulesIntegrationTestBase::$logger
SystemSendEmailTest::$mailManager protected property
SystemSendEmailTest::setUp protected function Overrides RulesIntegrationTestBase::setUp
SystemSendEmailTest::testSendMailToOneRecipient public function Tests sending a mail to one recipient.
SystemSendEmailTest::testSendMailToTwoRecipients public function Tests sending a mail to two recipients.
SystemSendEmailTest::testSummary public function Tests the summary.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass public static function