Koha/t/db_dependent/api/v1/patrons_holds.t
Jonathan Druart 7a32231a52
Bug 35353: Add REST API endpoint to retrieve old holds
Same as checkout but for holds, we need to provide a way to retrieve old
holds for a patron.

Test plan:
Create some holds for a patron, cancel and fulfill some, then use the
REST API endpoint with the new 'old' flag set to 1
  /api/v1/patrons/42/holds?old=1

Signed-off-by: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
2024-04-26 18:06:09 +02:00

169 lines
6 KiB
Perl
Executable file

#!/usr/bin/env perl
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use Test::More tests => 2;
use Test::MockModule;
use Test::Mojo;
use t::lib::TestBuilder;
use t::lib::Mocks;
use Koha::Database;
my $schema = Koha::Database->new->schema;
my $builder = t::lib::TestBuilder->new();
my $t = Test::Mojo->new('Koha::REST::V1');
t::lib::Mocks::mock_preference( 'RESTBasicAuth', 1 );
subtest 'list() tests' => sub {
plan tests => 18;
$schema->storage->txn_begin;
my $patron = $builder->build_object({
class => 'Koha::Patrons',
value => { flags => 2 ** 4 } # 'borrowers' flag == 4
});
my $password = 'thePassword123';
$patron->set_password({ password => $password, skip_validation => 1 });
my $userid = $patron->userid;
$t->get_ok("//$userid:$password@/api/v1/patrons/" . $patron->id . '/holds')
->status_is( 200, 'SWAGGER3.2.2' )
->json_is( [] );
my $hold_1 = $builder->build_object( { class => 'Koha::Holds', value => { borrowernumber => $patron->id } } );
my $hold_2 = $builder->build_object( { class => 'Koha::Holds', value => { borrowernumber => $patron->id } } );
my $hold_3 = $builder->build_object( { class => 'Koha::Holds', value => { borrowernumber => $patron->id } } );
$t->get_ok( "//$userid:$password@/api/v1/patrons/" . $patron->id . '/holds?_order_by=+me.hold_id' )
->status_is( 200, 'SWAGGER3.2.2' )
->json_is( '' => [ $hold_1->to_api, $hold_2->to_api, $hold_3->to_api ], 'Holds retrieved' );
$hold_1->fill;
$hold_3->fill;
$t->get_ok( "//$userid:$password@/api/v1/patrons/" . $patron->id . '/holds?_order_by=+me.hold_id' )
->status_is( 200, 'SWAGGER3.2.2' )->json_is( '' => [ $hold_2->to_api ], 'Only current holds retrieved' );
$t->get_ok( "//$userid:$password@/api/v1/patrons/" . $patron->id . '/holds?old=1&_order_by=+me.hold_id' )
->status_is( 200, 'SWAGGER3.2.2' )
->json_is( '' => [ $hold_1->to_api, $hold_3->to_api ], 'Only old holds retrieved' );
my $old_hold_1 = Koha::Old::Holds->find( $hold_1->id );
$old_hold_1->item->delete;
$old_hold_1->pickup_library->delete;
$t->get_ok( "//$userid:$password@/api/v1/patrons/" . $patron->id . '/holds?old=1&_order_by=+me.hold_id' )
->status_is( 200, 'SWAGGER3.2.2' )->json_is(
'' => [ $old_hold_1->get_from_storage->to_api, $hold_3->to_api ],
'Old holds even after item and library removed'
);
my $non_existent_patron = $builder->build_object({ class => 'Koha::Patrons' });
my $non_existent_patron_id = $non_existent_patron->id;
# get rid of the patron
$non_existent_patron->delete;
$t->get_ok("//$userid:$password@/api/v1/patrons/" . $non_existent_patron_id . '/holds')
->status_is( 404 )
->json_is( '/error' => 'Patron not found' );
$schema->storage->txn_rollback;
};
subtest 'delete_public() tests' => sub {
plan tests => 13;
$schema->storage->txn_begin;
t::lib::Mocks::mock_preference( 'RealTimeHoldsQueue', 0 );
my $patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 0 },
}
);
my $password = 'thePassword123';
$patron->set_password( { password => $password, skip_validation => 1 } );
my $userid = $patron->userid;
my $hold_to_delete = $builder->build_object( { class => 'Koha::Holds' } );
my $deleted_hold_id = $hold_to_delete->id;
$hold_to_delete->delete;
$t->delete_ok( "//$userid:$password@/api/v1/public/patrons/" . $patron->id . '/holds/' . $deleted_hold_id )
->status_is(404);
my $another_user_hold = $builder->build_object( { class => 'Koha::Holds' } );
$t->delete_ok( "//$userid:$password@/api/v1/public/patrons/" . $patron->id . '/holds/' . $another_user_hold->id )
->status_is( 404, 'Invalid patron_id and hold_id combination yields 404' );
my $non_waiting_hold = $builder->build_object(
{
class => 'Koha::Holds',
value => {
borrowernumber => $patron->id,
found => undef,
itemnumber => undef
}
}
);
$t->delete_ok( "//$userid:$password@/api/v1/public/patrons/" . $patron->id . '/holds/' . $non_waiting_hold->id )
->status_is( 204, 'SWAGGER3.2.4' )->content_is( '', 'SWAGGER3.3.4' );
my $cancellation_requestable;
my $hold_mock = Test::MockModule->new('Koha::Hold');
$hold_mock->mock( 'cancellation_requestable_from_opac', sub { return $cancellation_requestable; } );
my $item = $builder->build_sample_item;
my $waiting_hold = $builder->build_object(
{
class => 'Koha::Holds',
value => {
borrowernumber => $patron->id,
found => 'W',
itemnumber => $item->id,
}
}
);
$cancellation_requestable = 0;
$t->delete_ok( "//$userid:$password@/api/v1/public/patrons/" . $patron->id . '/holds/' . $waiting_hold->id )
->status_is(403)->json_is( { error => 'Cancellation forbidden' } );
$cancellation_requestable = 1;
$t->delete_ok( "//$userid:$password@/api/v1/public/patrons/" . $patron->id . '/holds/' . $waiting_hold->id )
->status_is(202);
my $cancellation_requests = $waiting_hold->cancellation_requests;
is( $cancellation_requests->count, 1, 'Cancellation request recorded' );
$schema->storage->txn_rollback;
};