Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nbulaj/ruby-chromedriver

Ruby, Chrome / Chrome driver, NodeJS on Docker for Cucumber specs
https://github.com/nbulaj/ruby-chromedriver

capybara chrome chromedriver cucumber docker ruby tests

Last synced: 3 months ago
JSON representation

Ruby, Chrome / Chrome driver, NodeJS on Docker for Cucumber specs

Host: GitHub
URL: https://github.com/nbulaj/ruby-chromedriver
Owner: nbulaj
License: mit
Created: 2017-07-18T09:56:41.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2023-04-17T06:39:21.000Z (almost 2 years ago)
Last Synced: 2024-10-03T19:41:00.557Z (4 months ago)
Topics: capybara, chrome, chromedriver, cucumber, docker, ruby, tests
Language: Dockerfile
Homepage:
Size: 35.2 KB
Stars: 32
Watchers: 2
Forks: 20
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# ruby-chromedriver

[![Docker Pulls](https://img.shields.io/docker/pulls/nbulai/ruby-chromedriver.svg)](https://hub.docker.com/r/nbulai/ruby-chromedriver/)
[![Docker Stars](https://img.shields.io/docker/stars/nbulai/ruby-chromedriver.svg)](https://hub.docker.com/r/nbulai/ruby-chromedriver/)

Ruby 3.1.x, Chrome / [Chrome driver](https://sites.google.com/chromium.org/driver/), NodeJS on
Docker for [Capybara](https://github.com/teamcapybara/capybara)/[Cucumber](https://github.com/cucumber/cucumber) specs.

Based on official Ruby image and uses official stable Chrome repository. Uses X virtual framebuffer (Xvfb)
for keycode conversions.

Can be used for Continuous Integration or Delivery (CI/CD) pipelines (like GitLab) instead of Qt and PhantomJS:

# CI/CD Configuration

Example of GitLab CI configuration for Ruby on Rails project with Cucumber using the image
(read https://about.gitlab.com/2017/12/19/moving-to-headless-chrome/):

```yaml
cucumber:
stage: test
image: 'nbulai/ruby-chromedriver:latest'
variables:
RAILS_ENV: test
script:
- chromedriver -v # to check version
- ...
- bin/cucumber
artifacts:
paths:
- coverage/
only:
- main
```

If you need some specific screen size for testing, then you can pass it as an `SCREEN` environment variable:

`docker run -e SCREEN="1280x1024x16" -t -i --rm nbulai/ruby-chromedriver:latest bash`

Don't forget to configure your Cucumber/Capybara to use Chrome as a driver (see instruction below).

First install it locally to run your test-suite (if you will run tests on the dev machine):

```bash
# add Google public key
wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
# add Google Chrome stable repository to sources
echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list
sudo apt-get update
# install Chrome and it's driver
sudo apt-get install google-chrome-stable chromium-chromedriver
sudo ln -s /usr/lib/chromium-browser/chromedriver /usr/bin/chromedriver
# check if all is OK
chromedriver -v
```

Add gem `selenium-webdriver` to your `Gemfile`:

```ruby
group :test do
# ...
gem 'selenium-webdriver'
end
```

And then edit `features/support/env.rb` (or other config file):

```ruby
# ...

Capybara.register_driver(:headless_chrome) do |app|
capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
# Add 'no-sandbox' arg if you have an "unknown error: Chrome failed to start: exited abnormally"
# @see https://github.com/SeleniumHQ/selenium/issues/4961
chromeOptions: { args: %w[headless disable-gpu no-sandbox] }
)

Capybara::Selenium::Driver.new(app, browser: :chrome, desired_capabilities: capabilities)
end

Capybara.javascript_driver = :headless_chrome

# ...
```

That's all. Run `bin/cucumber` to check your tests.

## License

This repo content is released under the [MIT License](http://www.opensource.org/licenses/MIT).