Koha-clms/t/db_dependent/api/v1/acquisitions_orders.t

594 lines
22 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 <https://www.gnu.org/licenses>.
use Modern::Perl;
use Test::NoWarnings;
use Test::More tests => 7;
use Test::Mojo;
use Test::Warn;
use t::lib::TestBuilder;
use t::lib::Mocks;
use JSON qw( encode_json );
use Koha::Acquisition::Orders;
use Koha::Database;
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 => 24;
$schema->storage->txn_begin;
my $patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 1 }
}
);
my $password = 'thePassword123';
$patron->set_password( { password => $password, skip_validation => 1 } );
my $userid = $patron->userid;
my $basket = $builder->build_object( { class => 'Koha::Acquisition::Baskets', value => { is_standing => 1 } } );
my $biblio = $builder->build_sample_biblio;
my $biblioitem = $biblio->biblioitem;
$biblioitem->set( { isbn => 'SOMETHING' } )->store;
# Create test context
my $order = $builder->build_object(
{
class => 'Koha::Acquisition::Orders',
value => {
basketno => $basket->basketno,
orderstatus => 'new',
biblionumber => $biblio->biblionumber,
quantityreceived => 0,
quantity => 1,
}
}
);
my $another_order = $order->unblessed; # create a copy of $order but make
delete $another_order->{ordernumber}; # sure ordernumber will be regenerated
$another_order = $builder->build_object( { class => 'Koha::Acquisition::Orders', value => $another_order } );
## Authorized user tests
my $count_of_orders = Koha::Acquisition::Orders->search( { orderstatus => 'new' } )->count;
# Make sure we are returned with the correct amount of orders
$t->get_ok("//$userid:$password@/api/v1/acquisitions/orders?status=new&_per_page=-1")
->status_is( 200, 'REST3.2.2' )
->json_has( '/' . ( $count_of_orders - 1 ) . '/order_id' )
->json_hasnt( '/' . ($count_of_orders) . '/order_id' );
subtest 'query parameters' => sub {
my $fields = {
biblio_id => 'biblionumber',
basket_id => 'basketno',
fund_id => 'budget_id',
};
my $size = keys %{$fields};
plan tests => $size * ( 2 + 2 * $size );
foreach my $field ( keys %{$fields} ) {
my $model_field = $fields->{$field};
my $result = $t->get_ok( "//$userid:$password@/api/v1/acquisitions/orders?$field=" . $order->$model_field )
->status_is(200);
foreach my $key ( keys %{$fields} ) {
my $key_field = $fields->{$key};
# Check the result order first since it's not predefined.
if ( $result->tx->res->json->[0]->{$key} eq $order->$key_field ) {
$result->json_is( "/0/$key", $order->$key_field );
$result->json_is( "/1/$key", $another_order->$key_field );
} else {
$result->json_is( "/0/$key", $another_order->$key_field );
$result->json_is( "/1/$key", $order->$key_field );
}
}
}
};
my $query = { "biblio.isbn" => { "-like" => "\%SOMETHING\%" } };
$t->get_ok(
"//$userid:$password@/api/v1/acquisitions/orders?q=" . encode_json($query) => { 'x-koha-embed' => 'biblio' } )
->status_is( 200, "Embedding biblio and searching on biblio.isbn doesn't make it explode" )
->json_has( "/0/biblio", "biblio object correctly embedded" )
->json_is( "/0/biblio/isbn", 'SOMETHING', 'Filtering by a biblioitems column works!' );
$query = { "biblio.isbn" => { "-like" => "\%SOMETHING\%" }, "biblio.title" => { -like => "\%\%" } };
$t->get_ok(
"//$userid:$password@/api/v1/acquisitions/orders?q=" . encode_json($query) => { 'x-koha-embed' => 'biblio' } )
->status_is( 200, "Embedding biblio and searching on biblio.isbn and biblio.title doesn't make it explode" )
->json_has( "/0/biblio", "biblio object correctly embedded" )
->json_is( "/0/biblio/isbn", 'SOMETHING', 'Filtering by a biblioitem column works!' )
->json_is( "/0/biblio/title", $biblio->title, 'Filtering by a biblioitem and biblio columns works!' );
my $result = $t->get_ok( "//$userid:$password@/api/v1/acquisitions/orders?biblio_id=" . $biblio->biblionumber )
->status_is(200);
is( scalar @{ $result->tx->res->json }, 2, 'Two orders fetched' );
# Mark $another_order as cancelled
$another_order->set( { orderstatus => 'cancelled' } )->store;
$result =
$t->get_ok( "//$userid:$password@/api/v1/acquisitions/orders?only_active=1&biblio_id=" . $biblio->biblionumber )
->status_is( 200, "only_active parameter accepted" );
is( scalar @{ $result->tx->res->json }, 1, 'Only one order is active' );
# Warn on unsupported query parameter
$t->get_ok("//$userid:$password@/api/v1/acquisitions/orders?order_blah=blah")
->status_is(400)
->json_is( [ { path => '/query/order_blah', message => 'Malformed query string' } ] );
subtest 'sorting tests' => sub {
plan tests => 14;
$schema->storage->txn_begin;
my $biblio_1 = $builder->build_sample_biblio();
my $biblio_2 = $builder->build_sample_biblio();
my $basket = $builder->build_object( { class => 'Koha::Acquisition::Baskets', value => { is_standing => 1 } } );
my $order_1 = $builder->build_object(
{
class => 'Koha::Acquisition::Orders',
value => {
basketno => $basket->basketno,
orderstatus => 'new',
biblionumber => $biblio_1->biblionumber
}
}
);
my $order_2 = $builder->build_object(
{
class => 'Koha::Acquisition::Orders',
value => {
basketno => $basket->basketno,
orderstatus => 'new',
biblionumber => $biblio_2->biblionumber
}
}
);
# order by order_id
my $result =
$t->get_ok(
"//$userid:$password@/api/v1/acquisitions/orders?_order_by=+me.order_id&basket_id=" . $basket->id )
->status_is( 200, "query successful" )
->tx->res->json;
is( scalar @$result, 2, 'Two elements returned' );
is( $result->[0]->{order_id}, $order_1->id, 'The first element is order_1' );
is( $result->[1]->{order_id}, $order_2->id, 'The second element is order_2' );
# now reverse order
$result =
$t->get_ok(
"//$userid:$password@/api/v1/acquisitions/orders?_order_by=-me.order_id&basket_id=" . $basket->id )
->status_is( 200, "query successful" )
->tx->res->json;
is( scalar @$result, 2, 'Two elements returned' );
is( $result->[0]->{order_id}, $order_2->id, 'The first element is order_2' );
is( $result->[1]->{order_id}, $order_1->id, 'The second element is order_1' );
$biblio_1->biblioitem->set(
{
isbn => 'A',
ean => 'Y',
publishercode => 'M',
}
)->store;
$biblio_2->biblioitem->set(
{
isbn => 'B',
ean => 'X',
publishercode => 'L',
}
)->store;
$result =
$t->get_ok(
"//$userid:$password@/api/v1/acquisitions/orders?_order_by=-biblio.isbn,+biblio.ean,-biblio.publisher&basket_id="
. $basket->id => { 'x-koha-embed' => 'biblio' } )->status_is( 200, "query successful" )->tx->res->json;
is( $result->[0]->{order_id}, $order_2->id, 'Ordered correctly' );
is( $result->[1]->{order_id}, $order_1->id, 'Ordered correctly' );
$schema->storage->txn_rollback;
};
$schema->storage->txn_rollback;
};
subtest 'get() tests' => sub {
plan tests => 6;
$schema->storage->txn_begin;
my $order = $builder->build_object(
{
class => 'Koha::Acquisition::Orders',
value => { orderstatus => 'new' }
}
);
my $patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 2048 }
}
);
my $password = 'thePassword123';
$patron->set_password( { password => $password, skip_validation => 1 } );
my $userid = $patron->userid;
$t->get_ok( "//$userid:$password@/api/v1/acquisitions/orders/" . $order->ordernumber )
->status_is( 200, 'REST3.2.2' )
->json_is( '' => $order->to_api, 'REST3.3.2' );
my $non_existent_order_id = $order->ordernumber;
$order->delete;
$t->get_ok( "//$userid:$password@/api/v1/acquisitions/orders/" . $non_existent_order_id )
->status_is(404)
->json_is( '/error' => 'Order not found' );
# FIXME This does not work on all the OS we support
## Regression tests for bug 25513
## Pick a high value that could be transformed into exponential
## representation and not considered a number by buggy DBD::mysql versions
#$order = $builder->build_object(
# {
# class => 'Koha::Acquisition::Orders',
# value => {
# orderstatus => 'new',
# ecost_tax_excluded => 9963405519357589504,
# unitprice => 10177559957753600000
# }
# }
#);
#
#$t->get_ok( "//$userid:$password@/api/v1/acquisitions/orders/" . $order->ordernumber )
# ->json_is( '' => $order->to_api, 'Number representation should be consistent' );
$schema->storage->txn_rollback;
};
subtest 'add() tests' => sub {
plan tests => 17;
$schema->storage->txn_begin;
my $authorized_patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 1 }
}
);
my $password = 'thePassword123';
$authorized_patron->set_password( { password => $password, skip_validation => 1 } );
my $auth_userid = $authorized_patron->userid;
my $unauthorized_patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 4 }
}
);
$unauthorized_patron->set_password( { password => $password, skip_validation => 1 } );
my $unauth_userid = $unauthorized_patron->userid;
my $order_obj = $builder->build_object(
{
class => 'Koha::Acquisition::Orders',
value => {
orderstatus => 'new',
unitprice => 10,
replacementprice => 10,
quantity => 2,
quantityreceived => 0,
datecancellationprinted => undef,
order_internalnote => 'This is a dummy note for testing'
}
}
);
my $order = $order_obj->to_api;
$order_obj->delete;
delete $order->{ordernumber};
$order->{uncertain_price} = Mojo::JSON->false;
# Unauthorized attempt to write
$t->post_ok( "//$unauth_userid:$password@/api/v1/acquisitions/orders" => json => $order )->status_is(403);
# Authorized attempt to write invalid data
my $order_with_invalid_field = {%$order};
$order_with_invalid_field->{'orderinvalid'} = 'Order invalid';
$t->post_ok( "//$auth_userid:$password@/api/v1/acquisitions/orders" => json => $order_with_invalid_field )
->status_is(400)
->json_is(
"/errors" => [
{
message => "Properties not allowed: orderinvalid.",
path => "/body"
}
]
);
# Authorized attempt to write
$t->post_ok( "//$auth_userid:$password@/api/v1/acquisitions/orders" => json => $order )
->status_is( 201, 'REST3.2.1' )
->json_is( '/internal_note' => $order->{internal_note}, 'REST3.3.1' )
->header_like( Location => qr/\/api\/v1\/acquisitions\/orders\/\d*/, 'REST3.4.1' );
# save the order_id
my $order_id = $order->{order_id};
# Authorized attempt to create with null id
$order->{order_id} = undef;
$t->post_ok( "//$auth_userid:$password@/api/v1/acquisitions/orders" => json => $order )
->status_is(400)
->json_has('/errors');
# Authorized attempt to create with existing id
$order->{order_id} = $order_id;
warning_like {
$t->post_ok( "//$auth_userid:$password@/api/v1/acquisitions/orders" => json => $order )
->status_is(409)
->json_has( '/error' => "Fails when trying to add an existing order_id" )
->json_like( '/conflict' => qr/(aqorders\.)?PRIMARY/ );
}
qr/Duplicate ID/, 'Warning from store on DuplicateID exception';
$schema->storage->txn_rollback;
};
subtest 'update() tests' => sub {
plan tests => 13;
$schema->storage->txn_begin;
my $authorized_patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 1 }
}
);
my $password = 'thePassword123';
$authorized_patron->set_password( { password => $password, skip_validation => 1 } );
my $auth_userid = $authorized_patron->userid;
my $unauthorized_patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 4 }
}
);
$unauthorized_patron->set_password( { password => $password, skip_validation => 1 } );
my $unauth_userid = $unauthorized_patron->userid;
my $library = $builder->build_object( { class => 'Koha::Libraries' } );
my $library_id = $library->branchcode;
# Unauthorized attempt to update
$t->put_ok( "//$unauth_userid:$password@/api/v1/libraries/$library_id" => json =>
{ name => 'New unauthorized name change' } )->status_is(403);
# Attempt partial update on a PUT
my $library_with_missing_field = {
address1 => "New library address",
};
my $result =
$t->put_ok( "//$auth_userid:$password@/api/v1/libraries/$library_id" => json => $library_with_missing_field )
->status_is(400);
# Check the result order first since it's not predefined.
if ( $result->tx->res->json->{errors}->[0]->{path} eq '/body/name' ) {
$result->json_is(
"/errors",
[
{ message => "Missing property.", path => "/body/name" },
{ message => "Missing property.", path => "/body/library_id" }
]
);
} else {
$result->json_is(
"/errors",
[
{ message => "Missing property.", path => "/body/library_id" },
{ message => "Missing property.", path => "/body/name" }
]
);
}
my $deleted_library = $builder->build_object( { class => 'Koha::Libraries' } );
my $library_with_updated_field = $deleted_library->to_api;
$library_with_updated_field->{library_id} = $library_id;
$deleted_library->delete;
$t->put_ok( "//$auth_userid:$password@/api/v1/libraries/$library_id" => json => $library_with_updated_field )
->status_is( 200, 'REST3.2.1' )
->json_is( '' => $library_with_updated_field, 'REST3.3.3' );
# Authorized attempt to write invalid data
my $library_with_invalid_field = {%$library_with_updated_field};
$library_with_invalid_field->{'branchinvalid'} = 'Library invalid';
$t->put_ok( "//$auth_userid:$password@/api/v1/libraries/$library_id" => json => $library_with_invalid_field )
->status_is(400)
->json_is(
"/errors" => [
{
message => "Properties not allowed: branchinvalid.",
path => "/body"
}
]
);
my $non_existent_code = 'nope' . int( rand(10000) );
$t->put_ok( "//$auth_userid:$password@/api/v1/libraries/$non_existent_code" => json => $library_with_updated_field )
->status_is(404);
$schema->storage->txn_rollback;
};
subtest 'delete() tests' => sub {
plan tests => 9;
$schema->storage->txn_begin;
my $authorized_patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 1 }
}
);
my $password = 'thePassword123';
$authorized_patron->set_password( { password => $password, skip_validation => 1 } );
my $auth_userid = $authorized_patron->userid;
my $unauthorized_patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 4 }
}
);
$unauthorized_patron->set_password( { password => $password, skip_validation => 1 } );
my $unauth_userid = $unauthorized_patron->userid;
my $order = $builder->build_object( { class => 'Koha::Acquisition::Orders' } );
# Unauthorized attempt to delete
$t->delete_ok( "//$unauth_userid:$password@/api/v1/acquisitions/orders/" . $order->ordernumber )->status_is(403);
# Check if status is cancelled?
$order->orderstatus('new')->store;
$t->delete_ok( "//$auth_userid:$password@/api/v1/acquisitions/orders/" . $order->ordernumber )->status_is(409);
$order->orderstatus('cancelled')->store;
$t->delete_ok( "//$auth_userid:$password@/api/v1/acquisitions/orders/" . $order->ordernumber )
->status_is( 204, 'REST3.2.4' )
->content_is( '', 'REST3.3.4' );
$t->delete_ok( "//$auth_userid:$password@/api/v1/acquisitions/orders/" . $order->ordernumber )->status_is(404);
$schema->storage->txn_rollback;
};
subtest 'Bug 42995 - nested +count embeds with has_many prefetch and pagination' => sub {
plan tests => 8;
$schema->storage->txn_begin;
my $patron = $builder->build_object(
{
class => 'Koha::Patrons',
value => { flags => 1 }
}
);
my $password = 'thePassword123';
$patron->set_password( { password => $password, skip_validation => 1 } );
my $userid = $patron->userid;
my $basket = $builder->build_object( { class => 'Koha::Acquisition::Baskets', value => { is_standing => 1 } } );
my $biblio = $builder->build_sample_biblio;
# Add items to the biblio so items+count has something to count
my $item = $builder->build_sample_item( { biblionumber => $biblio->biblionumber } );
# Add a suggestion so biblio.suggestions.suggester prefetch is exercised
my $suggester = $builder->build_object( { class => 'Koha::Patrons' } );
$builder->build_object(
{
class => 'Koha::Suggestions',
value => {
biblionumber => $biblio->biblionumber,
suggestedby => $suggester->borrowernumber,
STATUS => 'ACCEPTED',
}
}
);
my $order = $builder->build_object(
{
class => 'Koha::Acquisition::Orders',
value => {
basketno => $basket->basketno,
orderstatus => 'new',
biblionumber => $biblio->biblionumber,
quantityreceived => 0,
quantity => 1,
}
}
);
# Nested +count embeds under a joined parent combined with a has_many
# prefetch and pagination trigger DBIC's limiting subquery, which moves
# +select into the inner query where the parent alias is unavailable.
my $embed_header =
'biblio.items+count,biblio.holds+count,biblio.uncancelled_orders+count,biblio.suggestions.suggester';
# With default pagination (_per_page defaults to 20) and nested +count under
# a parent that also has a has_many child in prefetch.
# Filter by order_id via the q parameter with me. prefix to avoid column
# ambiguity when biblio is joined (biblioitem is has_many from biblio,
# triggering DBIC subselect).
my $query = encode_json( { "me.order_id" => $order->ordernumber } );
$t->get_ok( "//$userid:$password@/api/v1/acquisitions/orders?q=$query" => { 'x-koha-embed' => $embed_header } )
->status_is( 200, 'Nested +count embeds with has_many prefetch and pagination does not explode' )
->json_has( '/0/biblio', 'biblio embedded' )
->json_has( '/0/biblio/items_count', 'items_count present' )
->json_is( '/0/biblio/items_count', 1, 'items_count is correct' );
# Also test with only_active which adds an extra join (filter_by_active joins basket).
$embed_header =
'basket.basket_group,biblio.uncancelled_orders+count,biblio.holds+count,biblio.items+count,biblio.suggestions.suggester,fund,current_item_level_holds+count,items';
$t->get_ok(
"//$userid:$password@/api/v1/acquisitions/orders?only_active=1&q=$query" => { 'x-koha-embed' => $embed_header }
)
->status_is( 200, 'Full parcel page embed combination does not cause 500' )
->json_has( '/0/biblio', 'biblio embedded with full parcel page embeds' );
$schema->storage->txn_rollback;
};