Koha/t/db_dependent/Stats.t
Jonathan Druart 9d6d641d1f Bug 17600: Standardize our EXPORT_OK
On bug 17591 we discovered that there was something weird going on with
the way we export and use subroutines/modules.
This patch tries to standardize our EXPORT to use EXPORT_OK only.

That way we will need to explicitely define the subroutine we want to
use from a module.

This patch is a squashed version of:
Bug 17600: After export.pl
Bug 17600: After perlimport
Bug 17600: Manual changes
Bug 17600: Other manual changes after second perlimports run
Bug 17600: Fix tests

And a lot of other manual changes.

export.pl is a dirty script that can be found on bug 17600.

"perlimport" is:
git clone https://github.com/oalders/App-perlimports.git
cd App-perlimports/
cpanm --installdeps .
export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib"
find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \;

The ideas of this patch are to:
* use EXPORT_OK instead of EXPORT
* perltidy the EXPORT_OK list
* remove '&' before the subroutine names
* remove some uneeded use statements
* explicitely import the subroutines we need within the controllers or
modules

Note that the private subroutines (starting with _) should not be
exported (and not used from outside of the module except from tests).

EXPORT vs EXPORT_OK (from
https://www.thegeekstuff.com/2010/06/perl-exporter-examples/)
"""
Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members.

@EXPORT and @EXPORT_OK are the two main variables used during export operation.

@EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace.

@EXPORT_OK does export of symbols on demand basis.
"""

If this patch caused a conflict with a patch you wrote prior to its
push:
* Make sure you are not reintroducing a "use" statement that has been
removed
* "$subroutine" is not exported by the C4::$MODULE module
means that you need to add the subroutine to the @EXPORT_OK list
* Bareword "$subroutine" not allowed while "strict subs"
means that you didn't imported the subroutine from the module:
  - use $MODULE qw( $subroutine list );
You can also use the fully qualified namespace: C4::$MODULE::$subroutine

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-07-16 08:58:47 +02:00

160 lines
5.4 KiB
Perl
Executable file

#!/usr/bin/perl
use Modern::Perl;
use C4::Stats qw( UpdateStats );
use Koha::Database;
use Test::More tests => 18;
BEGIN {
use_ok('C4::Stats', qw( UpdateStats ));
}
can_ok(
'C4::Stats',
qw(UpdateStats)
);
my $schema = Koha::Database->new->schema;
$schema->storage->txn_begin;
my $dbh = C4::Context->dbh;
#
# Test UpdateStats
#
is (UpdateStats () ,undef, "UpdateStats returns undef if no params");
my $params = {
branch => "BRA",
itemnumber => 31,
borrowernumber => 5,
amount =>5.1,
other => "bla",
itemtype => "BK",
location => "LOC",
ccode => "CODE",
};
my $return_error;
# returns undef and croaks if type is not allowed
$params -> {type} = "bla";
eval {UpdateStats($params)};
$return_error = $@;
isnt ($return_error,'',"UpdateStats returns undef and croaks if type is not allowed");
delete $params->{type};
# returns undef and croaks if type is missing
eval {UpdateStats($params)};
$return_error = $@;
isnt ($return_error,'',"UpdateStats returns undef and croaks if no type given");
$params -> {type} = undef;
# returns undef and croaks if type is undef
eval {UpdateStats($params)};
$return_error = $@;
isnt ($return_error,'',"UpdateStats returns undef and croaks if type is undef");
# returns undef and croaks if mandatory params are missing
my @allowed_circulation_types = qw (renew issue localuse return);
my @allowed_accounts_types = qw (writeoff payment);
my @circulation_mandatory_keys = qw (branch borrowernumber itemnumber ccode itemtype); #don't check type here
my @accounts_mandatory_keys = qw (branch borrowernumber amount); #don't check type here
my @missing_errors = ();
foreach my $key (@circulation_mandatory_keys) {
my $value = $params->{$key};
delete $params->{$key};
foreach my $type (@allowed_circulation_types) {
$params->{type} = $type;
eval {UpdateStats($params)};
$return_error = $@;
push @missing_errors, "key:$key for type:$type" unless $return_error;
}
$params->{$key} = $value;
}
foreach my $key (@accounts_mandatory_keys) {
my $value = $params->{$key};
delete $params->{$key};
foreach my $type (@allowed_accounts_types) {
$params->{type} = $type;
eval {UpdateStats($params)};
$return_error = $@;
push @missing_errors, "key:$key for type:$type" unless $return_error;
}
$params->{$key} = $value;
}
is (join (", ", @missing_errors),'',"UpdateStats returns undef and croaks if mandatory params are missing");
# returns undef and croaks if forbidden params are given
$params -> {type} = "return";
$params -> {newparam} = "true";
eval {UpdateStats($params)};
$return_error = $@;
isnt ($return_error,'',"UpdateStats returns undef and croaks if a forbidden param is given");
delete $params->{newparam};
# save the params in the right database fields
$dbh->do(q|DELETE FROM statistics|);
$params = {
branch => "BRA",
itemnumber => 31,
borrowernumber => 5,
amount =>5.1,
other => "bla",
itemtype => "BK",
location => "LOC",
ccode => "CODE",
type => "return"
};
UpdateStats ($params);
my $sth = $dbh->prepare("SELECT * FROM statistics");
$sth->execute();
my $line = ${ $sth->fetchall_arrayref( {} ) }[0];
is ($params->{branch}, $line->{branch}, "UpdateStats save branch param in branch field of statistics table");
is ($params->{type}, $line->{type}, "UpdateStats save type param in type field of statistics table");
is ($params->{borrowernumber}, $line->{borrowernumber}, "UpdateStats save borrowernumber param in borrowernumber field of statistics table");
cmp_ok($params->{amount},'==', $line->{value}, "UpdateStats save amount param in value field of statistics table");
is ($params->{other}, $line->{other}, "UpdateStats save other param in other field of statistics table");
is ($params->{itemtype}, $line->{itemtype}, "UpdateStats save itemtype param in itemtype field of statistics table");
is ($params->{location}, $line->{location}, "UpdateStats save location param in location field of statistics table");
is ($params->{ccode}, $line->{ccode}, "UpdateStats save ccode param in ccode field of statistics table");
$dbh->do(q|DELETE FROM statistics|);
$params = {
branch => "BRA",
itemnumber => 31,
borrowernumber => 5,
amount => 5.1,
other => "bla",
itemtype => "BK",
ccode => "CODE",
type => "return"
};
UpdateStats($params);
$sth = $dbh->prepare("SELECT * FROM statistics");
$sth->execute();
$line = ${ $sth->fetchall_arrayref( {} ) }[0];
is( $line->{location}, undef,
"UpdateStats sets location to NULL if no location is passed in." );
$dbh->do(q|DELETE FROM statistics|);
$params = {
branch => "BRA",
itemnumber => 31,
borrowernumber => 5,
amount => 5.1,
other => "bla",
itemtype => "BK",
location => undef,
ccode => "CODE",
type => "return"
};
UpdateStats($params);
$sth = $dbh->prepare("SELECT * FROM statistics");
$sth->execute();
$line = ${ $sth->fetchall_arrayref( {} ) }[0];
is( $line->{location}, undef,
"UpdateStats sets location to NULL if undef is passed in." );
# More tests to write!