t/db_dependent/selenium/patrons_search.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
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use Modern::Perl;
  19
  20 our @cleanup;
  21 END {
  22     unless ( @cleanup ) { say "WARNING: Cleanup failed!" }
  23     $_->delete for @cleanup;
  24 };
  25
  26 use C4::Context;
  27
  28 use utf8;
  29 use Test::More;
  30 use Test::MockModule;
  31
  32 use C4::Context;
  33 use Koha::AuthUtils;
  34 use Koha::Patrons;
  35 use t::lib::Mocks;
  36 use t::lib::Selenium;
  37 use t::lib::TestBuilder;
  38
  39 eval { require Selenium::Remote::Driver; };
  40 if ( $@ ) {
  41     plan skip_all => "Selenium::Remote::Driver is needed for selenium tests.";
  42 } else {
  43     plan tests => 1;
  44 }
  45
  46
  47 my $s             = t::lib::Selenium->new;
  48 my $driver        = $s->driver;
  49 my $opac_base_url = $s->opac_base_url;
  50 my $base_url      = $s->base_url;
  51 my $builder       = t::lib::TestBuilder->new;
  52 my $schema        = Koha::Database->schema;
  53
  54 subtest 'Search patrons' => sub {
  55     plan tests => 25;
  56
  57     if ( Koha::Patrons->search({surname => {-like => "test_patron_%"}})->count ) {
  58         BAIL_OUT("Cannot run this test, data we need to create already exist in the DB");
  59     }
  60     my @patrons;
  61     my $borrowernotes           = q|<strong>just 'a" note</strong> \123 ❤|;
  62     my $borrowernotes_displayed = q|just 'a" note \123 ❤|;
  63     my $branchname = q|<strong>just 'another" library</strong> \123 ❤|;
  64     my $firstname  = q|<strong>fir's"tname</strong> \123 ❤|;
  65     my $address    = q|<strong>add'res"s</strong> \123 ❤|;
  66     my $email      = q|a<strong>bad_email</strong>@example\123 ❤.com|;
  67     my $patron_category = $builder->build_object(
  68         {
  69             class => 'Koha::Patron::Categories',
  70             value => { category_type => 'A' }
  71         }
  72     );
  73     my $library = $builder->build_object(
  74         { class => 'Koha::Libraries', value => { branchname => $branchname } }
  75     );
  76     my $default_patron_search_fields = C4::Context->preference('DefaultPatronSearchFields');
  77     my $default_patron_per_page = C4::Context->preference('PatronsPerPage');
  78     for my $i ( 1 .. 25 ) {
  79         push @patrons,
  80           $builder->build_object(
  81             {
  82                 class => 'Koha::Patrons',
  83                 value => {
  84                     surname       => "test_patron_" . $i++,
  85                     firstname     => $firstname,
  86                     categorycode  => $patron_category->categorycode,
  87                     branchcode    => $library->branchcode,
  88                     borrowernotes => $borrowernotes,
  89                     address       => $address,
  90                     email         => $email,
  91                 }
  92             }
  93           );
  94     }
  95
  96     push @patrons, $builder->build_object(
  97         {
  98             class => 'Koha::Patrons',
  99             value => {
 100                 surname   => "test",
 101                 firstname => "not_p_a_t_r_o_n",    # won't match 'patron'
 102                 categorycode  => $patron_category->categorycode,
 103                 branchcode    => $library->branchcode,
 104                 borrowernotes => $borrowernotes,
 105                 address       => $address,
 106                 email         => $email,
 107             }
 108         }
 109     );
 110
 111     my $library_2 = $builder->build_object(
 112         { class => 'Koha::Libraries', value => { branchname => 'X' . $branchname } }
 113     );
 114     push @patrons,
 115       $builder->build_object(
 116         {
 117             class => 'Koha::Patrons',
 118             value => {
 119                 surname       => "test_patron_26",
 120                 firstname     => $firstname,
 121                 categorycode  => $patron_category->categorycode,
 122                 branchcode    => $library_2->branchcode,
 123                 borrowernotes => $borrowernotes,
 124                 address       => $address,
 125                 email         => $email,
 126             }
 127         }
 128       );
 129
 130     my $attribute_type = Koha::Patron::Attribute::Type->new(
 131         {
 132             code        => 'my code1',
 133             description => 'my description1',
 134         }
 135     )->store;
 136     my $attribute_type_searchable = Koha::Patron::Attribute::Type->new(
 137         {
 138             code             => 'my code2',
 139             description      => 'my description2',
 140             opac_display     => 1,
 141             staff_searchable => 1
 142         }
 143     )->store;
 144     $patrons[0]->extended_attributes([
 145         { code => $attribute_type->code, attribute => 'test_attr_1' },
 146         { code => $attribute_type_searchable->code, attribute => 'test_attr_2'},
 147     ]);
 148     $patrons[1]->extended_attributes([
 149         { code => $attribute_type->code, attribute => 'test_attr_1' },
 150         { code => $attribute_type_searchable->code, attribute => 'test_attr_2'},
 151     ]);
 152
 153     my $total_number_of_patrons = Koha::Patrons->search->count;
 154     my $table_id = "memberresultst";
 155
 156     $s->auth;
 157     C4::Context->set_preference('DefaultPatronSearchFields',"");
 158     my $PatronsPerPage = 15;
 159     my $nb_standard_fields = 13;
 160     C4::Context->set_preference('PatronsPerPage', $PatronsPerPage);
 161     $driver->get( $base_url . "/members/members-home.pl" );
 162     my @adv_options = $driver->find_elements('//select[@id="searchfieldstype"]/option');
 163     is( scalar @adv_options, $nb_standard_fields + 1, 'All standard fields are searchable if DefaultPatronSearchFields not set. middle_name is there.');
 164     is( $adv_options[0]->get_value(), 'firstname,middle_name,surname,othernames,cardnumber,userid', 'Standard search uses hard coded list when DefaultPatronSearchFields not set');
 165     my @filter_options = $driver->find_elements('//select[@id="searchfieldstype_filter"]/option');
 166     is( scalar @filter_options, $nb_standard_fields + 1, 'All standard fields + middle_name are searchable by filter if DefaultPatronSearchFields not set');
 167     is( $filter_options[0]->get_value(), 'firstname,middle_name,surname,othernames,cardnumber,userid', 'Standard filter uses hard coded list when DefaultPatronSearchFields not set');
 168     C4::Context->set_preference('DefaultPatronSearchFields',"firstname,initials");
 169     $driver->get( $base_url . "/members/members-home.pl" );
 170     @adv_options = $driver->find_elements('//select[@id="searchfieldstype"]/option');
 171     is( scalar @adv_options, $nb_standard_fields, 'New option added when DefaultPatronSearchFields is populated with a field. Note that middle_name disappears, we do not want it if not part of DefaultPatronSearchFields');
 172     is( $adv_options[0]->get_value(), 'firstname,initials', 'Standard search uses DefaultPatronSearchFields when populated');
 173     @filter_options = $driver->find_elements('//select[@id="searchfieldstype_filter"]/option');
 174     is( scalar @filter_options, $nb_standard_fields, 'New filter option added when DefaultPatronSearchFields is populated with a field');
 175     is( $filter_options[0]->get_value(), 'firstname,initials', 'Standard filter uses DefaultPatronSearchFields when populated');
 176     C4::Context->set_preference('DefaultPatronSearchFields',"firstname,initials,horses");
 177     $driver->get( $base_url . "/members/members-home.pl" );
 178     @adv_options = $driver->find_elements('//select[@id="searchfieldstype"]/option');
 179     @filter_options = $driver->find_elements('//select[@id="searchfieldstype_filter"]/option');
 180     is( scalar @adv_options, $nb_standard_fields, 'Invalid option not added when DefaultPatronSearchFields is populated with an invalid field');
 181     is( scalar @filter_options, $nb_standard_fields, 'Invalid filter option not added when DefaultPatronSearchFields is populated with an invalid field');
 182     # NOTE: We should probably ensure the bad field is removed from 'standard' search here, else searches are broken
 183     C4::Context->set_preference('DefaultPatronSearchFields',"");
 184     $driver->get( $base_url . "/members/members-home.pl" );
 185     $s->fill_form( { search_patron_filter => 'test_patron' } );
 186     $s->submit_form;
 187     my $first_patron = $patrons[0];
 188
 189     $s->wait_for_ajax;
 190     my @td = $driver->find_elements('//table[@id="'.$table_id.'"]/tbody/tr/td');
 191     like ($td[2]->get_text, qr[\Q$firstname\E],
 192         'Column "Name" should be the 3rd and contain the firstname correctly filtered'
 193     );
 194     like ($td[2]->get_text, qr[\Q$address\E],
 195         'Column "Name" should be the 3rd and contain the address correctly filtered'
 196     );
 197     like ($td[2]->get_text, qr[\Q$email\E],
 198         'Column "Name" should be the 3rd and contain the email address correctly filtered'
 199     );
 200     is( $td[4]->get_text, $branchname,
 201         'Column "Library" should be the 6th and contain the html tags - they have been html filtered'
 202     );
 203     is( $td[9]->get_text, $borrowernotes_displayed,
 204         'Column "Circ note" should be the 10th and not contain the html tags - they have not been html filtered'
 205     );
 206
 207     $driver->find_element(
 208             '//a[@href="/cgi-bin/koha/members/memberentry.pl?op=modify&destination=circ&borrowernumber='
 209           . $first_patron->borrowernumber
 210           . '"]' )->click;
 211     is(
 212         $driver->get_title,
 213         sprintf(
 214             "Modify patron %s %s %s (%s) %s (%s) (%s) › Patrons › Koha",
 215             $first_patron->title, $first_patron->firstname, $first_patron->middle_name, $first_patron->othernames, $first_patron->surname, $first_patron->cardnumber,
 216             $first_patron->category->description,
 217         ),
 218         'Page title is correct after following modification link'
 219     );
 220
 221     $driver->get( $base_url . "/members/members-home.pl" );
 222     $s->fill_form( { search_patron_filter => 'test_patron' } );
 223     $s->submit_form;
 224     $s->wait_for_ajax;
 225
 226     $s->driver->find_element('//*[@id="'.$table_id.'_filter"]//input')->send_keys('test_patron');
 227     $s->wait_for_ajax;
 228     is( $driver->find_element('//div[@id="'.$table_id.'_info"]')->get_text, sprintf('Showing 1 to %s of %s entries (filtered from %s total entries)', $PatronsPerPage, 26, $total_number_of_patrons), 'Searching in standard brings back correct results' );
 229
 230     $s->driver->find_element('//table[@id="'.$table_id.'"]//th[@data-filter="libraries"]/select/option[@value="'.$library->branchcode.'"]')->click;
 231     $s->wait_for_ajax;
 232     is( $driver->find_element('//div[@id="'.$table_id.'_info"]')->get_text, sprintf('Showing 1 to %s of %s entries (filtered from %s total entries)', $PatronsPerPage, 25, $total_number_of_patrons), 'Filtering on library works in combination with main search' );
 233
 234     # Reset the filters
 235     $driver->find_element('//form[@id="patron_search_form"]//*[@id="clear_search"]')->click();
 236     $s->submit_form;
 237     $s->wait_for_ajax;
 238
 239     # And make sure all the patrons are present
 240     is( $driver->find_element('//div[@id="'.$table_id.'_info"]')->get_text, sprintf('Showing 1 to %s of %s entries', $PatronsPerPage, $total_number_of_patrons), 'Resetting filters works as expected' );
 241
 242     # Pattern terms must be split
 243     $s->fill_form( { search_patron_filter => 'test patron' } );
 244     $s->submit_form;
 245
 246     $s->wait_for_ajax;
 247     is( $driver->find_element('//div[@id="'.$table_id.'_info"]')->get_text, sprintf('Showing 1 to %s of %s entries (filtered from %s total entries)', $PatronsPerPage, 26, $total_number_of_patrons) );
 248     $driver->find_element('//form[@id="patron_search_form"]//*[@id="clear_search"]')->click();
 249     $s->submit_form;
 250     $s->wait_for_ajax;
 251
 252     # Search on non-searchable attribute, we expect no result!
 253     $s->fill_form( { search_patron_filter => 'test_attr_1' } );
 254     $s->submit_form;
 255     $s->wait_for_ajax;
 256
 257     is( $driver->find_element('//div[@id="'.$table_id.'_info"]')->get_text, sprintf('No entries to show (filtered from %s total entries)', $total_number_of_patrons), 'Searching on a non-searchable attribute returns no results' );
 258
 259     # clear form
 260     $driver->find_element('//form[@id="patron_search_form"]//*[@id="clear_search"]')->click();
 261     # Search on searchable attribute, we expect 2 patrons
 262     $s->fill_form( { search_patron_filter => 'test_attr_2' } );
 263     $s->submit_form;
 264     $s->wait_for_ajax;
 265
 266     is( $driver->find_element('//div[@id="'.$table_id.'_info"]')->get_text, sprintf('Showing 1 to %s of %s entries (filtered from %s total entries)', 2, 2, $total_number_of_patrons), 'Searching on a searchable attribute returns correct results' );
 267
 268     # Refine search and search for test_patron in all the data using the DT global search
 269     # No change in result expected, still 2 patrons
 270     $s->driver->find_element('//*[@id="'.$table_id.'_filter"]//input')->send_keys('test_patron');
 271     $s->wait_for_ajax;
 272     is( $driver->find_element('//div[@id="'.$table_id.'_info"]')->get_text, sprintf('Showing 1 to %s of %s entries (filtered from %s total entries)', 2, 2, $total_number_of_patrons), 'Refining with DataTables search works to further filter the original query' );
 273
 274     # Adding the surname of the first patron in the "Name" column
 275     # We expect only 1 result
 276     $s->driver->find_element('//table[@id="'.$table_id.'"]//input[@placeholder="Name search"]')->send_keys($patrons[0]->surname);
 277     $s->wait_for_ajax;
 278     is( $driver->find_element('//div[@id="'.$table_id.'_info"]')->get_text, sprintf('Showing 1 to %s of %s entries (filtered from %s total entries)', 1, 1, $total_number_of_patrons), 'Refining with header filters works to further filter the original query' );
 279
 280     subtest 'remember_search' => sub {
 281
 282         plan tests => 7;
 283
 284         C4::Context->set_preference( 'PatronsPerPage', 5 );
 285         $driver->get( $base_url . "/members/members-home.pl" );
 286         $s->fill_form( { search_patron_filter => 'test_patron' } );
 287         $s->submit_form;
 288         $s->wait_for_ajax;
 289         my $patron_selected_text = $driver->find_element('//div[@id="patron_search_selected"]/span')->get_text;
 290         is( $patron_selected_text, "", "Patrons selected is not displayed" );
 291
 292         my @checkboxes = $driver->find_elements(
 293             '//input[@type="checkbox"][@name="borrowernumber"]');
 294         $checkboxes[2]->click;
 295         $patron_selected_text = $driver->find_element('//div[@id="patron_search_selected"]/span')->get_text;
 296         is( $patron_selected_text, "Patrons selected: 1", "One patron selected" );
 297
 298         $checkboxes[4]->click;
 299         $patron_selected_text = $driver->find_element('//div[@id="patron_search_selected"]/span')->get_text;
 300         is( $patron_selected_text, "Patrons selected: 2", "Two patrons are selected" );
 301
 302         $driver->find_element('//*[@id="memberresultst_next"]')->click;
 303         $s->wait_for_ajax;
 304         @checkboxes = $driver->find_elements(
 305             '//input[@type="checkbox"][@name="borrowernumber"]');
 306         $checkboxes[0]->click;
 307         $patron_selected_text = $driver->find_element('//div[@id="patron_search_selected"]/span')->get_text;
 308         is( $patron_selected_text, "Patrons selected: 3", "Tree patrons are selected" );
 309
 310
 311         # Perform another search
 312         $driver->get( $base_url . "/members/members-home.pl" );
 313         $s->fill_form( { search_patron_filter => 'test_patron' } );
 314         $s->submit_form;
 315         $s->wait_for_ajax;
 316         $patron_selected_text = $driver->find_element('//div[@id="patron_search_selected"]/span')->get_text;
 317         is( $patron_selected_text, "Patrons selected: 3", "Tree patrons still selected" );
 318
 319         $driver->find_element('//*[@id="patronlist-menu"]')->click;
 320         $driver->find_element('//a[@class="patron-list-add"]')->click;
 321         my $patron_list_name = "my new list";
 322         $driver->find_element('//input[@id="new_patron_list"]')->send_keys($patron_list_name);
 323         $driver->find_element('//button[@id="add_to_patron_list_submit"]')->click;
 324         $s->wait_for_ajax;
 325         is( $driver->find_element('//*[@id="patron_list_dialog"]')->get_text, "Added 3 patrons to $patron_list_name." );
 326         my $patron_list = $schema->resultset('PatronList')->search({ name => $patron_list_name })->next;
 327         is( $schema->resultset('PatronListPatron')->search({ patron_list_id => $patron_list->patron_list_id })->count, 3 );
 328
 329         $patron_list->delete;
 330     };
 331
 332     push @cleanup, $_ for @patrons;
 333     push @cleanup, $library;
 334     push @cleanup, $library_2;
 335     push @cleanup, $patron_category;
 336     push @cleanup, $attribute_type, $attribute_type_searchable;
 337     C4::Context->set_preference('DefaultPatronSearchFields',$default_patron_search_fields);
 338     C4::Context->set_preference('PatronsPerPage',$default_patron_per_page);
 339
 340     $driver->quit();
 341 };