A browser automation framework and ecosystem.
Selenium is an umbrella project encapsulating a variety of tools and libraries enabling web browser automation. Selenium specifically provides an infrastructure for the W3C WebDriver specification — a platform and language-neutral coding interface compatible with all major web browsers.
The project is made possible by volunteer contributors who've generously donated thousands of hours in code development and upkeep.
Selenium's source code is made available under the Apache 2.0 license.
Please read CONTRIBUTING.md before submitting your pull requests.
Bazel was built by the fine folks at Google. Bazel manages dependency downloads, generate the Selenium binaries, executes tests, and does it all rather quickly.
$PATH. You may have to update this from time to time.
To build the most commonly-used modules of Selenium from source, execute this command from the root project folder:
bazel build java/...
The order the modules are built is determined by the build system. If you want to build an individual module (assuming all dependent modules have previously been built), try the following:
In this case,
testis a target in that directory's
As you see build targets scroll past in the log, you may want to run them individually.
.bazelversionfile and transparently passes through all command-line arguments to the real Bazel binary.
jaron the PATH (make sure you use
javaexecutable from JDK but not JRE).
javac. This command won't exist if you only have the JRE installed. If you're met with a list of command-line options, you're referencing the JDK properly.
pythonon the PATH
pip install requests
pip install tox
BAZEL_VSenvironment variable should point to the location of the build tools, e.g.
C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools
BAZEL_VCenvironment variable should point to the location of the command line tools, e.g.
C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC
BAZEL_VC_FULL_VERSIONenvironment variable should contain the version of the installed command line tools, e.g.
If you plan to compile the IE driver, you also need:
The build will work on any platform, but the tests for IE will be skipped silently if you are not building on Windows.
To build the bulk of the Selenium binaries from source, run the following command from the root folder:
To build the grid deployment jar, run this command:
bazel build grid
To run tests within a particular area of the project, use the "test" command, followed by the folder or target. Tests are tagged with "small", "medium", or "large", and can be filtered with the
bazel test --test_size_filters=small,medium java/...
Bazel's "test" command will run all tests in the package, including integration tests. Expect the
test java/...to launch browsers and consume a considerable amount of time and resources.
bazel run debug-server
The tests in this directory are normal HTML files with names ending with
_test.html. Click on one to load the page and run the test.
Here is the public Selenium Maven repository.
bazelmakes a top-level group of directories with the
bazel-prefix on each directory.
More general, but basic, help for
gois just a wrapper around Rake, so you can use the standard commands such as
rake -Tto get more information about available targets.
If it is not clear already, Selenium is not built with Maven. It is built with
bazel, though that is invoked with
goas outlined above, so you do not have to learn too much about that.
That said, it is possible to relatively quickly build Selenium pieces for Maven to use. You are only really going to want to do this when you are testing the cutting-edge of Selenium development (which we welcome) against your application. Here is the quickest way to build and deploy into your local maven repository (
~/.m2/repository), while skipping Selenium's own tests.
The maven jars should now be in your local
Refer to the Building Web Driver wiki page for the last word on building the bits and pieces of Selenium.
edgedriver. These need to be on your
By default, Bazel runs these tests in your current X-server UI. If you prefer, you can alternatively run them in a virtual or nested X-server.
sh bazel test --test_env=DISPLAY=:99 //java/... --test_tag_filters=chrome
An easy way to run tests in a virtual X-server is to use Bazel's
bazel test --run_under="xvfb-run -a" //java/... --test_tag_filters=chrome
Bazelisk is a Mac-friendly launcher for Bazel. To install, follow these steps:
brew tap bazelbuild/tap && \ brew uninstall bazel; \ brew install bazelbuild/tap/bazelisk
If you're getting errors that mention Xcode, you'll need to install the command-line tools.
Bazel for Mac requires some additional steps to configure properly. First things first: use the Bazelisk project (courtesy of philwo), a pure golang implementation of Bazel. In order to install Bazelisk, first verify that your Xcode will cooperate: execute the following command:
If the value is
/Applications/Xcode.app/Contents/Developer/, you can proceed with bazelisk installation. If, however, the return value is
/Library/Developer/CommandLineTools/, you'll need to redirect the Xcode system to the correct value.
sudo xcode-select -s /Applications/Xcode.app/Contents/Developer/ sudo xcodebuild -license
The first command will prompt you for a password. The second step requires you to read a new Xcode license, and then accept it by typing "agree".
(Thanks to this thread for these steps)