Bug 25476: Add ability to browse file uploads by category
[koha.git] / t / db_dependent / Template / Plugin / Branches.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 Test::More tests => 3;
20 use Test::MockModule;
21
22 use C4::Context;
23 use C4::Biblio qw(AddBiblio);
24 use Koha::Database;
25
26 use Clone qw(clone);
27 use List::MoreUtils qw(any);
28
29 use t::lib::TestBuilder;
30 use t::lib::Mocks;
31
32 BEGIN {
33     use_ok('Koha::Template::Plugin::Branches');
34 }
35
36 my $schema  = Koha::Database->schema;
37 my $builder = t::lib::TestBuilder->new;
38
39 subtest 'all() tests' => sub {
40
41     plan tests => 18;
42
43     $schema->storage->txn_begin;
44
45     my $library = $builder->build({
46         source => 'Branch',
47         value => {
48             branchcode => 'MYLIBRARY',
49             branchname => 'My sweet library'
50         }
51     });
52     my $another_library = $builder->build({
53         source => 'Branch',
54         value => {
55             branchcode => 'ANOTHERLIB',
56         }
57     });
58
59     my $plugin = Koha::Template::Plugin::Branches->new();
60     ok($plugin, "initialized Branches plugin");
61
62     my $name = $plugin->GetName($library->{branchcode});
63     is($name, $library->{branchname}, 'retrieved expected name for library');
64
65     $name = $plugin->GetName('__ANY__');
66     is($name, '', 'received empty string as name of the "__ANY__" placeholder library code');
67
68     $name = $plugin->GetName(undef);
69     is($name, '', 'received empty string as name of NULL/undefined library code');
70
71     is($plugin->GetLoggedInBranchcode(), '', 'no active library code if there is no active user session');
72     is($plugin->GetLoggedInBranchname(), '', 'no active library name if there is no active user session');
73
74     t::lib::Mocks::mock_userenv({ branchcode => 'MYLIBRARY', branchname => 'My sweet library' });
75     is($plugin->GetLoggedInBranchcode(), 'MYLIBRARY', 'GetLoggedInBranchcode() returns active library code');
76     is($plugin->GetLoggedInBranchname(), 'My sweet library', 'GetLoggedInBranchname() returns active library name');
77
78     t::lib::Mocks::mock_preference( 'IndependentBranches', 0 );
79     my $libraries = $plugin->all();
80     ok( scalar(@$libraries) > 1, 'If IndependentBranches is not set, all libraries should be returned' );
81     is( grep ( { $_->{branchcode} eq 'MYLIBRARY'  and $_->{selected} == 1 } @$libraries ),       1, 'Without selected parameter, my library should be preselected' );
82     is( grep ( { $_->{branchcode} eq 'ANOTHERLIB' and not exists $_->{selected} } @$libraries ), 1, 'Without selected parameter, other library should not be preselected' );
83     $libraries = $plugin->all( { selected => 'ANOTHERLIB' } );
84     is( grep ( { $_->{branchcode} eq 'MYLIBRARY'  and not exists $_->{selected} } @$libraries ), 1, 'With selected parameter, my library should not be preselected' );
85     is( grep ( { $_->{branchcode} eq 'ANOTHERLIB' and $_->{selected} == 1 } @$libraries ),       1, 'With selected parameter, other library should be preselected' );
86     $libraries = $plugin->all( { selected => '' } );
87     is( grep ( { exists $_->{selected} } @$libraries ), 0, 'With selected parameter set to an empty string, no library should be preselected' );
88
89     my $total = @{$plugin->all};
90     my $pickupable = @{$plugin->all( { search_params => { pickup_location => 1 } }) };
91     my $yet_another_library = $builder->build({
92         source => 'Branch',
93         value => {
94             branchcode => 'CANTPICKUP',
95             pickup_location => 0,
96         }
97     });
98     is(@{$plugin->all( { search_params => { pickup_location => 1 } }) }, $pickupable,
99        'Adding a new library with pickups'
100        .' disabled does not increase the amount returned by ->pickup_locations');
101     is(@{$plugin->all}, $total+1, 'However, adding a new library increases'
102        .' the total amount gotten with ->all');
103
104     t::lib::Mocks::mock_preference( 'IndependentBranches', 1 );
105     $libraries = $plugin->all();
106     is( scalar(@$libraries), 1, 'If IndependentBranches is set, only 1 library should be returned' );
107     $libraries = $plugin->all( { unfiltered => 1 } );
108     ok( scalar(@$libraries) > 1, 'If IndependentBranches is set, all libraries should be returned if the unfiltered flag is set' );
109
110     $schema->storage->txn_rollback;
111 };
112
113 subtest 'pickup_locations() tests' => sub {
114
115     plan tests => 8;
116
117     $schema->storage->txn_begin;
118
119     Koha::Libraries->search->update({ pickup_location => 0 });
120
121     my $library_1 = $builder->build_object({ class => 'Koha::Libraries', value => { pickup_location => 1 } });
122     my $library_2 = $builder->build_object({ class => 'Koha::Libraries', value => { pickup_location => 1 } });
123     my $library_3 = $builder->build_object({ class => 'Koha::Libraries', value => { pickup_location => 1 } });
124
125     my $plugin           = Koha::Template::Plugin::Branches->new();
126     my $pickup_locations = $plugin->pickup_locations();
127
128     is( scalar @{$pickup_locations}, 3, 'Libraries count is correct' );
129
130     $pickup_locations = $plugin->pickup_locations({ search_params => { item => undef }});
131     is( scalar @{$pickup_locations}, 3, 'item parameter not a ref, fallback to general search' );
132
133     $pickup_locations = $plugin->pickup_locations({ search_params => { biblio => undef }});
134     is( scalar @{$pickup_locations}, 3, 'biblio parameter not a ref, fallback to general search' );
135
136     my $item_class = Test::MockModule->new('Koha::Item');
137     $item_class->mock(
138         'pickup_locations',
139         sub {
140             return Koha::Libraries->search(
141                 { branchcode => $library_1->branchcode } );
142         }
143     );
144
145     my $item   = $builder->build_sample_item();
146     my $patron = $builder->build_object({ class => 'Koha::Patrons' });
147
148     $pickup_locations = $plugin->pickup_locations(
149         { search_params => { item => $item, patron => Koha::Patron->new } } );
150
151     is( scalar @{$pickup_locations}, 1, 'Only the library returned by $item->pickup_locations is returned' );
152     is( $pickup_locations->[0]->{branchcode}, $library_1->branchcode, 'Not cheating' );
153
154     my $biblio_class = Test::MockModule->new('Koha::Biblio');
155     $biblio_class->mock(
156         'pickup_locations',
157         sub {
158             return Koha::Libraries->search(
159                 { branchcode => $library_2->branchcode } );
160         }
161     );
162
163     my $biblio = $builder->build_sample_biblio();
164
165     $pickup_locations = $plugin->pickup_locations(
166         { search_params => { biblio => $biblio, patron => Koha::Patron->new } } );
167
168     is( scalar @{$pickup_locations}, 1, 'Only the library returned by $biblio->pickup_locations is returned' );
169     is( $pickup_locations->[0]->{branchcode}, $library_2->branchcode, 'Not cheating' );
170
171     subtest 'selected tests' => sub {
172
173         plan tests => 4;
174
175         t::lib::Mocks::mock_userenv({ branchcode => $library_2->branchcode });
176
177         $pickup_locations = $plugin->pickup_locations();
178
179         is( scalar @{$pickup_locations}, 3, 'Libraries count is correct' );
180         foreach my $pickup_location (@{ $pickup_locations }) {
181             next unless exists $pickup_location->{selected} and $pickup_location->{selected} == 1;
182             is( $pickup_location->{branchcode}, $library_2->branchcode, 'The right library is marked as selected' );
183         }
184
185         $pickup_locations = $plugin->pickup_locations({ selected => $library_3->branchcode });
186
187         is( scalar @{$pickup_locations}, 3, 'Libraries count is correct' );
188         foreach my $pickup_location (@{ $pickup_locations }) {
189             next unless exists $pickup_location->{selected} and $pickup_location->{selected} == 1;
190             is( $pickup_location->{branchcode}, $library_3->branchcode, 'The right library is marked as selected' );
191         }
192     };
193
194     $schema->storage->txn_rollback;
195 };