use Modern::Perl;
-use Test::More tests => 2;
+use Test::More tests => 7;
+use Test::Exception;
+use Koha::Account;
use Koha::Account::Lines;
+use Koha::Account::Offsets;
use Koha::Items;
+use t::lib::Mocks;
use t::lib::TestBuilder;
my $schema = Koha::Database->new->schema;
my $builder = t::lib::TestBuilder->new;
-subtest 'item' => sub {
+subtest 'item() tests' => sub {
- plan tests => 2;
+ plan tests => 3;
$schema->storage->txn_begin;
is( ref( $account_line_item ), 'Koha::Item', 'Koha::Account::Line->item should return a Koha::Item' );
is( $line->itemnumber, $account_line_item->itemnumber, 'Koha::Account::Line->item should return the correct item' );
+ $line->itemnumber(undef)->store;
+ is( $line->item, undef, 'Koha::Account::Line->item should return undef if no item linked' );
+
$schema->storage->txn_rollback;
};
-subtest 'total_outstanding' => sub {
+subtest 'total_outstanding() tests' => sub {
plan tests => 5;
$schema->storage->txn_rollback;
};
+
+subtest 'is_credit() and is_debit() tests' => sub {
+
+ plan tests => 4;
+
+ $schema->storage->txn_begin;
+
+ my $patron = $builder->build_object({ class => 'Koha::Patrons' });
+ my $account = $patron->account;
+
+ my $credit = $account->add_credit({ amount => 100, user_id => $patron->id });
+
+ ok( $credit->is_credit, 'is_credit detects credits' );
+ ok( !$credit->is_debit, 'is_debit detects credits' );
+
+ my $debit = Koha::Account::Line->new(
+ {
+ borrowernumber => $patron->id,
+ accounttype => "F",
+ amount => 10,
+ })->store;
+
+ ok( !$debit->is_credit, 'is_credit detects debits' );
+ ok( $debit->is_debit, 'is_debit detects debits');
+
+ $schema->storage->txn_rollback;
+};
+
+subtest 'apply() tests' => sub {
+
+ plan tests => 24;
+
+ $schema->storage->txn_begin;
+
+ my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
+ my $account = $patron->account;
+
+ my $credit = $account->add_credit( { amount => 100, user_id => $patron->id } );
+
+ my $debit_1 = Koha::Account::Line->new(
+ { borrowernumber => $patron->id,
+ accounttype => "F",
+ amount => 10,
+ amountoutstanding => 10
+ }
+ )->store;
+
+ my $debit_2 = Koha::Account::Line->new(
+ { borrowernumber => $patron->id,
+ accounttype => "F",
+ amount => 100,
+ amountoutstanding => 100
+ }
+ )->store;
+
+ $credit->discard_changes;
+ $debit_1->discard_changes;
+
+ my $debits = Koha::Account::Lines->search({ accountlines_id => $debit_1->id });
+ my $remaining_credit = $credit->apply( { debits => $debits, offset_type => 'Manual Credit' } );
+ is( $remaining_credit * 1, 90, 'Remaining credit is correctly calculated' );
+ $credit->discard_changes;
+ is( $credit->amountoutstanding * -1, $remaining_credit, 'Remaining credit correctly stored' );
+
+ # re-read debit info
+ $debit_1->discard_changes;
+ is( $debit_1->amountoutstanding * 1, 0, 'Debit has been cancelled' );
+
+ my $offsets = Koha::Account::Offsets->search( { credit_id => $credit->id, debit_id => $debit_1->id } );
+ is( $offsets->count, 1, 'Only one offset is generated' );
+ my $THE_offset = $offsets->next;
+ is( $THE_offset->amount * 1, -10, 'Amount was calculated correctly (less than the available credit)' );
+ is( $THE_offset->type, 'Manual Credit', 'Passed type stored correctly' );
+
+ $debits = Koha::Account::Lines->search({ accountlines_id => $debit_2->id });
+ $remaining_credit = $credit->apply( { debits => $debits } );
+ is( $remaining_credit, 0, 'No remaining credit left' );
+ $credit->discard_changes;
+ is( $credit->amountoutstanding * 1, 0, 'No outstanding credit' );
+ $debit_2->discard_changes;
+ is( $debit_2->amountoutstanding * 1, 10, 'Outstanding amount decremented correctly' );
+
+ $offsets = Koha::Account::Offsets->search( { credit_id => $credit->id, debit_id => $debit_2->id } );
+ is( $offsets->count, 1, 'Only one offset is generated' );
+ $THE_offset = $offsets->next;
+ is( $THE_offset->amount * 1, -90, 'Amount was calculated correctly (less than the available credit)' );
+ is( $THE_offset->type, 'Credit Applied', 'Defaults to \'Credit Applied\' offset type' );
+
+ $debits = Koha::Account::Lines->search({ accountlines_id => $debit_1->id });
+ throws_ok
+ { $credit->apply({ debits => $debits }); }
+ 'Koha::Exceptions::Account::NoAvailableCredit',
+ '->apply() can only be used with outstanding credits';
+
+ $debits = Koha::Account::Lines->search({ accountlines_id => $credit->id });
+ throws_ok
+ { $debit_1->apply({ debits => $debits }); }
+ 'Koha::Exceptions::Account::IsNotCredit',
+ '->apply() can only be used with credits';
+
+ $debits = Koha::Account::Lines->search({ accountlines_id => $credit->id });
+ my $credit_3 = $account->add_credit({ amount => 1 });
+ throws_ok
+ { $credit_3->apply({ debits => $debits }); }
+ 'Koha::Exceptions::Account::IsNotDebit',
+ '->apply() can only be applied to credits';
+
+ my $credit_2 = $account->add_credit({ amount => 20 });
+ my $debit_3 = Koha::Account::Line->new(
+ { borrowernumber => $patron->id,
+ accounttype => "F",
+ amount => 100,
+ amountoutstanding => 100
+ }
+ )->store;
+
+ $debits = Koha::Account::Lines->search({ accountlines_id => { -in => [ $debit_1->id, $debit_2->id, $debit_3->id, $credit->id ] } });
+ throws_ok {
+ $credit_2->apply( { debits => $debits, offset_type => 'Manual Credit' } ); }
+ 'Koha::Exceptions::Account::IsNotDebit',
+ '->apply() rolls back if any of the passed lines is not a debit';
+
+ is( $debit_1->discard_changes->amountoutstanding * 1, 0, 'No changes to already cancelled debit' );
+ is( $debit_2->discard_changes->amountoutstanding * 1, 10, 'Debit cancelled' );
+ is( $debit_3->discard_changes->amountoutstanding * 1, 100, 'Outstanding amount correctly calculated' );
+ is( $credit_2->discard_changes->amountoutstanding * -1, 20, 'No changes made' );
+
+ $debits = Koha::Account::Lines->search({ accountlines_id => { -in => [ $debit_1->id, $debit_2->id, $debit_3->id ] } });
+ $remaining_credit = $credit_2->apply( { debits => $debits, offset_type => 'Manual Credit' } );
+
+ is( $debit_1->discard_changes->amountoutstanding * 1, 0, 'No changes to already cancelled debit' );
+ is( $debit_2->discard_changes->amountoutstanding * 1, 0, 'Debit cancelled' );
+ is( $debit_3->discard_changes->amountoutstanding * 1, 90, 'Outstanding amount correctly calculated' );
+ is( $credit_2->discard_changes->amountoutstanding * 1, 0, 'No remaining credit' );
+
+ $schema->storage->txn_rollback;
+};
+
+subtest 'Keep account info when a patron is deleted' => sub {
+
+ plan tests => 2;
+
+ $schema->storage->txn_begin;
+
+ my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
+ my $item = $builder->build_object({ class => 'Koha::Items' });
+ my $line = Koha::Account::Line->new(
+ {
+ borrowernumber => $patron->borrowernumber,
+ itemnumber => $item->itemnumber,
+ accounttype => "F",
+ amount => 10,
+ })->store;
+
+ $item->delete;
+ $line = $line->get_from_storage;
+ is( $line->itemnumber, undef, "The account line should not be deleted when the related item is delete");
+
+ $patron->delete;
+ $line = $line->get_from_storage;
+ is( $line->borrowernumber, undef, "The account line should not be deleted when the related patron is delete");
+
+ $schema->storage->txn_rollback;
+};
+
+subtest 'adjust() tests' => sub {
+
+ plan tests => 33;
+
+ $schema->storage->txn_begin;
+
+ # count logs before any actions
+ my $action_logs = $schema->resultset('ActionLog')->search()->count;
+
+ # Disable logs
+ t::lib::Mocks::mock_preference( 'FinesLog', 0 );
+
+ my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
+ my $account = $patron->account;
+
+ my $debit_1 = Koha::Account::Line->new(
+ { borrowernumber => $patron->id,
+ accounttype => "F",
+ amount => 10,
+ amountoutstanding => 10
+ }
+ )->store;
+
+ my $debit_2 = Koha::Account::Line->new(
+ { borrowernumber => $patron->id,
+ accounttype => "FU",
+ amount => 100,
+ amountoutstanding => 100
+ }
+ )->store;
+
+ my $credit = $account->add_credit( { amount => 40, user_id => $patron->id } );
+
+ throws_ok { $debit_1->adjust( { amount => 50, type => 'bad' } ) }
+ qr/Update type not recognised/, 'Exception thrown for unrecognised type';
+
+ throws_ok { $debit_1->adjust( { amount => 50, type => 'fine_update' } ) }
+ qr/Update type not allowed on this accounttype/,
+ 'Exception thrown for type conflict';
+
+ # Increment an unpaid fine
+ $debit_2->adjust( { amount => 150, type => 'fine_update' } )->discard_changes;
+
+ is( $debit_2->amount * 1, 150, 'Fine amount was updated in full' );
+ is( $debit_2->amountoutstanding * 1, 150, 'Fine amountoutstanding was update in full' );
+ isnt( $debit_2->date, undef, 'Date has been set' );
+ is( $debit_2->lastincrement * 1, 50, 'lastincrement is the to the right value' );
+
+ my $offsets = Koha::Account::Offsets->search( { debit_id => $debit_2->id } );
+ is( $offsets->count, 1, 'An offset is generated for the increment' );
+ my $THIS_offset = $offsets->next;
+ is( $THIS_offset->amount * 1, 50, 'Amount was calculated correctly (increment by 50)' );
+ is( $THIS_offset->type, 'fine_increase', 'Adjust type stored correctly' );
+
+ is( $schema->resultset('ActionLog')->count(), $action_logs + 0, 'No log was added' );
+
+ # Update fine to partially paid
+ my $debits = Koha::Account::Lines->search({ accountlines_id => $debit_2->id });
+ $credit->apply( { debits => $debits, offset_type => 'Manual Credit' } );
+
+ $debit_2->discard_changes;
+ is( $debit_2->amount * 1, 150, 'Fine amount unaffected by partial payment' );
+ is( $debit_2->amountoutstanding * 1, 110, 'Fine amountoutstanding updated by partial payment' );
+
+ # Enable logs
+ t::lib::Mocks::mock_preference( 'FinesLog', 1 );
+
+ # Increment the partially paid fine
+ $debit_2->adjust( { amount => 160, type => 'fine_update' } )->discard_changes;
+
+ is( $debit_2->amount * 1, 160, 'Fine amount was updated in full' );
+ is( $debit_2->amountoutstanding * 1, 120, 'Fine amountoutstanding was updated by difference' );
+ is( $debit_2->lastincrement * 1, 10, 'lastincrement is the to the right value' );
+
+ $offsets = Koha::Account::Offsets->search( { debit_id => $debit_2->id } );
+ is( $offsets->count, 3, 'An offset is generated for the increment' );
+ $THIS_offset = $offsets->last;
+ is( $THIS_offset->amount * 1, 10, 'Amount was calculated correctly (increment by 10)' );
+ is( $THIS_offset->type, 'fine_increase', 'Adjust type stored correctly' );
+
+ is( $schema->resultset('ActionLog')->count(), $action_logs + 1, 'Log was added' );
+
+ # Decrement the partially paid fine, less than what was paid
+ $debit_2->adjust( { amount => 50, type => 'fine_update' } )->discard_changes;
+
+ is( $debit_2->amount * 1, 50, 'Fine amount was updated in full' );
+ is( $debit_2->amountoutstanding * 1, 10, 'Fine amountoutstanding was updated by difference' );
+ is( $debit_2->lastincrement * 1, -110, 'lastincrement is the to the right value' );
+
+ $offsets = Koha::Account::Offsets->search( { debit_id => $debit_2->id } );
+ is( $offsets->count, 4, 'An offset is generated for the decrement' );
+ $THIS_offset = $offsets->last;
+ is( $THIS_offset->amount * 1, -110, 'Amount was calculated correctly (decrement by 110)' );
+ is( $THIS_offset->type, 'fine_decrease', 'Adjust type stored correctly' );
+
+ # Decrement the partially paid fine, more than what was paid
+ $debit_2->adjust( { amount => 30, type => 'fine_update' } )->discard_changes;
+ is( $debit_2->amount * 1, 30, 'Fine amount was updated in full' );
+ is( $debit_2->amountoutstanding * 1, 0, 'Fine amountoutstanding was zeroed (payment was 40)' );
+ is( $debit_2->lastincrement * 1, -20, 'lastincrement is the to the right value' );
+
+ $offsets = Koha::Account::Offsets->search( { debit_id => $debit_2->id } );
+ is( $offsets->count, 5, 'An offset is generated for the decrement' );
+ $THIS_offset = $offsets->last;
+ is( $THIS_offset->amount * 1, -20, 'Amount was calculated correctly (decrement by 20)' );
+ is( $THIS_offset->type, 'fine_decrease', 'Adjust type stored correctly' );
+
+ my $overpayment_refund = $account->lines->last;
+ is( $overpayment_refund->amount * 1, -10, 'A new credit has been added' );
+ is( $overpayment_refund->description, 'Overpayment refund', 'Credit generated with the expected description' );
+
+ $schema->storage->txn_rollback;
+};
+
+subtest 'issue() tests' => sub {
+ plan tests => 6;
+
+ $schema->storage->txn_begin;
+
+ my $library = $builder->build( { source => 'Branch' } );
+ my $patron = $builder->build( { source => 'Borrower' } );
+ my $item = $builder->build( { source => 'Item' } );
+
+ my $checkout = Koha::Checkout->new(
+ { borrowernumber => $patron->{borrowernumber},
+ itemnumber => $item->{itemnumber},
+ branchcode => $library->{branchcode},
+ })->store;
+
+ my $line = Koha::Account::Line->new(
+ {
+ borrowernumber => $patron->{borrowernumber},
+ itemnumber => $item->{itemnumber},
+ issue_id => $checkout->issue_id,
+ accounttype => "F",
+ amount => 10,
+ })->store;
+
+ my $line_issue = $line->issue;
+ is( ref($line_issue), 'Koha::Checkout', 'Result type is correct' );
+ is( $line_issue->issue_id, $checkout->issue_id, 'Koha::Account::Line->issue should return the correct issue');
+
+ my ( $returned, undef, $old_checkout) = C4::Circulation::AddReturn( $item->{barcode} ,$library->{branchcode} );
+ is( $returned, 1, 'The item should have been returned' );
+
+ my $old_line_issue = $line->issue;
+ is( ref($old_line_issue), 'Koha::Old::Checkout', 'Result type is correct' );
+ is( $old_line_issue->issue_id, $old_checkout->issue_id, 'Koha::Account::Line->issue should return the correct old_issue' );
+
+ $line->issue_id(undef)->store;
+ is( $line->issue, undef, 'Koha::Account::Line->issue should return undef if no issue linked' );
+
+ $schema->storage->txn_rollback;
+};
+
+1;