Koha/t/db_dependent/api/v1/ill_backends.t
Pedro Amorim ac157b7a75
Bug 35581: Koha::Illrequest -> Koha::ILL::Request
Koha/Illrequests.pm -> Koha/ILL/Requests.pm

Merged:
t/db_dependent/Koha/Illrequests.t
t/db_dependent/Illrequests.t

Into:
t/db_dependent/Koha/ILL/Requests.t

ILL classes file structure is, for the most part, around 7 years old and doesn't follow a strict logic. It's so confusing that some test files exist redundantly.

This housekeeping should help future work in regards to ISO18626 to add Koha as a supplying agency instead of just requesting agency, as is now.
It should also help future housekeeping of moving backend related logic out of the Illrequest.pm into Illbackend.pm (now ILL/Request.pm and ILL/Backend.pm as of this patchset).
It should also help in structuring the addition of a master generic form (see bug 35570)

This patchset will require existing backends to be updated to match the new class names and structure, if they invoke them.

Test plan, k-t-d, run tests:
prove t/db_dependent/api/v1/ill_*
prove t/db_dependent/Koha/ILL/*

Test plan, k-t-d, manual:
1) Install FreeForm, enable ILL module, run:
bash <(curl -s https://raw.githubusercontent.com/ammopt/koha-ill-dev/master/start-ill-dev.sh)
2) You'll have to switch the FreeForm repo to the one compatible with this work, like:
cd /kohadevbox/koha/Koha/Illbackends/FreeForm
git checkout reorganize_ILL
3) Do some generic ILL testing:
3.1) Create a request
3.2) Add a comment to a request
3.3) Edit a request
3.4) Edit a request's item metadata
3.5) Confirm a request
3.6) List requests
3.7) Filter requests list using left side filters
4) Install a metadata enrichment plugin:
https://github.com/PTFS-Europe/koha-plugin-api-pubmed
4.1) Create an ILL batch and insert a pubmedid like 123
4.2) Add the request and finish batch
5) Verify all of the above works as expected

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Pedro Amorim <pedro.amorim@ptfs-europe.com>
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
2024-04-22 08:57:45 +02:00

214 lines
6.3 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 => 1;
use Test::MockModule;
use Test::MockObject;
use Test::Mojo;
use t::lib::TestBuilder;
use t::lib::Mocks;
use Koha::AuthorisedValueCategories;
use Koha::ILL::Requests;
my $schema = Koha::Database->new->schema;
my $builder = t::lib::TestBuilder->new;
t::lib::Mocks::mock_preference( 'RESTBasicAuth', 1 );
my $t = Test::Mojo->new('Koha::REST::V1');
subtest 'list() tests' => sub {
plan tests => 16;
# Mock ILL::Request::Config (as module)
my $illconfig_module = Test::MockModule->new('Koha::ILL::Request::Config');
# Start with no backends installed
$illconfig_module->mock( 'available_backends', sub { () } );
# Mock ILLBackend (as object)
my $backend = Test::MockObject->new;
$backend->set_isa('Koha::Illbackends::Mock');
$backend->set_always( 'name', 'Mock' );
$backend->set_always( 'capabilities', sub { return 'bar'; } );
$backend->mock(
'metadata',
sub {
my ( $self, $rq ) = @_;
return {
ID => $rq->illrequest_id,
Title => $rq->patron->borrowernumber
};
}
);
#Add a backend-specific status
$backend->mock(
'status_graph',
sub {
return {
READY => {
prev_actions => [ 'NEW', 'ERROR' ],
id => 'READY',
name => 'Request ready',
ui_method_name => 'Mark request as ready',
method => 'ready',
next_actions => [],
ui_method_icon => 'fa-check',
}
};
}
);
# Mock Koha::ILL::Request::load_backend (to load Mocked Backend)
my $illreqmodule = Test::MockModule->new('Koha::ILL::Request');
$illreqmodule->mock( 'load_backend',
sub { my $self = shift; $self->{_my_backend} = $backend; return $self }
);
$schema->storage->txn_begin;
Koha::ILL::Requests->search->delete;
# create an authorized user
my $librarian = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 2**22 } # 22 => ill
}
);
my $password = 'thePassword123';
$librarian->set_password( { password => $password, skip_validation => 1 } );
my $userid = $librarian->userid;
# create an unauthorized user
my $patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 0 }
}
);
$patron->set_password( { password => $password, skip_validation => 1 } );
my $unauth_userid = $patron->userid;
# Make sure the ILL_STATUS_ALIAS authorised value category is defined
unless (
Koha::AuthorisedValueCategories->search(
{ category_name => 'ILL_STATUS_ALIAS' }
)->count > 0
)
{
$builder->build_object(
{
class => 'Koha::AuthorisedValueCategories',
value => { category_name => 'ILL_STATUS_ALIAS' }
}
);
}
my $tag = "Print copy";
my $av_code = "print_copy";
my $av = $builder->build_object(
{
class => 'Koha::AuthorisedValues',
value => {
category => 'ILL_STATUS_ALIAS',
authorised_value => $av_code,
lib => $tag,
}
}
);
# No backends, expect empty
$t->get_ok("//$userid:$password@/api/v1/ill/backends")->status_is(200)
->json_is( [] );
# Mock one existing backend
$illconfig_module->mock( 'available_backends', sub { ["Mock"] } );
#One backend exists, expect that
$t->get_ok("//$userid:$password@/api/v1/ill/backends")->status_is(200)
->json_has( '/0/ill_backend_id', 'Mock' );
# Prepare status
my $backend_status = {
code => "READY",
str => "Request ready"
};
my $core_status = {
code => "COMP",
str => "Completed"
};
my $alias_status = {
code => $av_code,
str => $tag,
};
# Create some ILL requests
my $backend_status_req = $builder->build_object(
{
class => 'Koha::ILL::Requests',
value =>
{ status => $backend_status->{code}, backend => $backend->name }
}
);
my $core_status_req = $builder->build_object(
{
class => 'Koha::ILL::Requests',
value =>
{ status => $core_status->{code}, backend => $backend->name }
}
);
my $alias_status_req = $builder->build_object(
{
class => 'Koha::ILL::Requests',
value => {
status => $core_status->{code},
backend => $backend->name,
status_alias => $av->authorised_value
}
}
);
#Check for backend existing statuses
$t->get_ok("//$userid:$password@/api/v1/ill/backends/Mock" => {'x-koha-embed' => 'statuses+strings'} )
->status_is(200)
->json_has( '/statuses', [ $backend_status, $core_status, $alias_status ] );
#Check for backend existing statuses of a backend that doesn't exist
$t->get_ok("//$userid:$password@/api/v1/ill/backends/GhostBackend" => {'x-koha-embed' => 'statuses+strings'} )
->status_is(200)
->json_hasnt( 'statuses' );
# Unauthorized attempt to list
$t->get_ok("//$unauth_userid:$password@/api/v1/ill/backends")
->status_is(403);
# DELETE method not supported
$t->delete_ok("//$unauth_userid:$password@/api/v1/ill/backends")
->status_is(404);
$schema->storage->txn_rollback;
};