You are here

class SimplenewsSourceTest in Simplenews 8

Test cases for creating and sending newsletters.

@group simplenews

Hierarchy

Expanded class hierarchy of SimplenewsSourceTest

File

src/Tests/SimplenewsSourceTest.php, line 24
Simplenews source test functions.

Namespace

Drupal\simplenews\Tests
View source
class SimplenewsSourceTest extends SimplenewsTestBase {
  function setUp() {
    parent::setUp();

    // Create the filtered_html text format.
    $filtered_html_format = \Drupal::entityTypeManager()
      ->getStorage('filter_format')
      ->create(array(
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
      'weight' => 0,
      'filters' => array(
        // URL filter.
        'filter_url' => array(
          'weight' => 0,
          'status' => 1,
        ),
        // HTML filter.
        'filter_html' => array(
          'weight' => 1,
          'status' => 1,
          'allowed-values',
        ),
        // Line break filter.
        'filter_autop' => array(
          'weight' => 2,
          'status' => 1,
        ),
        // HTML corrector filter.
        'filter_htmlcorrector' => array(
          'weight' => 10,
          'status' => 1,
        ),
      ),
    ));
    $filtered_html_format
      ->save();
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer newsletters',
      'send newsletter',
      'administer nodes',
      'administer simplenews subscriptions',
      'create simplenews_issue content',
      'edit any simplenews_issue content',
      'view own unpublished content',
      'delete any simplenews_issue content',
      'administer simplenews settings',
      $filtered_html_format
        ->getPermissionName(),
    ));
    $this
      ->drupalLogin($admin_user);
  }

  /**
   * Tests that sending a minimal implementation of the source interface works.
   */
  function testSendMinimalSourceImplementation() {

    // Create a basic plaintext test source and send it.
    $plain_mail = new MailTest('plain');
    \Drupal::service('simplenews.mailer')
      ->sendMail($plain_mail);
    $mails = $this
      ->drupalGetMails();
    $mail = $mails[0];

    // Assert resulting mail.
    $this
      ->assertEqual('simplenews_node', $mail['id']);
    $this
      ->assertEqual('simplenews', $mail['module']);
    $this
      ->assertEqual('node', $mail['key']);
    $this
      ->assertEqual($plain_mail
      ->getRecipient(), $mail['to']);
    $this
      ->assertEqual($plain_mail
      ->getFromAddress(), $mail['from']);
    $this
      ->assertEqual($plain_mail
      ->getFromFormatted(), $mail['reply-to']);
    $this
      ->assertEqual($plain_mail
      ->getLanguage(), $mail['langcode']);
    $this
      ->assertTrue($mail['params']['plain']);
    $this
      ->assertFalse(isset($mail['params']['plaintext']));
    $this
      ->assertFalse(isset($mail['params']['attachments']));
    $this
      ->assertEqual($plain_mail
      ->getSubject(), $mail['subject']);
    $this
      ->assertTrue(strpos($mail['body'], 'the plain body') !== FALSE);
    $html_mail = new MailTest('html');
    \Drupal::service('simplenews.mailer')
      ->sendMail($html_mail);
    $mails = $this
      ->drupalGetMails();
    $mail = $mails[1];

    // Assert resulting mail.
    $this
      ->assertEqual('simplenews_node', $mail['id']);
    $this
      ->assertEqual('simplenews', $mail['module']);
    $this
      ->assertEqual('node', $mail['key']);
    $this
      ->assertEqual($plain_mail
      ->getRecipient(), $mail['to']);
    $this
      ->assertEqual($plain_mail
      ->getFromAddress(), $mail['from']);
    $this
      ->assertEqual($plain_mail
      ->getFromFormatted(), $mail['reply-to']);
    $this
      ->assertEqual($plain_mail
      ->getLanguage(), $mail['langcode']);
    $this
      ->assertEqual(NULL, $mail['params']['plain']);
    $this
      ->assertTrue(isset($mail['params']['plaintext']));
    $this
      ->assertTrue(strpos($mail['params']['plaintext'], 'the plain body') !== FALSE);
    $this
      ->assertTrue(isset($mail['params']['attachments']));
    $this
      ->assertEqual('example://test.png', $mail['params']['attachments'][0]['uri']);
    $this
      ->assertEqual($plain_mail
      ->getSubject(), $mail['subject']);
    $this
      ->assertTrue(strpos($mail['body'], 'the body') !== FALSE);
  }

  /**
   * Test sending a newsletter to 100 recipients with caching enabled.
   */
  function testSendCaching() {
    $this
      ->setUpSubscribers(100);
    $edit = array(
      'title[0][value]' => $this
        ->randomString(10),
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue' => 'default',
    );
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertTrue(preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

    // Add node to spool.
    \Drupal::service('simplenews.spool_storage')
      ->addFromEntity($node);

    // Unsubscribe one of the recipients to make sure that he doesn't receive
    // the mail.
    \Drupal::service('simplenews.subscription_manager')
      ->unsubscribe(array_shift($this->subscribers), $this
      ->getRandomNewsletter(), FALSE, 'test');
    $before = microtime(TRUE);
    \Drupal::service('simplenews.mailer')
      ->sendSpool();
    $after = microtime(TRUE);

    // Make sure that 99 mails have been sent.
    $this
      ->assertEqual(99, count($this
      ->drupalGetMails()));

    // Test that tokens are correctly replaced.
    foreach (array_slice($this
      ->drupalGetMails(), 0, 3) as $mail) {

      // Make sure that the same mail was used in the body token as it has been
      // sent to. Also verify that the mail is plaintext.
      $this
        ->assertTrue(strpos($mail['body'], '*' . $mail['to'] . '*') !== FALSE);
      $this
        ->assertFalse(strpos($mail['body'], '<strong>'));

      // Make sure the body is only attached once.
      $this
        ->assertEqual(1, preg_match_all('/Mail token/', $mail['body'], $matches));
      $this
        ->assertTrue(strpos($mail['body'], (string) t('Unsubscribe from this newsletter')));

      // Make sure the mail has the correct unsubscribe hash.
      $hash = simplenews_generate_hash($mail['to'], 'remove');
      $this
        ->assertTrue(strpos($mail['body'], $hash), 'Correct hash is used');
      $this
        ->assertTrue(strpos($mail['headers']['List-Unsubscribe'], $hash), 'Correct hash is used in header');
    }

    // Report time. @todo: Find a way to actually do some assertions here.
    $this
      ->pass(t('Mails have been sent in @sec seconds with build caching enabled.', array(
      '@sec' => round($after - $before, 3),
    )));
  }

  /**
   * Send a newsletter with the HTML format.
   */
  function testSendHTML() {
    $this
      ->setUpSubscribers(5);

    // Use custom testing mail system to support HTML mails.
    $mail_config = $this
      ->config('system.mail');
    $mail_config
      ->set('interface.default', 'test_simplenews_html_mail');
    $mail_config
      ->save();

    // Set the format to HTML.
    $this
      ->drupalGet('admin/config/services/simplenews');
    $this
      ->clickLink(t('Edit'));
    $edit_newsletter = array(
      'format' => 'html',
      // Use umlaut to provoke mime encoding.
      'from_name' => 'Drupäl',
      // @todo: This shouldn't be necessary, default value is missing. Probably
      // should not be required.
      'from_address' => $this
        ->randomEmail(),
      // Request a confirmation receipt.
      'receipt' => TRUE,
    );
    $this
      ->drupalPostForm(NULL, $edit_newsletter, t('Save'));
    $this
      ->clickLink(t('Edit'));
    $edit = array(
      // Always use a character that is escaped.
      'title[0][value]' => $this
        ->randomString() . '\'<',
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue' => 'default',
    );
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertTrue(preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

    // Add node to spool.
    \Drupal::service('simplenews.spool_storage')
      ->addFromEntity($node);

    // Send mails.
    \Drupal::service('simplenews.mailer')
      ->sendSpool();

    // Make sure that 5 mails have been sent.
    $this
      ->assertEqual(5, count($this
      ->drupalGetMails()));

    // Test that tokens are correctly replaced.
    foreach (array_slice($this
      ->drupalGetMails(), 0, 3) as $mail) {

      // Verify title.
      preg_match('|<h2>(.*)</h2>|', $mail['body'], $matches);
      $this
        ->assertEqual(Html::decodeEntities($matches[1]), $node
        ->getTitle());

      // Verify the format/content type.
      $this
        ->assertEqual($mail['params']['format'], 'text/html');
      $this
        ->assertEqual($mail['params']['plain'], NULL);
      $this
        ->assertEqual($mail['headers']['Content-Type'], 'text/html; charset=UTF-8');

      // Make sure that the same mail was used in the body token as it has been
      // sent to.
      $this
        ->assertTrue(strpos($mail['body'], '<strong>' . $mail['to'] . '</strong>') !== FALSE);

      // Make sure the body is only attached once.
      $this
        ->assertEqual(1, preg_match_all('/Mail token/', $mail['body'], $matches));

      // Check the plaintext version, both params][plaintext (Mime Mail) and
      // plain (Swiftmailer).
      $this
        ->assertTrue(strpos($mail['params']['plaintext'], $mail['to']) !== FALSE);
      $this
        ->assertFalse(strpos($mail['params']['plaintext'], '<strong>'));
      $this
        ->assertEqual($mail['params']['plaintext'], $mail['plain']);

      // Make sure the body is only attached once.
      $this
        ->assertEqual(1, preg_match_all('/Mail token/', $mail['params']['plaintext'], $matches));

      // Check the attachments and files arrays.
      $this
        ->assertTrue(is_array($mail['params']['attachments']));
      $this
        ->assertEqual($mail['params']['attachments'], $mail['params']['files']);

      // Make sure formatted address is properly encoded.
      $from = '"' . addslashes(Unicode::mimeHeaderEncode($edit_newsletter['from_name'])) . '" <' . $edit_newsletter['from_address'] . '>';
      $this
        ->assertEqual($from, $mail['reply-to']);

      // And make sure it won't get encoded twice.
      $this
        ->assertEqual($from, Unicode::mimeHeaderEncode($mail['reply-to']));

      // @todo: Improve this check, there are currently two spaces, not sure
      // where they are coming from.
      $this
        ->assertTrue(strpos($mail['body'], 'class="newsletter-footer"'));

      // Verify receipt headers.
      $this
        ->assertEqual($mail['headers']['Disposition-Notification-To'], $edit_newsletter['from_address']);
      $this
        ->assertEqual($mail['headers']['X-Confirm-Reading-To'], $edit_newsletter['from_address']);
    }
  }

  /**
   * Send a issue with the newsletter set to hidden.
   */
  function testSendHidden() {
    $this
      ->setUpSubscribers(5);

    // Set the format to HTML.
    $this
      ->drupalGet('admin/config/services/simplenews');
    $this
      ->clickLink(t('Edit'));
    $edit = array(
      'opt_inout' => 'hidden',
      // @todo: This shouldn't be necessary.
      'from_address' => $this
        ->randomEmail(),
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $edit = array(
      'title[0][value]' => $this
        ->randomString(10),
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue' => 'default',
    );
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertTrue(preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

    // Add node to spool.
    \Drupal::service('simplenews.spool_storage')
      ->addFromEntity($node);

    // Send mails.
    \Drupal::service('simplenews.mailer')
      ->sendSpool();

    // Make sure that 5 mails have been sent.
    $this
      ->assertEqual(5, count($this
      ->drupalGetMails()));

    // Test that tokens are correctly replaced.
    foreach (array_slice($this
      ->drupalGetMails(), 0, 3) as $mail) {

      // Verify the unsubscribe link is not displayed for hidden newsletters.
      $this
        ->assertFalse(strpos($mail['body'], (string) t('Unsubscribe from this newsletter')));
    }
  }

  /**
   * Test with disabled caching.
   */
  function testSendNoCaching() {
    $this
      ->setUpSubscribers(100);

    // Disable caching.
    $yaml = new Yaml();
    $directory = DRUPAL_ROOT . '/' . $this->siteDirectory;
    $content = file_get_contents($directory . '/services.yml');
    $services = $yaml
      ->parse($content);
    $services['services']['simplenews.mail_cache'] = [
      'class' => 'Drupal\\simplenews\\Mail\\MailCacheNone',
    ];
    file_put_contents($directory . '/services.yml', $yaml
      ->dump($services));
    $this
      ->rebuildContainer();
    \Drupal::moduleHandler()
      ->loadAll();
    $edit = array(
      'title[0][value]' => $this
        ->randomString(10),
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue' => 'default',
    );
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertTrue(preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

    // Add node to spool.
    \Drupal::service('simplenews.spool_storage')
      ->addFromEntity($node);
    $before = microtime(TRUE);
    \Drupal::service('simplenews.mailer')
      ->sendSpool();
    $after = microtime(TRUE);

    // Make sure that 100 mails have been sent.
    $this
      ->assertEqual(100, count($this
      ->drupalGetMails()));

    // Test that tokens are correctly replaced.
    foreach (array_slice($this
      ->drupalGetMails(), 0, 3) as $mail) {

      // Make sure that the same mail was used in the body token as it has been
      // sent to. Also verify that the mail is plaintext.
      $this
        ->assertTrue(strpos($mail['body'], '*' . $mail['to'] . '*') !== FALSE);
      $this
        ->assertFalse(strpos($mail['body'], '<strong>'));

      // Make sure the body is only attached once.
      $this
        ->assertEqual(1, preg_match_all('/Mail token/', $mail['body'], $matches));
    }

    // Report time. @todo: Find a way to actually do some assertions here.
    $this
      ->pass(t('Mails have been sent in @sec seconds with caching disabled.', array(
      '@sec' => round($after - $before, 3),
    )));
  }

  /**
   * Test sending when the issue node is missing.
   */
  function testSendMissingNode() {
    $this
      ->setUpSubscribers(1);
    $edit = array(
      'title[0][value]' => $this
        ->randomString(10),
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue' => 'default',
    );
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertTrue(preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

    // Add node to spool.
    \Drupal::service('simplenews.spool_storage')
      ->addFromEntity($node);

    // Delete the node manually in the database.
    \Drupal::database()
      ->delete('node')
      ->condition('nid', $node
      ->id())
      ->execute();
    \Drupal::database()
      ->delete('node_revision')
      ->condition('nid', $node
      ->id())
      ->execute();
    \Drupal::entityTypeManager()
      ->getStorage('node')
      ->resetCache();
    \Drupal::service('simplenews.mailer')
      ->sendSpool();

    // Make sure that no mails have been sent.
    $this
      ->assertEqual(0, count($this
      ->drupalGetMails()));
    $spool_row = \Drupal::database()
      ->query('SELECT * FROM {simplenews_mail_spool}')
      ->fetchObject();
    $this
      ->assertEqual(SpoolStorageInterface::STATUS_DONE, $spool_row->status);
  }

  /**
   * Test sending when there are no subscribers.
   */
  function testSendMissingSubscriber() {
    $this
      ->setUpSubscribers(1);
    $edit = array(
      'title[0][value]' => $this
        ->randomString(10),
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue' => 'default',
    );
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertTrue(preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

    // Add node to spool.
    \Drupal::service('simplenews.spool_storage')
      ->addFromEntity($node);

    // Delete the subscriber.
    $subscriber = simplenews_subscriber_load_by_mail(reset($this->subscribers));
    $subscriber
      ->delete();
    \Drupal::service('simplenews.mailer')
      ->sendSpool();

    // Make sure that no mails have been sent.
    $this
      ->assertEqual(0, count($this
      ->drupalGetMails()));
    $spool_row = \Drupal::database()
      ->query('SELECT * FROM {simplenews_mail_spool}')
      ->fetchObject();
    $this
      ->assertEqual(SpoolStorageInterface::STATUS_DONE, $spool_row->status);
  }

  /**
   * Test handling of the skip exception.
   */
  public function testSkip() {
    $this
      ->setUpSubscribers(1);

    // Setting the body to "Nothing interesting" provokes an exception in
    // simplenews_test_mail_alter().
    $node = $this
      ->drupalCreateNode([
      'body' => 'Nothing interesting',
      'type' => 'simplenews_issue',
      'simplenews_issue' => [
        'target_id' => 'default',
      ],
    ]);
    \Drupal::service('simplenews.spool_storage')
      ->addFromEntity($node);
    \Drupal::service('simplenews.mailer')
      ->sendSpool();
    $this
      ->assertEqual(0, count($this
      ->drupalGetMails()));
    $spool_row = \Drupal::database()
      ->select('simplenews_mail_spool', 'ms')
      ->fields('ms', [
      'status',
    ])
      ->execute()
      ->fetchAssoc();
    $this
      ->assertEqual(SpoolStorageInterface::STATUS_SKIPPED, $spool_row['status']);
  }

}

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.
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. Aliased as: drupalGetMails
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::debugCacheTags protected function Provides debug information for cache tags.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
CronRunTrait::cronRun protected function Runs cron on the test site.
EntityViewTrait::buildEntityView protected function Builds the renderable view of an entity. Aliased as: drupalBuildEntityView
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
GeneratePermutationsTrait::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
SimplenewsSourceTest::setUp function Sets up a Drupal site for running functional and integration tests. Overrides SimplenewsTestBase::setUp
SimplenewsSourceTest::testSendCaching function Test sending a newsletter to 100 recipients with caching enabled.
SimplenewsSourceTest::testSendHidden function Send a issue with the newsletter set to hidden.
SimplenewsSourceTest::testSendHTML function Send a newsletter with the HTML format.
SimplenewsSourceTest::testSendMinimalSourceImplementation function Tests that sending a minimal implementation of the source interface works.
SimplenewsSourceTest::testSendMissingNode function Test sending when the issue node is missing.
SimplenewsSourceTest::testSendMissingSubscriber function Test sending when there are no subscribers.
SimplenewsSourceTest::testSendNoCaching function Test with disabled caching.
SimplenewsSourceTest::testSkip public function Test handling of the skip exception.
SimplenewsTestBase::$config protected property The Simplenews settings config object.
SimplenewsTestBase::$modules public static property Modules to enable. 4
SimplenewsTestBase::addField protected function Creates and saves a field storage and instance.
SimplenewsTestBase::assertMailText protected function Checks if a string is found in the latest sent mail.
SimplenewsTestBase::getLatestSubscriber protected function Returns the last created Subscriber.
SimplenewsTestBase::getMail protected function Returns the body content of mail that has been sent.
SimplenewsTestBase::getRandomNewsletter function Select randomly one of the available newsletters.
SimplenewsTestBase::randomEmail function Generates a random email address.
SimplenewsTestBase::registerUser protected function Visits and submits the user registration form.
SimplenewsTestBase::resetPassLogin protected function Login a user, resetting their password.
SimplenewsTestBase::setUpSubscribers function
SimplenewsTestBase::setupSubscriptionBlock function Enable newsletter subscription block.
SimplenewsTestBase::subscribe protected function Visits and submits a newsletter management form.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$results public property Current results of this test case.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::checkRequirements protected function Checks the matching requirements for Test. 1
TestBase::checkTestHierarchyMismatch public function Fail the test if it belongs to a PHPUnit-based framework.
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert Deprecated public static function Store an assertion from outside the testing context. 1
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests. Overrides TestSetupTrait::prepareDatabasePrefix
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 2
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database. 1
TestBase::verbose protected function Logs a verbose message in a text file.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name. Aliased as: drupalCompareFiles
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
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.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. 1
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 2
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code. 1
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 1
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header. 1
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. 1
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 1
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::__construct public function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.