3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 3 of the License, or (at your option) any later
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License along
15 # with Koha; if not, see <http://www.gnu.org/licenses>.
24 use File::Temp qw( tempdir tempfile );
26 use Module::Load::Conditional qw(can_load);
28 use Test::More tests => 51;
32 use Koha::Plugins::Methods;
37 # Mock pluginsdir before loading Plugins module
38 my $path = dirname(__FILE__) . '/../lib';
39 t::lib::Mocks::mock_config( 'pluginsdir', $path );
41 use_ok('Koha::Plugins');
42 use_ok('Koha::Plugins::Handler');
43 use_ok('Koha::Plugins::Base');
44 use_ok('Koha::Plugin::Test');
47 my $schema = Koha::Database->new->schema;
49 subtest 'GetPlugins() tests' => sub {
53 $schema->storage->txn_begin;
54 # Temporarily remove any installed plugins data
55 Koha::Plugins::Methods->delete;
57 my $plugins = Koha::Plugins->new({ enable_plugins => 1 });
58 $plugins->InstallPlugins;
60 my @plugins = $plugins->GetPlugins({ method => 'report', all => 1 });
62 my @names = map { $_->get_metadata()->{'name'} } @plugins;
63 is( scalar grep( /^Test Plugin$/, @names), 1, "Koha::Plugins::GetPlugins functions correctly" );
65 @plugins = $plugins->GetPlugins({ metadata => { my_example_tag => 'find_me' }, all => 1 });
66 @names = map { $_->get_metadata()->{'name'} } @plugins;
67 is( scalar @names, 2, "Only two plugins found via a metadata tag" );
69 $schema->storage->txn_rollback;
72 subtest 'Version upgrade tests' => sub {
76 $schema->storage->txn_begin;
78 my $plugin = Koha::Plugin::Test->new( { enable_plugins => 1, cgi => CGI->new } );
80 # make sure there's no version on the DB
81 $schema->resultset('PluginData')
82 ->search( { plugin_class => $plugin->{class}, plugin_key => '__INSTALLED_VERSION__' } )
85 $plugin = Koha::Plugin::Test->new( { enable_plugins => 1, cgi => CGI->new } );
86 my $version = $plugin->retrieve_data('__INSTALLED_VERSION__');
88 is( $version, $plugin->get_metadata->{version}, 'Version has been populated correctly' );
90 $schema->storage->txn_rollback;
93 subtest 'is_enabled() tests' => sub {
96 $schema->storage->txn_begin;
98 # Make sure there's no previous installs or leftovers on DB
99 Koha::Plugins::Methods->delete;
100 $schema->resultset('PluginData')->delete;
102 my $plugin = Koha::Plugin::Test->new({ enable_plugins => 1, cgi => CGI->new });
103 ok( $plugin->is_enabled, 'Plugins enabled by default' );
107 ok( !$plugin->is_enabled, 'Calling ->disable disables the plugin' );
111 ok( $plugin->is_enabled, 'Calling ->enable enabled the plugin' );
113 $schema->storage->txn_rollback;
116 $schema->storage->txn_begin;
117 Koha::Plugins::Methods->delete;
119 Koha::Plugins->new( { enable_plugins => 1 } )->InstallPlugins();
121 ok( Koha::Plugins::Methods->search( { plugin_class => 'Koha::Plugin::Test' } )->count, 'Test plugin methods added to database' );
122 is( Koha::Plugins::Methods->search({ plugin_class => 'Koha::Plugin::Test', plugin_method => '_private_sub' })->count, 0, 'Private methods are skipped' );
124 my $mock_plugin = Test::MockModule->new( 'Koha::Plugin::Test' );
125 $mock_plugin->mock( 'test_template', sub {
126 my ( $self, $file ) = @_;
127 my $template = $self->get_template({ file => $file });
128 $template->param( filename => $file );
129 return $template->output;
132 ok( can_load( modules => { "Koha::Plugin::Test" => undef } ), 'Test can_load' );
134 my $plugin = Koha::Plugin::Test->new({ enable_plugins => 1, cgi => CGI->new });
136 isa_ok( $plugin, "Koha::Plugin::Test", 'Test plugin class' );
137 isa_ok( $plugin, "Koha::Plugins::Base", 'Test plugin parent class' );
139 ok( $plugin->can('report'), 'Test plugin can report' );
140 ok( $plugin->can('tool'), 'Test plugin can tool' );
141 ok( $plugin->can('to_marc'), 'Test plugin can to_marc' );
142 ok( $plugin->can('intranet_catalog_biblio_enhancements'), 'Test plugin can intranet_catalog_biblio_enhancements');
143 ok( $plugin->can('intranet_catalog_biblio_enhancements_toolbar_button'), 'Test plugin can intranet_catalog_biblio_enhancements_toolbar_button' );
144 ok( $plugin->can('opac_online_payment'), 'Test plugin can opac_online_payment' );
145 ok( $plugin->can('opac_online_payment_begin'), 'Test plugin can opac_online_payment_begin' );
146 ok( $plugin->can('opac_online_payment_end'), 'Test plugin can opac_online_payment_end' );
147 ok( $plugin->can('opac_head'), 'Test plugin can opac_head' );
148 ok( $plugin->can('opac_js'), 'Test plugin can opac_js' );
149 ok( $plugin->can('intranet_head'), 'Test plugin can intranet_head' );
150 ok( $plugin->can('intranet_js'), 'Test plugin can intranet_js' );
151 ok( $plugin->can('configure'), 'Test plugin can configure' );
152 ok( $plugin->can('install'), 'Test plugin can install' );
153 ok( $plugin->can('upgrade'), 'Test plugin can upgrade' );
154 ok( $plugin->can('uninstall'), 'Test plugin can install' );
156 is( Koha::Plugins::Handler->run({ class => "Koha::Plugin::Test", method => 'report', enable_plugins => 1 }), "Koha::Plugin::Test::report", 'Test run plugin report method' );
158 my $metadata = $plugin->get_metadata();
159 is( $metadata->{'name'}, 'Test Plugin', 'Test $plugin->get_metadata()' );
161 is( $plugin->get_qualified_table_name('mytable'), 'koha_plugin_test_mytable', 'Test $plugin->get_qualified_table_name()' );
162 is( $plugin->get_plugin_http_path(), '/plugin/Koha/Plugin/Test', 'Test $plugin->get_plugin_http_path()' );
164 # test absolute path change in get_template with Koha::Plugin::Test
165 # using the mock set before
166 # we also add tmpdir as an approved template dir
167 t::lib::Mocks::mock_config( 'pluginsdir', [ C4::Context->temporary_directory ] );
168 my ( $fh, $fn ) = tempfile( SUFFIX => '.tt', UNLINK => 1, DIR => C4::Context->temporary_directory );
169 print $fh 'I am [% filename %]';
171 my $classname = ref($plugin);
172 like( $plugin->test_template($fn), qr/^I am $fn/, 'Template works' );
174 my $result = $plugin->enable;
175 is( ref($result), 'Koha::Plugin::Test' );
178 my @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({
182 my @names = map { $_->get_metadata()->{'name'} } @plugins;
183 is( scalar grep( /^Test Plugin$/, @names), 1, "Koha::Plugins::GetPlugins functions correctly" );
184 @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({
185 metadata => { my_example_tag => 'find_me' },
188 @names = map { $_->get_metadata()->{'name'} } @plugins;
189 is( scalar grep( /^Test Plugin$/, @names), 1, "GetPlugins also found Test Plugin via a metadata tag" );
191 $result = $plugin->disable;
192 is( ref($result), 'Koha::Plugin::Test' );
194 @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins();
195 @names = map { $_->get_metadata()->{'name'} } @plugins;
196 is( scalar grep( /^Test Plugin$/, @names), 0, "GetPlugins does not found disabled Test Plugin" );
198 @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({ all => 1 });
199 @names = map { $_->get_metadata()->{'name'} } @plugins;
200 is( scalar grep( /^Test Plugin$/, @names), 1, "With all param, GetPlugins found disabled Test Plugin" );
202 for my $pass ( 1 .. 2 ) {
204 my $module_name = 'Koha::Plugin::Com::ByWaterSolutions::KitchenSink';
205 my $pm_path = 'Koha/Plugin/Com/ByWaterSolutions/KitchenSink.pm';
207 my $plugins_dir1 = tempdir( CLEANUP => 1 );
208 t::lib::Mocks::mock_config('pluginsdir', $plugins_dir1);
209 $plugins_dir = $plugins_dir1;
210 push @INC, $plugins_dir1;
212 my $plugins_dir1 = tempdir( CLEANUP => 1 );
213 my $plugins_dir2 = tempdir( CLEANUP => 1 );
214 t::lib::Mocks::mock_config('pluginsdir', [ $plugins_dir2, $plugins_dir1 ]);
215 $plugins_dir = $plugins_dir2;
217 push @INC, $plugins_dir2;
218 push @INC, $plugins_dir1;
220 my $full_pm_path = $plugins_dir . '/' . $pm_path;
222 my $ae = Archive::Extract->new( archive => "$Bin/KitchenSinkPlugin.kpz", type => 'zip' );
223 unless ( $ae->extract( to => $plugins_dir ) ) {
224 warn "ERROR: " . $ae->error;
226 use_ok('Koha::Plugin::Com::ByWaterSolutions::KitchenSink');
227 $plugin = Koha::Plugin::Com::ByWaterSolutions::KitchenSink->new({ enable_plugins => 1});
228 my $table = $plugin->get_qualified_table_name( 'mytable' );
230 ok( -f $plugins_dir . "/Koha/Plugin/Com/ByWaterSolutions/KitchenSink.pm", "KitchenSink plugin installed successfully" );
231 $INC{$pm_path} = $full_pm_path; # FIXME I do not really know why, but if this is moved before the $plugin constructor, it will fail with Can't locate object method "new" via package "Koha::Plugin::Com::ByWaterSolutions::KitchenSink"
232 Koha::Plugins->new( { enable_plugins => 1 } )->InstallPlugins();
233 Koha::Plugins::Handler->delete({ class => "Koha::Plugin::Com::ByWaterSolutions::KitchenSink", enable_plugins => 1 });
234 my $sth = C4::Context->dbh->table_info( undef, undef, $table, 'TABLE' );
235 my $info = $sth->fetchall_arrayref;
236 is( @$info, 0, "Table $table does no longer exist" );
237 ok( !( -f $full_pm_path ), "Koha::Plugins::Handler::delete works correctly." );
240 subtest 'output and output_html tests' => sub {
244 # Trick stdout to be able to test
247 open STDOUT, '>', \$stdout;
249 my $plugin = Koha::Plugin::Test->new({ enable_plugins => 1, cgi => CGI->new });
250 $plugin->test_output;
252 like($stdout, qr/Cache-control: no-cache/, 'force_no_caching sets Cache-control as desired');
253 like($stdout, qr{Content-Type: application/json; charset=UTF-8}, 'Correct content-type');
254 like($stdout, qr{¡Hola output!}, 'Correct data');
256 # reset the stdout buffer
259 open STDOUT, '>', \$stdout;
261 $plugin->test_output_html;
263 like($stdout, qr/Cache-control: no-cache/, 'force_no_caching sets Cache-control as desired');
264 like($stdout, qr{Content-Type: text/html; charset=UTF-8}, 'Correct content-type');
265 like($stdout, qr{¡Hola output_html!}, 'Correct data');
268 subtest 'Test _version_compare' => sub {
272 t::lib::Mocks::mock_config( 'enable_plugins', 1 );
274 is( Koha::Plugins::Base::_version_compare( '1.1.1', '2.2.2' ), -1, "1.1.1 is less then 2.2.2" );
275 is( Koha::Plugins::Base::_version_compare( '2.2.2', '1.1.1' ), 1, "1.1.1 is greater then 2.2.2" );
276 is( Koha::Plugins::Base::_version_compare( '1.1.1', '1.1.1' ), 0, "1.1.1 is equal to 1.1.1" );
277 is( Koha::Plugins::Base::_version_compare( '1.01.001', '1.1.1' ), 0, "1.01.001 is equal to 1.1.1" );
278 is( Koha::Plugins::Base::_version_compare( '1', '1.0.0' ), 0, "1 is equal to 1.0.0" );
279 is( Koha::Plugins::Base::_version_compare( '1.0', '1.0.0' ), 0, "1.0 is equal to 1.0.0" );
282 my $plugin = Koha::Plugin::Test->new;
283 is( $plugin->_version_compare( '1.1.1', '2.2.2' ), -1, "1.1.1 is less then 2.2.2" );
284 is( $plugin->_version_compare( '2.2.2', '1.1.1' ), 1, "1.1.1 is greater then 2.2.2" );
285 is( $plugin->_version_compare( '1.1.1', '1.1.1' ), 0, "1.1.1 is equal to 1.1.1" );
286 is( $plugin->_version_compare( '1.01.001', '1.1.1' ), 0, "1.01.001 is equal to 1.1.1" );
287 is( $plugin->_version_compare( '1', '1.0.0' ), 0, "1 is equal to 1.0.0" );
288 is( $plugin->_version_compare( '1.0', '1.0.0' ), 0, "1.0 is equal to 1.0.0" );
291 subtest 'bundle_path() tests' => sub {
295 t::lib::Mocks::mock_config( 'enable_plugins', 1 );
297 my @current_dir = File::Spec->splitdir(abs_path(__FILE__));
300 # remove db_dependent
303 my $plugin = Koha::Plugin::Test->new;
305 is( $plugin->bundle_path, File::Spec->catdir(@current_dir) . '/lib/Koha/Plugin/Test' );
309 subtest 'new() tests' => sub {
313 t::lib::Mocks::mock_config( 'pluginsdir', [ C4::Context->temporary_directory ] );
314 t::lib::Mocks::mock_config( 'enable_plugins', 0 );
316 my $result = Koha::Plugins->new();
317 is( $result, undef, 'calling new() on disabled plugins returns undef' );
319 $result = Koha::Plugins->new({ enable_plugins => 1 });
320 is( ref($result), 'Koha::Plugins', 'calling new with enable_plugins makes it override the config' );
323 $schema->storage->txn_rollback;
324 Koha::Plugins::Methods->delete;