1. sfTesterMailer.class.php
  2. /**
 * sfTesterMailer implements tests for the symfony mailer object.
 *
 * @package    symfony
 * @subpackage test
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfTesterMailer.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfTesterMailer extends sfTester
  4. {
  5.   protected
  6.     $logger  = null,
  7.     $message = null;
  9.   /**
  10.    * Prepares the tester.
  11.    */
  12.   public function prepare()
  13.   {
  14.   }
  16.   /**
  17.    * Initializes the tester.
  18.    */
  19.   public function initialize()
  20.   {
  21.     $this->logger = $this->browser->getContext()->getMailer()->getLogger();
  23.     if ($this->logger->countMessages())
  24.     {
  25.       $messages = $this->logger->getMessages();
  27.       $this->message = $messages[0];
  28.     }
  29.   }
  31.   /**
  32.    * Tests if message was send and optional how many.
  33.    *
  34.    * @param int $nb number of messages
  35.    *
  36.    * @return sfTestFunctionalBase|sfTester
  37.    */
  38.   public function hasSent($nb = null)
  39.   {
  40.     if (null === $nb)
  41.     {
  42.       $this->tester->ok($this->logger->countMessages() > 0, 'mailer sent some email(s).');
  43.     }
  44.     else
  45.     {
  46.       $this->tester->is($this->logger->countMessages(), $nb, sprintf('mailer sent %s email(s).', $nb));
  47.     }
  49.     return $this->getObjectToReturn();
  50.   }
  52.   /**
  53.    * Outputs some debug information about mails sent during the current request.
  54.    */
  55.   public function debug()
  56.   {
  57.     foreach ($this->logger->getMessages() as $message)
  58.     {
  59.       echo $message->toString()."\n\n";
  60.     }
  62.     exit(1);
  63.   }
  65.   /**
  66.    * Changes the context to use the email corresponding to the given criteria.
  67.    *
  68.    * @param string|array $to       the email or array(email => alias)
  69.    * @param int          $position address position
  70.    *
  71.    * @return sfTestFunctionalBase|sfTester
  72.    */
  73.   public function withMessage($to, $position = 1)
  74.   {
  75.     $messageEmail = $to;
  76.     if(is_array($to))
  77.     {
  78.       $alias        = current($to);
  79.       $to           = key($to);
  80.       $messageEmail = sprintf('%s <%s>', $alias, $to);
  81.     }
  83.     $matches = 0;
  84.     foreach ($this->logger->getMessages() as $message)
  85.     {
  86.       $email = $message->getTo();
  87.       if ($to == key($email))
  88.       {
  89.         $matches++;
  91.         if ($matches == $position)
  92.         {
  93.           $this->message = $message;
  95.           if(isset($alias) AND $alias != current($email))
  96.           {
  97.             break;
  98.           }
  100.           $this->tester->pass(sprintf('switch context to the message number "%s" sent to "%s"', $position, $messageEmail));
  102.           return $this;
  103.         }
  104.       }
  105.     }
  107.     $this->tester->fail(sprintf('unable to find a message sent to "%s"', $messageEmail));
  109.     return $this;
  110.   }
  112.   /**
  113.    * Tests for a mail message body.
  114.    *
  115.    * @param string $value regular expression or value
  116.    *
  117.    * @return sfTestFunctionalBase|sfTester
  118.    */
  119.   public function checkBody($value)
  120.   {
  121.     if (!$this->message)
  122.     {
  123.       $this->tester->fail('unable to test as no email were sent');
  124.     }
  126.     $body = $this->message->getBody();
  127.     $ok = false;
  128.     $regex = false;
  129.     $mustMatch = true;
  130.     if (preg_match('/^(!)?([^a-zA-Z0-9\\\\]).+?\\2[ims]?$/', $value, $match))
  131.     {
  132.       $regex = $value;
  133.       if ($match[1] == '!')
  134.       {
  135.         $mustMatch = false;
  136.         $regex = substr($value, 1);
  137.       }
  138.     }
  140.     if (false !== $regex)
  141.     {
  142.       if ($mustMatch)
  143.       {
  144.         if (preg_match($regex, $body))
  145.         {
  146.           $ok = true;
  147.           $this->tester->pass(sprintf('email body matches "%s"', $value));
  148.         }
  149.       }
  150.       else
  151.       {
  152.         if (preg_match($regex, $body))
  153.         {
  154.           $ok = true;
  155.           $this->tester->fail(sprintf('email body does not match "%s"', $value));
  156.         }
  157.       }
  158.     }
  159.     else if ($body == $value)
  160.     {
  161.       $ok = true;
  162.       $this->tester->pass(sprintf('email body is "%s"', $value));
  163.     }
  165.     if (!$ok)
  166.     {
  167.       if (!$mustMatch)
  168.       {
  169.         $this->tester->pass(sprintf('email body matches "%s"', $value));
  170.       }
  171.       else
  172.       {
  173.         $this->tester->fail(sprintf('email body matches "%s"', $value));
  174.       }
  175.     }
  177.     return $this->getObjectToReturn();
  178.   }
  180.   /**
  181.    * Tests for a mail message header.
  182.    *
  183.    * @param string $key   entry to test
  184.    * @param string $value regular expression or value
  185.    *
  186.    * @return sfTestFunctionalBase|sfTester
  187.    */
  188.   public function checkHeader($key, $value)
  189.   {
  190.     if (!$this->message)
  191.     {
  192.       $this->tester->fail('unable to test as no email were sent');
  193.     }
  195.     $headers = array();
  196.     foreach ($this->message->getHeaders()->getAll($key) as $header)
  197.     {
  198.       $headers[] = $header->getFieldBody();
  199.     }
  200.     $current = implode(', ', $headers);
  201.     $ok = false;
  202.     $regex = false;
  203.     $mustMatch = true;
  204.     if (preg_match('/^(!)?([^a-zA-Z0-9\\\\]).+?\\2[ims]?$/', $value, $match))
  205.     {
  206.       $regex = $value;
  207.       if ($match[1] == '!')
  208.       {
  209.         $mustMatch = false;
  210.         $regex = substr($value, 1);
  211.       }
  212.     }
  214.     foreach ($headers as $header)
  215.     {
  216.       if (false !== $regex)
  217.       {
  218.         if ($mustMatch)
  219.         {
  220.           if (preg_match($regex, $header))
  221.           {
  222.             $ok = true;
  223.             $this->tester->pass(sprintf('email header "%s" matches "%s" (%s)', $key, $value, $current));
  224.             break;
  225.           }
  226.         }
  227.         else
  228.         {
  229.           if (preg_match($regex, $header))
  230.           {
  231.             $ok = true;
  232.             $this->tester->fail(sprintf('email header "%s" does not match "%s" (%s)', $key, $value, $current));
  233.             break;
  234.           }
  235.         }
  236.       }
  237.       else if ($header == $value)
  238.       {
  239.         $ok = true;
  240.         $this->tester->pass(sprintf('email header "%s" is "%s" (%s)', $key, $value, $current));
  241.         break;
  242.       }
  243.     }
  245.     if (!$ok)
  246.     {
  247.       if (!$mustMatch)
  248.       {
  249.         $this->tester->pass(sprintf('email header "%s" matches "%s" (%s)', $key, $value, $current));
  250.       }
  251.       else
  252.       {
  253.         $this->tester->fail(sprintf('email header "%s" matches "%s" (%s)', $key, $value, $current));
  254.       }
  255.     }
  257.     return $this->getObjectToReturn();
  258.   }
  259. }
Debug toolbar