comparison core/lib/Drupal/Core/Test/AssertMailTrait.php @ 0:4c8ae668cc8c

Initial import (non-working)

+<?php
+
+namespace Drupal\Core\Test;
+
+/**
+ * Provides methods for testing emails sent during test runs.
+ */
+trait AssertMailTrait {
+
+  /**
+   * Gets an array containing all emails sent during this test case.
+   *
+   * @param array $filter
+   *   An array containing key/value pairs used to filter the emails that are
+   *   returned.
+   *
+   * @return array
+   *   An array containing email messages captured during the current test.
+   */
+  protected function getMails(array $filter = []) {
+    $captured_emails = $this->container->get('state')->get('system.test_mail_collector', []);
+    $filtered_emails = [];
+
+    foreach ($captured_emails as $message) {
+      foreach ($filter as $key => $value) {
+        if (!isset($message[$key]) || $message[$key] != $value) {
+          continue 2;
+        }
+      }
+      $filtered_emails[] = $message;
+    }
+
+    return $filtered_emails;
+  }
+
+  /**
+   * Asserts that the most recently sent email message has the given value.
+   *
+   * The field in $name must have the content described in $value.
+   *
+   * @param string $name
+   *   Name of field or message property to assert. Examples: subject, body,
+   *   id, ...
+   * @param string $value
+   *   Value of the field to assert.
+   * @param string $message
+   *   (optional) A message to display with the assertion. Do not translate
+   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
+   *   variables in the message text, not t(). If left blank, a default message
+   *   will be displayed.
+   * @param string $group
+   *   (optional) The group this message is in, which is displayed in a column
+   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
+   *   translate this string. Defaults to 'Email'; most tests do not override
+   *   this default.
+   *
+   * @return bool
+   *   TRUE on pass, FALSE on fail.
+   */
+  protected function assertMail($name, $value = '', $message = '', $group = 'Email') {
+    $captured_emails = $this->container->get('state')->get('system.test_mail_collector') ?: [];
+    $email = end($captured_emails);
+    return $this->assertTrue($email && isset($email[$name]) && $email[$name] == $value, $message, $group);
+  }
+
+  /**
+   * Asserts that the most recently sent email message has the string in it.
+   *
+   * @param string $field_name
+   *   Name of field or message property to assert: subject, body, id, ...
+   * @param string $string
+   *   String to search for.
+   * @param int $email_depth
+   *   Number of emails to search for string, starting with most recent.
+   * @param string $message
+   *   (optional) A message to display with the assertion. Do not translate
+   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
+   *   variables in the message text, not t(). If left blank, a default message
+   *   will be displayed.
+   * @param string $group
+   *   (optional) The group this message is in, which is displayed in a column
+   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
+   *   translate this string. Defaults to 'Other'; most tests do not override
+   *   this default.
+   *
+   * @return bool
+   *   TRUE on pass, FALSE on fail.
+   */
+  protected function assertMailString($field_name, $string, $email_depth, $message = '', $group = 'Other') {
+    $mails = $this->getMails();
+    $string_found = FALSE;
+    // Cast MarkupInterface objects to string.
+    $string = (string) $string;
+    for ($i = count($mails) - 1; $i >= count($mails) - $email_depth && $i >= 0; $i--) {
+      $mail = $mails[$i];
+      // Normalize whitespace, as we don't know what the mail system might have
+      // done. Any run of whitespace becomes a single space.
+      $normalized_mail = preg_replace('/\s+/', ' ', $mail[$field_name]);
+      $normalized_string = preg_replace('/\s+/', ' ', $string);
+      $string_found = (FALSE !== strpos($normalized_mail, $normalized_string));
+      if ($string_found) {
+        break;
+      }
+    }
+    if (!$message) {
+      $message = format_string('Expected text found in @field of email message: "@expected".', ['@field' => $field_name, '@expected' => $string]);
+    }
+    return $this->assertTrue($string_found, $message, $group);
+  }
+
+  /**
+   * Asserts that the most recently sent email message has the pattern in it.
+   *
+   * @param string $field_name
+   *   Name of field or message property to assert: subject, body, id, ...
+   * @param string $regex
+   *   Pattern to search for.
+   * @param string $message
+   *   (optional) A message to display with the assertion. Do not translate
+   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
+   *   variables in the message text, not t(). If left blank, a default message
+   *   will be displayed.
+   * @param string $group
+   *   (optional) The group this message is in, which is displayed in a column
+   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
+   *   translate this string. Defaults to 'Other'; most tests do not override
+   *   this default.
+   *
+   * @return bool
+   *   TRUE on pass, FALSE on fail.
+   */
+  protected function assertMailPattern($field_name, $regex, $message = '', $group = 'Other') {
+    $mails = $this->getMails();
+    $mail = end($mails);
+    $regex_found = preg_match("/$regex/", $mail[$field_name]);
+    if (!$message) {
+      $message = format_string('Expected text found in @field of email message: "@expected".', ['@field' => $field_name, '@expected' => $regex]);
+    }
+    return $this->assertTrue($regex_found, $message, $group);
+  }
+
+  /**
+   * Outputs to verbose the most recent $count emails sent.
+   *
+   * @param int $count
+   *   Optional number of emails to output.
+   */
+  protected function verboseEmail($count = 1) {
+    $mails = $this->getMails();
+    for ($i = count($mails) - 1; $i >= count($mails) - $count && $i >= 0; $i--) {
+      $mail = $mails[$i];
+      $this->verbose('Email:<pre>' . print_r($mail, TRUE) . '</pre>');
+    }
+  }
+
+}