Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/t/db_dependent/api/v1/patrons_accounts.t
Martin Renvoize a702f57adf
Bug 21043: Handle exceptions and switch to debit response 
We were cheating a bit here and expecting a 'debit' to be sent in but a
'line' to be returned.

We should really be sending a debit and returning a debit.. so I've
update the paths schema as such and we're now coercing the
Koha::Account::Line object that's returned by Koha::Account->add_debit
into a Koha::Account::Debit object. Longer term it would be nice to
convert returns from the various Koha::Account methods to their correct
Koha::Account:: objects as apposed to them all being the base ::Line

I've also added some code to catch exceptions that can be thrown by
Koha::Account->add_debit and added the appropriate 400 errors into the
path specs again.

Finally.. I added more unit tests to prove the above

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-05-05 12:13:52 -03:00

474 lines
14 KiB
Perl
Executable file
Raw Blame History

#!/usr/bin/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 => 5;
use Test::Mojo;
use t::lib::TestBuilder;
use t::lib::Mocks;
use Koha::Account::Lines;
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 'get_balance() tests' => sub {
plan tests => 15;
$schema->storage->txn_begin;
# Enable AccountAutoReconcile
t::lib::Mocks::mock_preference( 'AccountAutoReconcile', 1 );
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 $library = $builder->build_object( { class => 'Koha::Libraries' } );
my $patron_id = $patron->id;
my $account = $patron->account;
$t->get_ok("//$userid:$password@/api/v1/patrons/$patron_id/account")
->status_is(200)->json_is(
{
balance => 0.00,
outstanding_debits => { total => 0, lines => [] },
outstanding_credits => { total => 0, lines => [] }
}
);
my $debit_1 = $account->add_debit(
{
amount => 50,
description => "A description",
type => "NEW_CARD",
user_id => $patron->borrowernumber,
library_id => $library->id,
interface => 'test',
}
)->store();
$debit_1->discard_changes;
my $debit_2 = $account->add_debit(
{
amount => 50.01,
description => "A description",
type => "NEW_CARD", # New card
user_id => $patron->borrowernumber,
library_id => $library->id,
interface => 'test',
}
)->store();
$debit_2->discard_changes;
$t->get_ok("//$userid:$password@/api/v1/patrons/$patron_id/account")
->status_is(200)->json_is(
{
balance => 100.01,
outstanding_debits => {
total => 100.01,
lines => [ $debit_1->to_api, $debit_2->to_api ]
},
outstanding_credits => {
total => 0,
lines => []
}
}
);
$account->pay(
{
amount => 100.01,
note => 'He paid!',
description => 'Finally!',
library_id => $patron->branchcode,
account_type => 'PAYMENT'
}
);
$t->get_ok("//$userid:$password@/api/v1/patrons/$patron_id/account")
->status_is(200)->json_is(
{
balance => 0,
outstanding_debits => { total => 0, lines => [] },
outstanding_credits => { total => 0, lines => [] }
}
);
# add a credit
my $credit_line = $account->add_credit(
{
amount => 10,
user_id => $patron->id,
library_id => $library->id,
interface => 'test'
}
);
# re-read from the DB
$credit_line->discard_changes;
$t->get_ok("//$userid:$password@/api/v1/patrons/$patron_id/account")
->status_is(200)->json_is(
{
balance => -10,
outstanding_debits => {
total => 0,
lines => []
},
outstanding_credits => {
total => -10,
lines => [ $credit_line->to_api ]
}
}
);
# Accountline without manager_id (happens with fines.pl cron for example)
my $debit_3 = $account->add_debit(
{
amount => 50,
description => "A description",
type => "NEW_CARD", # New card
user_id => undef,
library_id => $library->id,
interface => 'test',
}
)->store();
$debit_3->discard_changes;
$t->get_ok("//$userid:$password@/api/v1/patrons/$patron_id/account")
->status_is(200)->json_is(
{
balance => 40.00,
outstanding_debits => {
total => 50.00,
lines => [ $debit_3->to_api ]
},
outstanding_credits => {
total => -10,
lines => [ $credit_line->to_api ]
}
}
);
$schema->storage->txn_rollback;
};
subtest 'add_credit() tests' => sub {
plan tests => 18;
$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 $library = $builder->build_object( { class => 'Koha::Libraries' } );
my $patron_id = $patron->id;
my $account = $patron->account;
is( $account->outstanding_debits->count,
0, 'No outstanding debits for patron' );
is( $account->outstanding_credits->count,
0, 'No outstanding credits for patron' );
my $credit = { amount => 100 };
my $ret = $t->post_ok(
"//$userid:$password@/api/v1/patrons/$patron_id/account/credits" =>
json => $credit )->status_is(201)->tx->res->json;
is_deeply(
$ret,
Koha::Account::Lines->find( $ret->{account_line_id} )->to_api,
'Line returned correctly'
);
my $outstanding_credits = $account->outstanding_credits;
is( $outstanding_credits->count, 1 );
is( $outstanding_credits->total_outstanding, -100 );
my $debit_1 = $account->add_debit(
{
amount => 10,
description => "A description",
type => "NEW_CARD",
user_id => $patron->borrowernumber,
interface => 'test',
}
)->store();
my $debit_2 = $account->add_debit(
{
amount => 15,
description => "A description",
type => "NEW_CARD",
user_id => $patron->borrowernumber,
interface => 'test',
}
)->store();
is( $account->outstanding_debits->total_outstanding, 25 );
$credit->{library_id} = $library->id;
$ret = $t->post_ok(
"//$userid:$password@/api/v1/patrons/$patron_id/account/credits" =>
json => $credit )->status_is(201)->tx->res->json;
is_deeply(
$ret,
Koha::Account::Lines->find( $ret->{account_line_id} )->to_api,
'Line returned correctly'
);
my $account_line_id = $t->tx->res->json->{account_line_id};
is( Koha::Account::Lines->find($account_line_id)->branchcode,
$library->id, 'Library id is sored correctly' );
is( $account->outstanding_debits->total_outstanding,
0, "Debits have been cancelled automatically" );
my $debit_3 = $account->add_debit(
{
amount => 100,
description => "A description",
type => "NEW_CARD",
user_id => $patron->borrowernumber,
interface => 'test',
}
)->store();
$credit = {
amount => 35,
account_lines_ids => [ $debit_1->id, $debit_2->id, $debit_3->id ]
};
$ret = $t->post_ok(
"//$userid:$password@/api/v1/patrons/$patron_id/account/credits" =>
json => $credit )->status_is(201)->tx->res->json;
is_deeply(
$ret,
Koha::Account::Lines->find( $ret->{account_line_id} )->to_api,
'Line returned correctly'
);
my $outstanding_debits = $account->outstanding_debits;
is( $outstanding_debits->total_outstanding, 65 );
is( $outstanding_debits->count, 1 );
$schema->storage->txn_rollback;
};
subtest 'list_credits() test' => sub {
plan tests => 3;
$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 $patron_id = $patron->borrowernumber;
my $account = $patron->account;
$account->add_credit({
type => 'PAYMENT',
amount => 35,
interface => 'staff',
});
$account->add_credit({
type => 'PAYMENT',
amount => 70,
interface => 'staff',
});
my $ret = $t->get_ok("//$userid:$password@/api/v1/patrons/$patron_id/account/credits")
->status_is(200)
->tx->res->json;
is(-105, $ret->[0]->{amount} + $ret->[1]->{amount}, 'Total credits are -105');
$schema->storage->txn_rollback;
};
subtest 'list_debits() test' => sub {
plan tests => 3;
$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 $patron_id = $patron->borrowernumber;
my $account = $patron->account;
$account->add_debit(
{ amount => 100,
description => "A description",
type => "NEW_CARD",
user_id => $patron->borrowernumber,
interface => 'test',
}
);
$account->add_debit(
{ amount => 40,
description => "A description",
type => "NEW_CARD",
user_id => $patron->borrowernumber,
interface => 'test',
}
);
my $ret = $t->get_ok("//$userid:$password@/api/v1/patrons/$patron_id/account/debits")
->status_is(200)
->tx->res->json;
is(140, $ret->[0]->{amount} + $ret->[1]->{amount}, 'Total debits are 140');
};
subtest 'add_debit() tests' => sub {
plan tests => 18;
$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 $library = $builder->build_object( { class => 'Koha::Libraries' } );
my $patron_id = $patron->id;
my $account = $patron->account;
is( $account->outstanding_debits->count,
0, 'No outstanding debits for patron' );
is( $account->outstanding_credits->count,
0, 'No outstanding credits for patron' );
my $debit = {
amount => 100,
description => "A description",
type => "NEW_CARD",
user_id => $patron->borrowernumber,
interface => 'test',
library_id => $library->id,
};
my $ret = $t->post_ok(
"//$userid:$password@/api/v1/patrons/$patron_id/account/debits" =>
json => $debit )->status_is(201)->tx->res->json;
my $account_line = Koha::Account::Debits->find( $ret->{account_line_id} );
is_deeply( $ret, $account_line->to_api, 'Line returned correctly' );
is( $account_line->branchcode,
$library->id, 'Library id is stored correctly' );
my $outstanding_debits = $account->outstanding_debits;
is( $outstanding_debits->count, 1, "One outstanding debit added" );
is( $outstanding_debits->total_outstanding, 100, "Outstanding debit is 100" );
my $credit_1 = $account->add_credit(
{
amount => 10,
interface => 'test',
}
)->store()->apply( { debits => [$account_line] } );
my $credit_2 = $account->add_credit(
{
amount => 15,
interface => 'test'
}
)->store()->apply( { debits => [$account_line] } );
is( $account->outstanding_credits->total_outstanding, 0, "Credits all applied" );
is( $account->outstanding_debits->total_outstanding,
75, "Credits partially cancelled debit" );
my $account_line_id = $ret->{account_line_id};
$t->post_ok(
"//$userid:$password@/api/v1/patrons/$patron_id/account/debits" =>
json => $debit )->status_is(201);
is( $account->outstanding_debits->total_outstanding,
175, "Debit added to total outstanding debits" );
# Cash register handling and PAYOUTs
t::lib::Mocks::mock_preference( 'UseCashRegisters', 1 );
my $payout = {
amount => 10,
description => "A description",
type => "PAYOUT",
payout_type => "CASH",
user_id => $patron->borrowernumber,
interface => 'test',
library_id => $library->id,
};
$t->post_ok(
"//$userid:$password@/api/v1/patrons/$patron_id/account/debits" =>
json => $payout )->status_is(400)
->json_is( '/error' => 'Account transaction requires a cash register' );
my $register = $builder->build_object(
{
class => 'Koha::Cash::Registers',
}
);
$payout->{cash_register_id} = $register->id;
my $res = $t->post_ok(
"//$userid:$password@/api/v1/patrons/$patron_id/account/debits" =>
json => $payout )->status_is(201)->tx->res->json;
$schema->storage->txn_rollback;
};
View git blame Copy permalink