Selenium::PhantomJS - Use GhostDriver without a Selenium server
my $driver = Selenium::PhantomJS->new;
# when you're done
This class allows you to use PhantomJS via Ghostdriver without needing the JRE
or a selenium server running. When you refrain from passing the
"remote_server_addr" and "port" arguments, we will search
for the phantomjs executable binary in your $PATH. We'll try to start the
binary connect to it, shutting it down at the end of the test.
If the binary is not found, we'll fall back to the default
Selenium::Remote::Driver behavior of assuming defaults of 127.0.0.1:4444 after
waiting a few seconds.
If you specify a remote server address, or a port, we'll assume you know what
you're doing and take no additional behavior.
If you're curious whether your Selenium::PhantomJS instance is using a separate
PhantomJS binary, or through the selenium server, you can check the
"binary_mode" attr after instantiation.
my $driver = Selenium::PhantomJS->new;
N.B. - if you're using Windows and you installed "phantomjs" via
"npm install -g phantomjs", there is a very high probability that we
will _not_ close down your phantomjs binary correctly after your test. You
will be able to tell if we leave around empty command windows that you didn't
start yourself. The easiest way to fix this is to download PhantomJS manually
from their website <http://phantomjs.org/download.html> and put it in
your "%PATH%". If this is a blocking issue for you, let us know in
Github <https://github.com/gempesaw/Selenium-Remote-Driver>; thanks!
Optional: specify the path to your binary. If you don't specify anything, we'll
try to find it on our own via "which" in File::Which.
Optional: specify the port that we should bind to. If you don't specify
anything, we'll default to the driver's default port. Since there's no a
priori guarantee that this will be an open port, this is _not_ necessarily the
port that we end up using - if the port here is already bound, we'll search
above it until we find an open one.
See "port" in Selenium::CanStartBinary for more details, and
"port" in Selenium::Remote::Driver after instantiation to see what
the actual port turned out to be.
Optional: specify any additional command line arguments you'd like invoked
during the binary startup. See "custom_args" in
Selenium::CanStartBinary for more information.
Optional: specify how long to wait for the binary to start itself and listen on
its port. The default duration is arbitrarily 10 seconds. It accepts an
integer number of seconds to wait: the following will wait up to 20 seconds:
Selenium::PhantomJS->new( startup_timeout => 20 );
See "startup_timeout" in Selenium::CanStartBinary for more
Call this method instead of "quit" in Selenium::Remote::Driver to
ensure that the binary executable is also closed, instead of simply closing
the browser itself. If the browser is still around, it will call
"quit" for you. After that, it will try to shutdown the browser
binary by making a GET to /shutdown and on Windows, it will attempt to do a
"taskkill" on the binary CMD window.
It doesn't take any arguments, and it doesn't return anything.
We do our best to call this when the $driver option goes out of scope, but if
that happens during global destruction, there's nothing we can do.
Please see those modules/websites for more information related to this module.
Please report any bugs or feature requests on the bugtracker website
When submitting a bug or request, please include a test-file or a patch to an
existing test-file that illustrates the bug or desired feature.
- Daniel Gempesaw <email@example.com>
- Emmanuel Peroumalnaïk <firstname.lastname@example.org>
- Luke Closs <email@example.com>
- Mark Stosberg <firstname.lastname@example.org>
- Aditya Ivaturi <email@example.com>
Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child
Copyright (c) 2014-2017 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
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