Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zalando/zalenium
A flexible and scalable container based Selenium Grid with video recording, live preview, basic auth & dashboard.
https://github.com/zalando/zalenium
browserstack docker docker-selenium kubernetes saucelabs selenium selenium-grid testing testingbot
Last synced: about 1 month ago
JSON representation
A flexible and scalable container based Selenium Grid with video recording, live preview, basic auth & dashboard.
- Host: GitHub
- URL: https://github.com/zalando/zalenium
- Owner: zalando
- License: other
- Archived: true
- Created: 2016-10-04T11:23:35.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-09-11T10:00:37.000Z (about 3 years ago)
- Last Synced: 2024-04-16T14:08:23.045Z (7 months ago)
- Topics: browserstack, docker, docker-selenium, kubernetes, saucelabs, selenium, selenium-grid, testing, testingbot
- Language: Java
- Homepage: https://opensource.zalando.com/zalenium/
- Size: 13.4 MB
- Stars: 2,381
- Watchers: 135
- Forks: 577
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-list-docker - zalenium
README
[](https://travis-ci.org/zalando/zalenium)
[](https://www.codacy.com/app/diemol_zalenium/zalenium?utm_source=github.com&utm_medium=referral&utm_content=zalando/zalenium&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/zalando/zalenium)
[](https://github.com/zalando/zalenium/releases)
[](https://hub.docker.com/r/dosel/zalenium/tags/)
[](https://seleniumhq.herokuapp.com)
# :exclamation: This project is not being developed anymore. We will only reply to issues and to questions in the Zalenium Slack channel.
## The last Zalenium release was [3.141.59z](https://github.com/zalando/zalenium/releases/tag/3.141.59z)
### From now on, we will spend our time just replying to new issues and answering questions at the Zalenium Slack channel.
### Unfortunately, no new maintainers were found and this project won't be developed anymore.
### The most relevant features from Zalenium are being/will be implemented in the upstream Grid 4.x, keep an eye on https://github.com/seleniumhq/docker-selenium/. You could migrate to this project in the near future.
### We want to truly thank all of our users for making this a great project, helping us spread the word and improve the testing community ❤️ This project was made for the community and by the community!
---
This is a Selenium Grid extension to scale your local grid dynamically with docker containers. It uses
[docker-selenium](https://github.com/elgalu/docker-selenium) to run your tests in Firefox and Chrome locally, if you
need a different browser, your tests can get redirected to a cloud testing provider ([Sauce Labs](https://saucelabs.com/),
[BrowserStack](https://www.browserstack.com/), [TestingBot](https://testingbot.com/), [CrossBrowserTesting](https://crossbrowsertesting.com/), [LambdaTest](https://www.lambdatest.com/)). Zalenium also works out of the box
in [Kubernetes](https://zalando.github.io/zalenium/#kubernetes).
Zalenium's maintainers add new features regularly. We invite you to test it, report bugs, suggest any ideas you may
have, and contribute. See our [contributing guidelines](https://zalando.github.io/zalenium/#contributing) for more details.
### Why?
> Thanks for open sourcing this. Our test suite run time has dropped from more than an hour to six minutes. — [@TKueck](https://twitter.com/Tkueck/status/887425829273088000)
We know how complicated it is to:
* Have a stable grid to run UI tests with Selenium
* Maintain it over time (keep up with new browser, Selenium and drivers versions)
* Provide capabilities to cover all browsers and platforms
That is why we took this approach where [docker-selenium](https://github.com/elgalu/docker-selenium) nodes are
created on demand. Your UI tests in Firefox and Chrome will run faster because they are running on a local grid,
on a node created from scratch and disposed after the test completes.
If you need a capability that cannot be fulfilled by [docker-selenium](https://github.com/elgalu/docker-selenium),
the test gets redirected to a cloud testing provider ([Sauce Labs](https://saucelabs.com/),
[BrowserStack](https://www.browserstack.com/), [TestingBot](https://testingbot.com/), [CrossBrowserTesting](https://crossbrowsertesting.com/), [LambdaTest](https://www.lambdatest.com/)).
Zalenium's main goal is: to allow anyone to have a disposable and flexible Selenium Grid infrastructure.
Part of the idea comes from this [Sauce Labs post](https://saucelabs.com/blog/introducing-the-sauce-plugin-for-selenium-grid).
### What does **Zalenium** mean?
As you can imagine, it is the result of mixing _[Zalando](https://tech.zalando.com)_ and _[Selenium](http://www.seleniumhq.org/)_.
As mentioned before, this project's aim is to provide a simple way to create a grid and contribute to the Selenium community.
Nevertheless, this is _**not**_ an official [Selenium](http://www.seleniumhq.org/) project. We kindly ask you to create
[issues](https://github.com/zalando/zalenium/issues/new) in this repository. If you have questions about how to get
started, please join the #zalenium channel on [Slack](https://seleniumhq.herokuapp.com).
***
## Contents
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Run it](#run-it)
* [Additional features](#additional-features)
* [Documentation](#documentation)
## Getting Started
#### Prerequisites
* Docker engine running, version >= 1.11.1 (probably works with earlier versions, not tested yet).
* Make sure your docker daemon is running (e.g. `docker info` works without errors).
* Pull the [docker-selenium](https://github.com/elgalu/docker-selenium) image. `docker pull elgalu/selenium`
* `docker pull dosel/zalenium`
#### Run it
* Zalenium uses docker to scale on-demand, therefore we need to give it the `docker.sock` full access, this is known as
"Docker alongside docker".
```sh
# Pull docker-selenium
docker pull elgalu/selenium
# Pull Zalenium
docker pull dosel/zalenium
docker run --rm -ti --name zalenium -p 4444:4444 \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp/videos:/home/seluser/videos \
--privileged dosel/zalenium start
```
* Why `--privileged`? We suggest you run Zalenium as `--privileged` to speed up the node registration process by
increasing the entropy level with [Haveged](http://www.issihosts.com/haveged/). Using `--privileged` is optional
since it is just meant to improve its performance. For more information, check this
[tutorial](https://www.digitalocean.com/community/tutorials/how-to-setup-additional-entropy-for-cloud-servers-using-haveged).
* Try also our one line installer and starter for OSX/Linux (it will check for the latest images and ask for missing dependencies.)
```sh
curl -sSL https://raw.githubusercontent.com/dosel/t/i/p | bash -s start
```
* More usage examples, parameters, configurations, video usage and one line starters can be seen [here](https://zalando.github.io/zalenium/#usage)
* After the output, you can check the [grid](http://localhost:4444/grid/console) console
* Now you can point your Selenium tests to [http://localhost:4444/wd/hub](http://localhost:4444/wd/hub)
* Stop it: `docker stop zalenium`
## Additional features
* [Dashboard](http://localhost:4444/dashboard), see all the videos and aggregated logs after your tests completed.
* Live preview of your running tests [http://localhost:4444/grid/admin/live](http://localhost:4444/grid/admin/live)
* Video recording, check them in the `/tmp/videos` folder (or the one you mapped when starting Zalenium)
* Customise video file naming via capabilities, basic auth and [more](https://zalando.github.io/zalenium/#usage)
## Documentation
Check the complete documentation at https://zalando.github.io/zalenium/
License
===================
See [License](LICENSE.md)
Security
===================
See [Security](SECURITY.md)