8 use File::Temp qw( tempdir tempfile );
10 use Module::Load::Conditional qw(can_load);
12 use Test::More tests => 41;
19 push( @INC, dirname(__FILE__) . '/../lib' );
21 use_ok('Koha::Plugins');
22 use_ok('Koha::Plugins::Handler');
23 use_ok('Koha::Plugins::Base');
24 use_ok('Koha::Plugin::Test');
27 my $mock_plugin = Test::MockModule->new( 'Koha::Plugin::Test' );
28 $mock_plugin->mock( 'test_template', sub {
29 my ( $self, $file ) = @_;
30 my $template = $self->get_template({ file => $file });
31 $template->param( filename => $file );
32 return $template->output;
35 ok( can_load( modules => { "Koha::Plugin::Test" => undef } ), 'Test can_load' );
37 my $plugin = Koha::Plugin::Test->new({ enable_plugins => 1, cgi => CGI->new });
39 isa_ok( $plugin, "Koha::Plugin::Test", 'Test plugin class' );
40 isa_ok( $plugin, "Koha::Plugins::Base", 'Test plugin parent class' );
42 ok( $plugin->can('report'), 'Test plugin can report' );
43 ok( $plugin->can('tool'), 'Test plugin can tool' );
44 ok( $plugin->can('to_marc'), 'Test plugin can to_marc' );
45 ok( $plugin->can('intranet_catalog_biblio_enhancements'), 'Test plugin can intranet_catalog_biblio_enhancements');
46 ok( $plugin->can('intranet_catalog_biblio_enhancements_toolbar_button'), 'Test plugin can intranet_catalog_biblio_enhancements_toolbar_button' );
47 ok( $plugin->can('opac_online_payment'), 'Test plugin can opac_online_payment' );
48 ok( $plugin->can('opac_online_payment_begin'), 'Test plugin can opac_online_payment_begin' );
49 ok( $plugin->can('opac_online_payment_end'), 'Test plugin can opac_online_payment_end' );
50 ok( $plugin->can('opac_head'), 'Test plugin can opac_head' );
51 ok( $plugin->can('opac_js'), 'Test plugin can opac_js' );
52 ok( $plugin->can('intranet_head'), 'Test plugin can intranet_head' );
53 ok( $plugin->can('intranet_js'), 'Test plugin can intranet_js' );
54 ok( $plugin->can('configure'), 'Test plugin can configure' );
55 ok( $plugin->can('install'), 'Test plugin can install' );
56 ok( $plugin->can('upgrade'), 'Test plugin can upgrade' );
57 ok( $plugin->can('uninstall'), 'Test plugin can install' );
59 is( Koha::Plugins::Handler->run({ class => "Koha::Plugin::Test", method => 'report', enable_plugins => 1 }), "Koha::Plugin::Test::report", 'Test run plugin report method' );
61 my $metadata = $plugin->get_metadata();
62 is( $metadata->{'name'}, 'Test Plugin', 'Test $plugin->get_metadata()' );
64 is( $plugin->get_qualified_table_name('mytable'), 'koha_plugin_test_mytable', 'Test $plugin->get_qualified_table_name()' );
65 is( $plugin->get_plugin_http_path(), '/plugin/Koha/Plugin/Test', 'Test $plugin->get_plugin_http_path()' );
67 # test absolute path change in get_template with Koha::Plugin::Test
68 # using the mock set before
69 # we also add tmpdir as an approved template dir
70 t::lib::Mocks::mock_config( 'pluginsdir', [ C4::Context->temporary_directory ] );
71 my ( $fh, $fn ) = tempfile( SUFFIX => '.tt', UNLINK => 1, DIR => C4::Context->temporary_directory );
72 print $fh 'I am [% filename %]';
74 my $classname = ref($plugin);
75 like( $plugin->test_template($fn), qr/^I am $fn/, 'Template works' );
78 my @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({
81 my @names = map { $_->get_metadata()->{'name'} } @plugins;
82 is( scalar grep( /^Test Plugin$/, @names), 1, "Koha::Plugins::GetPlugins functions correctly" );
83 @plugins = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({
84 metadata => { my_example_tag => 'find_me' },
86 @names = map { $_->get_metadata()->{'name'} } @plugins;
87 is( scalar grep( /^Test Plugin$/, @names), 1, "GetPlugins also found Test Plugin via a metadata tag" );
88 # Test two metadata conditions; one does not exist for Test.pm
89 # Since it is a required key, we should not find the same results
90 my @plugins2 = Koha::Plugins->new({ enable_plugins => 1 })->GetPlugins({
91 metadata => { my_example_tag => 'find_me', not_there => '1' },
93 isnt( scalar @plugins2, scalar @plugins, 'GetPlugins with two metadata conditions' );
95 for my $pass ( 1 .. 2 ) {
97 my $module_name = 'Koha::Plugin::Com::ByWaterSolutions::KitchenSink';
98 my $pm_path = 'Koha/Plugin/Com/ByWaterSolutions/KitchenSink.pm';
100 my $plugins_dir1 = tempdir( CLEANUP => 1 );
101 t::lib::Mocks::mock_config('pluginsdir', $plugins_dir1);
102 $plugins_dir = $plugins_dir1;
103 push @INC, $plugins_dir1;
105 my $plugins_dir1 = tempdir( CLEANUP => 1 );
106 my $plugins_dir2 = tempdir( CLEANUP => 1 );
107 t::lib::Mocks::mock_config('pluginsdir', [ $plugins_dir2, $plugins_dir1 ]);
108 $plugins_dir = $plugins_dir2;
110 push @INC, $plugins_dir2;
111 push @INC, $plugins_dir1;
113 my $full_pm_path = $plugins_dir . '/' . $pm_path;
115 my $ae = Archive::Extract->new( archive => "$Bin/KitchenSinkPlugin.kpz", type => 'zip' );
116 unless ( $ae->extract( to => $plugins_dir ) ) {
117 warn "ERROR: " . $ae->error;
119 use_ok('Koha::Plugin::Com::ByWaterSolutions::KitchenSink');
120 $plugin = Koha::Plugin::Com::ByWaterSolutions::KitchenSink->new({ enable_plugins => 1});
121 my $table = $plugin->get_qualified_table_name( 'mytable' );
123 ok( -f $plugins_dir . "/Koha/Plugin/Com/ByWaterSolutions/KitchenSink.pm", "KitchenSink plugin installed successfully" );
124 $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"
125 Koha::Plugins::Handler->delete({ class => "Koha::Plugin::Com::ByWaterSolutions::KitchenSink", enable_plugins => 1 });
126 my $sth = C4::Context->dbh->table_info( undef, undef, $table, 'TABLE' );
127 my $info = $sth->fetchall_arrayref;
128 is( @$info, 0, "Table $table does no longer exist" );
129 ok( !( -f $full_pm_path ), "Koha::Plugins::Handler::delete works correctly." );
132 subtest 'output and output_html tests' => sub {
136 # Trick stdout to be able to test
139 open STDOUT, '>', \$stdout;
141 my $plugin = Koha::Plugin::Test->new({ enable_plugins => 1, cgi => CGI->new });
142 $plugin->test_output;
144 like($stdout, qr/Cache-control: no-cache/, 'force_no_caching sets Cache-control as desired');
145 like($stdout, qr{Content-Type: application/json; charset=UTF-8}, 'Correct content-type');
146 like($stdout, qr{¡Hola output!}, 'Correct data');
148 # reset the stdout buffer
151 open STDOUT, '>', \$stdout;
153 $plugin->test_output_html;
155 like($stdout, qr/Cache-control: no-cache/, 'force_no_caching sets Cache-control as desired');
156 like($stdout, qr{Content-Type: text/html; charset=UTF-8}, 'Correct content-type');
157 like($stdout, qr{¡Hola output_html!}, 'Correct data');
160 subtest 'Test _version_compare' => sub {
164 is( Koha::Plugins::Base::_version_compare( '1.1.1', '2.2.2' ), -1, "1.1.1 is less then 2.2.2" );
165 is( Koha::Plugins::Base::_version_compare( '2.2.2', '1.1.1' ), 1, "1.1.1 is greater then 2.2.2" );
166 is( Koha::Plugins::Base::_version_compare( '1.1.1', '1.1.1' ), 0, "1.1.1 is equal to 1.1.1" );
167 is( Koha::Plugins::Base::_version_compare( '1.01.001', '1.1.1' ), 0, "1.01.001 is equal to 1.1.1" );
168 is( Koha::Plugins::Base::_version_compare( '1', '1.0.0' ), 0, "1 is equal to 1.0.0" );
169 is( Koha::Plugins::Base::_version_compare( '1.0', '1.0.0' ), 0, "1.0 is equal to 1.0.0" );