t/db_dependent/Letters.t

   1 #!/usr/bin/perl
   2
   3 # This file is part of Koha.
   4 #
   5 # Copyright (C) 2013 Equinox Software, Inc.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21 use Test::More tests => 58;
  22 use Test::MockModule;
  23 use Test::Warn;
  24
  25 use MARC::Record;
  26
  27 my %mail;
  28 my $module = new Test::MockModule('Mail::Sendmail');
  29 $module->mock(
  30     'sendmail',
  31     sub {
  32         warn "Fake sendmail";
  33         %mail = @_;
  34     }
  35 );
  36
  37 use_ok('C4::Context');
  38 use_ok('C4::Members');
  39 use_ok('C4::Branch');
  40 use_ok('C4::Acquisition');
  41 use_ok('C4::Biblio');
  42 use_ok('C4::Bookseller');
  43 use_ok('C4::Letters');
  44 use t::lib::Mocks;
  45 use Koha::DateUtils qw( dt_from_string output_pref );
  46 use Koha::Acquisition::Order;
  47 use Koha::Acquisition::Bookseller;
  48 use Koha::Database;
  49
  50 my $dbh = C4::Context->dbh;
  51
  52 my $database = Koha::Database->new();
  53 my $schema = $database->schema();
  54 $schema->storage->txn_begin();
  55
  56 # Start transaction
  57 $dbh->{RaiseError} = 1;
  58
  59 $dbh->do(q|DELETE FROM letter|);
  60 $dbh->do(q|DELETE FROM message_queue|);
  61 $dbh->do(q|DELETE FROM message_transport_types|);
  62
  63 my $date = dt_from_string;
  64 my $borrowernumber = AddMember(
  65     firstname    => 'Jane',
  66     surname      => 'Smith',
  67     categorycode => 'PT',
  68     branchcode   => 'CPL',
  69     dateofbirth  => $date,
  70 );
  71
  72 my $marc_record = MARC::Record->new;
  73 my( $biblionumber, $biblioitemnumber ) = AddBiblio( $marc_record, '' );
  74
  75 # GetMessageTransportTypes
  76 my $mtts = C4::Letters::GetMessageTransportTypes();
  77 is( @$mtts, 0, 'GetMessageTransportTypes returns the correct number of message types' );
  78
  79 $dbh->do(q|
  80     INSERT INTO message_transport_types( message_transport_type ) VALUES ('email'), ('phone'), ('print'), ('sms')
  81 |);
  82 $mtts = C4::Letters::GetMessageTransportTypes();
  83 is_deeply( $mtts, ['email', 'phone', 'print', 'sms'], 'GetMessageTransportTypes returns all values' );
  84
  85
  86 # EnqueueLetter
  87 is( C4::Letters::EnqueueLetter(), undef, 'EnqueueLetter without argument returns undef' );
  88
  89 my $my_message = {
  90     borrowernumber         => $borrowernumber,
  91     message_transport_type => 'sms',
  92     to_address             => 'to@example.com',
  93     from_address           => 'from@example.com',
  94 };
  95 my $message_id = C4::Letters::EnqueueLetter($my_message);
  96 is( $message_id, undef, 'EnqueueLetter without the letter argument returns undef' );
  97
  98 delete $my_message->{message_transport_type};
  99 $my_message->{letter} = {
 100     content      => 'a message',
 101     title        => 'message title',
 102     metadata     => 'metadata',
 103     code         => 'TEST_MESSAGE',
 104     content_type => 'text/plain',
 105 };
 106 $message_id = C4::Letters::EnqueueLetter($my_message);
 107 is( $message_id, undef, 'EnqueueLetter without the message type argument argument returns undef' );
 108
 109 $my_message->{message_transport_type} = 'sms';
 110 $message_id = C4::Letters::EnqueueLetter($my_message);
 111 ok(defined $message_id && $message_id > 0, 'new message successfully queued');
 112
 113
 114 # GetQueuedMessages
 115 my $messages = C4::Letters::GetQueuedMessages();
 116 is( @$messages, 1, 'GetQueuedMessages without argument returns all the entries' );
 117
 118 $messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber });
 119 is( @$messages, 1, 'one message stored for the borrower' );
 120 is( $messages->[0]->{message_id}, $message_id, 'EnqueueLetter returns the message id correctly' );
 121 is( $messages->[0]->{borrowernumber}, $borrowernumber, 'EnqueueLetter stores the borrower number correctly' );
 122 is( $messages->[0]->{subject}, $my_message->{letter}->{title}, 'EnqueueLetter stores the subject correctly' );
 123 is( $messages->[0]->{content}, $my_message->{letter}->{content}, 'EnqueueLetter stores the content correctly' );
 124 is( $messages->[0]->{message_transport_type}, $my_message->{message_transport_type}, 'EnqueueLetter stores the message type correctly' );
 125 is( $messages->[0]->{status}, 'pending', 'EnqueueLetter stores the status pending correctly' );
 126
 127
 128 # SendQueuedMessages
 129 my $messages_processed = C4::Letters::SendQueuedMessages();
 130 is($messages_processed, 1, 'all queued messages processed');
 131
 132 $messages = C4::Letters::GetQueuedMessages({ borrowernumber => $borrowernumber });
 133 is(
 134     $messages->[0]->{status},
 135     'failed',
 136     'message marked failed if tried to send SMS message for borrower with no smsalertnumber set (bug 11208)'
 137 );
 138
 139 # GetLetters
 140 my $letters = C4::Letters::GetLetters();
 141 is( @$letters, 0, 'GetLetters returns the correct number of letters' );
 142
 143 my $title = q|<<branches.branchname>> - <<status>>|;
 144 my $content = q|Dear <<borrowers.firstname>> <<borrowers.surname>>,
 145 According to our current records, you have items that are overdue.Your library does not charge late fines, but please return or renew them at the branch below as soon as possible.
 146
 147 <<branches.branchname>>
 148 <<branches.branchaddress1>>
 149 URL: <<OPACBaseURL>>
 150
 151 The following item(s) is/are currently <<status>>:
 152
 153 <item> <<count>>. <<items.itemcallnumber>>, Barcode: <<items.barcode>> </item>
 154
 155 Thank-you for your prompt attention to this matter.
 156 Don't forget your date of birth: <<borrowers.dateofbirth>>.
 157 Look at this wonderful biblio timestamp: <<biblio.timestamp>>.
 158 |;
 159
 160 $dbh->do( q|INSERT INTO letter(branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES ('CPL','my module','my code','my name',1,?,?,'email')|, undef, $title, $content );
 161 $letters = C4::Letters::GetLetters();
 162 is( @$letters, 1, 'GetLetters returns the correct number of letters' );
 163 is( $letters->[0]->{branchcode}, 'CPL', 'GetLetters gets the branch code correctly' );
 164 is( $letters->[0]->{module}, 'my module', 'GetLetters gets the module correctly' );
 165 is( $letters->[0]->{code}, 'my code', 'GetLetters gets the code correctly' );
 166 is( $letters->[0]->{name}, 'my name', 'GetLetters gets the name correctly' );
 167
 168
 169 # getletter
 170 my $letter = C4::Letters::getletter('my module', 'my code', 'CPL', 'email');
 171 is( $letter->{branchcode}, 'CPL', 'GetLetters gets the branch code correctly' );
 172 is( $letter->{module}, 'my module', 'GetLetters gets the module correctly' );
 173 is( $letter->{code}, 'my code', 'GetLetters gets the code correctly' );
 174 is( $letter->{name}, 'my name', 'GetLetters gets the name correctly' );
 175 is( $letter->{is_html}, 1, 'GetLetters gets the boolean is_html correctly' );
 176 is( $letter->{title}, $title, 'GetLetters gets the title correctly' );
 177 is( $letter->{content}, $content, 'GetLetters gets the content correctly' );
 178 is( $letter->{message_transport_type}, 'email', 'GetLetters gets the message type correctly' );
 179
 180
 181 # addalert
 182 my $type = 'my type';
 183 my $externalid = 'my external id';
 184 my $alert_id = C4::Letters::addalert($borrowernumber, $type, $externalid);
 185 isnt( $alert_id, undef, 'addalert does not return undef' );
 186
 187 my $alerts = C4::Letters::getalert($borrowernumber);
 188 is( @$alerts, 1, 'addalert adds an alert' );
 189 is( $alerts->[0]->{alertid}, $alert_id, 'addalert returns the alert id correctly' );
 190 is( $alerts->[0]->{type}, $type, 'addalert stores the type correctly' );
 191 is( $alerts->[0]->{externalid}, $externalid, 'addalert stores the externalid correctly' );
 192
 193
 194 # getalert
 195 $alerts = C4::Letters::getalert($borrowernumber, $type);
 196 is( @$alerts, 1, 'getalert returns the correct number of alerts' );
 197 $alerts = C4::Letters::getalert($borrowernumber, $type, $externalid);
 198 is( @$alerts, 1, 'getalert returns the correct number of alerts' );
 199 $alerts = C4::Letters::getalert($borrowernumber, 'another type');
 200 is( @$alerts, 0, 'getalert returns the correct number of alerts' );
 201 $alerts = C4::Letters::getalert($borrowernumber, $type, 'another external id');
 202 is( @$alerts, 0, 'getalert returns the correct number of alerts' );
 203
 204
 205 # delalert
 206 eval {
 207     C4::Letters::delalert();
 208 };
 209 isnt( $@, undef, 'delalert without argument returns an error' );
 210 $alerts = C4::Letters::getalert($borrowernumber);
 211 is( @$alerts, 1, 'delalert without argument does not remove an alert' );
 212
 213 C4::Letters::delalert($alert_id);
 214 $alerts = C4::Letters::getalert($borrowernumber);
 215 is( @$alerts, 0, 'delalert removes an alert' );
 216
 217
 218 # GetPreparedLetter
 219 t::lib::Mocks::mock_preference('OPACBaseURL', 'http://thisisatest.com');
 220
 221 my $sms_content = 'This is a SMS for an <<status>>';
 222 $dbh->do( q|INSERT INTO letter(branchcode,module,code,name,is_html,title,content,message_transport_type) VALUES ('CPL','my module','my code','my name',1,'my title',?,'sms')|, undef, $sms_content );
 223
 224 my $tables = {
 225     borrowers => $borrowernumber,
 226     branches => 'CPL',
 227     biblio => $biblionumber,
 228 };
 229 my $substitute = {
 230     status => 'overdue',
 231 };
 232 my $repeat = [
 233     {
 234         itemcallnumber => 'my callnumber1',
 235         barcode        => '1234',
 236     },
 237     {
 238         itemcallnumber => 'my callnumber2',
 239         barcode        => '5678',
 240     },
 241 ];
 242 my $prepared_letter = GetPreparedLetter((
 243     module      => 'my module',
 244     branchcode  => 'CPL',
 245     letter_code => 'my code',
 246     tables      => $tables,
 247     substitute  => $substitute,
 248     repeat      => $repeat,
 249 ));
 250 my $branch = GetBranchDetail('CPL');
 251 my $my_title_letter = qq|$branch->{branchname} - $substitute->{status}|;
 252 my $my_content_letter = qq|Dear Jane Smith,
 253 According to our current records, you have items that are overdue.Your library does not charge late fines, but please return or renew them at the branch below as soon as possible.
 254
 255 $branch->{branchname}
 256 $branch->{branchaddress1}
 257 URL: http://thisisatest.com
 258
 259 The following item(s) is/are currently $substitute->{status}:
 260
 261 <item> 1. $repeat->[0]->{itemcallnumber}, Barcode: $repeat->[0]->{barcode} </item>
 262 <item> 2. $repeat->[1]->{itemcallnumber}, Barcode: $repeat->[1]->{barcode} </item>
 263
 264 Thank-you for your prompt attention to this matter.
 265 Don't forget your date of birth: | . output_pref({ dt => $date, dateonly => 1 }) . q|.
 266 Look at this wonderful biblio timestamp: | . output_pref({ dt => $date }) . ".\n";
 267 is( $prepared_letter->{title}, $my_title_letter, 'GetPreparedLetter returns the title correctly' );
 268 is( $prepared_letter->{content}, $my_content_letter, 'GetPreparedLetter returns the content correctly' );
 269
 270 $prepared_letter = GetPreparedLetter((
 271     module                 => 'my module',
 272     branchcode             => 'CPL',
 273     letter_code            => 'my code',
 274     tables                 => $tables,
 275     substitute             => $substitute,
 276     repeat                 => $repeat,
 277     message_transport_type => 'sms',
 278 ));
 279 $my_content_letter = qq|This is a SMS for an $substitute->{status}|;
 280 is( $prepared_letter->{content}, $my_content_letter, 'GetPreparedLetter returns the content correctly' );
 281
 282 $dbh->do(q{INSERT INTO letter (module, code, name, title, content) VALUES ('claimacquisition','TESTACQCLAIM','Acquisition Claim','Item Not Received','<<aqbooksellers.name>>|<<aqcontacts.name>>|<order>Ordernumber <<aqorders.ordernumber>> (<<biblio.title>>) (<<aqorders.quantity>> ordered)</order>');});
 283
 284 my $booksellerid = C4::Bookseller::AddBookseller(
 285     {
 286         name => "my vendor",
 287         address1 => "bookseller's address",
 288         phone => "0123456",
 289         active => 1,
 290         deliverytime => 5,
 291     },
 292     [
 293         { name => 'John Smith',  phone => '0123456x1', claimacquisition => 1 },
 294         { name => 'Leo Tolstoy', phone => '0123456x2', claimissues => 1 },
 295     ]
 296 );
 297 my $basketno = NewBasket($booksellerid, 1);
 298
 299 my $budgetid = C4::Budgets::AddBudget({
 300     budget_code => "budget_code_test_letters",
 301     budget_name => "budget_name_test_letters",
 302 });
 303
 304 my $bib = MARC::Record->new();
 305 if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
 306     $bib->append_fields(
 307         MARC::Field->new('200', ' ', ' ', a => 'Silence in the library'),
 308     );
 309 } else {
 310     $bib->append_fields(
 311         MARC::Field->new('245', ' ', ' ', a => 'Silence in the library'),
 312     );
 313 }
 314
 315 ($biblionumber, $biblioitemnumber) = AddBiblio($bib, '');
 316 my $order = Koha::Acquisition::Order->new(
 317     {
 318         basketno => $basketno,
 319         quantity => 1,
 320         biblionumber => $biblionumber,
 321         budget_id => $budgetid,
 322     }
 323 )->insert;
 324 my $ordernumber = $order->{ordernumber};
 325
 326 C4::Acquisition::CloseBasket( $basketno );
 327 my $err;
 328 warning_like {
 329     $err = SendAlerts( 'claimacquisition', [ $ordernumber ], 'TESTACQCLAIM' ) }
 330     qr/^Bookseller .* without emails at/,
 331     "SendAlerts prints a warning";
 332 is($err->{'error'}, 'no_email', "Trying to send an alert when there's no e-mail results in an error");
 333
 334 my $bookseller = Koha::Acquisition::Bookseller->fetch({ id => $booksellerid });
 335 $bookseller->contacts->[0]->email('testemail@mydomain.com');
 336 C4::Bookseller::ModBookseller($bookseller);
 337 $bookseller = Koha::Acquisition::Bookseller->fetch({ id => $booksellerid });
 338
 339 warning_is {
 340     $err = SendAlerts( 'claimacquisition', [ $ordernumber ], 'TESTACQCLAIM' ) }
 341     "Fake sendmail",
 342     "SendAlerts is using the mocked sendmail routine";
 343
 344 is($err, 1, "Successfully sent claim");
 345 is($mail{'To'}, 'testemail@mydomain.com', "mailto correct in sent claim");
 346 is($mail{'Message'}, 'my vendor|John Smith|Ordernumber ' . $ordernumber . ' (Silence in the library) (1 ordered)', 'Claim notice text constructed successfully');
 347
 348 $schema->storage->txn_rollback();