class SimplenewsSubscribeTest in Simplenews 8.2

Same name and namespace in other branches

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

Un/subscription of anonymous and authenticated users.

Subscription via block, subscription page and account page.

@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\SimplenewsSubscribeTest

Expanded class hierarchy of SimplenewsSubscribeTest

File

tests/src/Functional/SimplenewsSubscribeTest.php, line 17

Namespace

Drupal\Tests\simplenews\Functional

View source

class SimplenewsSubscribeTest extends SimplenewsTestBase {

  /**
   * Subscribe to multiple newsletters at the same time.
   */
  public function testSubscribeMultiple() {
    $admin_user = $this
      ->drupalCreateUser([
      '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 = [
        '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 = [
      '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.'));

    // Verify listed changes.
    foreach ($newsletters as $newsletter_id => $newsletter) {
      $this
        ->assertMailText(t('Subscribe to @name', [
        '@name' => $newsletter->name,
      ]), 0, in_array($newsletter_id, $enable));
    }
    $mails = $this
      ->getMails();
    $this
      ->assertEqual($mails[0]['from'], 'simpletest@example.com');
    $this
      ->assertEqual($mails[0]['headers']['From'], '"Drupal" <simpletest@example.com>');
    $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?', [
      '%user' => simplenews_mask_mail($mail),
    ]));

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

    /** @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
          ->assertEquals(1, count($subscription_newsletter));
      }
      else {
        $this
          ->assertFalse($is_subscribed);
        $this
          ->assertEquals(0, count($subscription_newsletter));
      }
    }

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

    // Unsubscribe from two of the three enabled newsletters.
    $disable = array_rand(array_flip($enable), 2);
    $edit = [
      '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.'));

    // Unsubscribe with no confirmed email.
    $subscription_manager = \Drupal::service('simplenews.subscription_manager');
    try {
      $subscription_manager
        ->unsubscribe('new@email.com', $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', [
        '@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?', [
      '%user' => simplenews_mask_mail($mail),
    ]));

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

    // 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 = [
      '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 = [
      '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 = [
      '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.'));
    $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 = [
      '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.', [
      '%user' => $mail,
    ]));

    // 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
      ->assertSession()
      ->statusCodeNotEquals(404);
    $this
      ->assertRaw(t('All changes to your subscriptions where already applied. No changes made.'));

    // Using confirmation page.
    $this
      ->drupalGet($confirm_url);
    $this
      ->assertSession()
      ->statusCodeNotEquals(404);
    $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 = [
      'mail[0][value]' => $mail,
    ];
    foreach ($enable as $newsletter_id) {
      $edit['subscriptions[' . $newsletter_id . ']'] = TRUE;
    }
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $subscriber = Subscriber::loadByMail($mail);
    $expired_timestamp = REQUEST_TIME - 86401;
    $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, [], 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', [
        '@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?', [
      '%user' => simplenews_mask_mail($mail),
    ]));

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

  /**
   * Extract a confirmation link from a mail body.
   */
  protected 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', [
      '@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.
   */
  public function testSubscribeAnonymous() {

    // 0. Preparation
    // Login admin
    // Set permission for anonymous to subscribe
    // Enable newsletter block
    // Logout admin.
    $admin_user = $this
      ->drupalCreateUser([
      '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 = [
        'name' => $name,
        'id' => strtolower($name),
        'description' => $this
          ->randomString(20),
        'opt_inout' => 'double',
      ];
      $this
        ->drupalPostForm(NULL, $edit, t('Save'));
    }
    $newsletter_id = $this
      ->getRandomNewsletter();
    $this
      ->drupalLogout();

    // @codingStandardsIgnoreLine

    //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 = [
      'newsletters' => [
        $newsletter_id,
      ],
      'message' => $this
        ->randomMachineName(4),
    ];
    $single_block = $this
      ->setupSubscriptionBlock($block_settings);

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

    // Now with valid email.
    $mail = $this
      ->randomEmail(8);
    $edit = [
      '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.'));
    $subscriber = Subscriber::loadByMail($mail);
    $this
      ->assertNotNull($subscriber, 'New subscriber entity successfully loaded.');
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEquals(SIMPLENEWS_SUBSCRIPTION_STATUS_UNCONFIRMED, $subscription->status, t('Subscription is unconfirmed'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(0));
    $this
      ->drupalGet($confirm_url);
    $newsletter = Newsletter::load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', [
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    ]));
    $this
      ->drupalPostForm(NULL, [], t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', [
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    ]));
    $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();
    $pass = $this
      ->randomMachineName();
    $edit = [
      'name' => $this
        ->randomMachineName(),
      'mail' => $mail,
      'pass[pass1]' => $pass,
      '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 = Subscriber::loadByMail($mail);
    $account = user_load_by_mail($mail);
    $this
      ->assertEqual($subscriber
      ->getUserId(), $account
      ->id());
    $this
      ->assertEqual($account
      ->getDisplayName(), $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 = [
      "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.'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(2));
    $this
      ->drupalGet($confirm_url);
    $newsletter = Newsletter::load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', [
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    ]));
    $this
      ->drupalPostForm($confirm_url, [], t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', [
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    ]));

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

    // Try to submit multi-signup form without selecting a newsletter.
    $mail = $this
      ->randomEmail(8);
    $edit = [
      '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 = [
      '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 = Newsletter::load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', [
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    ]));
    $this
      ->drupalPostForm($confirm_url, [], t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', [
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    ]));

    // Try to subscribe again, this should not re-set the status to unconfirmed.
    $edit = [
      '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 = Subscriber::loadByMail($mail);
    $this
      ->assertNotEqual($subscriber, FALSE, 'New subscriber entity successfully loaded.');
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEquals(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);

    // Now the same with the newsletter/subscriptions page.
    $mail = $this
      ->randomEmail(8);
    $edit = [
      '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 = [
      '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 = Newsletter::load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', [
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    ]));
    $this
      ->drupalPostForm($confirm_url, [], t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', [
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    ]));

    // Test unsubscribe on newsletter/subscriptions page.
    $edit = [
      '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 = [
      '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', [
      '@mail' => $mail,
    ]), 6);
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(6));
    $mails = $this
      ->getMails();
    $this
      ->assertEqual($mails[0]['from'], 'simpletest@example.com');
    $this
      ->assertEqual($mails[0]['headers']['From'], '"Drupal" <simpletest@example.com>');
    $this
      ->drupalGet($confirm_url);
    $newsletter = Newsletter::load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to remove %user from the %newsletter mailing list?', [
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    ]));
    $this
      ->drupalPostForm($confirm_url, [], t('Unsubscribe'));
    $this
      ->assertRaw(t('%user was unsubscribed from the %newsletter mailing list.', [
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    ]));

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

    // Make sure the subscription is confirmed.
    \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber')
      ->resetCache();
    $subscriber = Subscriber::loadByMail($mail);
    $this
      ->assertTrue($subscriber
      ->isSubscribed($newsletter_id));
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEquals(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 = [
      '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 = [
      'mail[0][value]' => $mail,
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    ];
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
    $subscriber = Subscriber::loadByMail($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, [], t('Request new confirmation mail'));
    $confirm_url = $this
      ->extractConfirmationLink($this
      ->getMail(9));
    $this
      ->drupalGet($confirm_url);
    $newsletter = Newsletter::load($newsletter_id);
    $this
      ->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', [
      '%user' => simplenews_mask_mail($mail),
      '%newsletter' => $newsletter->name,
    ]));
    $this
      ->drupalPostForm($confirm_url, [], t('Subscribe'));
    $this
      ->assertRaw(t('%user was added to the %newsletter mailing list.', [
      '%user' => $mail,
      '%newsletter' => $newsletter->name,
    ]));

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

  /**
   * Test anonymous subscription with single opt in.
   *
   * Steps performed:
   *   0. Preparation
   *   1. Subscribe anonymous via block.
   */
  public 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([
      '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 = [
      '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 = [
      'newsletters' => [
        $newsletter_id,
      ],
      'message' => $this
        ->randomMachineName(4),
    ];
    $this
      ->setupSubscriptionBlock($block_settings);

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

    // Unsubscribe again.
    $edit = [
      'mail[0][value]' => $mail,
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    ];
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Unsubscribe'));
    \Drupal::entityTypeManager()
      ->getStorage('simplenews_subscriber')
      ->resetCache();
    $subscriber = Subscriber::loadByMail($mail);
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEquals(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.
   */
  public function testSubscribeAuthenticated() {

    // 0. Preparation
    // Login admin
    // Set permission for anonymous to subscribe
    // Enable newsletter block
    // Logout admin
    // Login Subscriber.
    $admin_user = $this
      ->drupalCreateUser([
      '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 = [
        '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 = [
      'newsletters' => [
        $newsletter_id,
      ],
      'message' => $this
        ->randomMachineName(4),
    ];
    $single_block = $this
      ->setupSubscriptionBlock($block_settings);
    $subscriber_user = $this
      ->drupalCreateUser([
      '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.'));
    $this
      ->assertEqual($this
      ->countSubscribers(), 1);

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

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

    // 4. Unsubscribe authenticated via account page
    // Unsubscribe + submit
    // Assert confirmation message.
    $edit = [
      "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.', [
      '%mail' => $subscriber_user
        ->getEmail(),
    ]));
    $subscriber = Subscriber::loadByMail($subscriber_user
      ->getEmail());
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEquals(SIMPLENEWS_SUBSCRIPTION_STATUS_UNSUBSCRIBED, $subscription->status, t('Subscription is unsubscribed'));

    // 5. Subscribe authenticated via account page
    // Subscribe + submit
    // Assert confirmation message.
    $this
      ->resetSubscribers();
    $edit = [
      "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.', [
      '%mail' => $subscriber_user
        ->getEmail(),
    ]));
    $count = 1;
    $this
      ->assertEqual($this
      ->countSubscribers(), $count);

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

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

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

    // Check that the user has only access to their 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, [], t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', [
      '@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 = [
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', [
      '@mail' => $subscriber_user2
        ->getEmail(),
    ]));
    $this
      ->assertEqual($this
      ->countSubscribers(), $count);
    $this
      ->assertFieldChecked('edit-subscriptions-' . $newsletter_id);

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

    // And now the same for the newsletter/subscriptions page.
    $subscriber_user3 = $this
      ->drupalCreateUser([
      'subscribe to newsletters',
    ]);
    $this
      ->drupalLogin($subscriber_user3);
    $this
      ->assertNoField('mail[0][value]');
    $this
      ->drupalPostForm('newsletter/subscriptions', [], t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', [
      '@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 = [
      'subscriptions[' . $newsletter_id . ']' => TRUE,
    ];
    $this
      ->drupalPostForm('newsletter/subscriptions', $edit, t('Update'));
    $this
      ->assertText(t('The newsletter subscriptions for @mail have been updated.', [
      '@mail' => $subscriber_user3
        ->getEmail(),
    ]));
    $this
      ->assertEqual($this
      ->countSubscribers(), $count);
    $this
      ->assertFieldChecked('edit-subscriptions-' . $newsletter_id);

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

  /**
   * Tests Creation of Simplenews Subscription block.
   */
  public function testSimplenewsSubscriptionBlock() {
    $admin_user = $this
      ->drupalCreateUser([
      '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 = [
      '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.');
  }

  /**
   * Tests admin creating a single subscriber.
   */
  public function testAdminCreate() {
    $admin_user = $this
      ->drupalCreateUser([
      'administer simplenews subscriptions',
    ]);
    $this
      ->drupalLogin($admin_user);
    $newsletter_id = $this
      ->getRandomNewsletter();
    $mail = $this
      ->randomEmail();
    $this
      ->drupalGet('admin/people/simplenews/create');
    $this
      ->assertText('Add subscriber');
    $edit = [
      "subscriptions[{$newsletter_id}]" => TRUE,
      'mail[0][value]' => $mail,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertText(t('Subscriber @mail has been added.', [
      '@mail' => $mail,
    ]));
    $subscriber = Subscriber::loadByMail($mail);
    $subscription = $subscriber
      ->getSubscription($newsletter_id);
    $this
      ->assertEquals(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);

    // Check that an unsubscribe link works without any permissions.
    $this
      ->drupalLogout();
    user_role_revoke_permissions(AccountInterface::ANONYMOUS_ROLE, [
      'subscribe to newsletters',
    ]);
    $node = $this
      ->drupalCreateNode([
      'type' => 'simplenews_issue',
      'simplenews_issue[target_id]' => [
        'target_id' => $newsletter_id,
      ],
    ]);
    \Drupal::service('simplenews.spool_storage')
      ->addIssue($node);
    \Drupal::service('simplenews.mailer')
      ->sendSpool();
    $unsubscribe_url = $this
      ->extractConfirmationLink($this
      ->getMail(0));
    $this
      ->drupalGet($unsubscribe_url);
    $this
      ->assertText('Confirm remove subscription');
    $this
      ->drupalPostForm(NULL, [], t('Unsubscribe'));
    $this
      ->assertText('was unsubscribed from the Default newsletter mailing list.');
  }

  /**
   * 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());
  }

}

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.
SimplenewsSubscribeTest::countSubscribers	protected	function	Gets the number of subscribers entities.
SimplenewsSubscribeTest::extractConfirmationLink	protected	function	Extract a confirmation link from a mail body.
SimplenewsSubscribeTest::resetSubscribers	protected	function	Delete all subscriber entities ready for the next test.
SimplenewsSubscribeTest::testAdminCreate	public	function	Tests admin creating a single subscriber.
SimplenewsSubscribeTest::testSimplenewsSubscriptionBlock	public	function	Tests Creation of Simplenews Subscription block.
SimplenewsSubscribeTest::testSubscribeAnonymous	public	function	TestSubscribeAnonymous.
SimplenewsSubscribeTest::testSubscribeAnonymousSingle	public	function	Test anonymous subscription with single opt in.
SimplenewsSubscribeTest::testSubscribeAuthenticated	public	function	TestSubscribeAuthenticated.
SimplenewsSubscribeTest::testSubscribeMultiple	public	function	Subscribe to multiple newsletters at the same time.
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::setUp	protected	function	Overrides BrowserTestBase::setUp	9
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 SimplenewsSubscribeTest in Simplenews 8.2

Hierarchy

File

Namespace

Members

API Navigation