Jonathan Druart
fec6a3c83a
Element id=doc does not longer exist on the admin home page The "main block" need to be localized using the new class 'main container-fluid' We will certainly need to improve this later. Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
236 lines
7.5 KiB
Perl
236 lines
7.5 KiB
Perl
package t::lib::Selenium;
|
|
|
|
# This file is part of Koha.
|
|
#
|
|
# Koha is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# 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.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
|
|
use Modern::Perl;
|
|
use Carp qw( croak );
|
|
|
|
use C4::Context;
|
|
|
|
use base qw(Class::Accessor);
|
|
__PACKAGE__->mk_accessors(qw(login password base_url selenium_addr selenium_port driver));
|
|
|
|
sub new {
|
|
my ( $class, $params ) = @_;
|
|
my $self = {};
|
|
my $config = $class->config;
|
|
$self->{login} = $params->{login} || $config->{login};
|
|
$self->{password} = $params->{password} || $config->{password};
|
|
$self->{base_url} = $params->{base_url} || $config->{base_url};
|
|
$self->{selenium_addr} = $params->{selenium_addr} || $config->{selenium_addr};
|
|
$self->{selenium_port} = $params->{selenium_port} || $config->{selenium_port};
|
|
$self->{driver} = Selenium::Remote::Driver->new(
|
|
port => $self->{selenium_port},
|
|
remote_server_addr => $self->{selenium_addr},
|
|
error_handler => sub {
|
|
my $selenium_error = $_[1];
|
|
print STDERR "\nSTRACE:";
|
|
my $i = 1;
|
|
while ( (my @call_details = (caller($i++))) ){
|
|
print STDERR "\t" . $call_details[1]. ":" . $call_details[2] . " in " . $call_details[3]."\n";
|
|
}
|
|
print STDERR "\n";
|
|
croak $selenium_error; }
|
|
);
|
|
return bless $self, $class;
|
|
}
|
|
|
|
sub config {
|
|
return {
|
|
login => $ENV{KOHA_USER} || 'koha',
|
|
password => $ENV{KOHA_PASS} || 'koha',
|
|
base_url => ( $ENV{KOHA_INTRANET_URL} || C4::Context->preference("staffClientBaseURL") ) . "/cgi-bin/koha/",
|
|
selenium_addr => $ENV{SELENIUM_ADDR} || 'localhost',
|
|
selenium_port => $ENV{SELENIUM_PORT} || 4444,
|
|
};
|
|
}
|
|
|
|
sub auth {
|
|
my ( $self, $login, $password ) = @_;
|
|
|
|
$login ||= $self->login;
|
|
$password ||= $self->password;
|
|
my $mainpage = $self->base_url . 'mainpage.pl';
|
|
|
|
$self->driver->get($mainpage);
|
|
$self->fill_form( { userid => $login, password => $password } );
|
|
my $login_button = $self->driver->find_element('//input[@id="submit"]');
|
|
$login_button->submit();
|
|
}
|
|
|
|
sub fill_form {
|
|
my ( $self, $values ) = @_;
|
|
while ( my ( $id, $value ) = each %$values ) {
|
|
my $element = $self->driver->find_element('//*[@id="'.$id.'"]');
|
|
my $tag = $element->get_tag_name();
|
|
if ( $tag eq 'input' ) {
|
|
$self->driver->find_element('//input[@id="'.$id.'"]')->send_keys($value);
|
|
} elsif ( $tag eq 'select' ) {
|
|
$self->driver->find_element('//select[@id="'.$id.'"]/option[@value="'.$value.'"]')->click;
|
|
}
|
|
}
|
|
}
|
|
|
|
sub submit_form {
|
|
my ( $self ) = @_;
|
|
|
|
my $default_submit_selector = '//fieldset[@class="action"]/input[@type="submit"]';
|
|
$self->click_when_visible( $default_submit_selector );
|
|
}
|
|
|
|
sub click {
|
|
my ( $self, $params ) = @_;
|
|
my $xpath_selector;
|
|
if ( exists $params->{main} ) {
|
|
$xpath_selector = '//div[@id="'.$params->{main}.'"]';
|
|
} elsif ( exists $params->{main_class} ) {
|
|
$xpath_selector = '//div[@class="'.$params->{main_class}.'"]';
|
|
}
|
|
if ( exists $params->{href} ) {
|
|
if ( ref( $params->{href} ) ) {
|
|
for my $k ( keys %{ $params->{href} } ) {
|
|
if ( $k eq 'ends-with' ) {
|
|
# ends-with version for xpath version 1
|
|
my $ends_with = $params->{href}{"ends-with"};
|
|
$xpath_selector .= '//a[substring(@href, string-length(@href) - string-length("'.$ends_with.'") + 1 ) = "'.$ends_with.'"]';
|
|
# ends-with version for xpath version 2
|
|
#$xpath_selector .= '//a[ends-with(@href, "'.$ends_with.'") ]';
|
|
|
|
} else {
|
|
die "Only ends-with is supported so far ($k)";
|
|
}
|
|
}
|
|
} else {
|
|
$xpath_selector .= '//a[contains(@href, "'.$params->{href}.'")]';
|
|
}
|
|
}
|
|
if ( exists $params->{id} ) {
|
|
$xpath_selector .= '//*[@id="'.$params->{id}.'"]';
|
|
}
|
|
$self->click_when_visible( $xpath_selector );
|
|
}
|
|
|
|
sub click_when_visible {
|
|
my ( $self, $xpath_selector ) = @_;
|
|
$self->driver->set_implicit_wait_timeout(20000);
|
|
my ($visible, $elt);
|
|
while ( not $visible ) {
|
|
$elt = $self->driver->find_element($xpath_selector);
|
|
$visible = $elt->is_displayed;
|
|
$self->driver->pause(1000) unless $visible;
|
|
}
|
|
$elt->click;
|
|
}
|
|
|
|
=head1 NAME
|
|
|
|
t::lib::Selenium - Selenium helper module
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
my $s = t::lib::Selenium->new;
|
|
my $driver = $s->driver;
|
|
my $base_url = $s->base_url;
|
|
$s->auth;
|
|
$driver->get($s->base_url . 'mainpage.pl');
|
|
$s->fill_form({ input_id => 'value' });
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The goal of this module is to group the different actions we need
|
|
when we use automation test using Selenium
|
|
=head1 METHODS
|
|
|
|
=head2 new
|
|
|
|
my $s = t::lib::Selenium->new;
|
|
|
|
Constructor - Returns the object Selenium
|
|
You can pass login, password, base_url, selenium_addr, selenium_port
|
|
If not passed, the environment variables will be used
|
|
KOHA_USER, KOHA_PASS, KOHA_INTRANET_URL, SELENIUM_ADDR SELENIUM_PORT
|
|
Or koha, koha, syspref staffClientBaseURL, localhost, 4444
|
|
|
|
=head2 auth
|
|
|
|
$s->auth;
|
|
|
|
Will login into Koha.
|
|
|
|
=head2 fill_form
|
|
|
|
$driver->get($url)
|
|
$s->fill_form({
|
|
input_id => 'value',
|
|
element_id => 'other_value',
|
|
});
|
|
|
|
Will fill the different elements of a form.
|
|
The keys must be element ids (input and select are supported so far)
|
|
The values must a string.
|
|
|
|
=head2 submit_form
|
|
|
|
$s->submit_form;
|
|
|
|
It will submit the form using the submit button present in in the fieldset with a clas="action".
|
|
It should be the default way. If it does not work you should certainly fix the Koha interface.
|
|
|
|
=head2 click
|
|
|
|
$s->click
|
|
|
|
This is a bit dirty for now but will evolve depending on the needs
|
|
3 parameters possible but only the following 2 forms are used:
|
|
$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
|
|
$s->click({ id => 'element_id });
|
|
|
|
=head2 click_when_visible
|
|
|
|
$c->click_when_visible
|
|
|
|
Should always be called to avoid the "An element could not be located on the page" error
|
|
|
|
=head2
|
|
|
|
|
|
=head1 AUTHORS
|
|
|
|
Jonathan Druart <jonathan.druart@bugs.koha-community.org>
|
|
|
|
Alex Buckley <alexbuckley@catalyst.net.nz>
|
|
|
|
Koha Development Team
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2017 - Koha Development Team
|
|
|
|
=head1 LICENSE
|
|
|
|
This file is part of Koha.
|
|
|
|
Koha is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
|
|
|
|
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.
|
|
|
|
You should have received a copy of the GNU General Public License along with Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
=cut
|
|
|
|
1;
|