class EmailContext in Open Social 8.7

Hierarchy

• class \Drupal\social\Behat\EmailContext implements \Behat\Behat\Context\Context

1 string reference to 'EmailContext'

behat.yml in tests/behat/config/behat.yml

tests/behat/config/behat.yml

File

tests/behat/features/bootstrap/EmailContext.php, line 12

Namespace

Drupal\social\Behat

class EmailContext implements Context {

  /**
   * We need to enable the spool directory.
   *
   * @BeforeScenario @email-spool
   */
  public function enableEmailSpool() {

    // Update Drupal configuration.
    $swiftmailer_config = \Drupal::configFactory()
      ->getEditable('swiftmailer.transport');
    $swiftmailer_config
      ->set('transport', 'spool');
    $swiftmailer_config
      ->set('spool_directory', $this
      ->getSpoolDir());
    $swiftmailer_config
      ->save();

    // Clean up emails that were left behind.
    $this
      ->purgeSpool();
  }

  /**
   * Revert back to the old situation (native PHP mail).
   *
   * @AfterScenario @email-spool
   */
  public function disableEmailSpool() {

    // Update Drupal configuration.
    $swiftmailer_config = \Drupal::configFactory()
      ->getEditable('swiftmailer.transport');
    $swiftmailer_config
      ->set('transport', 'native');
    $swiftmailer_config
      ->save();

    // Clean up emails after us.
    $this
      ->purgeSpool();
  }

  /**
   * Get a list of spooled emails.
   *
   * @return Finder|null
   *   Returns a Finder if the directory exists.
   * @throws Exception
   */
  public function getSpooledEmails() {
    $finder = new Finder();
    $spoolDir = $this
      ->getSpoolDir();
    if (empty($spoolDir)) {
      throw new \Exception('Could not retrieve the spool directory, or the directory does not exist.');
    }
    try {
      $finder
        ->files()
        ->in($spoolDir);
      return $finder;
    } catch (InvalidArgumentException $exception) {
      return NULL;
    }
  }

  /**
   * Get content of email.
   *
   * @param string $file
   *   Path to the file.
   *
   * @return string
   *   An unserialized email.
   */
  public function getEmailContent($file) {
    return unserialize(file_get_contents($file));
  }

  /**
   * Get the path where the spooled emails are stored.
   *
   * @return string
   *   The path where the spooled emails are stored.
   */
  protected function getSpoolDir() {
    $path = '/var/www/html/profiles/contrib/social/tests/behat/features/swiftmailer-spool';
    if (!file_exists($path)) {
      mkdir($path, 0777, true);
    }
    return $path;
  }

  /**
   * Purge the messages in the spool.
   */
  protected function purgeSpool() {
    $filesystem = new Filesystem();
    $finder = $this
      ->getSpooledEmails();
    if ($finder) {

      /** @var File $file */
      foreach ($finder as $file) {
        $filesystem
          ->remove($file
          ->getRealPath());
      }
    }
  }

  /**
   * Find an email with the given subject and body.
   *
   * @param string $subject
   *   The subject of the email.
   * @param array $body
   *   Text that should be in the email.
   *
   * @return bool
   *   Email was found or not.
   * @throws Exception
   */
  protected function findSubjectAndBody($subject, $body) {
    $finder = $this
      ->getSpooledEmails();
    $found_email = FALSE;
    if ($finder) {

      /** @var File $file */
      foreach ($finder as $file) {

        /** @var Swift_Message $email */
        $email = $this
          ->getEmailContent($file);
        $email_subject = $email
          ->getSubject();
        $email_body = $email
          ->getBody();

        // Make it a traversable HTML doc.
        $doc = new \DOMDocument();
        $doc
          ->loadHTML($email_body);
        $xpath = new \DOMXPath($doc);

        // Find the post header and email content in the HTML file.
        $content = $xpath
          ->evaluate('string(//*[contains(@class,"postheader")])');
        $content .= $xpath
          ->evaluate('string(//*[contains(@class,"main")])');
        $content_found = 0;
        foreach ($body as $string) {
          if (strpos($content, $string)) {
            $content_found++;
          }
        }
        if ($email_subject == $subject && $content_found === count($body)) {
          $found_email = TRUE;
        }
      }
    }
    else {
      throw new \Exception('There are no email messages.');
    }
    return $found_email;
  }

  /**
   * I run the digest cron.
   *
   * @Then I run the :arg1 digest cron
   */
  public function iRunTheDigestCron($frequency) {

    // Update the timings in the digest table.
    $query = \Drupal::database()
      ->update('user_activity_digest');
    $query
      ->fields([
      'timestamp' => 1,
    ]);
    $query
      ->condition('frequency', $frequency);
    $query
      ->execute();

    // Update last run time to make sure we can run the digest cron.
    \Drupal::state()
      ->set('digest.' . $frequency . '.last_run', 1);
    \Drupal::service('cron')
      ->run();
  }

  /**
   * I read an email.
   *
   * @Then /^(?:|I )should have an email with subject "([^"]*)" and "([^"]*)" in the body$/
   */
  public function iShouldHaveAnEmailWithTitleAndBody($subject, $body) {
    $found_email = $this
      ->findSubjectAndBody($subject, [
      $body,
    ]);
    if (!$found_email) {
      throw new \Exception('There is no email with that subject and body.');
    }
  }

  /**
   * I read an email with multiple content.
   *
   * @Then I should have an email with subject :arg1 and in the content:
   */
  public function iShouldHaveAnEmailWithTitleAndBodyMulti($subject, TableNode $table) {
    $body = [];
    $hash = $table
      ->getHash();
    foreach ($hash as $row) {
      $body[] = $row['content'];
    }
    $found_email = $this
      ->findSubjectAndBody($subject, $body);
    if (!$found_email) {
      throw new \Exception('There is no email with that subject and body.');
    }
  }

  /**
   * I do not have an email.
   *
   * @Then /^(?:|I )should not have an email with subject "([^"]*)" and "([^"]*)" in the body$/
   */
  public function iShouldNotHaveAnEmailWithTitleAndBody($subject, $body) {
    $found_email = $this
      ->findSubjectAndBody($subject, [
      $body,
    ]);
    if ($found_email) {
      throw new \Exception('There is an email with that subject and body.');
    }
  }

  /**
   * I do not have an email with multiple content.
   *
   * @Then I should not have an email with subject :arg1 and in the content:
   */
  public function iShouldNotHaveAnEmailWithTitleAndBodyMulti($subject, TableNode $table) {
    $body = [];
    $hash = $table
      ->getHash();
    foreach ($hash as $row) {
      $body[] = $row['content'];
    }
    $found_email = $this
      ->findSubjectAndBody($subject, $body);
    if ($found_email) {
      throw new \Exception('There is an email with that subject and body.');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EmailContext::disableEmailSpool	public	function	Revert back to the old situation (native PHP mail).
EmailContext::enableEmailSpool	public	function	We need to enable the spool directory.
EmailContext::findSubjectAndBody	protected	function	Find an email with the given subject and body.
EmailContext::getEmailContent	public	function	Get content of email.
EmailContext::getSpoolDir	protected	function	Get the path where the spooled emails are stored.
EmailContext::getSpooledEmails	public	function	Get a list of spooled emails.
EmailContext::iRunTheDigestCron	public	function	I run the digest cron.
EmailContext::iShouldHaveAnEmailWithTitleAndBody	public	function	I read an email.
EmailContext::iShouldHaveAnEmailWithTitleAndBodyMulti	public	function	I read an email with multiple content.
EmailContext::iShouldNotHaveAnEmailWithTitleAndBody	public	function	I do not have an email.
EmailContext::iShouldNotHaveAnEmailWithTitleAndBodyMulti	public	function	I do not have an email with multiple content.
EmailContext::purgeSpool	protected	function	Purge the messages in the spool.