Bug 14711: Change prototype for AddReserve - pass a hashref
[koha-ffzg.git] / t / db_dependent / Koha / Holds.t
1 #!/usr/bin/perl
2
3 # Copyright 2017 Koha Development team
4 #
5 # This file is part of Koha
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
22 use Test::More tests => 1;
23 use Test::Warn;
24
25 use C4::Reserves;
26 use Koha::Holds;
27 use Koha::Database;
28
29 use t::lib::Mocks;
30 use t::lib::TestBuilder;
31
32 my $schema = Koha::Database->new->schema;
33 $schema->storage->txn_begin;
34
35 my $builder = t::lib::TestBuilder->new;
36
37 subtest 'cancel' => sub {
38     plan tests => 12;
39     my $biblioitem = $builder->build_object( { class => 'Koha::Biblioitems' } );
40     my $library    = $builder->build_object( { class => 'Koha::Libraries' } );
41     my $itemtype   = $builder->build_object( { class => 'Koha::ItemTypes', value => { rentalcharge => 0 } } );
42     my $item_info  = {
43         biblionumber     => $biblioitem->biblionumber,
44         biblioitemnumber => $biblioitem->biblioitemnumber,
45         homebranch       => $library->branchcode,
46         holdingbranch    => $library->branchcode,
47         itype            => $itemtype->itemtype,
48     };
49     my $item = $builder->build_object( { class => 'Koha::Items', value => $item_info } );
50     my $manager = $builder->build_object({ class => "Koha::Patrons" });
51     t::lib::Mocks::mock_userenv({ patron => $manager,branchcode => $manager->branchcode });
52
53     my ( @patrons, @holds );
54     for my $i ( 0 .. 2 ) {
55         my $priority = $i + 1;
56         my $patron   = $builder->build_object(
57             {
58                 class => 'Koha::Patrons',
59                 value => { branchcode => $library->branchcode, }
60             }
61         );
62         my $reserve_id = C4::Reserves::AddReserve(
63             {
64                 branchcode     => $library->branchcode,
65                 borrowernumber => $patron->borrowernumber,
66                 biblionumber   => $item->biblionumber,
67                 priority       => $priority,
68                 title          => "title for fee",
69                 itemnumber     => $item->itemnumber,
70             }
71         );
72         my $hold = Koha::Holds->find($reserve_id);
73         push @patrons, $patron;
74         push @holds,   $hold;
75     }
76
77     # There are 3 holds on this records
78     my $nb_of_holds =
79       Koha::Holds->search( { biblionumber => $item->biblionumber } )->count;
80     is( $nb_of_holds, 3,
81         'There should have 3 holds placed on this biblio record' );
82     my $first_hold  = $holds[0];
83     my $second_hold = $holds[1];
84     my $third_hold  = $holds[2];
85     is( ref($second_hold), 'Koha::Hold',
86         'We should play with Koha::Hold objects' );
87     is( $second_hold->priority, 2,
88         'Second hold should have a priority set to 3' );
89
90     # Remove the second hold, only 2 should still exist in DB and priorities must have been updated
91     my $is_cancelled = $second_hold->cancel;
92     is( ref($is_cancelled), 'Koha::Hold',
93         'Koha::Hold->cancel should return the Koha::Hold (?)' )
94       ;    # This is can reconsidered
95     is( $second_hold->in_storage, 0,
96         'The hold has been cancelled and does not longer exist in DB' );
97     $nb_of_holds =
98       Koha::Holds->search( { biblionumber => $item->biblionumber } )->count;
99     is( $nb_of_holds, 2,
100         'a hold has been cancelled, there should have only 2 holds placed on this biblio record'
101     );
102
103     # discard_changes to refetch
104     is( $first_hold->discard_changes->priority, 1, 'First hold should still be first' );
105     is( $third_hold->discard_changes->priority, 2, 'Third hold should now be second' );
106
107     subtest 'charge_cancel_fee parameter' => sub {
108         plan tests => 4;
109         my $patron_category = $builder->build_object({ class => 'Koha::Patron::Categories', value => { reservefee => 0 } } );
110         my $patron = $builder->build_object({ class => 'Koha::Patrons', value => { categorycode => $patron_category->categorycode } });
111         is( $patron->account->balance, 0, 'A new patron does not have any charges' );
112
113         my $hold_info = {
114             branchcode     => $library->branchcode,
115             borrowernumber => $patron->borrowernumber,
116             biblionumber   => $item->biblionumber,
117             priority       => 1,
118             title          => "title for fee",
119             itemnumber     => $item->itemnumber,
120         };
121
122         # First, test cancelling a reserve when there's no charge configured.
123         t::lib::Mocks::mock_preference('ExpireReservesMaxPickUpDelayCharge', 0);
124         my $reserve_id = C4::Reserves::AddReserve( $hold_info );
125         Koha::Holds->find( $reserve_id )->cancel( { charge_cancel_fee => 1 } );
126         is( $patron->account->balance, 0, 'ExpireReservesMaxPickUpDelayCharge=0 - The patron should not have been charged' );
127
128         # Then, test cancelling a reserve when there's no charge desired.
129         t::lib::Mocks::mock_preference('ExpireReservesMaxPickUpDelayCharge', 42);
130         $reserve_id = C4::Reserves::AddReserve( $hold_info );
131         Koha::Holds->find( $reserve_id )->cancel(); # charge_cancel_fee => 0
132         is( $patron->account->balance, 0, 'ExpireReservesMaxPickUpDelayCharge=42, but charge_cancel_fee => 0, The patron should not have been charged' );
133
134
135         # Finally, test cancelling a reserve when there's a charge desired and configured.
136         t::lib::Mocks::mock_preference('ExpireReservesMaxPickUpDelayCharge', 42);
137         $reserve_id = C4::Reserves::AddReserve( $hold_info );
138         Koha::Holds->find( $reserve_id )->cancel( { charge_cancel_fee => 1 } );
139         is( int($patron->account->balance), 42, 'ExpireReservesMaxPickUpDelayCharge=42 and charge_cancel_fee => 1, The patron should have been charged!' );
140     };
141
142     subtest 'waiting hold' => sub {
143         plan tests => 1;
144         my $patron = $builder->build_object({ class => 'Koha::Patrons' });
145         my $reserve_id = C4::Reserves::AddReserve(
146             {
147                 branchcode     => $library->branchcode,
148                 borrowernumber => $patron->borrowernumber,
149                 biblionumber   => $item->biblionumber,
150                 priority       => 1,
151                 title          => "title for fee",
152                 itemnumber     => $item->itemnumber,
153                 found          => 'W',
154             }
155         );
156         Koha::Holds->find( $reserve_id )->cancel;
157         my $hold_old = Koha::Old::Holds->find( $reserve_id );
158         is( $hold_old->found, 'W', 'The found column should have been kept and a hold is cancelled' );
159     };
160
161     subtest 'HoldsLog' => sub {
162         plan tests => 2;
163         my $patron = $builder->build_object({ class => 'Koha::Patrons' });
164         my $hold_info = {
165             branchcode     => $library->branchcode,
166             borrowernumber => $patron->borrowernumber,
167             biblionumber   => $item->biblionumber,
168             priority       => 1,
169             title          => "title for fee",
170             itemnumber     => $item->itemnumber,
171         };
172
173         t::lib::Mocks::mock_preference('HoldsLog', 0);
174         my $reserve_id = C4::Reserves::AddReserve($hold_info);
175         Koha::Holds->find( $reserve_id )->cancel;
176         my $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'HOLDS', action => 'CANCEL', object => $reserve_id } )->count;
177         is( $number_of_logs, 0, 'Without HoldsLog, Koha::Hold->cancel should not have logged' );
178
179         t::lib::Mocks::mock_preference('HoldsLog', 1);
180         $reserve_id = C4::Reserves::AddReserve($hold_info);
181         Koha::Holds->find( $reserve_id )->cancel;
182         $number_of_logs = $schema->resultset('ActionLog')->search( { module => 'HOLDS', action => 'CANCEL', object => $reserve_id } )->count;
183         is( $number_of_logs, 1, 'With HoldsLog, Koha::Hold->cancel should have logged' );
184     };
185
186     subtest 'rollback' => sub {
187         plan tests => 3;
188         my $patron_category = $builder->build_object(
189             {
190                 class => 'Koha::Patron::Categories',
191                 value => { reservefee => 0 }
192             }
193         );
194         my $patron = $builder->build_object(
195             {
196                 class => 'Koha::Patrons',
197                 value => { categorycode => $patron_category->categorycode }
198             }
199         );
200         my $hold_info = {
201             branchcode     => $library->branchcode,
202             borrowernumber => $patron->borrowernumber,
203             biblionumber   => $item->biblionumber,
204             priority       => 1,
205             title          => "title for fee",
206             itemnumber     => $item->itemnumber,
207         };
208
209         t::lib::Mocks::mock_preference( 'ExpireReservesMaxPickUpDelayCharge',42 );
210         my $reserve_id = C4::Reserves::AddReserve($hold_info);
211         my $hold       = Koha::Holds->find($reserve_id);
212
213         # Add a row with the same id to make the cancel fails
214         Koha::Old::Hold->new( $hold->unblessed )->store;
215
216         warning_like {
217             eval { $hold->cancel( { charge_cancel_fee => 1 } ) };
218         }
219         qr{.*DBD::mysql::st execute failed: Duplicate entry.*},
220           'DBD should have raised an error about dup primary key';
221
222         $hold = Koha::Holds->find($reserve_id);
223         is( ref($hold), 'Koha::Hold', 'The hold should not have been deleted' );
224         is( $patron->account->balance, 0,
225 'If the hold has not been cancelled, the patron should not have been charged'
226         );
227     };
228
229 };
230
231 $schema->storage->txn_rollback;
232
233 1;