t/db_dependent/Koha/Plugins/Plugins.t

   1 #!/usr/bin/perl
   2
   3 # This file is part of Koha.
   4 #
   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
   8 # version.
   9 #
  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.
  13 #
  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>.
  16
  17 use Modern::Perl;
  18
  19 use Archive::Extract;
  20 use CGI;
  21 use Cwd qw(abs_path);
  22 use File::Basename;
  23 use File::Spec;
  24 use File::Temp qw( tempdir tempfile );
  25 use FindBin qw($Bin);
  26 use Module::Load::Conditional qw(can_load);
  27 use Test::MockModule;
  28 use Test::More tests => 52;
  29
  30 use C4::Context;
  31 use Koha::Database;
  32 use Koha::Plugins::Methods;
  33
  34 use t::lib::Mocks;
  35
  36 BEGIN {
  37     # Mock pluginsdir before loading Plugins module
  38     my $path = dirname(__FILE__) . '/../../../lib';
  39     t::lib::Mocks::mock_config( 'pluginsdir', $path );
  40
  41     use_ok('Koha::Plugins');
  42     use_ok('Koha::Plugins::Handler');
  43     use_ok('Koha::Plugins::Base');
  44     use_ok('Koha::Plugin::Test');
  45 }
  46
  47 my $schema = Koha::Database->new->schema;
  48
  49 subtest 'call() tests' => sub {
  50     plan tests => 2;
  51
  52     $schema->storage->txn_begin;
  53     # Temporarily remove any installed plugins data
  54     Koha::Plugins::Methods->delete;
  55
  56     my $plugins = Koha::Plugins->new({ enable_plugins => 1 });
  57     my @plugins = $plugins->InstallPlugins;
  58     foreach my $plugin (@plugins) {
  59         $plugin->enable();
  60     }
  61
  62     my @responses = Koha::Plugins->call('check_password', { password => 'foo' });
  63
  64     my $expected = [ { error => 1, msg => 'PIN should be four digits' } ];
  65     is_deeply(\@responses, $expected, 'call() should return all responses from plugins');
  66
  67     # Make sure parameters are correctly passed to the plugin method
  68     my @responses = Koha::Plugins->call('check_password', { password => '1234' });
  69
  70     my $expected = [ { error => 0 } ];
  71     is_deeply(\@responses, $expected, 'call() should return all responses from plugins');
  72
  73     $schema->storage->txn_rollback;
  74 };
  75
  76 subtest 'GetPlugins() tests' => sub {
  77
  78     plan tests => 2;
  79
  80     $schema->storage->txn_begin;
  81     # Temporarily remove any installed plugins data
  82     Koha::Plugins::Methods->delete;
  83
  84     my $plugins = Koha::Plugins->new({ enable_plugins => 1 });
  85     $plugins->InstallPlugins;
  86
  87     my @plugins = $plugins->GetPlugins({ method => 'report', all => 1 });
  88
  89     my @names = map { $_->get_metadata()->{'name'} } @plugins;
  90     is( scalar grep( /^Test Plugin$/, @names), 1, "Koha::Plugins::GetPlugins functions correctly" );
  91
  92     @plugins = $plugins->GetPlugins({ metadata => { my_example_tag  => 'find_me' }, all => 1 });
  93     @names = map { $_->get_metadata()->{'name'} } @plugins;
  94     is( scalar @names, 2, "Only two plugins found via a metadata tag" );
  95
  96     $schema->storage->txn_rollback;
  97 };
  98
  99 subtest 'Version upgrade tests' => sub {
 100
 101     plan tests => 1;
 102
 103     $schema->storage->txn_begin;
 104
 105     my $plugin = Koha::Plugin::Test->new( { enable_plugins => 1, cgi => CGI->new } );
 106
 107     # make sure there's no version on the DB
 108     $schema->resultset('PluginData')
 109         ->search( { plugin_class => $plugin->{class}, plugin_key => '__INSTALLED_VERSION__' } )
 110         ->delete;
 111
 112     $plugin = Koha::Plugin::Test->new( { enable_plugins => 1, cgi => CGI->new } );
 113     my $version = $plugin->retrieve_data('__INSTALLED_VERSION__');
 114
 115     is( $version, $plugin->get_metadata->{version}, 'Version has been populated correctly' );
 116
 117     $schema->storage->txn_rollback;
 118 };
 119
 120 subtest 'is_enabled() tests' => sub {
 121
 122     plan tests => 3;
 123     $schema->storage->txn_begin;
 124
 125     # Make sure there's no previous installs or leftovers on DB
 126     Koha::Plugins::Methods->delete;
 127     $schema->resultset('PluginData')->delete;
 128
 129     my $plugin = Koha::Plugin::Test->new({ enable_plugins => 1, cgi => CGI->new });
 130     ok( $plugin->is_enabled, 'Plugins enabled by default' );
 131
 132     # disable
 133     $plugin->disable;
 134     ok( !$plugin->is_enabled, 'Calling ->disable disables the plugin' );
 135
 136     # enable
 137     $plugin->enable;
 138     ok( $plugin->is_enabled, 'Calling ->enable enabled the plugin' );
 139
 140     $schema->storage->txn_rollback;
 141 };
 142
 143 $schema->storage->txn_begin;
 144 Koha::Plugins::Methods->delete;
 145
 146 Koha::Plugins->new( { enable_plugins => 1 } )->InstallPlugins();
 147
 148 ok( Koha::Plugins::Methods->search( { plugin_class => 'Koha::Plugin::Test' } )->count, 'Test plugin methods added to database' );
 149 is( Koha::Plugins::Methods->search({ plugin_class => 'Koha::Plugin::Test', plugin_method => '_private_sub' })->count, 0, 'Private methods are skipped' );
 150
 151 my $mock_plugin = Test::MockModule->new( 'Koha::Plugin::Test' );
 152 $mock_plugin->mock( 'test_template', sub {
 153     my ( $self, $file ) = @_;
 154     my $template = $self->get_template({ file => $file });
 155     $template->param( filename => $file );
 156     return $template->output;
 157 });
 158
 159 ok( can_load( modules => { "Koha::Plugin::Test" => undef } ), 'Test can_load' );
 160
 161 my $plugin = Koha::Plugin::Test->new({ enable_plugins => 1, cgi => CGI->new });
 162
 163 isa_ok( $plugin, "Koha::Plugin::Test", 'Test plugin class' );
 164 isa_ok( $plugin, "Koha::Plugins::Base", 'Test plugin parent class' );
 165
 166 ok( $plugin->can('report'), 'Test plugin can report' );
 167 ok( $plugin->can('tool'), 'Test plugin can tool' );
 168 ok( $plugin->can('to_marc'), 'Test plugin can to_marc' );
 169 ok( $plugin->can('intranet_catalog_biblio_enhancements'), 'Test plugin can intranet_catalog_biblio_enhancements');
 170 ok( $plugin->can('intranet_catalog_biblio_enhancements_toolbar_button'), 'Test plugin can intranet_catalog_biblio_enhancements_toolbar_button' );
 171 ok( $plugin->can('opac_online_payment'), 'Test plugin can opac_online_payment' );
 172 ok( $plugin->can('opac_online_payment_begin'), 'Test plugin can opac_online_payment_begin' );
 173 ok( $plugin->can('opac_online_payment_end'), 'Test plugin can opac_online_payment_end' );
 174 ok( $plugin->can('opac_head'), 'Test plugin can opac_head' );
 175 ok( $plugin->can('opac_js'), 'Test plugin can opac_js' );
 176 ok( $plugin->can('intranet_head'), 'Test plugin can intranet_head' );
 177 ok( $plugin->can('intranet_js'), 'Test plugin can intranet_js' );
 178 ok( $plugin->can('configure'), 'Test plugin can configure' );
 179 ok( $plugin->can('install'), 'Test plugin can install' );
 180 ok( $plugin->can('upgrade'), 'Test plugin can upgrade' );
 181 ok( $plugin->can('uninstall'), 'Test plugin can install' );
 182
 183 is( Koha::Plugins::Handler->run({ class => "Koha::Plugin::Test", method => 'report', enable_plugins => 1 }), "Koha::Plugin::Test::report", 'Test run plugin report method' );
 184
 185 my $metadata = $plugin->get_metadata();
 186 is( $metadata->{'name'}, 'Test Plugin', 'Test $plugin->get_metadata()' );
 187
 188 is( $plugin->get_qualified_table_name('mytable'), 'koha_plugin_test_mytable', 'Test $plugin->get_qualified_table_name()' );
 189 is( $plugin->get_plugin_http_path(), '/plugin/Koha/Plugin/Test', 'Test $plugin->get_plugin_http_path()' );
 190
 191 # test absolute path change in get_template with Koha::Plugin::Test
 192 # using the mock set before
 193 # we also add tmpdir as an approved template dir
 194 t::lib::Mocks::mock_config( 'pluginsdir', [ C4::Context->temporary_directory ] );
 195 my ( $fh, $fn ) = tempfile( SUFFIX => '.tt', UNLINK => 1, DIR => C4::Context->temporary_directory );
 196 print $fh 'I am [% filename %]';
 197 close $fh;
 198 my $classname = ref($plugin);
 199 like( $plugin->test_template($fn), qr/^I am $fn/, 'Template works' );
 200
 201 my $result = $plugin->enable;
 202 is( ref($result), 'Koha::Plugin::Test' );
 203
 204 # testing GetPlugins
 205 my @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({
 206     method => 'report'
 207 });
 208
 209 my @names = map { $_->get_metadata()->{'name'} } @plugins;
 210 is( scalar grep( /^Test Plugin$/, @names), 1, "Koha::Plugins::GetPlugins functions correctly" );
 211 @plugins =  Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({
 212     metadata => { my_example_tag  => 'find_me' },
 213 });
 214
 215 @names = map { $_->get_metadata()->{'name'} } @plugins;
 216 is( scalar grep( /^Test Plugin$/, @names), 1, "GetPlugins also found Test Plugin via a metadata tag" );
 217
 218 $result = $plugin->disable;
 219 is( ref($result), 'Koha::Plugin::Test' );
 220
 221 @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins();
 222 @names = map { $_->get_metadata()->{'name'} } @plugins;
 223 is( scalar grep( /^Test Plugin$/, @names), 0, "GetPlugins does not found disabled Test Plugin" );
 224
 225 @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({ all => 1 });
 226 @names = map { $_->get_metadata()->{'name'} } @plugins;
 227 is( scalar grep( /^Test Plugin$/, @names), 1, "With all param, GetPlugins found disabled Test Plugin" );
 228
 229 for my $pass ( 1 .. 2 ) {
 230     my $plugins_dir;
 231     my $module_name = 'Koha::Plugin::Com::ByWaterSolutions::KitchenSink';
 232     my $pm_path = 'Koha/Plugin/Com/ByWaterSolutions/KitchenSink.pm';
 233     if ( $pass == 1 ) {
 234         my $plugins_dir1 = tempdir( CLEANUP => 1 );
 235         t::lib::Mocks::mock_config('pluginsdir', $plugins_dir1);
 236         $plugins_dir = $plugins_dir1;
 237         push @INC, $plugins_dir1;
 238     } else {
 239         my $plugins_dir1 = tempdir( CLEANUP => 1 );
 240         my $plugins_dir2 = tempdir( CLEANUP => 1 );
 241         t::lib::Mocks::mock_config('pluginsdir', [ $plugins_dir2, $plugins_dir1 ]);
 242         $plugins_dir = $plugins_dir2;
 243         pop @INC;
 244         push @INC, $plugins_dir2;
 245         push @INC, $plugins_dir1;
 246     }
 247     my $full_pm_path = $plugins_dir . '/' . $pm_path;
 248
 249     my $ae = Archive::Extract->new( archive => "$Bin/KitchenSinkPlugin.kpz", type => 'zip' );
 250     unless ( $ae->extract( to => $plugins_dir ) ) {
 251         warn "ERROR: " . $ae->error;
 252     }
 253     use_ok('Koha::Plugin::Com::ByWaterSolutions::KitchenSink');
 254     $plugin = Koha::Plugin::Com::ByWaterSolutions::KitchenSink->new({ enable_plugins => 1});
 255     my $table = $plugin->get_qualified_table_name( 'mytable' );
 256
 257     ok( -f $plugins_dir . "/Koha/Plugin/Com/ByWaterSolutions/KitchenSink.pm", "KitchenSink plugin installed successfully" );
 258     $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"
 259     Koha::Plugins->new( { enable_plugins => 1 } )->InstallPlugins();
 260     Koha::Plugins::Handler->delete({ class => "Koha::Plugin::Com::ByWaterSolutions::KitchenSink", enable_plugins => 1 });
 261     my $sth = C4::Context->dbh->table_info( undef, undef, $table, 'TABLE' );
 262     my $info = $sth->fetchall_arrayref;
 263     is( @$info, 0, "Table $table does no longer exist" );
 264     ok( !( -f $full_pm_path ), "Koha::Plugins::Handler::delete works correctly." );
 265 }
 266
 267 subtest 'output and output_html tests' => sub {
 268
 269     plan tests => 6;
 270
 271     # Trick stdout to be able to test
 272     local *STDOUT;
 273     my $stdout;
 274     open STDOUT, '>', \$stdout;
 275
 276     my $plugin = Koha::Plugin::Test->new({ enable_plugins => 1, cgi => CGI->new });
 277     $plugin->test_output;
 278
 279     like($stdout, qr/Cache-control: no-cache/, 'force_no_caching sets Cache-control as desired');
 280     like($stdout, qr{Content-Type: application/json; charset=UTF-8}, 'Correct content-type');
 281     like($stdout, qr{¡Hola output!}, 'Correct data');
 282
 283     # reset the stdout buffer
 284     $stdout = '';
 285     close STDOUT;
 286     open STDOUT, '>', \$stdout;
 287
 288     $plugin->test_output_html;
 289
 290     like($stdout, qr/Cache-control: no-cache/, 'force_no_caching sets Cache-control as desired');
 291     like($stdout, qr{Content-Type: text/html; charset=UTF-8}, 'Correct content-type');
 292     like($stdout, qr{¡Hola output_html!}, 'Correct data');
 293 };
 294
 295 subtest 'Test _version_compare' => sub {
 296
 297     plan tests => 12;
 298
 299     t::lib::Mocks::mock_config( 'enable_plugins', 1 );
 300
 301     is( Koha::Plugins::Base::_version_compare( '1.1.1',    '2.2.2' ), -1, "1.1.1 is less then 2.2.2" );
 302     is( Koha::Plugins::Base::_version_compare( '2.2.2',    '1.1.1' ),  1, "1.1.1 is greater then 2.2.2" );
 303     is( Koha::Plugins::Base::_version_compare( '1.1.1',    '1.1.1' ),  0, "1.1.1 is equal to 1.1.1" );
 304     is( Koha::Plugins::Base::_version_compare( '1.01.001', '1.1.1' ),  0, "1.01.001 is equal to 1.1.1" );
 305     is( Koha::Plugins::Base::_version_compare( '1',        '1.0.0' ),  0, "1 is equal to 1.0.0" );
 306     is( Koha::Plugins::Base::_version_compare( '1.0',      '1.0.0' ),  0, "1.0 is equal to 1.0.0" );
 307
 308     # OO tests
 309     my $plugin = Koha::Plugin::Test->new;
 310     is( $plugin->_version_compare( '1.1.1',    '2.2.2' ), -1, "1.1.1 is less then 2.2.2" );
 311     is( $plugin->_version_compare( '2.2.2',    '1.1.1' ),  1, "1.1.1 is greater then 2.2.2" );
 312     is( $plugin->_version_compare( '1.1.1',    '1.1.1' ),  0, "1.1.1 is equal to 1.1.1" );
 313     is( $plugin->_version_compare( '1.01.001', '1.1.1' ),  0, "1.01.001 is equal to 1.1.1" );
 314     is( $plugin->_version_compare( '1',        '1.0.0' ),  0, "1 is equal to 1.0.0" );
 315     is( $plugin->_version_compare( '1.0',      '1.0.0' ),  0, "1.0 is equal to 1.0.0" );
 316 };
 317
 318 subtest 'bundle_path() tests' => sub {
 319
 320     plan tests => 1;
 321
 322     t::lib::Mocks::mock_config( 'enable_plugins', 1 );
 323
 324     my @current_dir = File::Spec->splitdir(abs_path(__FILE__));
 325     # remote Plugins.t
 326     pop @current_dir;
 327     # remove /Plugins
 328     pop @current_dir;
 329     # remove /Koha
 330     pop @current_dir;
 331     # remove db_dependent
 332     pop @current_dir;
 333
 334     my $plugin = Koha::Plugin::Test->new;
 335
 336     is( $plugin->bundle_path, File::Spec->catdir(@current_dir) . '/lib/Koha/Plugin/Test' );
 337
 338 };
 339
 340 subtest 'new() tests' => sub {
 341
 342     plan tests => 2;
 343
 344     t::lib::Mocks::mock_config( 'pluginsdir', [ C4::Context->temporary_directory ] );
 345     t::lib::Mocks::mock_config( 'enable_plugins', 0 );
 346
 347     my $result = Koha::Plugins->new();
 348     is( $result, undef, 'calling new() on disabled plugins returns undef' );
 349
 350     $result = Koha::Plugins->new({ enable_plugins => 1 });
 351     is( ref($result), 'Koha::Plugins', 'calling new with enable_plugins makes it override the config' );
 352 };
 353
 354 $schema->storage->txn_rollback;
 355 Koha::Plugins::Methods->delete;