You are here

Home » API reference » SMTP Authentication Support 8 » SMTPMailSystemTest.php

class SMTPMailSystemTest in SMTP Authentication Support 8

Validate requirements for SMTPMailSystem.

@group SMTP

Hierarchy

Expanded class hierarchy of SMTPMailSystemTest

File

tests/src/Unit/Plugin/Mail/SMTPMailSystemTest.php, line 26

Namespace

Drupal\Tests\smtp\Unit\Plugin\Mail
View source 
class SMTPMailSystemTest extends UnitTestCase {

  /**
   * The email validator.
   *
   * @var \Drupal\Component\Utility\EmailValidatorInterface
   */
  protected $emailValidator;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    $this->mockConfigFactory = $this
      ->getConfigFactoryStub([
      'smtp.settings' => [
        'smtp_timeout' => 30,
        'smtp_reroute_address' => '',
      ],
      'system.site' => [
        'name' => 'Mock site name',
      ],
    ]);
    $this->mockConfigFactoryRerouted = $this
      ->getConfigFactoryStub([
      'smtp.settings' => [
        'smtp_reroute_address' => 'blackhole@galaxy.com',
      ],
    ]);
    $this->mockLogger = $this
      ->prophesize(LoggerChannelFactoryInterface::class);
    $this->mockLogger
      ->get('smtp')
      ->willReturn($this
      ->prophesize(LoggerChannelInterface::class));
    $this->mockMessenger = $this
      ->prophesize(Messenger::class);
    $this->mockCurrentUser = $this
      ->prophesize(AccountProxy::class);
    $this->mockFileSystem = $this
      ->prophesize(FileSystem::class);
    $this->mimeTypeGuesser = $this
      ->prophesize(MimeTypeGuesser::class);
    $mockContainer = $this->mockContainer = $this
      ->prophesize(ContainerInterface::class);
    $mockContainer
      ->get('config.factory')
      ->willReturn($this->mockConfigFactory);
    $mockContainer
      ->get('logger.factory')
      ->willReturn($this->mockLogger
      ->reveal());
    $mockContainer
      ->get('messenger')
      ->willReturn($this->mockMessenger
      ->reveal());
    $mockContainer
      ->get('current_user')
      ->willReturn($this->mockCurrentUser
      ->reveal());
    $mockContainer
      ->get('file_system')
      ->willReturn($this->mockFileSystem
      ->reveal());
    $mockContainer
      ->get('file.mime_type.guesser')
      ->willReturn($this->mimeTypeGuesser
      ->reveal());
    $mockStringTranslation = $this
      ->prophesize(TranslationInterface::class);
    $mockStringTranslation
      ->translate(Argument::any())
      ->willReturnArgument(0);
    $mockStringTranslation
      ->translate(Argument::any(), Argument::any())
      ->willReturnArgument(0);
    $mockStringTranslation
      ->translateString(Argument::any())
      ->willReturn('.');
    $mockContainer
      ->get('string_translation')
      ->willReturn($mockStringTranslation
      ->reveal());

    // Email validator.
    $this->emailValidator = new EmailValidator();
    $mockContainer
      ->get('email.validator')
      ->willReturn($this->emailValidator);
    \Drupal::setContainer($this->mockContainer
      ->reveal());
  }

  /**
   * Provides scenarios for getComponents().
   */
  public function getComponentsProvider() {
    return [
      [
        // Input.
        'name@example.com',
        // Expected.
        [
          'name' => '',
          'email' => 'name@example.com',
        ],
      ],
      [
        ' name@example.com',
        [
          'name' => '',
          'input' => 'name@example.com',
          'email' => 'name@example.com',
        ],
      ],
      [
        'name@example.com ',
        [
          'name' => '',
          'input' => 'name@example.com',
          'email' => 'name@example.com',
        ],
      ],
      [
        'some name <address@example.com>',
        [
          'name' => 'some name',
          'email' => 'address@example.com',
        ],
      ],
      [
        '"some name" <address@example.com>',
        [
          'name' => 'some name',
          'email' => 'address@example.com',
        ],
      ],
      [
        '<address@example.com>',
        [
          'name' => '',
          'email' => 'address@example.com',
        ],
      ],
    ];
  }

  /**
   * Test getComponents().
   *
   * @dataProvider getComponentsProvider
   */
  public function testGetComponents($input, $expected) {
    $mailSystem = new SMTPMailSystemTestHelper([], '', [], $this->mockLogger
      ->reveal(), $this->mockMessenger
      ->reveal(), $this->emailValidator, $this->mockConfigFactory, $this->mockCurrentUser
      ->reveal(), $this->mockFileSystem
      ->reveal(), $this->mimeTypeGuesser
      ->reveal());
    $ret = $mailSystem
      ->publicGetComponents($input);
    if (!empty($expected['input'])) {
      $this
        ->assertEquals($expected['input'], $ret['input']);
    }
    else {
      $this
        ->assertEquals($input, $ret['input']);
    }
    $this
      ->assertEquals($expected['name'], $ret['name']);
    $this
      ->assertEquals($expected['email'], $ret['email']);
  }

  /**
   * Test applyRerouting().
   */
  public function testApplyRerouting() {
    $mailSystemRerouted = new SMTPMailSystemTestHelper([], '', [], $this->mockLogger
      ->reveal(), $this->mockMessenger
      ->reveal(), $this->emailValidator, $this->mockConfigFactoryRerouted, $this->mockCurrentUser
      ->reveal(), $this->mockFileSystem
      ->reveal(), $this->mimeTypeGuesser
      ->reveal());
    $to = 'abc@example.com';
    $headers = [
      'some' => 'header',
      'cc' => 'xyz@example.com',
      'bcc' => 'ttt@example.com',
    ];
    list($new_to, $new_headers) = $mailSystemRerouted
      ->publicApplyRerouting($to, $headers);
    $this
      ->assertEquals($new_to, 'blackhole@galaxy.com', 'to address is set to the reroute address.');
    $this
      ->assertEquals($new_headers, [
      'some' => 'header',
    ], 'bcc and cc headers are unset when rerouting.');
    $mailSystemNotRerouted = new SMTPMailSystemTestHelper([], '', [], $this->mockLogger
      ->reveal(), $this->mockMessenger
      ->reveal(), $this->emailValidator, $this->mockConfigFactory, $this->mockCurrentUser
      ->reveal(), $this->mockFileSystem
      ->reveal(), $this->mimeTypeGuesser
      ->reveal());
    $to = 'abc@example.com';
    $headers = [
      'some' => 'header',
      'cc' => 'xyz@example.com',
      'bcc' => 'ttt@example.com',
    ];
    list($new_to, $new_headers) = $mailSystemNotRerouted
      ->publicApplyRerouting($to, $headers);
    $this
      ->assertEquals($new_to, $to, 'original to address is preserved when not rerouting.');
    $this
      ->assertEquals($new_headers, $headers, 'bcc and cc headers are preserved when not rerouting.');
  }

  /**
   * Provides scenarios for testMailValidator().
   */
  public function mailValidatorProvider() {
    $emailValidatorPhpMailerDefault = new EmailValidatorPhpMailerDefault();
    $emailValidatorDrupal = new EmailValidator();
    return [
      'Without umlauts, PHPMailer default validator, no exception' => [
        'test@drupal.org',
        'PhpUnit Localhost <phpunit@localhost.com>',
        $emailValidatorPhpMailerDefault,
        NULL,
      ],
      'With umlauts in local part, PHPMailer default validator, exception' => [
        'testmüller@drupal.org',
        'PhpUnit Localhost <phpunit@localhost.com>',
        $emailValidatorPhpMailerDefault,
        PHPMailerException::class,
      ],
      'With umlauts in domain part, PHPMailer default validator, exception' => [
        'test@müllertest.de',
        'PhpUnit Localhost <phpunit@localhost.com>',
        $emailValidatorPhpMailerDefault,
        PHPMailerException::class,
      ],
      'Without top-level domain in domain part, PHPMailer default validator, exception' => [
        'test@drupal',
        'PhpUnit Localhost <phpunit@localhost.com>',
        $emailValidatorPhpMailerDefault,
        PHPMailerException::class,
      ],
      'Without umlauts, Drupal mail validator, no exception' => [
        'test@drupal.org',
        'PhpUnit Localhost <phpunit@localhost.com>',
        $emailValidatorDrupal,
        NULL,
      ],
      'With umlauts in local part, Drupal mail validator, no exception' => [
        'testmüller@drupal.org',
        'PhpUnit Localhost <phpunit@localhost.com>',
        $emailValidatorDrupal,
        NULL,
      ],
      'With umlauts in domain part, Drupal mail validator, no exception' => [
        'test@müllertest.de',
        'PhpUnit Localhost <phpunit@localhost.com>',
        $emailValidatorDrupal,
        NULL,
      ],
      'Without top-level domain in domain part, Drupal mail validator, no exception' => [
        'test@drupal',
        'PhpUnit Localhost <phpunit@localhost.com>',
        $emailValidatorDrupal,
        NULL,
      ],
    ];
  }

  /**
   * Test mail() with focus on the mail validator.
   *
   * @dataProvider mailValidatorProvider
   */
  public function testMailValidator(string $to, string $from, EmailValidatorInterface $validator, $exception) {
    $this->emailValidator = $validator;
    $mailSystem = new SMTPMailSystemTestHelper([], '', [], $this->mockLogger
      ->reveal(), $this->mockMessenger
      ->reveal(), $validator, $this->mockConfigFactory, $this->mockCurrentUser
      ->reveal(), $this->mockFileSystem
      ->reveal(), $this->mimeTypeGuesser
      ->reveal());
    $message = [
      'to' => $to,
      'from' => $from,
      'body' => 'Some test content for testMailValidatorDrupal',
      'headers' => [
        'content-type' => 'text/plain',
      ],
      'subject' => 'testMailValidatorDrupal',
    ];
    if (isset($exception)) {
      $this
        ->expectException($exception);
    }

    // Call function.
    $result = $mailSystem
      ->mail($message);

    // More important than the result is that no exception was thrown, if
    // $exception is unset.
    self::assertTrue($result);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
SMTPMailSystemTest::$emailValidator protected property The email validator.
SMTPMailSystemTest::getComponentsProvider public function Provides scenarios for getComponents().
SMTPMailSystemTest::mailValidatorProvider public function Provides scenarios for testMailValidator().
SMTPMailSystemTest::setUp protected function Overrides UnitTestCase::setUp
SMTPMailSystemTest::testApplyRerouting public function Test applyRerouting().
SMTPMailSystemTest::testGetComponents public function Test getComponents().
SMTPMailSystemTest::testMailValidator public function Test mail() with focus on the mail validator.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated protected function Mocks a block with a block plugin. 1
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.