1 package t::lib::Selenium;
3 # This file is part of Koha.
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.
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.
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>.
24 use base qw(Class::Accessor);
25 __PACKAGE__->mk_accessors(qw(login password base_url selenium_addr selenium_port driver));
28 my ( $class, $params ) = @_;
30 my $config = $class->config;
31 $self->{login} = $params->{login} || $config->{login};
32 $self->{password} = $params->{password} || $config->{password};
33 $self->{base_url} = $params->{base_url} || $config->{base_url};
34 $self->{selenium_addr} = $params->{selenium_addr} || $config->{selenium_addr};
35 $self->{selenium_port} = $params->{selenium_port} || $config->{selenium_port};
36 $self->{driver} = Selenium::Remote::Driver->new(
37 port => $self->{selenium_port},
38 remote_server_addr => $self->{selenium_addr},
39 error_handler => sub {
40 my $selenium_error = $_[1];
41 print STDERR "\nSTRACE:";
43 while ( (my @call_details = (caller($i++))) ){
44 print STDERR "\t" . $call_details[1]. ":" . $call_details[2] . " in " . $call_details[3]."\n";
47 croak $selenium_error; }
49 return bless $self, $class;
54 login => $ENV{KOHA_USER} || 'koha',
55 password => $ENV{KOHA_PASS} || 'koha',
56 base_url => ( $ENV{KOHA_INTRANET_URL} || C4::Context->preference("staffClientBaseURL") ) . "/cgi-bin/koha/",
57 selenium_addr => $ENV{SELENIUM_ADDR} || 'localhost',
58 selenium_port => $ENV{SELENIUM_PORT} || 4444,
63 my ( $self, $login, $password ) = @_;
65 $login ||= $self->login;
66 $password ||= $self->password;
67 my $mainpage = $self->base_url . 'mainpage.pl';
69 $self->driver->get($mainpage);
70 $self->fill_form( { userid => $login, password => $password } );
71 my $login_button = $self->driver->find_element('//input[@id="submit"]');
72 $login_button->submit();
76 my ( $self, $values ) = @_;
77 while ( my ( $id, $value ) = each %$values ) {
78 my $element = $self->driver->find_element('//*[@id="'.$id.'"]');
79 my $tag = $element->get_tag_name();
80 if ( $tag eq 'input' ) {
81 $self->driver->find_element('//input[@id="'.$id.'"]')->send_keys($value);
82 } elsif ( $tag eq 'select' ) {
83 $self->driver->find_element('//select[@id="'.$id.'"]/option[@value="'.$value.'"]')->click;
91 my $default_submit_selector = '//fieldset[@class="action"]/input[@type="submit"]';
92 $self->click_when_visible( $default_submit_selector );
96 my ( $self, $params ) = @_;
98 if ( exists $params->{main} ) {
99 $xpath_selector = '//div[@id="'.$params->{main}.'"]';
101 if ( exists $params->{href} ) {
102 if ( ref( $params->{href} ) ) {
103 for my $k ( keys %{ $params->{href} } ) {
104 if ( $k eq 'ends-with' ) {
105 # ends-with version for xpath version 1
106 my $ends_with = $params->{href}{"ends-with"};
107 $xpath_selector .= '//a[substring(@href, string-length(@href) - string-length("'.$ends_with.'") + 1 ) = "'.$ends_with.'"]';
108 # ends-with version for xpath version 2
109 #$xpath_selector .= '//a[ends-with(@href, "'.$ends_with.'") ]';
112 die "Only ends-with is supported so far ($k)";
116 $xpath_selector .= '//a[contains(@href, "'.$params->{href}.'")]';
119 if ( exists $params->{id} ) {
120 $xpath_selector .= '//*[@id="'.$params->{id}.'"]';
122 $self->click_when_visible( $xpath_selector );
125 sub click_when_visible {
126 my ( $self, $xpath_selector ) = @_;
127 $self->driver->set_implicit_wait_timeout(20000);
129 while ( not $visible ) {
130 $elt = $self->driver->find_element($xpath_selector);
131 $visible = $elt->is_displayed;
132 $self->driver->pause(1000) unless $visible;
139 t::lib::Selenium - Selenium helper module
143 my $s = t::lib::Selenium->new;
144 my $driver = $s->driver;
145 my $base_url = $s->base_url;
147 $driver->get($s->base_url . 'mainpage.pl');
148 $s->fill_form({ input_id => 'value' });
152 The goal of this module is to group the different actions we need
153 when we use automation test using Selenium
158 my $s = t::lib::Selenium->new;
160 Constructor - Returns the object Selenium
161 You can pass login, password, base_url, selenium_addr, selenium_port
162 If not passed, the environment variables will be used
163 KOHA_USER, KOHA_PASS, KOHA_INTRANET_URL, SELENIUM_ADDR SELENIUM_PORT
164 Or koha, koha, syspref staffClientBaseURL, localhost, 4444
170 Will login into Koha.
177 element_id => 'other_value',
180 Will fill the different elements of a form.
181 The keys must be element ids (input and select are supported so far)
182 The values must a string.
188 It will submit the form using the submit button present in in the fieldset with a clas="action".
189 It should be the default way. If it does not work you should certainly fix the Koha interface.
195 This is a bit dirty for now but will evolve depending on the needs
196 3 parameters possible but only the following 2 forms are used:
197 $s->click({ href => '/module/script.pl?foo=bar', main => 'doc3' }); # Sometimes we have doc or doc3. To make sure we are not going to hit a link in the header
198 $s->click({ id => 'element_id });
200 =head2 click_when_visible
202 $c->click_when_visible
204 Should always be called to avoid the "An element could not be located on the page" error
211 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
213 Alex Buckley <alexbuckley@catalyst.net.nz>
215 Koha Development Team
219 Copyright 2017 - Koha Development Team
223 This file is part of Koha.
225 Koha is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
226 the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
228 Koha is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
230 You should have received a copy of the GNU General Public License along with Koha; if not, see <http://www.gnu.org/licenses>.