class SimplenewsSourceTest in Simplenews 8.2

Same name and namespace in other branches

3.x tests/src/Functional/SimplenewsSourceTest.php \Drupal\Tests\simplenews\Functional\SimplenewsSourceTest

Test cases for creating and sending newsletters.

@group simplenews

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\simplenews\Functional\SimplenewsTestBase uses AssertMailTrait, CronRunTrait
  - class \Drupal\Tests\simplenews\Functional\SimplenewsSourceTest

Expanded class hierarchy of SimplenewsSourceTest

File

tests/src/Functional/SimplenewsSourceTest.php, line 18

Namespace

Drupal\Tests\simplenews\Functional

View source

class SimplenewsSourceTest extends SimplenewsTestBase {

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

    // Create the filtered_html text format.
    $filtered_html_format = \Drupal::entityTypeManager()
      ->getStorage('filter_format')
      ->create([
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
      'weight' => 0,
      'filters' => [
        // URL filter.
        'filter_url' => [
          'weight' => 0,
          'status' => 1,
        ],
        // HTML filter.
        'filter_html' => [
          'weight' => 1,
          'status' => 1,
          'allowed-values' => '',
        ],
        // Line break filter.
        'filter_autop' => [
          'weight' => 2,
          'status' => 1,
        ],
        // HTML corrector filter.
        'filter_htmlcorrector' => [
          'weight' => 10,
          'status' => 1,
        ],
      ],
    ]);
    $filtered_html_format
      ->save();
    $admin_user = $this
      ->drupalCreateUser([
      '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.
   */
  public 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
      ->getMails();
    $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
      ->getMails();
    $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.
   */
  public function testSendCaching() {
    $this
      ->setUpSubscribers(100);
    $edit = [
      'title[0][value]' => $this
        ->randomString(10),
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue[target_id]' => 'default',
    ];
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertEqual(1, preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

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

    // Unsubscribe one of the recipients to make sure that they don'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
      ->getMails()));

    // Test that tokens are correctly replaced.
    foreach (array_slice($this
      ->getMails(), 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')) !== FALSE);

      // Make sure the mail has the correct unsubscribe hash.
      $hash = simplenews_generate_hash($mail['to'], 'remove');
      $this
        ->assertTrue(strpos($mail['body'], $hash) !== FALSE, 'Correct hash is used');
      $this
        ->assertTrue(strpos($mail['headers']['List-Unsubscribe'], $hash) !== FALSE, '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.', [
      '@sec' => round($after - $before, 3),
    ]));
  }

  /**
   * Send a newsletter with the HTML format.
   */
  public 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 = [
      '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 = [
      // Always use a character that is escaped.
      'title[0][value]' => $this
        ->randomString() . '\'<',
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue[target_id]' => 'default',
    ];
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertEqual(1, preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

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

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

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

    // Test that tokens are correctly replaced.
    foreach (array_slice($this
      ->getMails(), 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"') !== FALSE);

      // 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.
   */
  public function testSendHidden() {
    $this
      ->setUpSubscribers(5);

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

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

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

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

    // Test that tokens are correctly replaced.
    foreach (array_slice($this
      ->getMails(), 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.
   */
  public 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 = [
      'title[0][value]' => $this
        ->randomString(10),
      'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>",
      'simplenews_issue[target_id]' => 'default',
    ];
    $this
      ->drupalPostForm('node/add/simplenews_issue', $edit, 'Save');
    $this
      ->assertEqual(1, preg_match('|node/(\\d+)$|', $this
      ->getUrl(), $matches), 'Node created');
    $node = Node::load($matches[1]);

    // Add node to spool.
    \Drupal::service('simplenews.spool_storage')
      ->addIssue($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
      ->getMails()));

    // Test that tokens are correctly replaced.
    foreach (array_slice($this
      ->getMails(), 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.', [
      '@sec' => round($after - $before, 3),
    ]));
  }

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

    // Add node to spool.
    \Drupal::service('simplenews.spool_storage')
      ->addIssue($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
      ->getMails()));
    $spool_row = \Drupal::database()
      ->query('SELECT * FROM {simplenews_mail_spool}')
      ->fetchObject();
    $this
      ->assertEqual(SpoolStorageInterface::STATUS_SKIPPED, $spool_row->status);
  }

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

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

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

    // Make sure that no mails have been sent.
    $this
      ->assertEqual(0, count($this
      ->getMails()));
    $spool_row = \Drupal::database()
      ->query('SELECT * FROM {simplenews_mail_spool}')
      ->fetchObject();
    $this
      ->assertEqual(SpoolStorageInterface::STATUS_SKIPPED, $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]' => [
        'target_id' => 'default',
      ],
    ]);
    \Drupal::service('simplenews.spool_storage')
      ->addIssue($node);
    \Drupal::service('simplenews.mailer')
      ->sendSpool();
    $this
      ->assertEqual(0, count($this
      ->getMails()));
    $spool_row = \Drupal::database()
      ->select('simplenews_mail_spool', 'ms')
      ->fields('ms', [
      'status',
    ])
      ->execute()
      ->fetchAssoc();
    $this
      ->assertEqual(SpoolStorageInterface::STATUS_SKIPPED, $spool_row['status']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::assertCacheTag	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader	protected	function	Checks that current response header equals value.
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::assertLink	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.	1
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.	1
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.	1
AssertLegacyTrait::assertResponse	protected	function	Asserts the page responds with the specified response code.	1
AssertLegacyTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.	1
AssertLegacyTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent	protected	function	Gets the current raw content.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
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.
AssertMailTrait::verboseEmail	protected	function	Outputs to verbose the most recent $count emails sent.
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property
BrowserTestBase::$minkDefaultDriverClass	protected	property		1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated	protected	function	Returns all response headers.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct	public	function		1
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
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.
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.
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
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.
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	protected	function	Overrides SimplenewsTestBase::setUp
SimplenewsSourceTest::testSendCaching	public	function	Test sending a newsletter to 100 recipients with caching enabled.
SimplenewsSourceTest::testSendHidden	public	function	Send a issue with the newsletter set to hidden.
SimplenewsSourceTest::testSendHtml	public	function	Send a newsletter with the HTML format.
SimplenewsSourceTest::testSendMinimalSourceImplementation	public	function	Tests that sending a minimal implementation of the source interface works.
SimplenewsSourceTest::testSendMissingNode	public	function	Test sending when the issue node is missing.
SimplenewsSourceTest::testSendMissingSubscriber	public	function	Test sending when there are no subscribers.
SimplenewsSourceTest::testSendNoCaching	public	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::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
SimplenewsTestBase::$modules	public static	property	Modules to enable. Overrides BrowserTestBase::$modules	5
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	protected	function	Select randomly one of the available newsletters.
SimplenewsTestBase::randomEmail	protected	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	protected	function	Setup subscribers.
SimplenewsTestBase::setupSubscriptionBlock	protected	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.
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.
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.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	2
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	3
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
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. 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.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class SimplenewsSourceTest in Simplenews 8.2

Hierarchy

File

Namespace

Members

API Navigation