You are here

Home » API reference » Mime Mail 8 » MimeMailFormatHelperTest.php

class MimeMailFormatHelperTest in Mime Mail 8

Tests that Mime Mail utility functions work properly.

@coversDefaultClass \Drupal\mimemail\Utility\MimeMailFormatHelper

@group mimemail

Hierarchy

Expanded class hierarchy of MimeMailFormatHelperTest

File

tests/src/Kernel/MimeMailFormatHelperTest.php, line 16

Namespace

Drupal\Tests\mimemail\Kernel
View source 
class MimeMailFormatHelperTest extends KernelTestBase {
  use UserCreationTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'mailsystem',
    'mimemail',
    'system',
    'user',
  ];

  /**
   * Administrator.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * Authenticated user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $userA;

  /**
   * A different authenticated user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $userB;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Sets up an anonymous and two authenticated users.
    $this->adminUser = $this
      ->setUpCurrentUser([
      'uid' => 1,
      'name' => 'username with spaces',
      'mail' => 'admin@test.example.com',
    ]);
    $this->userA = $this
      ->createUser([], 'CapitaL', FALSE, [
      'mail' => 'namea@example.com',
    ]);
    $this->userB = $this
      ->createUser([], '', FALSE, [
      'mail' => 'nameb@example.com',
    ]);
  }

  /**
   * Tests formatting an address string.
   *
   * @param string|array|\Drupal\user\UserInterface $address
   *   MimeMailFormatHelper::mimeMailAddress() accepts addresses in one of
   *   four different formats:
   *   - A text email address, e.g. someone@example.com.
   *   - An array where the values are each a text email address.
   *   - An associative array to represent one email address, containing keys:
   *     - mail: A text email address, as above.
   *     - (optional) name: A text name to accompany the email address,
   *       e.g. 'John Doe'.
   *   - A fully loaded object implementing \Drupal\user\UserInterface.
   * @param string $result
   *   Email address after formatting.
   * @param string $simplified_result
   *   Simplified email address after formatting.
   *
   * @dataProvider providerAddress
   * @dataProvider providerArrayOfAddresses
   * @dataProvider providerAssociativeAddressArray
   * @covers ::mimeMailAddress
   */
  public function testAddress($address, $result, $simplified_result) {

    // Test not simplified.
    $formatted = MimeMailFormatHelper::mimeMailAddress($address, $simplify = FALSE);
    $this
      ->assertSame($result, $formatted);

    // Test simplified.
    $formatted = MimeMailFormatHelper::mimeMailAddress($address, $simplify = TRUE);
    $this
      ->assertSame($simplified_result, $formatted);
  }

  /**
   * Provides test data for testAddress().
   *
   * Tests addresses provided as text email addresses, e.g. someone@example.com.
   */
  public function providerAddress() {

    // Format of each element is:
    // - address: Email address to test.
    // - result: Expected return value from
    //   MimeMailFormatHelper::mimeMailAddress($address, $simplify = FALSE).
    // - simplified_result: Expected return value from
    //   MimeMailFormatHelper::mimeMailAddress($address, $simplify = TRUE).
    $addresses = [
      'Encoded display-name' => [
        '=?utf-8?Q?Drupal=20Supporters?= <support@association.drupal.org>',
        '=?utf-8?Q?Drupal=20Supporters?= <support@association.drupal.org>',
        'support@association.drupal.org',
      ],
      'Display-name needing quotes' => [
        'Acme Industries, Inc. <no-reply@acme.example.com>',
        '"Acme Industries, Inc." <no-reply@acme.example.com>',
        'no-reply@acme.example.com',
      ],
      'UTF-8 display-name' => [
        '山田太郎 <taro@example.com>',
        '=?UTF-8?B?5bGx55Sw5aSq6YOO?= <taro@example.com>',
        'taro@example.com',
      ],
      'No display-name' => [
        'alpher@example.com',
        'alpher@example.com',
        'alpher@example.com',
      ],
      'No display-name, address between < and >' => [
        '<tr@202830.no-reply.drupal.org>',
        '<tr@202830.no-reply.drupal.org>',
        'tr@202830.no-reply.drupal.org',
      ],
    ];
    return $addresses;
  }

  /**
   * Provides test data for testAddress().
   *
   * Tests addresses provided as an array of text email addresses.
   */
  public function providerArrayOfAddresses() {

    // Format of each element is:
    // - address: Array of email addresses to test.
    // - result: Expected return value from
    //   MimeMailFormatHelper::mimeMailAddress($address, $simplify = FALSE).
    // - simplified_result: Expected return value from
    //   MimeMailFormatHelper::mimeMailAddress($address, $simplify = TRUE).
    $addresses = [
      'Array of address strings' => [
        [
          '=?utf-8?Q?Drupal=20Supporters?= <support@association.drupal.org>',
          'Acme Industries, Inc. <no-reply@acme.example.com>',
          '山田太郎 <taro@example.com>',
          'bethe@example.com',
          '<subscriber@example.com>',
        ],
        [
          '=?utf-8?Q?Drupal=20Supporters?= <support@association.drupal.org>',
          '"Acme Industries, Inc." <no-reply@acme.example.com>',
          '=?UTF-8?B?5bGx55Sw5aSq6YOO?= <taro@example.com>',
          'bethe@example.com',
          '<subscriber@example.com>',
        ],
        [
          'support@association.drupal.org',
          'no-reply@acme.example.com',
          'taro@example.com',
          'bethe@example.com',
          'subscriber@example.com',
        ],
      ],
    ];
    return $addresses;
  }

  /**
   * Provides test data for testAddress().
   *
   * Tests addresses provided as associative arrays containing keys:
   * - mail: A text email address, as above.
   * - (optional) name: A text name to accompany the email address,
   *   e.g. 'John Doe'.
   */
  public function providerAssociativeAddressArray() {

    // Format of each element is:
    // - address: Associative array of addresses, with 'mail' and 'name' keys.
    // - result: Expected return value from
    //   MimeMailFormatHelper::mimeMailAddress($address, $simplify = FALSE).
    // - simplified_result: Expected return value from
    //   MimeMailFormatHelper::mimeMailAddress($address, $simplify = TRUE).
    $addresses = [
      'Encoded display-name in array' => [
        [
          'name' => '=?utf-8?Q?Drupal=20Supporters?=',
          'mail' => 'support@association.drupal.org',
        ],
        '=?utf-8?Q?Drupal=20Supporters?= <support@association.drupal.org>',
        'support@association.drupal.org',
      ],
      'Display-name needing quotes in array' => [
        [
          'name' => 'Acme Industries, Inc.',
          'mail' => 'no-reply@acme.example.com',
        ],
        '"Acme Industries, Inc." <no-reply@acme.example.com>',
        'no-reply@acme.example.com',
      ],
      'UTF-8 display-name in array' => [
        [
          'name' => '山田太郎',
          'mail' => 'taro@example.com',
        ],
        '=?UTF-8?B?5bGx55Sw5aSq6YOO?= <taro@example.com>',
        'taro@example.com',
      ],
      'No display-name' => [
        [
          'name' => '',
          'mail' => 'gamow@example.com',
        ],
        'gamow@example.com',
        'gamow@example.com',
      ],
    ];
    return $addresses;
  }

  /**
   * Tests MimeMailFormatHelper::mimeMailAddress() with user objects.
   *
   * Tests addresses provided as fully loaded objects implementing
   * \Drupal\user\UserInterface. This can't be done in a data provider
   * function because the User module will not be set up at the time
   * the data provider is executed.
   *
   * @covers ::mimeMailAddress
   */
  public function testAddressUserObject() {

    // Format of each element is:
    // - address: Instance of a User object containing an email field.
    // - result: Expected return value from
    //   MimeMailFormatHelper::mimeMailAddress($address, $simplify = FALSE).
    // - simplified_result: Expected return value from
    //   MimeMailFormatHelper::mimeMailAddress($address, $simplify = TRUE).
    $addresses = [
      'User name with spaces' => [
        $this->adminUser,
        'username with spaces <admin@test.example.com>',
        'admin@test.example.com',
      ],
      'User name with capital letters' => [
        $this->userA,
        'CapitaL <namea@example.com>',
        'namea@example.com',
      ],
      'Random user name' => [
        $this->userB,
        $this->userB
          ->getAccountName() . ' <nameb@example.com>',
        'nameb@example.com',
      ],
    ];
    foreach ($addresses as $address) {

      // Test not simplified.
      $formatted = MimeMailFormatHelper::mimeMailAddress($address[0], $simplify = FALSE);
      $this
        ->assertSame($address[1], $formatted);

      // Test simplified.
      $formatted = MimeMailFormatHelper::mimeMailAddress($address[0], $simplify = TRUE);
      $this
        ->assertSame($address[2], $formatted);
    }
  }

  /**
   * Tests helper function for formatting URLs.
   *
   * @param string $url
   *   URL to test.
   * @param bool $absolute
   *   Whether the URL is absolute.
   * @param string $expected
   *   URL after formatting.
   *
   * @dataProvider providerTestUrl
   * @covers ::mimeMailUrl
   */
  public function testUrl($url, $absolute, $expected) {
    $result = MimeMailFormatHelper::mimeMailUrl($url, $absolute);
    $this
      ->assertSame($expected, $result);
  }

  /**
   * Provides test data for testUrl().
   */
  public function providerTestUrl() {

    // Format of each element is:
    // - url: URL to test.
    // - absolute: Whether the URL is absolute.
    // - expected: URL after formatting.
    return [
      'Hash mark URL without fragment left intact.' => [
        '#',
        FALSE,
        '#',
      ],
      'Security token removed from styled image URL.' => [
        '/sites/default/files/styles/thumbnail/public/image.jpg?itok=Wrl6Qi9U',
        TRUE,
        '/sites/default/files/styles/thumbnail/public/image.jpg',
      ],
      'Space in the filename of the attachment left intact.' => [
        $expected = 'public://' . $this
          ->randomMachineName() . ' ' . $this
          ->randomMachineName() . '.' . $this
          ->randomMachineName(3),
        TRUE,
        $expected,
      ],
    ];
  }

  /**
   * Tests making headers RFC822-compliant.
   *
   * @param array $headers
   *   An array of headers where the keys are header field names and the
   *   values are the header field bodies.
   * @param string $expected
   *   One string containing a concatenation of all formatted header fields.
   *
   * @dataProvider providerRfcHeaders
   * @covers ::mimeMailRfcHeaders
   */
  public function testRfcHeaders(array $headers, $expected) {
    $actual = MimeMailFormatHelper::mimeMailRfcHeaders($headers);
    $this
      ->assertSame($expected, $actual);
  }

  /**
   * Provides test data for testRfcHeaders().
   */
  public function providerRfcHeaders() {

    // Format of each element is:
    // - headers: An associative array of header fields to test. Each element
    //   is keyed by the header field name, which the array value being the
    //   header field body.
    // - expected: Expected return value from
    //   MimeMailFormatHelper::mimeMailRfcHeaders($headers).
    $headers = [
      'Multipart mail message header' => [
        [
          'MIME-Version' => '1.0',
          'ContentType' => 'multipart/mixed; boundary="379e3cea84af565a8053ea9e61054fc1294536001"',
          'Content-Transfer-Encoding' => '8bit',
        ],
        "MIME-Version: 1.0\r\n" . "ContentType: multipart/mixed;\r\n boundary=\"379e3cea84af565a8053ea9e61054fc1294536001\"\r\n" . "Content-Transfer-Encoding: 8bit\r\n",
      ],
      'Plaintext mail message header' => [
        [
          'MIME-Version' => '1.0',
          'Content-Type' => 'text/plain; charset=utf-8',
          'Content-Transfer-Encoding' => '8bit',
        ],
        "MIME-Version: 1.0\r\n" . "Content-Type: text/plain; charset=utf-8\r\n" . "Content-Transfer-Encoding: 8bit\r\n",
      ],
      'Plaintext MIME part header' => [
        [
          'Content-Type' => 'text/plain; charset=utf-8',
          'Content-Disposition' => 'inline',
          'Content-Transfer-Encoding' => '8bit',
        ],
        "Content-Type: text/plain; charset=utf-8\r\n" . "Content-Disposition: inline\r\n" . "Content-Transfer-Encoding: 8bit\r\n",
      ],
      'HTML MIME part header' => [
        [
          'ContentType' => 'text/html; charset=utf-8',
          'Content-Disposition' => 'inline',
          'Content-Transfer-Encoding' => '8bit',
        ],
        "ContentType: text/html; charset=utf-8\r\n" . "Content-Disposition: inline\r\n" . "Content-Transfer-Encoding: 8bit\r\n",
      ],
      'Multipart alternative MIME part header' => [
        [
          'ContentType' => 'multipart/alternative; boundary="233fe3c3a9841692454109103d46c2362d0ebe050"',
          'Content-Transfer-Encoding' => '8bit',
        ],
        "ContentType: multipart/alternative;\r\n boundary=\"233fe3c3a9841692454109103d46c2362d0ebe050\"\r\n" . "Content-Transfer-Encoding: 8bit\r\n",
      ],
      'PNG image attachment part header' => [
        [
          'Content-ID' => '<6152ca67d63c8f310d767bcdcdef9563@test.example.com>',
          'ContentType' => 'image/png; name="selfie.png"',
          'Content-Disposition' => 'attachment; filename="selfie.png"',
          'Content-Transfer-Encoding' => 'base64',
        ],
        "Content-ID: <6152ca67d63c8f310d767bcdcdef9563@test.example.com>\r\n" . "ContentType: image/png; name=\"selfie.png\"\r\n" . "Content-Disposition: attachment; filename=\"selfie.png\"\r\n" . "Content-Transfer-Encoding: base64\r\n",
      ],
      'JPG image attachment part header' => [
        [
          'Content-ID' => '<ea5183a8aaaacf76b4676e33a7788cc4@test.example.com>',
          'ContentType' => 'image/jpeg; name="spruce.jpg"',
          'Content-Disposition' => 'attachment; filename="spruce.jpg"',
          'Content-Transfer-Encoding' => 'base64',
        ],
        "Content-ID: <ea5183a8aaaacf76b4676e33a7788cc4@test.example.com>\r\n" . "ContentType: image/jpeg; name=\"spruce.jpg\"\r\n" . "Content-Disposition: attachment; filename=\"spruce.jpg\"\r\n" . "Content-Transfer-Encoding: base64\r\n",
      ],
      'PDF file attachment part header' => [
        [
          'Content-ID' => '<3360eda02899acf5ec5965dbd6717332@test.example.com>',
          'ContentType' => 'application/pdf; name="Really_Long_Filename_That_Should_Be_Wrapped.pdf"',
          'Content-Disposition' => 'attachment; filename="Really_Long_Filename_That_Should_Be_Wrapped.pdf"',
          'Content-Transfer-Encoding' => 'base64',
        ],
        "Content-ID: <3360eda02899acf5ec5965dbd6717332@test.example.com>\r\n" . "ContentType: application/pdf;\r\n name=\"Really_Long_Filename_That_Should_Be_Wrapped.pdf\"\r\n" . "Content-Disposition: attachment;\r\n filename=\"Really_Long_Filename_That_Should_Be_Wrapped.pdf\"\r\n" . "Content-Transfer-Encoding: base64\r\n",
      ],
    ];
    return $headers;
  }

  /**
   * Tests the regular expression for extracting the mail address.
   *
   * @covers ::mimeMailHeaders
   */
  public function testHeaders() {
    $chars = [
      '-',
      '.',
      '+',
      '_',
    ];
    $name = $this
      ->randomString();
    $local = $this
      ->randomMachineName() . $chars[array_rand($chars)] . $this
      ->randomMachineName();
    $domain = $this
      ->randomMachineName() . '-' . $this
      ->randomMachineName() . '.' . $this
      ->randomMachineName(rand(2, 4));
    $headers = MimeMailFormatHelper::mimeMailHeaders([], "{$name} <{$local}@{$domain}>");
    $result = $headers['Return-Path'];
    $expected = "<{$local}@{$domain}>";
    $this
      ->assertSame($result, $expected, 'Return-Path header field correctly set.');
  }

}

Members

Namesort descending 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.
MimeMailFormatHelperTest::$adminUser protected property Administrator.
MimeMailFormatHelperTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
MimeMailFormatHelperTest::$userA protected property Authenticated user.
MimeMailFormatHelperTest::$userB protected property A different authenticated user.
MimeMailFormatHelperTest::providerAddress public function Provides test data for testAddress().
MimeMailFormatHelperTest::providerArrayOfAddresses public function Provides test data for testAddress().
MimeMailFormatHelperTest::providerAssociativeAddressArray public function Provides test data for testAddress().
MimeMailFormatHelperTest::providerRfcHeaders public function Provides test data for testRfcHeaders().
MimeMailFormatHelperTest::providerTestUrl public function Provides test data for testUrl().
MimeMailFormatHelperTest::setUp protected function Overrides KernelTestBase::setUp
MimeMailFormatHelperTest::testAddress public function Tests formatting an address string.
MimeMailFormatHelperTest::testAddressUserObject public function Tests MimeMailFormatHelper::mimeMailAddress() with user objects.
MimeMailFormatHelperTest::testHeaders public function Tests the regular expression for extracting the mail address.
MimeMailFormatHelperTest::testRfcHeaders public function Tests making headers RFC822-compliant.
MimeMailFormatHelperTest::testUrl public function Tests helper function for formatting URLs.
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.
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.