3 # This file is part of Koha.
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.
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.
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>.
20 use Test::More tests => 5;
23 use t::lib::TestBuilder;
26 use Koha::ERM::EHoldings::Titles;
27 use Koha::ERM::EHoldings::Packages;
28 use Koha::Virtualshelves;
31 my $schema = Koha::Database->new->schema;
32 my $builder = t::lib::TestBuilder->new;
34 my $t = Test::Mojo->new('Koha::REST::V1');
36 subtest 'list() tests' => sub {
40 $schema->storage->txn_begin;
42 Koha::ERM::EHoldings::Titles->search->delete;
44 my $librarian = $builder->build_object(
46 class => 'Koha::Patrons',
47 value => { flags => 2**28 }
50 my $password = 'thePassword123';
51 $librarian->set_password( { password => $password, skip_validation => 1 } );
52 my $userid = $librarian->userid;
54 my $patron = $builder->build_object(
56 class => 'Koha::Patrons',
57 value => { flags => 0 }
61 $patron->set_password( { password => $password, skip_validation => 1 } );
62 my $unauth_userid = $patron->userid;
64 ## Authorized user tests
65 # No EHoldings title, so empty array should be returned
66 $t->get_ok("//$userid:$password@/api/v1/erm/eholdings/local/titles")
67 ->status_is(200)->json_is( [] );
70 $builder->build_object( { class => 'Koha::ERM::EHoldings::Titles' } );
72 # One EHoldings title created, should get returned
73 $t->get_ok("//$userid:$password@/api/v1/erm/eholdings/local/titles")
74 ->status_is(200)->json_is( [ $ehtitle->to_api ] );
76 my $another_ehtitle = $builder->build_object(
78 class => 'Koha::ERM::EHoldings::Titles',
79 value => { publication_type => $ehtitle->publication_type }
82 my $ehtitle_with_another_publication_type =
83 $builder->build_object( { class => 'Koha::ERM::EHoldings::Titles' } );
85 # Two EHoldings titles created, they should both be returned
86 $t->get_ok("//$userid:$password@/api/v1/erm/eholdings/local/titles")
87 ->status_is(200)->json_is(
90 $another_ehtitle->to_api,
91 $ehtitle_with_another_publication_type->to_api
95 # Filtering works, two EHoldings titles sharing publication_type
97 "//$userid:$password@/api/v1/erm/eholdings/local/titles?publication_type="
98 . $ehtitle->publication_type )->status_is(200)
99 ->json_is( [ $ehtitle->to_api, $another_ehtitle->to_api ] );
101 # Attempt to search by publication_title like 'ko'
103 $another_ehtitle->delete;
104 $ehtitle_with_another_publication_type->delete;
105 $t->get_ok(qq~//$userid:$password@/api/v1/erm/eholdings/local/titles?q=[{"me.publication_title":{"like":"%ko%"}}]~)
106 ->status_is(200)->json_is( [] );
108 my $ehtitle_to_search = $builder->build_object(
110 class => 'Koha::ERM::EHoldings::Titles',
112 publication_title => 'koha',
117 # Search works, searching for publication_title like 'ko'
118 $t->get_ok(qq~//$userid:$password@/api/v1/erm/eholdings/local/titles?q=[{"me.publication_title":{"like":"%ko%"}}]~)
119 ->status_is(200)->json_is( [ $ehtitle_to_search->to_api ] );
121 # Warn on unsupported query parameter
123 "//$userid:$password@/api/v1/erm/eholdings/local/titles?blah=blah")
126 [ { path => '/query/blah', message => 'Malformed query string' } ] );
128 # Unauthorized access
129 $t->get_ok("//$unauth_userid:$password@/api/v1/erm/eholdings/local/titles")
132 $schema->storage->txn_rollback;
135 subtest 'get() tests' => sub {
139 $schema->storage->txn_begin;
142 $builder->build_object( { class => 'Koha::ERM::EHoldings::Titles' } );
143 my $librarian = $builder->build_object(
145 class => 'Koha::Patrons',
146 value => { flags => 2**28 }
149 my $password = 'thePassword123';
150 $librarian->set_password( { password => $password, skip_validation => 1 } );
151 my $userid = $librarian->userid;
153 my $patron = $builder->build_object(
155 class => 'Koha::Patrons',
156 value => { flags => 0 }
160 $patron->set_password( { password => $password, skip_validation => 1 } );
161 my $unauth_userid = $patron->userid;
163 # This EHoldings title exists, should get returned
164 $t->get_ok( "//$userid:$password@/api/v1/erm/eholdings/local/titles/"
165 . $ehtitle->title_id )->status_is(200)->json_is( $ehtitle->to_api );
167 # Return one EHoldings title with embed
168 $t->get_ok( "//$userid:$password@/api/v1/erm/eholdings/local/titles/"
169 . $ehtitle->title_id =>
170 { 'x-koha-embed' => 'resources,resources.package' } )->status_is(200)
171 ->json_is( { %{ $ehtitle->to_api }, resources => [] } );
173 # Unauthorized access
174 $t->get_ok( "//$unauth_userid:$password@/api/v1/erm/eholdings/local/titles/"
175 . $ehtitle->title_id )->status_is(403);
177 # Attempt to get non-existent EHoldings title
178 my $ehtitle_to_delete =
179 $builder->build_object( { class => 'Koha::ERM::EHoldings::Titles' } );
180 my $non_existent_id = $ehtitle_to_delete->title_id;
181 $ehtitle_to_delete->delete;
184 "//$userid:$password@/api/v1/erm/eholdings/local/titles/$non_existent_id"
185 )->status_is(404)->json_is( '/error' => 'eHolding title not found' );
187 $schema->storage->txn_rollback;
190 subtest 'add() tests' => sub {
194 $schema->storage->txn_begin;
196 my $librarian = $builder->build_object(
198 class => 'Koha::Patrons',
199 value => { flags => 2**28 }
202 my $password = 'thePassword123';
203 $librarian->set_password( { password => $password, skip_validation => 1 } );
204 my $userid = $librarian->userid;
206 my $patron = $builder->build_object(
208 class => 'Koha::Patrons',
209 value => { flags => 0 }
213 $patron->set_password( { password => $password, skip_validation => 1 } );
214 my $unauth_userid = $patron->userid;
217 publication_title => "Publication title",
218 print_identifier => "Print-format identifier",
219 online_identifier => "Online-format identifier",
220 date_first_issue_online =>
221 "Date of first serial issue available online",
222 num_first_vol_online => "Number of first volume available online",
223 num_first_issue_online => "Number of first issue available online",
224 date_last_issue_online => "Date of last issue available online",
225 num_last_vol_online => "Number of last volume available online",
226 num_last_issue_online => "Number of last issue available online",
227 title_url => "Title-level URL",
228 first_author => "First author",
229 embargo_info => "Embargo information",
230 coverage_depth => "Coverage depth",
232 publisher_name => "Publisher name",
233 publication_type => "Book",
234 date_monograph_published_print =>
235 "Date the monograph is first published in print",
236 date_monograph_published_online =>
237 "Date the monograph is first published online",
238 monograph_volume => "Number of volume for monograph",
239 monograph_edition => "Edition of the monograph",
240 first_editor => "First editor",
241 parent_publication_title_id =>
242 "Title identifier of the parent publication",
243 preceeding_publication_title_id =>
244 "Title identifier of any preceding publication title",
245 access_type => "Access type"
248 # Unauthorized attempt to write
250 "//$unauth_userid:$password@/api/v1/erm/eholdings/local/titles" =>
251 json => $ehtitle )->status_is(403);
253 # Authorized attempt to write invalid data
254 my $ehtitle_with_invalid_field = {
255 blah => "EHolding Title Blah",
256 publication_title => "Publication title",
257 print_identifier => "Print-format identifier"
261 "//$userid:$password@/api/v1/erm/eholdings/local/titles" => json =>
262 $ehtitle_with_invalid_field )->status_is(400)->json_is(
265 message => "Properties not allowed: blah.",
271 # Authorized attempt to write
274 "//$userid:$password@/api/v1/erm/eholdings/local/titles" => json =>
275 $ehtitle )->status_is( 201, 'SWAGGER3.2.1' )->header_like(
276 Location => qr|^/api/v1/erm/eholdings/local/titles/\d*|,
278 )->json_is( '/publication_title' => $ehtitle->{publication_title} )
279 ->json_is( '/print_identifier' => $ehtitle->{print_identifier} )
280 ->json_is( '/notes' => $ehtitle->{notes} )
281 ->json_is( '/publisher_name' => $ehtitle->{publisher_name} )
282 ->tx->res->json->{title_id};
284 # Import titles from virtualshelf to package
286 $builder->build_object( { class => 'Koha::ERM::EHoldings::Packages' } )
290 $builder->build_object(
292 class => 'Koha::Virtualshelves',
294 $virtual_shelf->transfer_ownership($librarian->borrowernumber);
295 my $virtual_shelf_id = $virtual_shelf->shelfnumber;
299 list_id => $virtual_shelf_id,
300 package_id => $ehpackage_id
304 "//$userid:$password@/api/v1/erm/eholdings/local/titles/import" => json =>
305 $import_request )->status_is(201)->json_has('/job_id');
307 # Attempt to import titles from a virtualshelf that doesn't exist
308 $virtual_shelf->delete;
310 "//$userid:$password@/api/v1/erm/eholdings/local/titles/import" => json =>
311 $import_request )->status_is(404)->json_is(
312 { error => 'List not found' }
315 # Authorized attempt to create with null id
316 $ehtitle->{title_id} = undef;
318 "//$userid:$password@/api/v1/erm/eholdings/local/titles" => json =>
319 $ehtitle )->status_is(400)->json_has('/errors');
321 # Authorized attempt to create with existing id
322 $ehtitle->{title_id} = $ehtitle_id;
324 "//$userid:$password@/api/v1/erm/eholdings/local/titles" => json =>
325 $ehtitle )->status_is(400)->json_is(
328 message => "Read-only.",
329 path => "/body/title_id"
334 $schema->storage->txn_rollback;
337 subtest 'update() tests' => sub {
341 $schema->storage->txn_begin;
343 my $librarian = $builder->build_object(
345 class => 'Koha::Patrons',
346 value => { flags => 2**28 }
349 my $password = 'thePassword123';
350 $librarian->set_password( { password => $password, skip_validation => 1 } );
351 my $userid = $librarian->userid;
353 my $patron = $builder->build_object(
355 class => 'Koha::Patrons',
356 value => { flags => 0 }
360 $patron->set_password( { password => $password, skip_validation => 1 } );
361 my $unauth_userid = $patron->userid;
364 $builder->build_object( { class => 'Koha::ERM::EHoldings::Titles' } )
367 # Unauthorized attempt to update
369 "//$unauth_userid:$password@/api/v1/erm/eholdings/local/titles/$ehtitle_id"
371 { publication_title => 'New unauthorized publication_title change' } )
374 # Attempt partial update on a PUT
375 my $ehtitle_with_missing_field = { date_first_issue_online =>
376 "Date of first serial issue available online", };
379 "//$userid:$password@/api/v1/erm/eholdings/local/titles/$ehtitle_id" =>
380 json => $ehtitle_with_missing_field )->status_is(400)->json_is(
383 message => "Missing property.",
384 path => "/body/publication_title"
389 # Full object update on PUT
390 my $ehtitle_with_updated_field = {
391 publication_title => "Publication title",
392 print_identifier => "Print-format identifier",
393 online_identifier => "Online-format identifier",
394 date_first_issue_online =>
395 "Date of first serial issue available online",
396 num_first_vol_online => "Number of first volume available online",
397 num_first_issue_online => "Number of first issue available online",
398 date_last_issue_online => "Date of last issue available online",
399 num_last_vol_online => "Number of last volume available online",
400 num_last_issue_online => "Number of last issue available online",
401 title_url => "Title-level URL",
402 first_author => "First author",
403 embargo_info => "Embargo information",
404 coverage_depth => "Coverage depth",
406 publisher_name => "Publisher name",
407 publication_type => "Book",
408 date_monograph_published_print =>
409 "Date the monograph is first published in print",
410 date_monograph_published_online =>
411 "Date the monograph is first published online",
412 monograph_volume => "Number of volume for monograph",
413 monograph_edition => "Edition of the monograph",
414 first_editor => "First editor",
415 parent_publication_title_id =>
416 "Title identifier of the parent publication",
417 preceeding_publication_title_id =>
418 "Title identifier of any preceding publication title",
419 access_type => "Access type"
423 "//$userid:$password@/api/v1/erm/eholdings/local/titles/$ehtitle_id" =>
424 json => $ehtitle_with_updated_field )->status_is(200)
425 ->json_is( '/publication_title' => 'Publication title' );
427 # Authorized attempt to write invalid data
428 my $ehtitle_with_invalid_field = {
429 blah => "EHolding Title Blah",
430 publication_title => "Publication title",
431 print_identifier => "Print-format identifier"
435 "//$userid:$password@/api/v1/erm/eholdings/local/titles/$ehtitle_id" =>
436 json => $ehtitle_with_invalid_field )->status_is(400)->json_is(
439 message => "Properties not allowed: blah.",
445 # Attempt to update non-existent EHolding title
446 my $ehtitle_to_delete =
447 $builder->build_object( { class => 'Koha::ERM::EHoldings::Titles' } );
448 my $non_existent_id = $ehtitle_to_delete->title_id;
449 $ehtitle_to_delete->delete;
452 "//$userid:$password@/api/v1/erm/eholdings/local/titles/$non_existent_id"
453 => json => $ehtitle_with_updated_field )->status_is(404);
455 # Wrong method (POST)
456 $ehtitle_with_updated_field->{title_id} = 2;
459 "//$userid:$password@/api/v1/erm/eholdings/local/titles/$ehtitle_id" =>
460 json => $ehtitle_with_updated_field )->status_is(404);
462 $schema->storage->txn_rollback;
465 subtest 'delete() tests' => sub {
469 $schema->storage->txn_begin;
471 my $librarian = $builder->build_object(
473 class => 'Koha::Patrons',
474 value => { flags => 2**28 }
477 my $password = 'thePassword123';
478 $librarian->set_password( { password => $password, skip_validation => 1 } );
479 my $userid = $librarian->userid;
481 my $patron = $builder->build_object(
483 class => 'Koha::Patrons',
484 value => { flags => 0 }
488 $patron->set_password( { password => $password, skip_validation => 1 } );
489 my $unauth_userid = $patron->userid;
492 $builder->build_object( { class => 'Koha::ERM::EHoldings::Titles' } )
495 # Unauthorized attempt to delete
497 "//$unauth_userid:$password@/api/v1/erm/eholdings/local/titles/$ehtitle_id"
500 # Delete existing EHolding title
502 "//$userid:$password@/api/v1/erm/eholdings/local/titles/$ehtitle_id")
503 ->status_is( 204, 'SWAGGER3.2.4' )->content_is( '', 'SWAGGER3.3.4' );
505 # Attempt to delete non-existent EHolding title
507 "//$userid:$password@/api/v1/erm/eholdings/local/titles/$ehtitle_id")
510 $schema->storage->txn_rollback;