Skip to content

Latest commit

 

History

History
206 lines (147 loc) · 6.56 KB

README.md

File metadata and controls

206 lines (147 loc) · 6.56 KB

Selenium::Remote::Driver

Build Status

Selenium WebDriver is a test tool that allows you to write automated web application UI tests in any programming language against any HTTP website using any mainstream JavaScript-enabled browser. This module is a Perl implementation of the client for the Webdriver JSONWireProtocol that Selenium provides.

This module sends commands directly to the server using HTTP. Using this module together with the Selenium Server, you can automatically control any supported browser. To use this module, you need to have already downloaded and started the standalone Selenium Server.

Installation

It's probably easiest to use cpanm:

$ cpanm Selenium::Remote::Driver

If you want to install from this repository, you have a few options:

With Dist::Zilla

If you have Dist::Zilla, it's straightforward:

$ dzil listdeps --missing | cpanm
$ dzil install

Without Dist::Zilla

We maintain two branches that have Makefile.PL: cpan and build/master. The cpan branch is only updated every time we release to the CPAN, and it is not kept up to date with master. The build/master branch is an up-to-date copy of the latest changes in master, and will usually contain changes that have not made it to a CPAN release yet.

To get either of these, you can use the following, (replacing "build/master" with "cpan" if desired):

$ cpanm -v git://github.com/gempesaw/Selenium-Remote-Driver.git@build/master

Or, without cpanm and/or without the git:// protocol:

$ git clone https://github.com/gempesaw/Selenium-Remote-Driver --branch build/master --single-branch --depth 1
$ cd Selenium-Remote-Driver
$ perl Makefile.PL

Note that due to POD::Weaver, the line numbers between these generated branches and the master branch are unfortunately completely incompatible.

Viewing dependencies

You can also use cpanm to help you with dependencies after you've cloned the repository:

$ cpanm --showdeps .

Usage

You'll need a Remote WebDriver Server running somewhere. You can download a selenium-standalone-server.jar and run one locally, or you can point your driver somewhere like Saucelabs.

Locally

#! /usr/bin/perl

use strict;
use warnings;
use Selenium::Remote::Driver;

my $driver = Selenium::Remote::Driver->new;
$driver->get('http://www.google.com');
print $driver->get_title . "\n"; # "Google"

my $query = $driver->find_element('q', 'name');
$query->send_keys('CPAN Selenium Remote Driver');

my $send_search = $driver->find_element('btnG', 'name');
$send_search->click;

# make the find_element blocking for a second to allow the title to change
$driver->set_implicit_wait_timeout(2000);
my $results = $driver->find_element('search', 'id');

print $driver->get_title . "\n"; # CPAN Selenium Remote Driver - Google Search
$driver->quit;

Saucelabs

use Selenium::Remote::Driver;

my $user = $ENV{SAUCE_USERNAME};
my $key = $ENV{SAUCE_ACCESS_KEY};

my $driver = Selenium::Remote::Driver->new(
    remote_server_addr => $user . ':' . $key . '@ondemand.saucelabs.com',
    port => 80
);

$driver->get('http://www.google.com');
print $driver->get_title();
$driver->quit();

There are additional usage examples on metacpan, and also in this project's wiki, including setting up the standalone server, running tests on Internet Explorer, Chrome, PhantomJS, and other useful example snippets.

NB: Problems with Webdriver 2.42.x ?

It appears that the standalone webdriver API for no-content successful responses changed slightly in 2.42.x versions, breaking things like get_ok and set_window_size. Your options for fixes are:

  • Upgrade your version of S::R::D via your preferred method! We've released v0.2002 of S::R::D to CPAN, which contains the fixes to address this.
  • Or, stick with v2.41.0 of the Selenium standalone server or lower for your tests. v0.2001 of S::R::D still works with v2.41.0 of the standalone server.

Support and Documentation

There is a new mailing list available at

https://groups.google.com/forum/#!forum/selenium-remote-driver

for usage questions and ensuing discussions. If you've come across a bug, please open an issue in the Github issue tracker. The POD is available in the usual places, including metacpan, and in your shell via perldoc.

$ perldoc Selenium::Remote::Driver
$ perldoc Selenium::Remote::WebElement

Contributing

Thanks for considering contributing! The contributing guidelines are also in the wiki. The documentation there also includes information on generating new recordings via

$ perl t/bin/record.pl

Copyright and License

Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child

Copyright (c) 2014 Daniel Gempesaw

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.