rt/lib/RT/Test/Email.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 use warnings;
  50 use strict;
  51
  52 package RT::Test::Email;
  53 use Test::More;
  54 use Test::Email;
  55 use Email::Abstract;
  56 use base 'Exporter';
  57 our @EXPORT = qw(mail_ok);
  58
  59 RT::Test->set_mail_catcher;
  60
  61 =head1 NAME
  62
  63 RT::Test::Email -
  64
  65 =head1 SYNOPSIS
  66
  67   use RT::Test::Email;
  68
  69   mail_ok {
  70     # ... code
  71
  72   } { from => 'admin@localhost', body => qr('hello') },
  73     { from => 'admin@localhost', body => qr('hello again') };
  74
  75   # ... more code
  76
  77   # XXX: not yet
  78   mail_sent_ok { from => 'admin@localhost', body => qr('hello') };
  79
  80   # you should expect all mails by the end of the test
  81
  82
  83 =head1 DESCRIPTION
  84
  85 This is a test helper module for RT, allowing you to expect mail
  86 notification generated during the block or the test.
  87
  88 =cut
  89
  90 sub mail_ok (&@) {
  91     my $code = shift;
  92
  93     $code->();
  94     local $Test::Builder::Level = $Test::Builder::Level + 1;
  95     my @msgs = RT::Test->fetch_caught_mails;
  96     is(@msgs, @_, "Sent exactly " . @_ . " emails");
  97
  98     for my $spec (@_) {
  99         my $msg = shift @msgs
 100             or ok(0, 'Expecting message but none found.'), next;
 101
 102         $msg =~ s/^\s*//gs; # XXX: for some reasons, message from template has leading newline
 103         # XXX: use Test::Email directly?
 104         my $te = Email::Abstract->new($msg)->cast('MIME::Entity');
 105         bless $te, 'Test::Email';
 106         $te->ok($spec, "email matched");
 107         my $Test = Test::More->builder;
 108         if (!($Test->summary)[$Test->current_test-1]) {
 109             diag $te->as_string;
 110         }
 111     }
 112     RT::Test->clean_caught_mails;
 113 }
 114
 115 END {
 116     my $Test = Test::More->builder;
 117     # Such a hack -- try to detect if this is a forked copy and don't
 118     # do cleanup in that case.
 119     return if $Test->{Original_Pid} != $$;
 120
 121     my @mail = RT::Test->fetch_caught_mails;
 122     if (scalar @mail) {
 123         diag ((scalar @mail)." uncaught notification email at end of test: ");
 124         diag "From: @{[ $_->header('From' ) ]}, Subject: @{[ $_->header('Subject') ]}"
 125             for @mail;
 126         die;
 127     }
 128 }
 129
 130 1;
 131