Bug 23156: Add pagination to checkouts in ILS-DI GetPatronInfo service
[koha-equinox.git] / t / db_dependent / ILSDI_Services.t
index d918e43..b1288ec 100644 (file)
@@ -19,11 +19,14 @@ use Modern::Perl;
 
 use CGI qw ( -utf8 );
 
-use Test::More tests => 4;
+use Test::More tests => 9;
 use Test::MockModule;
 use t::lib::Mocks;
 use t::lib::TestBuilder;
 
+use C4::Items qw( ModItemTransfer );
+use C4::Circulation;
+
 use Koha::AuthUtils;
 
 BEGIN {
@@ -42,9 +45,17 @@ subtest 'AuthenticatePatron test' => sub {
 
     my $plain_password = 'tomasito';
 
+    $builder->build({
+        source => 'Borrower',
+        value => {
+            cardnumber => undef,
+        }
+    });
+
     my $borrower = $builder->build({
         source => 'Borrower',
         value  => {
+            cardnumber => undef,
             password => Koha::AuthUtils::hash_password( $plain_password )
         }
     });
@@ -95,7 +106,7 @@ subtest 'AuthenticatePatron test' => sub {
 
 subtest 'GetPatronInfo/GetBorrowerAttributes test for extended patron attributes' => sub {
 
-    plan tests => 2;
+    plan tests => 5;
 
     $schema->storage->txn_begin;
 
@@ -105,6 +116,7 @@ subtest 'GetPatronInfo/GetBorrowerAttributes test for extended patron attributes
     $schema->resultset( 'BorrowerAttributeType' )->delete_all;
     $schema->resultset( 'Category' )->delete_all;
     $schema->resultset( 'Item' )->delete_all; # 'Branch' deps. on this
+    $schema->resultset( 'Club' )->delete_all;
     $schema->resultset( 'Branch' )->delete_all;
 
     # Configure Koha to enable ILS-DI server and extended attributes:
@@ -132,12 +144,21 @@ subtest 'GetPatronInfo/GetBorrowerAttributes test for extended patron attributes
     my $attr_type = $builder->build( {
         source => 'BorrowerAttributeType',
         value  => {
-            code                      => 'DOORCODE',
+            code                      => 'HIDEME',
             opac_display              => 0,
             authorised_value_category => '',
             class                     => '',
         }
     } );
+    my $attr_type_visible = $builder->build( {
+        source => 'BorrowerAttributeType',
+        value  => {
+            code                      => 'SHOWME',
+            opac_display              => 1,
+            authorised_value_category => '',
+            class                     => '',
+        }
+    } );
 
     # Create a new user:
     my $brwr = $builder->build( {
@@ -157,21 +178,28 @@ subtest 'GetPatronInfo/GetBorrowerAttributes test for extended patron attributes
     } );
 
     # Set the new attribute for our user:
-    my $attr = $builder->build( {
+    my $attr_hidden = $builder->build( {
         source => 'BorrowerAttribute',
         value  => {
             borrowernumber => $brwr->{'borrowernumber'},
             code           => $attr_type->{'code'},
-            attribute      => '1337',
+            attribute      => '1337 hidden',
+        }
+    } );
+    my $attr_shown = $builder->build( {
+        source => 'BorrowerAttribute',
+        value  => {
+            borrowernumber => $brwr->{'borrowernumber'},
+            code           => $attr_type_visible->{'code'},
+            attribute      => '1337 shown',
         }
     } );
 
-    $builder->build(
+    my $fine = $builder->build(
         {
             source => 'Accountline',
             value  => {
                 borrowernumber    => $brwr->{borrowernumber},
-                accountno         => 1,
                 accounttype       => 'xxx',
                 amountoutstanding => 10
             }
@@ -183,31 +211,40 @@ subtest 'GetPatronInfo/GetBorrowerAttributes test for extended patron attributes
     $query->param( 'service', 'GetPatronInfo' );
     $query->param( 'patron_id', $brwr->{'borrowernumber'} );
     $query->param( 'show_attributes', '1' );
+    $query->param( 'show_fines', '1' );
 
     my $reply = C4::ILSDI::Services::GetPatronInfo( $query );
 
     # Build a structure for comparison:
     my $cmp = {
-        category_code     => $attr_type->{'category_code'},
-        class             => $attr_type->{'class'},
-        code              => $attr->{'code'},
-        description       => $attr_type->{'description'},
-        display_checkout  => $attr_type->{'display_checkout'},
-        value             => $attr->{'attribute'},
+        category_code     => $attr_type_visible->{'category_code'},
+        class             => $attr_type_visible->{'class'},
+        code              => $attr_shown->{'code'},
+        description       => $attr_type_visible->{'description'},
+        display_checkout  => $attr_type_visible->{'display_checkout'},
+        value             => $attr_shown->{'attribute'},
         value_description => undef,
     };
 
     is( $reply->{'charges'}, '10.00',
         'The \'charges\' attribute should be correctly filled (bug 17836)' );
 
+    is( scalar( @{$reply->{fines}->{fine}}), 1, 'There should be only 1 account line');
+    is(
+        $reply->{fines}->{fine}->[0]->{accountlines_id},
+        $fine->{accountlines_id},
+        "The accountline should be the correct one"
+    );
+
     # Check results:
     is_deeply( $reply->{'attributes'}, [ $cmp ], 'Test GetPatronInfo - show_attributes parameter' );
 
+    ok( exists $reply->{is_expired}, 'There should be the is_expired information');
+
     # Cleanup
     $schema->storage->txn_rollback;
 };
 
-
 subtest 'LookupPatron test' => sub {
 
     plan tests => 9;
@@ -262,3 +299,388 @@ subtest 'LookupPatron test' => sub {
     # Cleanup
     $schema->storage->txn_rollback;
 };
+
+subtest 'Holds test' => sub {
+
+    plan tests => 5;
+
+    $schema->storage->txn_begin;
+
+    t::lib::Mocks::mock_preference( 'AllowHoldsOnDamagedItems', 0 );
+
+    my $patron = $builder->build({
+        source => 'Borrower',
+    });
+
+    my $biblio = $builder->build({
+        source => 'Biblio',
+    });
+
+    my $biblioitems = $builder->build({
+        source => 'Biblioitem',
+        value => {
+            biblionumber => $biblio->{biblionumber},
+        }
+    });
+
+    my $item = $builder->build({
+        source => 'Item',
+        value => {
+            biblionumber => $biblio->{biblionumber},
+            damaged => 1
+        }
+    });
+
+    my $query = new CGI;
+    $query->param( 'patron_id', $patron->{borrowernumber});
+    $query->param( 'bib_id', $biblio->{biblionumber});
+
+    my $reply = C4::ILSDI::Services::HoldTitle( $query );
+    is( $reply->{code}, 'damaged', "Item damaged" );
+
+    my $item_o = Koha::Items->find($item->{itemnumber});
+    $item_o->damaged(0)->store;
+
+    my $hold = $builder->build({
+        source => 'Reserve',
+        value => {
+            borrowernumber => $patron->{borrowernumber},
+            biblionumber => $biblio->{biblionumber},
+            itemnumber => $item->{itemnumber}
+        }
+    });
+
+    $reply = C4::ILSDI::Services::HoldTitle( $query );
+    is( $reply->{code}, 'itemAlreadyOnHold', "Item already on hold" );
+
+    my $biblio_with_no_item = $builder->build({
+        source => 'Biblio',
+    });
+
+    $query = new CGI;
+    $query->param( 'patron_id', $patron->{borrowernumber});
+    $query->param( 'bib_id', $biblio_with_no_item->{biblionumber});
+
+    $reply = C4::ILSDI::Services::HoldTitle( $query );
+    is( $reply->{code}, 'NoItems', 'Biblio has no item' );
+
+    my $biblio2 = $builder->build({
+        source => 'Biblio',
+    });
+
+    my $biblioitems2 = $builder->build({
+        source => 'Biblioitem',
+        value => {
+            biblionumber => $biblio2->{biblionumber},
+        }
+    });
+
+    my $item2 = $builder->build({
+        source => 'Item',
+        value => {
+            biblionumber => $biblio2->{biblionumber},
+            damaged => 0
+        }
+    });
+
+    t::lib::Mocks::mock_preference( 'ReservesControlBranch', 'PatronLibrary' );
+    my $issuingrule = $builder->build({
+        source => 'Issuingrule',
+        value => {
+            categorycode => $patron->{categorycode},
+            itemtype => $item2->{itype},
+            branchcode => $patron->{branchcode},
+            reservesallowed => 0,
+        }
+    });
+
+    $query = new CGI;
+    $query->param( 'patron_id', $patron->{borrowernumber});
+    $query->param( 'bib_id', $biblio2->{biblionumber});
+    $query->param( 'item_id', $item2->{itemnumber});
+
+    $reply = C4::ILSDI::Services::HoldItem( $query );
+    is( $reply->{code}, 'tooManyReserves', "Too many reserves" );
+
+    my $biblio3 = $builder->build({
+        source => 'Biblio',
+    });
+
+    my $biblioitems3 = $builder->build({
+        source => 'Biblioitem',
+        value => {
+            biblionumber => $biblio3->{biblionumber},
+        }
+    });
+
+    # Adding a holdable item to biblio 3.
+    my $item3 = $builder->build({
+        source => 'Item',
+        value => {
+            biblionumber => $biblio3->{biblionumber},
+            damaged => 0,
+        }
+    });
+
+    my $item4 = $builder->build({
+        source => 'Item',
+        value => {
+            biblionumber => $biblio3->{biblionumber},
+            damaged => 1,
+        }
+    });
+
+    my $issuingrule2 = $builder->build({
+        source => 'Issuingrule',
+        value => {
+            categorycode => $patron->{categorycode},
+            itemtype => $item3->{itype},
+            branchcode => $patron->{branchcode},
+            reservesallowed => 10,
+        }
+    });
+
+    $query = new CGI;
+    $query->param( 'patron_id', $patron->{borrowernumber});
+    $query->param( 'bib_id', $biblio3->{biblionumber});
+    $query->param( 'item_id', $item4->{itemnumber});
+
+    $reply = C4::ILSDI::Services::HoldItem( $query );
+    is( $reply->{code}, 'damaged', "Item is damaged" );
+
+    $schema->storage->txn_rollback;
+};
+
+subtest 'Holds test for branch transfer limits' => sub {
+
+    plan tests => 4;
+
+    $schema->storage->txn_begin;
+
+    # Test enforement of branch transfer limits
+    t::lib::Mocks::mock_preference( 'UseBranchTransferLimits', '1' );
+    t::lib::Mocks::mock_preference( 'BranchTransferLimitsType', 'itemtype' );
+
+    my $patron = $builder->build({
+        source => 'Borrower',
+    });
+
+    my $origin_branch = $builder->build(
+        {
+            source => 'Branch',
+            value  => {
+                pickup_location => 1,
+            }
+        }
+    );
+    my $pickup_branch = $builder->build(
+        {
+            source => 'Branch',
+            value  => {
+                pickup_location => 1,
+            }
+        }
+    );
+
+    my $biblio = $builder->build({
+        source => 'Biblio',
+    });
+    my $biblioitem = $builder->build({
+        source => 'Biblioitem',
+        value => {
+            biblionumber => $biblio->{biblionumber},
+        }
+    });
+    my $item = $builder->build({
+        source => 'Item',
+        value => {
+            homebranch => $origin_branch->{branchcode},
+            holdingbranch => $origin_branch->{branchcode},
+            biblionumber => $biblio->{biblionumber},
+            damaged => 0,
+            itemlost => 0,
+        }
+    });
+
+    Koha::IssuingRules->search()->delete();
+    my $issuingrule = $builder->build({
+        source => 'Issuingrule',
+        value => {
+            categorycode => '*',
+            itemtype => '*',
+            branchcode => '*',
+            reservesallowed => 99,
+        }
+    });
+
+    my $limit = Koha::Item::Transfer::Limit->new({
+        toBranch => $pickup_branch->{branchcode},
+        fromBranch => $item->{holdingbranch},
+        itemtype => $item->{itype},
+    })->store();
+
+    my $query = new CGI;
+    $query->param( 'pickup_location', $pickup_branch->{branchcode} );
+    $query->param( 'patron_id', $patron->{borrowernumber});
+    $query->param( 'bib_id', $biblio->{biblionumber});
+    $query->param( 'item_id', $item->{itemnumber});
+
+    my $reply = C4::ILSDI::Services::HoldItem( $query );
+    is( $reply->{code}, 'cannotBeTransferred', "Item hold, Item cannot be transferred" );
+
+    $reply = C4::ILSDI::Services::HoldTitle( $query );
+    is( $reply->{code}, 'cannotBeTransferred', "Record hold, Item cannot be transferred" );
+
+    t::lib::Mocks::mock_preference( 'UseBranchTransferLimits', '0' );
+
+    $reply = C4::ILSDI::Services::HoldItem( $query );
+    is( $reply->{code}, undef, "Item hold, Item can be transferred" );
+
+    Koha::Holds->search()->delete();
+
+    $reply = C4::ILSDI::Services::HoldTitle( $query );
+    is( $reply->{code}, undef, "Record hold, Item con be transferred" );
+
+    $schema->storage->txn_rollback;
+};
+
+subtest 'GetRecords' => sub {
+
+    plan tests => 1;
+
+    $schema->storage->txn_begin;
+
+    t::lib::Mocks::mock_preference( 'ILS-DI', 1 );
+
+    my $branch1 = $builder->build({
+        source => 'Branch',
+    });
+    my $branch2 = $builder->build({
+        source => 'Branch',
+    });
+
+    my $biblio = $builder->build({
+        source => 'Biblio',
+    });
+    my $biblioitem = $builder->build({
+        source => 'Biblioitem',
+        value => {
+            biblionumber => $biblio->{biblionumber},
+        },
+    });
+    my $item = $builder->build_object({
+        class => 'Koha::Items',
+        value => {
+            biblionumber => $biblio->{biblionumber},
+            biblioitemnumber => $biblioitem->{biblioitemnumber},
+            homebranch => $branch1->{branchcode},
+            holdingbranch => $branch1->{branchcode},
+        },
+    });
+
+    ModItemTransfer($item->itemnumber, $branch1->{branchcode}, $branch2->{branchcode});
+
+    my $cgi = new CGI;
+    $cgi->param(service => 'GetRecords');
+    $cgi->param(id => $biblio->{biblionumber});
+
+    my $reply = C4::ILSDI::Services::GetRecords($cgi);
+
+    my $transfer = $item->get_transfer;
+    my $expected = {
+        datesent => $transfer->datesent,
+        frombranch => $transfer->frombranch,
+        tobranch => $transfer->tobranch,
+    };
+    is_deeply($reply->{record}->[0]->{items}->{item}->[0]->{transfer}, $expected,
+        'GetRecords returns transfer informations');
+
+    $schema->storage->txn_rollback;
+};
+
+subtest 'RenewHold' => sub {
+    plan tests => 4;
+
+    $schema->storage->txn_begin;
+
+    my $cgi    = new CGI;
+    my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
+    my $item   = $builder->build_object( { class => 'Koha::Items' } );
+    $cgi->param( patron_id => $patron->borrowernumber );
+    $cgi->param( item_id   => $item->itemnumber );
+
+    t::lib::Mocks::mock_userenv( { patron => $patron } );    # For AddIssue
+    my $checkout = C4::Circulation::AddIssue( $patron->unblessed, $item->barcode );
+
+    # Everything is ok
+    my $reply = C4::ILSDI::Services::RenewLoan($cgi);
+    is( exists $reply->{date_due}, 1, 'If the item is checked out, the date_due key should exist' );
+
+    # The item is not checked out
+    $checkout->delete;
+    $reply = C4::ILSDI::Services::RenewLoan($cgi);
+    is( $reply, undef, 'If the item is not checked out, we should not explode.');    # FIXME We should return an error code instead
+
+    # The item does not exist
+    $item->delete;
+    $reply = C4::ILSDI::Services::RenewLoan($cgi);
+    is( $reply->{code}, 'RecordNotFound', 'If the item does not exist, RecordNotFound should be returned');
+
+    $patron->delete;
+    $reply = C4::ILSDI::Services::RenewLoan($cgi);
+    is( $reply->{code}, 'PatronNotFound', 'If the patron does not exist, PatronNotFound should be returned');
+
+    $schema->storage->txn_rollback;
+};
+
+subtest 'GetPatronInfo paginated loans' => sub {
+    plan tests => 7;
+
+    $schema->storage->txn_begin;
+
+    my $library = $builder->build_object({
+        class => 'Koha::Libraries',
+    });
+
+    my $item1 = $builder->build_sample_item({ library => $library->branchcode });
+    my $item2 = $builder->build_sample_item({ library => $library->branchcode });
+    my $item3 = $builder->build_sample_item({ library => $library->branchcode });
+    my $patron = $builder->build_object({
+        class => 'Koha::Patrons',
+        value => {
+            branchcode => $library->branchcode,
+        },
+    });
+    my $module = new Test::MockModule('C4::Context');
+    $module->mock('userenv', sub { { branch => $library->branchcode } });
+    my $date_due = DateTime->now->add(weeks => 2);
+    my $issue1 = C4::Circulation::AddIssue($patron->unblessed, $item1->barcode, $date_due);
+    my $date_due1 = Koha::DateUtils::dt_from_string( $issue1->date_due );
+    my $issue2 = C4::Circulation::AddIssue($patron->unblessed, $item2->barcode, $date_due);
+    my $date_due2 = Koha::DateUtils::dt_from_string( $issue2->date_due );
+    my $issue3 = C4::Circulation::AddIssue($patron->unblessed, $item3->barcode, $date_due);
+    my $date_due3 = Koha::DateUtils::dt_from_string( $issue3->date_due );
+
+    my $cgi = new CGI;
+
+    $cgi->param( 'service', 'GetPatronInfo' );
+    $cgi->param( 'patron_id', $patron->borrowernumber );
+    $cgi->param( 'show_loans', '1' );
+    $cgi->param( 'loans_per_page', '2' );
+    $cgi->param( 'loans_page', '1' );
+    my $reply = C4::ILSDI::Services::GetPatronInfo($cgi);
+
+    is($reply->{total_loans}, 3, 'total_loans == 3');
+    is(scalar @{ $reply->{loans}->{loan} }, 2, 'GetPatronInfo returned only 2 loans');
+    is($reply->{loans}->{loan}->[0]->{itemnumber}, $item3->itemnumber);
+    is($reply->{loans}->{loan}->[1]->{itemnumber}, $item2->itemnumber);
+
+    $cgi->param( 'loans_page', '2' );
+    $reply = C4::ILSDI::Services::GetPatronInfo($cgi);
+
+    is($reply->{total_loans}, 3, 'total_loans == 3');
+    is(scalar @{ $reply->{loans}->{loan} }, 1, 'GetPatronInfo returned only 1 loan');
+    is($reply->{loans}->{loan}->[0]->{itemnumber}, $item1->itemnumber);
+
+    $schema->storage->txn_rollback;
+};