SimplenewsSubscribeTest.php in Simplenews 8

Simplenews subscribe test functions.

Namespace

Drupal\simplenews\Tests

File

src/Tests/SimplenewsSubscribeTest.php

<?php

/**
 * @file
 * Simplenews subscribe test functions.
 *
 * @ingroup simplenews
 */
namespace Drupal\simplenews\Tests;

use Drupal\Core\Url;

/**
 * (un)subscription of anonymous and authenticated users.
 *
 * Subscription via block, subscription page and account page
 *
 * @group simplenews
 */
class SimplenewsSubscribeTest extends SimplenewsTestBase {

  /**
   * Subscribe to multiple newsletters at the same time.
   */
  function testSubscribeMultiple() {
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer blocks',
      'administer content types',
      'administer nodes',
      'access administration pages',
      'administer permissions',
      'administer newsletters',
      'administer simplenews subscriptions',
    ));
    $this
      ->drupalLogin($admin_user);
    $this
      ->drupalGet('admin/config/services/simplenews');
    for ($i = 0; $i < 5; $i++) {
      $this
        ->clickLink(t('Add newsletter'));
      $name = $this
        ->randomMachineName();
      $edit = array(
        'name' => $name,
        'id' => strtolower($name),
        'description' => $this
          ->randomString(20),
        'opt_inout' => 'double',
      );
      $this
        ->drupalPostForm(NULL, $edit, t('Save'));
    }
    $newsletters = simplenews_newsletter_get_all();
    $this
      ->drupalLogout();
    $enable = array_rand($newsletters, 3);
    $mail = $this
      ->randomEmail(8);
    $edit = array(
      'mail[0][value]' => $mail,
    );
    foreach ($enable as $newsletter_id) {
      $edit['subscriptions[' . $newsletter_id . ']'] = TRUE;
    }
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'), t('Subscription confirmation e-mail sent.'));

    // Verify listed changes.
    foreach ($newsletters as $newsletter_id => $newsletter) {
      $this
        ->assertMailText(t('Subscribe to @name', array(
        '@name' => $newsletter->name,
      )), 0, in_array($newsletter_id, $enable));
    }
    $mails = $this
      ->drupalGetMails();
    $this
      ->assertEqual($mails[0]['from'], '[e-mail]');
    $this
      ->assertEqual($mails[0]['headers']['From'], '"Drupal" <[e-mail]>');
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(0));
    $this
      ->drupalGet($confirm_url);
    $this
      ->assertRaw(t('Are you sure you want to confirm the following subscription changes for %user?', array(
      '%user' => simplenews_mask_mail($mail),
    )), t('Subscription confirmation found.'));

    // Verify listed changes.
    foreach ($newsletters as $newsletter_id => $newsletter) {
      if (in_array($newsletter_id, $enable)) {
        $this
          ->assertText(t('Subscribe to @name', array(
          '@name' => $newsletter->name,
        )));
      }
      else {
        $this
          ->assertNoText(t('Subscribe to @name', array(
          '@name' => $newsletter->name,
        )));
      }
    }
    $this
      ->drupalPostForm($confirm_url, array(), t('Confirm'));
    $this
      ->assertRaw(t('Subscription changes confirmed for %user.', array(
      '%user' => $mail,
    )), t('Anonymous subscriber added to newsletter'));

    /** @var \Drupal\simplenews\Subscription\SubscriptionManagerInterface $subscription_manager */
    $subscription_manager = \Drupal::service('simplenews.subscription_manager');
    $subscription_manager
      ->reset();
    $subscriber_storage = \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber');
    $subscriber_storage
      ->resetCache();

    // Verify subscription changes.
    foreach ($newsletters as $newsletter_id => $newsletter) {
      $is_subscribed = $subscription_manager
        ->isSubscribed($mail, $newsletter_id);
      $subscription_newsletter = $subscriber_storage
        ->getSubscriptionsByNewsletter($newsletter_id);
      if (in_array($newsletter_id, $enable)) {
        $this
          ->assertTrue($is_subscribed);
        $this
          ->assertEqual(1, count($subscription_newsletter));
      }
      else {
        $this
          ->assertFalse($is_subscribed);
        $this
          ->assertEqual(0, count($subscription_newsletter));
      }
    }

    // Go to the manage page and submit without changes.
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $hash = simplenews_generate_hash($subscriber
      ->getMail(), 'manage');
    $this
      ->drupalPostForm('newsletter/subscriptions/' . $subscriber
      ->id() . '/' . REQUEST_TIME . '/' . $hash, array(), t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', array(
      '@mail' => $mail,
    )));
    $this
      ->assertEqual(1, count($this
      ->drupalGetMails()), t('No confirmation mails have been sent.'));

    // Unsubscribe from two of the three enabled newsletters.
    $disable = array_rand(array_flip($enable), 2);
    $edit = array(
      'mail[0][value]' => $mail,
    );
    foreach ($disable as $newsletter_id) {
      $edit['subscriptions[' . $newsletter_id . ']'] = TRUE;
    }
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Unsubscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to cancel your subscription.'), t('Subscription confirmation e-mail sent.'));

    // Unsubscribe with no confirmed email.
    $subscription_manager = \Drupal::service('simplenews.subscription_manager');
    try {
      $subscription_manager
        ->unsubscribe('[e-mail]', $newsletter_id, FALSE);
      $this
        ->fail('Exception not thrown.');
    } catch (\Exception $e) {
      $this
        ->assertEqual($e
        ->getMessage(), 'The subscriber does not exist.');
    }

    // Verify listed changes.
    foreach ($newsletters as $newsletter_id => $newsletter) {
      $this
        ->assertMailText(t('Unsubscribe from @name', array(
        '@name' => $newsletter->name,
      )), 1, in_array($newsletter_id, $disable));
    }
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(1));
    $this
      ->drupalGet($confirm_url);
    $this
      ->assertRaw(t('Are you sure you want to confirm the following subscription changes for %user?', array(
      '%user' => simplenews_mask_mail($mail),
    )), t('Subscription confirmation found.'));

    // Verify listed changes.
    foreach ($newsletters as $newsletter_id => $newsletter) {
      if (in_array($newsletter_id, $disable)) {
        $this
          ->assertText(t('Unsubscribe from @name', array(
          '@name' => $newsletter->name,
        )));
      }
      else {
        $this
          ->assertNoText(t('Unsubscribe from @name', array(
          '@name' => $newsletter->name,
        )));
      }
    }
    $this
      ->drupalPostForm($confirm_url, array(), t('Confirm'));
    $this
      ->assertRaw(t('Subscription changes confirmed for %user.', array(
      '%user' => $mail,
    )), t('Anonymous subscriber added to newsletter'));

    // Verify subscription changes.
    $subscriber_storage
      ->resetCache();
    $subscription_manager
      ->reset();
    $still_enabled = array_diff($enable, $disable);
    foreach ($newsletters as $newsletter_id => $newsletter) {
      $is_subscribed = $subscription_manager
        ->isSubscribed($mail, $newsletter_id);
      if (in_array($newsletter_id, $still_enabled)) {
        $this
          ->assertTrue($is_subscribed);
      }
      else {
        $this
          ->assertFalse($is_subscribed);
      }
    }

    // Make sure that a single change results in a non-multi confirmation mail.
    $newsletter_id = reset($disable);
    $edit = array(
      'mail[0][value]' => $mail,
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $this
      ->getMail(2);

    // Load simplenews settings config object.
    $config = $this
      ->config('simplenews.settings');

    // Change behavior to always use combined mails.
    $config
      ->set('subscription.use_combined', 'always');
    $config
      ->save();
    $edit = array(
      'mail[0][value]' => $mail,
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $this
      ->getMail(3);

    // Change behavior to never, should send two separate mails.
    $config
      ->set('subscription.use_combined', 'never');
    $config
      ->save();
    $edit = array(
      'mail[0][value]' => $mail,
    );
    foreach ($disable as $newsletter_id) {
      $edit['subscriptions[' . $newsletter_id . ']'] = TRUE;
    }
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'), t('Subscription confirmation e-mail sent.'));
    $this
      ->extractConfirmationLink($this
      ->getMail(4));
    $this
      ->extractConfirmationLink($this
      ->getMail(5));

    // Make sure that the /ok suffix works, unsubscribe from everything.
    $config
      ->set('subscription.use_combined', 'multiple');
    $config
      ->save();
    $edit = array(
      'mail[0][value]' => $mail,
    );
    foreach (array_keys($newsletters) as $newsletter_id) {
      $edit['subscriptions[' . $newsletter_id . ']'] = TRUE;
    }
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Unsubscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to cancel your subscription.'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(6));
    $this
      ->drupalGet($confirm_url);
    $this
      ->drupalGet($confirm_url . '/ok');
    $this
      ->assertRaw(t('Subscription changes confirmed for %user.', array(
      '%user' => $mail,
    )), t('Confirmation message displayed.'));

    // Verify subscription changes.
    $subscriber_storage
      ->resetCache();
    $subscription_manager
      ->reset();
    foreach (array_keys($newsletters) as $newsletter_id) {
      $this
        ->assertFalse($subscription_manager
        ->isSubscribed($mail, $newsletter_id));
    }

    // Call confirmation url after it is allready used.
    // Using direct url.
    $this
      ->drupalGet($confirm_url . '/ok');
    $this
      ->assertNoResponse(404, 'Redirected after calling confirmation url more than once.');
    $this
      ->assertRaw(t('All changes to your subscriptions where already applied. No changes made.'));

    // Using confirmation page.
    $this
      ->drupalGet($confirm_url);
    $this
      ->assertNoResponse(404, 'Redirected after calling confirmation url more than once.');
    $this
      ->assertRaw(t('All changes to your subscriptions where already applied. No changes made.'));

    // Test expired confirmation links.
    $enable = array_rand($newsletters, 3);
    $mail = $this
      ->randomEmail(8);
    $edit = array(
      'mail[0][value]' => $mail,
    );
    foreach ($enable as $newsletter_id) {
      $edit['subscriptions[' . $newsletter_id . ']'] = TRUE;
    }
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $expired_timestamp = REQUEST_TIME - 86401;
    $changes = $subscriber
      ->getChanges();
    $hash = simplenews_generate_hash($subscriber
      ->getMail(), 'combined' . serialize($subscriber
      ->getChanges()), $expired_timestamp);
    $url = 'newsletter/confirm/combined/' . $subscriber
      ->id() . '/' . $expired_timestamp . '/' . $hash;
    $this
      ->drupalGet($url);
    $this
      ->assertText(t('This link has expired.'));
    $this
      ->drupalPostForm(NULL, array(), t('Request new confirmation mail'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(8));

    // Verify listed changes.
    foreach ($newsletters as $newsletter_id => $newsletter) {
      $this
        ->assertMailText(t('Subscribe to @name', array(
        '@name' => $newsletter->name,
      )), 8, in_array($newsletter_id, $enable));
    }
    $this
      ->drupalGet($confirm_url);
    $this
      ->assertRaw(t('Are you sure you want to confirm the following subscription changes for %user?', array(
      '%user' => simplenews_mask_mail($mail),
    )), t('Subscription confirmation found.'));

    // Verify listed changes.
    foreach ($newsletters as $newsletter_id => $newsletter) {
      if (in_array($newsletter_id, $enable)) {
        $this
          ->assertText(t('Subscribe to @name', array(
          '@name' => $newsletter->name,
        )));
      }
      else {
        $this
          ->assertNoText(t('Subscribe to @name', array(
          '@name' => $newsletter->name,
        )));
      }
    }
    $this
      ->drupalPostForm($confirm_url, array(), t('Confirm'));
    $this
      ->assertRaw(t('Subscription changes confirmed for %user.', array(
      '%user' => $mail,
    )), t('Anonymous subscriber added to newsletter'));
  }

  /**
   * Extract a confirmation link from a mail body.
   */
  function extractConfirmationLink($body) {
    $pattern = '@newsletter/confirm/.+@';
    preg_match($pattern, $body, $match);
    $found = preg_match($pattern, $body, $match);
    if (!$found) {
      $this
        ->fail('Confirmation URL found.');
      return FALSE;
    }
    $confirm_url = $match[0];
    $this
      ->pass(t('Confirmation URL found: @url', array(
      '@url' => $confirm_url,
    )));
    return $confirm_url;
  }

  /**
   * testSubscribeAnonymous
   *
   * Steps performed:
   *   0. Preparation
   *   1. Subscribe anonymous via block
   *   2. Subscribe anonymous via subscription page
   *   3. Subscribe anonymous via multi block
   */
  function testSubscribeAnonymous() {

    // 0. Preparation
    // Login admin
    // Set permission for anonymous to subscribe
    // Enable newsletter block
    // Logout admin
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer blocks',
      'administer content types',
      'administer nodes',
      'access administration pages',
      'administer newsletters',
      'administer permissions',
    ));
    $this
      ->drupalLogin($admin_user);

    // Create some newsletters for multi-sign up block.
    $this
      ->drupalGet('admin/config/services/simplenews');
    for ($i = 0; $i < 5; $i++) {
      $this
        ->clickLink(t('Add newsletter'));
      $name = $this
        ->randomMachineName();
      $edit = array(
        'name' => $name,
        'id' => strtolower($name),
        'description' => $this
          ->randomString(20),
        'opt_inout' => 'double',
      );
      $this
        ->drupalPostForm(NULL, $edit, t('Save'));
    }
    $newsletter_id = $this
      ->getRandomNewsletter();
    $this
      ->drupalLogout();

    //file_put_contents('output.html', $this->drupalGetContent());

    // 1. Subscribe anonymous via block
    // Subscribe + submit
    // Assert confirmation message
    // Assert outgoing email
    //
    // Confirm using mail link
    // Confirm using mail link
    // Assert confirmation message
    // Setup subscription block with subscription form.
    $block_settings = array(
      'newsletters' => array(
        $newsletter_id,
      ),
      'message' => $this
        ->randomMachineName(4),
    );
    $single_block = $this
      ->setupSubscriptionBlock($block_settings);

    // Testing invalid email error message.
    $mail = '@example.com';
    $edit = array(
      'mail[0][value]' => $mail,
    );
    $this
      ->drupalPostForm('', $edit, t('Subscribe'));
    $this
      ->assertText(t("The email address {$mail} is not valid"), t("Invalid email shows error."));

    // Now with valid email.
    $mail = $this
      ->randomEmail(8);
    $edit = array(
      'mail[0][value]' => $mail,
    );
    $this
      ->drupalPostForm('', $edit, t('Subscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'), t('Subscription confirmation e-mail sent.'));
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $this
      ->assertNotNull($subscriber, 'New subscriber entity successfully loaded.');
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_UNCONFIRMED, $subscription->status, t('Subscription is unconfirmed'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(0));
    $this
      ->drupalGet($confirm_url);
    $newsletter = simplenews_newsletter_load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array(
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    )), t('Subscription confirmation found.'));
    $this
      ->drupalPostForm(NULL, array(), t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', array(
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    )), t('Anonymous subscriber added to newsletter'));
    $this
      ->assertUrl(new Url('<front>'));

    // Test that it is possible to register with a mail address that is already
    // a subscriber.
    $site_config = $this
      ->config('user.settings');
    $site_config
      ->set('register', 'visitors');
    $site_config
      ->set('verify_mail', false);
    $site_config
      ->save();
    $edit = array(
      'name' => $this
        ->randomMachineName(),
      'mail' => $mail,
      'pass[pass1]' => $pass = $this
        ->randomMachineName(),
      'pass[pass2]' => $pass,
    );
    $this
      ->drupalPostForm('user/register', $edit, t('Create new account'));

    // Verify confirmation messages.
    $this
      ->assertText(t('Registration successful. You are now logged in.'));

    // Verify that the subscriber has been updated and references to the correct
    // user.
    \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber')
      ->resetCache();
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $account = user_load_by_mail($mail);
    $this
      ->assertEqual($subscriber
      ->getUserId(), $account
      ->id());
    $this
      ->assertEqual($account
      ->getUsername(), $edit['name']);
    $this
      ->drupalLogout();

    // Disable the newsletter block.
    $single_block
      ->delete();

    // 2. Subscribe anonymous via subscription page
    // Subscribe + submit
    // Assert confirmation message
    // Assert outgoing email
    //
    // Confirm using mail link
    // Confirm using mail link
    // Assert confirmation message
    $mail = $this
      ->randomEmail(8);
    $edit = array(
      "subscriptions[{$newsletter_id}]" => '1',
      'mail[0][value]' => $mail,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'), t('Subscription confirmation e-mail sent.'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(2));
    $this
      ->drupalGet($confirm_url);
    $newsletter = simplenews_newsletter_load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array(
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    )), t('Subscription confirmation found.'));
    $this
      ->drupalPostForm($confirm_url, array(), t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', array(
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    )), t('Anonymous subscriber added to newsletter'));

    // 3. Subscribe anonymous via multi block
    // Setup subscription block with subscription form.
    $block_settings = array(
      'newsletters' => array_keys(simplenews_newsletter_get_all()),
      'message' => $this
        ->randomMachineName(4),
    );
    $multi_block = $this
      ->setupSubscriptionBlock($block_settings);

    // Try to submit multi-signup form without selecting a newsletter.
    $mail = $this
      ->randomEmail(8);
    $edit = array(
      'mail[0][value]' => $mail,
    );
    $this
      ->drupalPostForm('', $edit, t('Subscribe'));
    $this
      ->assertText(t('You must select at least one newsletter.'));

    // Now fill out the form and try again. The e-mail should still be listed.
    $edit = array(
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Subscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(3));
    $this
      ->drupalGet($confirm_url);
    $newsletter = simplenews_newsletter_load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array(
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    )), t('Subscription confirmation found.'));
    $this
      ->drupalPostForm($confirm_url, array(), t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', array(
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    )), t('Anonymous subscriber added to newsletter'));

    // Try to subscribe again, this should not re-set the status to unconfirmed.
    $edit = array(
      'mail[0][value]' => $mail,
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Subscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'));
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $this
      ->assertNotEqual($subscriber, FALSE, 'New subscriber entity successfully loaded.');
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);

    // Now the same with the newsletter/subscriptions page.
    $mail = $this
      ->randomEmail(8);
    $edit = array(
      'mail[0][value]' => $mail,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $this
      ->assertText(t('You must select at least one newsletter.'));

    // Now fill out the form and try again.
    $edit = array(
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Subscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(5));
    $this
      ->drupalGet($confirm_url);
    $newsletter = simplenews_newsletter_load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array(
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    )), t('Subscription confirmation found.'));
    $this
      ->drupalPostForm($confirm_url, array(), t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', array(
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    )), t('Anonymous subscriber added to newsletter'));

    // Test unsubscribe on newsletter/subscriptions page.
    $edit = array(
      'mail[0][value]' => $mail,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Unsubscribe'));
    $this
      ->assertText(t('You must select at least one newsletter.'));

    // Now fill out the form and try again.
    $edit = array(
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Unsubscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to cancel your subscription.'));
    $this
      ->assertMailText(t('We have received a request to remove the @mail', array(
      '@mail' => $mail,
    )), 6);
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(6));
    $mails = $this
      ->drupalGetMails();
    $this
      ->assertEqual($mails[0]['from'], '[e-mail]');
    $this
      ->assertEqual($mails[0]['headers']['From'], '"Drupal" <[e-mail]>');
    $this
      ->drupalGet($confirm_url);
    $newsletter = simplenews_newsletter_load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to remove %user from the %newsletter mailing list?', array(
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    )), t('Subscription confirmation found.'));
    $this
      ->drupalPostForm($confirm_url, array(), t('Unsubscribe'));
    $this
      ->assertRaw(t('%user was unsubscribed from the %newsletter mailing list.', array(
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    )), t('Anonymous subscriber removed from newsletter'));

    // Visit the newsletter/subscriptions page with the hash.
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $hash = simplenews_generate_hash($subscriber
      ->getMail(), 'manage');
    $this
      ->drupalGet('newsletter/subscriptions/' . $subscriber
      ->id() . '/' . REQUEST_TIME . '/' . $hash);
    $this
      ->assertText(t('Subscriptions for @mail', array(
      '@mail' => $mail,
    )));
    $edit = array(
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', array(
      '@mail' => $mail,
    )));

    // Make sure the subscription is confirmed.
    \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber')
      ->resetCache();
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $this
      ->assertTrue($subscriber
      ->isSubscribed($newsletter_id));
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);

    // Attempt to fetch the page using a wrong hash but correct format.
    $hash = simplenews_generate_hash($subscriber
      ->getMail() . 'a', 'manage');
    $this
      ->drupalGet('newsletter/subscriptions/' . $subscriber
      ->id() . '/' . REQUEST_TIME . '/' . $hash);
    $this
      ->assertResponse(404);

    // Attempt to unsubscribe a non-existing subscriber.
    $mail = $this
      ->randomEmail();
    $edit = array(
      'mail[0][value]' => $mail,
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Unsubscribe'));
    $this
      ->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to cancel your subscription.'));
    $this
      ->assertMailText('is not subscribed to this mailing list', 7);

    // Test expired confirmation links.
    $edit = array(
      'mail[0][value]' => $mail,
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $expired_timestamp = REQUEST_TIME - 86401;
    $hash = simplenews_generate_hash($subscriber
      ->getMail(), 'add', $expired_timestamp);
    $url = 'newsletter/confirm/add/' . $subscriber
      ->id() . '/' . $newsletter_id . '/' . $expired_timestamp . '/' . $hash;
    $this
      ->drupalGet($url);
    $this
      ->assertText(t('This link has expired.'));
    $this
      ->drupalPostForm(NULL, array(), t('Request new confirmation mail'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(9));
    $this
      ->drupalGet($confirm_url);
    $newsletter = simplenews_newsletter_load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array(
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    )), t('Subscription confirmation found.'));
    $this
      ->drupalPostForm($confirm_url, array(), t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', array(
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    )), t('Anonymous subscriber added to newsletter'));

    // Make sure the subscription is confirmed now.
    \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber')
      ->resetCache();
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $this
      ->assertTrue($subscriber
      ->isSubscribed($newsletter_id));
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);
  }

  /**
   * Test anonymous subscription with single opt in.
   *
   * Steps performed:
   *   0. Preparation
   *   1. Subscribe anonymous via block
   */
  function testSubscribeAnonymousSingle() {

    // 0. Preparation
    // Login admin
    // Create single opt in newsletter.
    // Set permission for anonymous to subscribe
    // Enable newsletter block
    // Logout admin
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer blocks',
      'administer content types',
      'administer nodes',
      'access administration pages',
      'administer permissions',
      'administer newsletters',
    ));
    $this
      ->drupalLogin($admin_user);
    $this
      ->drupalGet('admin/config/services/simplenews');
    $this
      ->clickLink(t('Add newsletter'));
    $name = $this
      ->randomMachineName();
    $edit = array(
      'name' => $name,
      'id' => strtolower($name),
      'description' => $this
        ->randomString(20),
      'opt_inout' => 'single',
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->drupalLogout();
    $newsletter_id = $edit['id'];

    // Setup subscription block with subscription form.
    $block_settings = array(
      'newsletters' => array(
        $newsletter_id,
      ),
      'message' => $this
        ->randomMachineName(4),
    );
    $block = $this
      ->setupSubscriptionBlock($block_settings);

    // 1. Subscribe anonymous via block
    // Subscribe + submit
    // Assert confirmation message
    // Verify subscription state.
    $mail = $this
      ->randomEmail(8);
    $edit = array(
      'mail[0][value]' => $mail,
    );
    $this
      ->drupalPostForm('', $edit, t('Subscribe'));
    $this
      ->assertText(t('You have been subscribed.'), t('Anonymous subscriber added to newsletter'));
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);

    // Unsubscribe again.
    $edit = array(
      'mail[0][value]' => $mail,
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Unsubscribe'));
    \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber')
      ->resetCache();
    $subscriber = simplenews_subscriber_load_by_mail($mail);
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_UNSUBSCRIBED, $subscription->status);
  }

  /**
   * testSubscribeAuthenticated
   *
   * Steps performed:
   *   0. Preparation
   *   1. Subscribe authenticated via block
   *   2. Unsubscribe authenticated via subscription page
   *   3. Subscribe authenticated via subscription page
   *   4. Unsubscribe authenticated via account page
   *   5. Subscribe authenticated via account page
   *   6. Subscribe authenticated via multi block
   */
  function testSubscribeAuthenticated() {

    // 0. Preparation
    // Login admin
    // Set permission for anonymous to subscribe
    // Enable newsletter block
    // Logout admin
    // Login Subscriber
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer blocks',
      'administer content types',
      'administer nodes',
      'access administration pages',
      'administer permissions',
      'administer newsletters',
    ));
    $this
      ->drupalLogin($admin_user);

    // Create some newsletters for multi-sign up block.
    $this
      ->drupalGet('admin/config/services/simplenews');
    for ($i = 0; $i < 5; $i++) {
      $this
        ->clickLink(t('Add newsletter'));
      $name = $this
        ->randomMachineName();
      $edit = array(
        'name' => $name,
        'id' => strtolower($name),
        'description' => $this
          ->randomString(20),
        'opt_inout' => 'double',
      );
      $this
        ->drupalPostForm(NULL, $edit, t('Save'));
    }
    $newsletter_id = $this
      ->getRandomNewsletter();
    $this
      ->drupalLogout();

    // Setup subscription block with subscription form.
    $block_settings = array(
      'newsletters' => array(
        $newsletter_id,
      ),
      'message' => $this
        ->randomMachineName(4),
    );
    $single_block = $this
      ->setupSubscriptionBlock($block_settings);
    $subscriber_user = $this
      ->drupalCreateUser(array(
      'subscribe to newsletters',
    ));
    $this
      ->drupalLogin($subscriber_user);
    $this
      ->assertEqual($this
      ->countSubscribers(), 0);

    // 1. Subscribe authenticated via block
    // Subscribe + submit
    // Assert confirmation message
    $this
      ->drupalPostForm(NULL, [], t('Subscribe'));
    $this
      ->assertText(t('You have been subscribed.'), t('Authenticated user subscribed using the subscription block.'));
    $this
      ->assertEqual($this
      ->countSubscribers(), 1);

    // 2. Unsubscribe authenticated via subscription page
    // Unsubscribe + submit
    // Assert confirmation message
    $edit = array(
      "subscriptions[{$newsletter_id}]" => 0,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Update'));
    $this
      ->assertRaw(t('The newsletter subscriptions for %mail have been updated.', array(
      '%mail' => $subscriber_user
        ->getEmail(),
    )), t('Authenticated user unsubscribed on the subscriptions page.'));

    // 3. Subscribe authenticated via subscription page
    // Subscribe + submit
    // Assert confirmation message
    $this
      ->resetSubscribers();
    $edit = array(
      "subscriptions[{$newsletter_id}]" => '1',
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Update'));
    $this
      ->assertRaw(t('The newsletter subscriptions for %mail have been updated.', array(
      '%mail' => $subscriber_user
        ->getEmail(),
    )), t('Authenticated user subscribed on the subscriptions page.'));
    $this
      ->assertEqual($this
      ->countSubscribers(), 1);

    // 4. Unsubscribe authenticated via account page
    // Unsubscribe + submit
    // Assert confirmation message
    $edit = array(
      "subscriptions[{$newsletter_id}]" => FALSE,
    );
    $url = 'user/' . $subscriber_user
      ->id() . '/simplenews';
    $this
      ->drupalPostForm($url, $edit, t('Save'));
    $this
      ->assertRaw(t('Your newsletter subscriptions have been updated.', array(
      '%mail' => $subscriber_user
        ->getEmail(),
    )), t('Authenticated user unsubscribed on the account page.'));
    $subscriber = simplenews_subscriber_load_by_mail($subscriber_user
      ->getEmail());
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_UNSUBSCRIBED, $subscription->status, t('Subscription is unsubscribed'));

    // 5. Subscribe authenticated via account page
    // Subscribe + submit
    // Assert confirmation message
    $this
      ->resetSubscribers();
    $edit = array(
      "subscriptions[{$newsletter_id}]" => '1',
    );
    $url = 'user/' . $subscriber_user
      ->id() . '/simplenews';
    $this
      ->drupalPostForm($url, $edit, t('Save'));
    $this
      ->assertRaw(t('Your newsletter subscriptions have been updated.', array(
      '%mail' => $subscriber_user
        ->getEmail(),
    )), t('Authenticated user unsubscribed on the account page.'));
    $count = 1;
    $this
      ->assertEqual($this
      ->countSubscribers(), $count);

    // Disable the newsletter block.
    $single_block
      ->delete();

    // Setup subscription block with subscription form.
    $block_settings = array(
      'newsletters' => array_keys(simplenews_newsletter_get_all()),
      'message' => $this
        ->randomMachineName(4),
    );
    $multi_block = $this
      ->setupSubscriptionBlock($block_settings);

    // Try to submit multi-signup form without selecting a newsletter.
    $subscriber_user2 = $this
      ->drupalCreateUser(array(
      'subscribe to newsletters',
    ));
    $this
      ->drupalLogin($subscriber_user2);

    // Check that the user has only access to his own subscriptions page.
    $this
      ->drupalGet('user/' . $subscriber_user
      ->id() . '/simplenews');
    $this
      ->assertResponse(403);
    $this
      ->drupalGet('user/' . $subscriber_user2
      ->id() . '/simplenews');
    $this
      ->assertResponse(200);
    $this
      ->assertNoField('mail[0][value]');
    $this
      ->drupalPostForm(NULL, array(), t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', array(
      '@mail' => $subscriber_user2
        ->getEmail(),
    )));

    // Nothing should have happened to subscriptions but this does create a subscriber.
    $this
      ->assertNoFieldChecked('edit-subscriptions-' . $newsletter_id);
    $count++;
    $this
      ->assertEqual($this
      ->countSubscribers(), $count);

    // Now fill out the form and try again.
    $edit = array(
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', array(
      '@mail' => $subscriber_user2
        ->getEmail(),
    )));
    $this
      ->assertEqual($this
      ->countSubscribers(), $count);
    $this
      ->assertFieldChecked('edit-subscriptions-' . $newsletter_id);

    // Unsubscribe.
    $edit = array(
      'subscriptions[' . $newsletter_id . ']' => FALSE,
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', array(
      '@mail' => $subscriber_user2
        ->getEmail(),
    )));
    $this
      ->assertNoFieldChecked('edit-subscriptions-' . $newsletter_id);

    // And now the same for the newsletter/subscriptions page.
    $subscriber_user3 = $this
      ->drupalCreateUser(array(
      'subscribe to newsletters',
    ));
    $this
      ->drupalLogin($subscriber_user3);
    $this
      ->assertNoField('mail[0][value]');
    $this
      ->drupalPostForm('newsletter/subscriptions', array(), t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', array(
      '@mail' => $subscriber_user3
        ->getEmail(),
    )));

    // Nothing should have happened to subscriptions but this does create a subscriber.
    $this
      ->assertNoFieldChecked('edit-subscriptions-' . $newsletter_id);
    $count++;
    $this
      ->assertEqual($this
      ->countSubscribers(), $count);

    // Now fill out the form and try again.
    $edit = array(
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', array(
      '@mail' => $subscriber_user3
        ->getEmail(),
    )));
    $this
      ->assertEqual($this
      ->countSubscribers(), $count);
    $this
      ->assertFieldChecked('edit-subscriptions-' . $newsletter_id);

    // Unsubscribe.
    $edit = array(
      'subscriptions[' . $newsletter_id . ']' => FALSE,
    );
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', array(
      '@mail' => $subscriber_user3
        ->getEmail(),
    )));
    $this
      ->assertNoFieldChecked('edit-subscriptions-' . $newsletter_id);
  }

  /**
   * Tests Creation of Simplenews Subscription block.
   */
  public function testSimplenewsSubscriptionBlock() {
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer blocks',
    ));
    $this
      ->drupalLogin($admin_user);
    $this
      ->drupalGet('/admin/structure/block/add/simplenews_subscription_block/classy');

    // Check for Unique ID field.
    $this
      ->assertText('Unique ID');
    $edit = array(
      'settings[unique_id]' => 'test_simplenews_123',
      'settings[newsletters][default]' => TRUE,
      'region' => 'header',
    );
    $this
      ->drupalPostForm(NULL, $edit, t('Save block'));
    $this
      ->drupalGet('');

    // Provided Unique ID is used as form_id.
    $this
      ->assertFieldByXPath("//*[@id=\"simplenews-subscriptions-block-test-simplenews-123\"]", NULL, 'Form ID found and contains expected value.');
  }

  /**
   * Gets the number of subscribers entities.
   */
  protected function countSubscribers() {
    return \Drupal::entityQuery('simplenews_subscriber')
      ->count()
      ->execute();
  }

  /**
   * Delete all subscriber entities ready for the next test.
   */
  protected function resetSubscribers() {
    $storage = \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber');
    $storage
      ->delete($storage
      ->loadMultiple());
  }

}

Classes

Name	Description
SimplenewsSubscribeTest	(un)subscription of anonymous and authenticated users.