From 7dff752930984391ff46b61c6890b360eec0889b Mon Sep 17 00:00:00 2001
From: Kyle M Hall <kyle@bywatersolutions.com>
Date: Wed, 2 Oct 2024 12:59:53 -0400
Subject: [PATCH] Bug 37869: Add unit tests

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
---
 t/db_dependent/Koha/Plugins/Holds_hooks.t   |  1 +
 t/db_dependent/Koha/Plugins/Message_hooks.t | 78 +++++++++++++++++++++
 t/db_dependent/Koha/Plugins/Plugins.t       |  1 +
 t/lib/plugins/Koha/Plugin/Test.pm           |  5 ++
 4 files changed, 85 insertions(+)
 create mode 100755 t/db_dependent/Koha/Plugins/Message_hooks.t

diff --git a/t/db_dependent/Koha/Plugins/Holds_hooks.t b/t/db_dependent/Koha/Plugins/Holds_hooks.t
index 90d1df0c286..dd4d84755a9 100755
--- a/t/db_dependent/Koha/Plugins/Holds_hooks.t
+++ b/t/db_dependent/Koha/Plugins/Holds_hooks.t
@@ -68,6 +68,7 @@ subtest 'after_hold_create() hook tests' => sub {
     $test_plugin->mock( 'after_biblio_action', undef );
     $test_plugin->mock( 'item_barcode_transform', undef );
     $test_plugin->mock( 'after_hold_action', undef );
+    $test_plugin->mock( 'before_send_messages', undef );
 
     my $biblio = $builder->build_sample_biblio();
     my $item_1 = $builder->build_sample_item( { biblionumber => $biblio->biblionumber } );
diff --git a/t/db_dependent/Koha/Plugins/Message_hooks.t b/t/db_dependent/Koha/Plugins/Message_hooks.t
new file mode 100755
index 00000000000..6abb2781b07
--- /dev/null
+++ b/t/db_dependent/Koha/Plugins/Message_hooks.t
@@ -0,0 +1,78 @@
+#!/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::MockModule;
+use Test::Warn;
+
+use File::Basename;
+
+use C4::Letters qw( SendQueuedMessages );
+
+use t::lib::Mocks;
+use t::lib::TestBuilder;
+
+BEGIN {
+    # Mock pluginsdir before loading Plugins module
+    my $path = dirname(__FILE__) . '/../../../lib/plugins';
+    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 'after_hold_create() hook tests' => sub {
+
+    plan tests => 1;
+
+    $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
+        }
+    );
+
+    # Avoid testing useless warnings
+    my $test_plugin = Test::MockModule->new('Koha::Plugin::Test');
+    $test_plugin->mock( 'after_item_action',      undef );
+    $test_plugin->mock( 'after_biblio_action',    undef );
+    $test_plugin->mock( 'item_barcode_transform', undef );
+    $test_plugin->mock( 'after_hold_action',      undef );
+
+    warnings_like { SendQueuedMessages(); }
+    [qr/before_send_messages called/],
+        'Plugin hook before_send_messages triggered when SendQueuedMessages is called';
+
+    Koha::Plugins->RemovePlugins;
+    $schema->storage->txn_rollback;
+};
diff --git a/t/db_dependent/Koha/Plugins/Plugins.t b/t/db_dependent/Koha/Plugins/Plugins.t
index 1c8f96ab156..90e505c0d3c 100755
--- a/t/db_dependent/Koha/Plugins/Plugins.t
+++ b/t/db_dependent/Koha/Plugins/Plugins.t
@@ -257,6 +257,7 @@ subtest 'Koha::Plugin::Test' => sub {
     ok( $plugin->can('intranet_catalog_biblio_enhancements_toolbar_button'), 'Test plugin can intranet_catalog_biblio_enhancements_toolbar_button' );
     ok( $plugin->can('opac_online_payment'), 'Test plugin can opac_online_payment' );
     ok( $plugin->can('after_hold_create'), 'Test plugin can after_hold_create' );
+    ok( $plugin->can('before_send_messages'), 'Test plugin can before_send_messages' );
     ok( $plugin->can('opac_online_payment_begin'), 'Test plugin can opac_online_payment_begin' );
     ok( $plugin->can('opac_online_payment_end'), 'Test plugin can opac_online_payment_end' );
     ok( $plugin->can('opac_head'), 'Test plugin can opac_head' );
diff --git a/t/lib/plugins/Koha/Plugin/Test.pm b/t/lib/plugins/Koha/Plugin/Test.pm
index 255fc90a122..7472928fff5 100644
--- a/t/lib/plugins/Koha/Plugin/Test.pm
+++ b/t/lib/plugins/Koha/Plugin/Test.pm
@@ -151,6 +151,11 @@ sub after_hold_create {
     Koha::Exception->throw("after_hold_create called with parameter " . ref($param) );
 }
 
+sub before_send_messages {
+    my ( $self, $param ) = @_;
+    Koha::Exception->throw("before_send_messages called");
+}
+
 sub before_biblio_action {
     my ( $self, $params ) = @_;
 
-- 
2.47.0