rt/lib/RT/Test/Email.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2018 Best Practical Solutions, LLC
   6 #                                          <sales@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 =head1 NAME
  60
  61 RT::Test::Email -
  62
  63 =head1 SYNOPSIS
  64
  65   use RT::Test::Email;
  66
  67   mail_ok {
  68     # ... code
  69
  70   } { from => 'admin@localhost', body => qr('hello') },
  71     { from => 'admin@localhost', body => qr('hello again') };
  72
  73   # ... more code
  74
  75   # XXX: not yet
  76   mail_sent_ok { from => 'admin@localhost', body => qr('hello') };
  77
  78   # you should expect all mails by the end of the test
  79
  80
  81 =head1 DESCRIPTION
  82
  83 This is a test helper module for RT, allowing you to expect mail
  84 notification generated during the block or the test.
  85
  86 =cut
  87
  88 sub mail_ok (&@) {
  89     my $code = shift;
  90
  91     $code->();
  92     local $Test::Builder::Level = $Test::Builder::Level + 1;
  93     my @msgs = RT::Test->fetch_caught_mails;
  94     is(@msgs, @_, "Sent exactly " . @_ . " emails");
  95
  96     for my $spec (@_) {
  97         my $msg = shift @msgs
  98             or ok(0, 'Expecting message but none found.'), next;
  99
 100         $msg =~ s/^\s*//gs; # XXX: for some reasons, message from template has leading newline
 101         # XXX: use Test::Email directly?
 102         my $te = Email::Abstract->new($msg)->cast('MIME::Entity');
 103         bless $te, 'Test::Email';
 104         $te->ok($spec, "email matched");
 105         my $Test = Test::More->builder;
 106         if (!($Test->summary)[$Test->current_test-1]) {
 107             diag $te->as_string;
 108         }
 109     }
 110     RT::Test->clean_caught_mails;
 111 }
 112
 113 END {
 114     my $Test = Test::More->builder;
 115     # Such a hack -- try to detect if this is a forked copy and don't
 116     # do cleanup in that case.
 117     return if $Test->{Original_Pid} != $$;
 118
 119     my @mail = RT::Test->fetch_caught_mails;
 120     if (scalar @mail) {
 121         diag ((scalar @mail)." uncaught notification email at end of test: ");
 122         diag "From: @{[ $_->header('From' ) ]}, Subject: @{[ $_->header('Subject') ]}"
 123             for map { Email::Abstract->new($_)->cast('Email::Simple') } @mail;
 124
 125         die;
 126     }
 127 }
 128
 129 1;
 130