Bug 25855: Unit tests
authorTomas Cohen Arazi <tomascohen@theke.io>
Tue, 23 Jun 2020 19:18:54 +0000 (16:18 -0300)
committerJonathan Druart <jonathan.druart@bugs.koha-community.org>
Thu, 30 Jul 2020 15:30:23 +0000 (17:30 +0200)
This patch adds tests fr a new circulation hook for plugins.
In this case the post_renewal_action hook,

The tests add the hook to the Test plugin, and verify that all the
required parameters are passed for the plugin hook to use them.
It relies on throwing an exception that is to be caught.

Sponsored-by: ByWater Solutions
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

t/db_dependent/Koha/Plugins/Circulation_hooks.t [new file with mode: 0755]
t/lib/Koha/Plugin/Test.pm

diff --git a/t/db_dependent/Koha/Plugins/Circulation_hooks.t b/t/db_dependent/Koha/Plugins/Circulation_hooks.t
new file mode 100755 (executable)
index 0000000..738ee8c
--- /dev/null
@@ -0,0 +1,85 @@
+#!/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 => 4;
+use Test::Warn;
+
+use File::Basename;
+
+use C4::Circulation qw(AddIssue AddRenewal);
+
+use t::lib::Mocks;
+use t::lib::TestBuilder;
+
+BEGIN {
+    # Mock pluginsdir before loading Plugins module
+    my $path = dirname(__FILE__) . '/../../../lib';
+    t::lib::Mocks::mock_config( 'pluginsdir', $path );
+
+    use_ok('Koha::Plugins');
+    use_ok('Koha::Plugins::Handler');
+    use_ok('Koha::Plugin::Test');
+}
+
+my $schema  = Koha::Database->new->schema;
+my $builder = t::lib::TestBuilder->new;
+
+t::lib::Mocks::mock_config( 'enable_plugins', 1 );
+
+subtest 'post_renewal_action() hook tests' => sub {
+
+    plan tests => 4;
+
+    $schema->storage->txn_begin;
+
+    my $plugins = Koha::Plugins->new;
+    $plugins->InstallPlugins;
+
+    my $plugin = Koha::Plugin::Test->new->enable;
+
+    my $patron = $builder->build_object({ class => 'Koha::Patrons' });
+
+    t::lib::Mocks::mock_userenv(
+        {
+            patron     => $patron,
+            branchcode => $patron->branchcode
+        }
+    );
+
+    my ($biblio, $item);
+
+    warning_like { $biblio = $builder->build_sample_biblio(); }
+            qr/after_biblio_action called with action: create, ref: Koha::Biblio/,
+            'AddBiblio calls the hook with action=create';
+
+    warning_like { $item = $builder->build_sample_item({ biblionumber => $biblio->biblionumber }); }
+            qr/after_item_action called with action: create, ref: Koha::Item/,
+            'AddItem calls the hook with action=create';
+
+    warning_like { AddIssue( $patron->unblessed, $item->barcode ); }
+            qr/after_item_action called with action: modify, ref: Koha::Item/,
+            'AddItem calls the hook with action=modify';
+
+    warnings_like { AddRenewal( $patron->borrowernumber, $item->id, $patron->branchcode ); }
+            [ qr/after_item_action called with action: modify, ref: Koha::Item/,
+              qr/post_renewal_action .* DateTime/ ],
+            'AddRenewal calls the post_renewal_action hook';
+
+    $schema->storage->txn_rollback;
+    Koha::Plugins::Methods->delete;
+};
index 8036c1f..0cc2234 100644 (file)
@@ -155,6 +155,31 @@ sub after_item_action {
     }
 }
 
+sub post_renewal_action {
+    my ( $self, $params ) = @_;
+
+    my $renewal_library_id = $params->{renewal_library_id};
+    my $charge             = $params->{charge};
+    my $item_id            = $params->{item_id};
+    my $item_type          = $params->{item_type};
+    my $shelving_location  = $params->{shelving_location};
+    my $patron_id          = $params->{patron_id};
+    my $collection_code    = $params->{collection_code};
+    my $date_due           = $params->{date_due};
+
+    Koha::Exceptions::Exception->throw(
+        "post_renewal_action " .
+        "$renewal_library_id " .
+        "$charge " .
+        "$item_id " .
+        "$item_type " .
+        "$shelving_location " .
+        "$patron_id " .
+        "$collection_code " .
+        ref($date_due)
+    );
+}
+
 sub api_routes {
     my ( $self, $args ) = @_;