t/db_dependent/api/v1/holds.t

   1 #!/usr/bin/env perl
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use Modern::Perl;
  19
  20 use Test::More tests => 8;
  21 use Test::Mojo;
  22 use t::lib::TestBuilder;
  23 use t::lib::Mocks;
  24
  25 use DateTime;
  26
  27 use C4::Context;
  28 use Koha::Patrons;
  29 use C4::Reserves;
  30 use C4::Items;
  31
  32 use Koha::Database;
  33 use Koha::DateUtils;
  34 use Koha::Biblios;
  35 use Koha::Biblioitems;
  36 use Koha::Items;
  37 use Koha::CirculationRules;
  38
  39 my $schema  = Koha::Database->new->schema;
  40 my $builder = t::lib::TestBuilder->new();
  41
  42 $schema->storage->txn_begin;
  43
  44 t::lib::Mocks::mock_preference( 'RESTBasicAuth', 1 );
  45
  46 my $t = Test::Mojo->new('Koha::REST::V1');
  47
  48 my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
  49 my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
  50 my $itemtype = $builder->build({ source => 'Itemtype' })->{itemtype};
  51
  52 # Generic password for everyone
  53 my $password = 'thePassword123';
  54
  55 # User without any permissions
  56 my $nopermission = $builder->build_object({
  57     class => 'Koha::Patrons',
  58     value => {
  59         branchcode   => $branchcode,
  60         categorycode => $categorycode,
  61         flags        => 0
  62     }
  63 });
  64 $nopermission->set_password( { password => $password, skip_validation => 1 } );
  65 my $nopermission_userid = $nopermission->userid;
  66
  67 my $patron_1 = $builder->build_object(
  68     {
  69         class => 'Koha::Patrons',
  70         value => {
  71             categorycode => $categorycode,
  72             branchcode   => $branchcode,
  73             surname      => 'Test Surname',
  74             flags        => 80, #borrowers and reserveforothers flags
  75         }
  76     }
  77 );
  78 $patron_1->set_password( { password => $password, skip_validation => 1 } );
  79 my $userid_1 = $patron_1->userid;
  80
  81 my $patron_2 = $builder->build_object(
  82     {
  83         class => 'Koha::Patrons',
  84         value => {
  85             categorycode => $categorycode,
  86             branchcode   => $branchcode,
  87             surname      => 'Test Surname 2',
  88             flags        => 16, # borrowers flag
  89         }
  90     }
  91 );
  92 $patron_2->set_password( { password => $password, skip_validation => 1 } );
  93 my $userid_2 = $patron_2->userid;
  94
  95 my $patron_3 = $builder->build_object(
  96     {
  97         class => 'Koha::Patrons',
  98         value => {
  99             categorycode => $categorycode,
 100             branchcode   => $branchcode,
 101             surname      => 'Test Surname 3',
 102             flags        => 64, # reserveforothers flag
 103         }
 104     }
 105 );
 106 $patron_3->set_password( { password => $password, skip_validation => 1 } );
 107 my $userid_3 = $patron_3->userid;
 108
 109 my $biblio_1 = $builder->build_sample_biblio;
 110 my $item_1   = $builder->build_sample_item({ biblionumber => $biblio_1->biblionumber, itype => $itemtype });
 111
 112 my $biblio_2 = $builder->build_sample_biblio;
 113 my $item_2   = $builder->build_sample_item({ biblionumber => $biblio_2->biblionumber, itype => $itemtype });
 114
 115 my $dbh = C4::Context->dbh;
 116 $dbh->do('DELETE FROM reserves');
 117 Koha::CirculationRules->search()->delete();
 118 Koha::CirculationRules->set_rules(
 119     {
 120         categorycode => undef,
 121         branchcode   => undef,
 122         itemtype     => undef,
 123         rules        => {
 124             reservesallowed => 1,
 125             holds_per_record => 99
 126         }
 127     }
 128 );
 129
 130 my $reserve_id = C4::Reserves::AddReserve(
 131     {
 132         branchcode     => $branchcode,
 133         borrowernumber => $patron_1->borrowernumber,
 134         biblionumber   => $biblio_1->biblionumber,
 135         priority       => 1,
 136         itemnumber     => $item_1->itemnumber,
 137     }
 138 );
 139
 140 # Add another reserve to be able to change first reserve's rank
 141 my $reserve_id2 = C4::Reserves::AddReserve(
 142     {
 143         branchcode     => $branchcode,
 144         borrowernumber => $patron_2->borrowernumber,
 145         biblionumber   => $biblio_1->biblionumber,
 146         priority       => 2,
 147         itemnumber     => $item_1->itemnumber,
 148     }
 149 );
 150
 151 my $suspended_until = DateTime->now->add(days => 10)->truncate( to => 'day' );
 152 my $expiration_date = DateTime->now->add(days => 10)->truncate( to => 'day' );
 153
 154 my $post_data = {
 155     patron_id => int($patron_1->borrowernumber),
 156     biblio_id => int($biblio_1->biblionumber),
 157     item_id => int($item_1->itemnumber),
 158     pickup_library_id => $branchcode,
 159     expiration_date => output_pref({ dt => $expiration_date, dateformat => 'rfc3339', dateonly => 1 }),
 160     priority => 2,
 161 };
 162 my $put_data = {
 163     priority => 2,
 164     suspended_until => output_pref({ dt => $suspended_until, dateformat => 'rfc3339' }),
 165 };
 166
 167 subtest "Test endpoints without authentication" => sub {
 168     plan tests => 8;
 169     $t->get_ok('/api/v1/holds')
 170       ->status_is(401);
 171     $t->post_ok('/api/v1/holds')
 172       ->status_is(401);
 173     $t->put_ok('/api/v1/holds/0')
 174       ->status_is(401);
 175     $t->delete_ok('/api/v1/holds/0')
 176       ->status_is(401);
 177 };
 178
 179 subtest "Test endpoints without permission" => sub {
 180
 181     plan tests => 10;
 182
 183     $t->get_ok( "//$nopermission_userid:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber ) # no permission
 184       ->status_is(403);
 185
 186     $t->get_ok( "//$userid_3:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber )    # no permission
 187       ->status_is(403);
 188
 189     $t->post_ok( "//$nopermission_userid:$password@/api/v1/holds" => json => $post_data )
 190       ->status_is(403);
 191
 192     $t->put_ok( "//$nopermission_userid:$password@/api/v1/holds/0" => json => $put_data )
 193       ->status_is(403);
 194
 195     $t->delete_ok( "//$nopermission_userid:$password@/api/v1/holds/0" )
 196       ->status_is(403);
 197 };
 198
 199 subtest "Test endpoints with permission" => sub {
 200
 201     plan tests => 44;
 202
 203     $t->get_ok( "//$userid_1:$password@/api/v1/holds" )
 204       ->status_is(200)
 205       ->json_has('/0')
 206       ->json_has('/1')
 207       ->json_hasnt('/2');
 208
 209     $t->get_ok( "//$userid_1:$password@/api/v1/holds?priority=2" )
 210       ->status_is(200)
 211       ->json_is('/0/patron_id', $patron_2->borrowernumber)
 212       ->json_hasnt('/1');
 213
 214     $t->put_ok( "//$userid_1:$password@/api/v1/holds/$reserve_id" => json => $put_data )
 215       ->status_is(200)
 216       ->json_is( '/hold_id', $reserve_id )
 217       ->json_is( '/suspended_until', output_pref({ dt => $suspended_until, dateformat => 'rfc3339' }) )
 218       ->json_is( '/priority', 2 );
 219
 220     $t->delete_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id" )
 221       ->status_is(200);
 222
 223     $t->put_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id" => json => $put_data )
 224       ->status_is(404)
 225       ->json_has('/error');
 226
 227     $t->delete_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id" )
 228       ->status_is(404)
 229       ->json_has('/error');
 230
 231     $t->get_ok( "//$userid_2:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber )
 232       ->status_is(200)
 233       ->json_is([]);
 234
 235     my $inexisting_borrowernumber = $patron_2->borrowernumber * 2;
 236     $t->get_ok( "//$userid_1:$password@/api/v1/holds?patron_id=$inexisting_borrowernumber")
 237       ->status_is(200)
 238       ->json_is([]);
 239
 240     $t->delete_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id2" )
 241       ->status_is(200);
 242
 243     $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json => $post_data )
 244       ->status_is(201)
 245       ->json_has('/hold_id');
 246     # Get id from response
 247     $reserve_id = $t->tx->res->json->{hold_id};
 248
 249     $t->get_ok( "//$userid_1:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber )
 250       ->status_is(200)
 251       ->json_is('/0/hold_id', $reserve_id)
 252       ->json_is('/0/expiration_date', output_pref({ dt => $expiration_date, dateformat => 'rfc3339', dateonly => 1 }))
 253       ->json_is('/0/pickup_library_id', $branchcode);
 254
 255     $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json => $post_data )
 256       ->status_is(403)
 257       ->json_like('/error', qr/itemAlreadyOnHold/);
 258
 259     $post_data->{biblionumber} = int($biblio_2->biblionumber);
 260     $post_data->{itemnumber}   = int($item_2->itemnumber);
 261
 262     $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json => $post_data )
 263       ->status_is(403)
 264       ->json_like('/error', qr/itemAlreadyOnHold/);
 265 };
 266
 267 subtest 'Reserves with itemtype' => sub {
 268     plan tests => 9;
 269
 270     my $post_data = {
 271         patron_id => int($patron_1->borrowernumber),
 272         biblio_id => int($biblio_1->biblionumber),
 273         pickup_library_id => $branchcode,
 274         item_type => $itemtype,
 275     };
 276
 277     $t->delete_ok( "//$userid_3:$password@/api/v1/holds/$reserve_id" )
 278       ->status_is(200);
 279
 280     $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json => $post_data )
 281       ->status_is(201)
 282       ->json_has('/hold_id');
 283
 284     $reserve_id = $t->tx->res->json->{hold_id};
 285
 286     $t->get_ok( "//$userid_1:$password@/api/v1/holds?patron_id=" . $patron_1->borrowernumber )
 287       ->status_is(200)
 288       ->json_is('/0/hold_id', $reserve_id)
 289       ->json_is('/0/item_type', $itemtype);
 290 };
 291
 292
 293 subtest 'test AllowHoldDateInFuture' => sub {
 294
 295     plan tests => 6;
 296
 297     $dbh->do('DELETE FROM reserves');
 298
 299     my $future_hold_date = DateTime->now->add(days => 10)->truncate( to => 'day' );
 300
 301     my $post_data = {
 302         patron_id => int($patron_1->borrowernumber),
 303         biblio_id => int($biblio_1->biblionumber),
 304         item_id => int($item_1->itemnumber),
 305         pickup_library_id => $branchcode,
 306         expiration_date => output_pref({ dt => $expiration_date, dateformat => 'rfc3339', dateonly => 1 }),
 307         hold_date => output_pref({ dt => $future_hold_date, dateformat => 'rfc3339', dateonly => 1 }),
 308         priority => 2,
 309     };
 310
 311     t::lib::Mocks::mock_preference( 'AllowHoldDateInFuture', 0 );
 312
 313     $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json => $post_data )
 314       ->status_is(400)
 315       ->json_has('/error');
 316
 317     t::lib::Mocks::mock_preference( 'AllowHoldDateInFuture', 1 );
 318
 319     $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json => $post_data )
 320       ->status_is(201)
 321       ->json_is('/hold_date', output_pref({ dt => $future_hold_date, dateformat => 'rfc3339', dateonly => 1 }));
 322 };
 323
 324 subtest 'test AllowHoldPolicyOverride' => sub {
 325
 326     plan tests => 5;
 327
 328     $dbh->do('DELETE FROM reserves');
 329
 330     Koha::CirculationRules->set_rules(
 331         {
 332             itemtype     => undef,
 333             branchcode   => undef,
 334             rules        => {
 335                 holdallowed              => 1
 336             }
 337         }
 338     );
 339
 340     t::lib::Mocks::mock_preference( 'AllowHoldPolicyOverride', 0 );
 341
 342     $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json => $post_data )
 343       ->status_is(403)
 344       ->json_has('/error');
 345
 346     t::lib::Mocks::mock_preference( 'AllowHoldPolicyOverride', 1 );
 347
 348     $t->post_ok( "//$userid_3:$password@/api/v1/holds" => json => $post_data )
 349       ->status_is(201);
 350 };
 351
 352 $schema->storage->txn_rollback;
 353
 354 subtest 'suspend and resume tests' => sub {
 355
 356     plan tests => 21;
 357
 358     $schema->storage->txn_begin;
 359
 360     my $password = 'AbcdEFG123';
 361
 362     my $patron = $builder->build_object(
 363         { class => 'Koha::Patrons', value => { userid => 'tomasito', flags => 1 } } );
 364     $patron->set_password({ password => $password, skip_validation => 1 });
 365     my $userid = $patron->userid;
 366
 367     # Disable logging
 368     t::lib::Mocks::mock_preference( 'HoldsLog',      0 );
 369     t::lib::Mocks::mock_preference( 'RESTBasicAuth', 1 );
 370
 371     my $hold = $builder->build_object(
 372         {   class => 'Koha::Holds',
 373             value => { suspend => 0, suspend_until => undef, waitingdate => undef }
 374         }
 375     );
 376
 377     ok( !$hold->is_suspended, 'Hold is not suspended' );
 378     $t->post_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
 379         ->status_is( 201, 'Hold suspension created' );
 380
 381     $hold->discard_changes;    # refresh object
 382
 383     ok( $hold->is_suspended, 'Hold is suspended' );
 384     $t->json_is(
 385         '/end_date',
 386         output_pref(
 387             {   dt         => dt_from_string( $hold->suspend_until ),
 388                 dateformat => 'rfc3339',
 389                 dateonly   => 1
 390             }
 391         )
 392     );
 393
 394     $t->delete_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
 395       ->status_is( 204, "Correct status when deleting a resource" )
 396       ->json_is( undef );
 397
 398     # Pass a an expiration date for the suspension
 399     my $date = dt_from_string()->add( days => 5 );
 400     $t->post_ok(
 401               "//$userid:$password@/api/v1/holds/"
 402             . $hold->id
 403             . "/suspension" => json => {
 404             end_date =>
 405                 output_pref( { dt => $date, dateformat => 'rfc3339', dateonly => 1 } )
 406             }
 407     )->status_is( 201, 'Hold suspension created' )
 408         ->json_is( '/end_date',
 409         output_pref( { dt => $date, dateformat => 'rfc3339', dateonly => 1 } ) )
 410         ->header_is( Location => "/api/v1/holds/" . $hold->id . "/suspension", 'The Location header is set' );
 411
 412     $t->delete_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
 413       ->status_is( 204, "Correct status when deleting a resource" )
 414       ->json_is( undef );
 415
 416     $hold->set_waiting->discard_changes;
 417
 418     $t->post_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
 419       ->status_is( 400, 'Cannot suspend waiting hold' )
 420       ->json_is( '/error', 'Found hold cannot be suspended. Status=W' );
 421
 422     $hold->set_waiting(1)->discard_changes;
 423
 424     $t->post_ok( "//$userid:$password@/api/v1/holds/" . $hold->id . "/suspension" )
 425       ->status_is( 400, 'Cannot suspend waiting hold' )
 426       ->json_is( '/error', 'Found hold cannot be suspended. Status=T' );
 427
 428     $schema->storage->txn_rollback;
 429 };
 430
 431 subtest 'PUT /holds/{hold_id}/priority tests' => sub {
 432
 433     plan tests => 14;
 434
 435     $schema->storage->txn_begin;
 436
 437     my $password = 'AbcdEFG123';
 438
 439     my $library  = $builder->build_object({ class => 'Koha::Libraries' });
 440     my $patron_np = $builder->build_object(
 441         { class => 'Koha::Patrons', value => { flags => 0 } } );
 442     $patron_np->set_password( { password => $password, skip_validation => 1 } );
 443     my $userid_np = $patron_np->userid;
 444
 445     my $patron = $builder->build_object(
 446         { class => 'Koha::Patrons', value => { flags => 0 } } );
 447     $patron->set_password( { password => $password, skip_validation => 1 } );
 448     my $userid = $patron->userid;
 449     $builder->build(
 450         {
 451             source => 'UserPermission',
 452             value  => {
 453                 borrowernumber => $patron->borrowernumber,
 454                 module_bit     => 6,
 455                 code           => 'modify_holds_priority',
 456             },
 457         }
 458     );
 459
 460     # Disable logging
 461     t::lib::Mocks::mock_preference( 'HoldsLog',      0 );
 462     t::lib::Mocks::mock_preference( 'RESTBasicAuth', 1 );
 463
 464     my $biblio   = $builder->build_sample_biblio;
 465     my $patron_1 = $builder->build_object(
 466         {
 467             class => 'Koha::Patrons',
 468             value => { branchcode => $library->branchcode }
 469         }
 470     );
 471     my $patron_2 = $builder->build_object(
 472         {
 473             class => 'Koha::Patrons',
 474             value => { branchcode => $library->branchcode }
 475         }
 476     );
 477     my $patron_3 = $builder->build_object(
 478         {
 479             class => 'Koha::Patrons',
 480             value => { branchcode => $library->branchcode }
 481         }
 482     );
 483
 484     my $hold_1 = Koha::Holds->find(
 485         AddReserve(
 486             {
 487                 branchcode     => $library->branchcode,
 488                 borrowernumber => $patron_1->borrowernumber,
 489                 biblionumber   => $biblio->biblionumber,
 490                 priority       => 1,
 491             }
 492         )
 493     );
 494     my $hold_2 = Koha::Holds->find(
 495         AddReserve(
 496             {
 497                 branchcode     => $library->branchcode,
 498                 borrowernumber => $patron_2->borrowernumber,
 499                 biblionumber   => $biblio->biblionumber,
 500                 priority       => 2,
 501             }
 502         )
 503     );
 504     my $hold_3 = Koha::Holds->find(
 505         AddReserve(
 506             {
 507                 branchcode     => $library->branchcode,
 508                 borrowernumber => $patron_3->borrowernumber,
 509                 biblionumber   => $biblio->biblionumber,
 510                 priority       => 3,
 511             }
 512         )
 513     );
 514
 515     $t->put_ok( "//$userid_np:$password@/api/v1/holds/"
 516           . $hold_3->id
 517           . "/priority" => json => 1 )->status_is(403);
 518
 519     $t->put_ok( "//$userid:$password@/api/v1/holds/"
 520           . $hold_3->id
 521           . "/priority" => json => 1 )->status_is(200)->json_is(1);
 522
 523     is( $hold_1->discard_changes->priority, 2, 'Priority adjusted correctly' );
 524     is( $hold_2->discard_changes->priority, 3, 'Priority adjusted correctly' );
 525     is( $hold_3->discard_changes->priority, 1, 'Priority adjusted correctly' );
 526
 527     $t->put_ok( "//$userid:$password@/api/v1/holds/"
 528           . $hold_3->id
 529           . "/priority" => json => 3 )->status_is(200)->json_is(3);
 530
 531     is( $hold_1->discard_changes->priority, 1, 'Priority adjusted correctly' );
 532     is( $hold_2->discard_changes->priority, 2, 'Priority adjusted correctly' );
 533     is( $hold_3->discard_changes->priority, 3, 'Priority adjusted correctly' );
 534
 535     $schema->storage->txn_rollback;
 536 };