Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbalatero/capybara-chromedriver-logger
Enables console.log/error/info output from Javascript feature specs running with Chromedriver
https://github.com/dbalatero/capybara-chromedriver-logger
capybara chrome chromedriver console logger logging rspec ruby testing
Last synced: 5 days ago
JSON representation
Enables console.log/error/info output from Javascript feature specs running with Chromedriver
- Host: GitHub
- URL: https://github.com/dbalatero/capybara-chromedriver-logger
- Owner: dbalatero
- License: mit
- Created: 2018-02-17T19:44:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-19T13:32:04.000Z (about 2 years ago)
- Last Synced: 2024-12-16T15:11:06.024Z (6 days ago)
- Topics: capybara, chrome, chromedriver, console, logger, logging, rspec, ruby, testing
- Language: Ruby
- Homepage:
- Size: 506 KB
- Stars: 54
- Watchers: 4
- Forks: 27
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/dbalatero/capybara-chromedriver-logger)
# capybara-chromedriver-logger
This gem provides `console.log` debug output for Ruby feature specs running under Chromedriver.
We currently assume you're running:
* capybara
* chromedriver + selenium-webdriver
* rspec
to handle your JS feature specs. I'd love to expand support for other combinations of test environments!
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'capybara-chromedriver-logger'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install capybara-chromedriver-logger
## Usage
You'll want to modify your `spec_helper.rb` file to configure Capybara correctly:
```ruby
Capybara.register_driver(:chrome) do |app|
# option 1:
# This wraps Selenium::WebDriver::Remote::Capabilities.chrome() with the
# correct settings for logging.
capabilities = Capybara::Chromedriver::Logger.build_capabilities(
chromeOptions: {
args: %w[headless]
}
)
Capybara::Selenium::Driver.new(
app,
browser: :chrome,
desired_capabilities: capabilities
)
end
# Use the driver we've configured
Capybara.default_driver = :chrome
Capybara.javascript_driver = :chrome
# Option 1: Setup hooks for your feature specs
Capybara::Chromedriver::Logger::TestHooks.for_rspec!
# Option 2: if you prefer to hook it in manually:
RSpec.configure do |config|
config.after :each, type: :feature do
Capybara::Chromedriver::Logger::TestHooks.after_example!
end
end
```
If you don't want to use the capability wrapper above for any reason, you can
still manually configure things:
```ruby
# option 2: manual setup
# Turn on browser logs
capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
chromeOptions: {
args: %w[headless],
# required for Chrome 75+
w3c: false
},
# For up to Chrome 74
loggingPrefs: {
browser: 'ALL'
}
# for Chrome 75+
"goog:loggingPrefs" => {
browser: 'ALL'
}
)
```
## Configuration
Here are examples of the supported configuration options:
```ruby
# If you set this to true, any specs that generate console errors
# will automatically raise. This is similar to poltergeist's
# `js_errors: true` config option
#
# If you filter out any errors with the `filters` option, they will
# not trigger an exception in your spec examples.
#
# default: false
Capybara::Chromedriver::Logger.raise_js_errors = true
# If third-party libraries are dumping obnoxious logs into your output,
# you can filter them out here.
#
# default: []
Capybara::Chromedriver::Logger.filters = [
/Download the React DevTools/i,
/The SSL certificate used to load resources from/i
]
# If you want to filter out specific severity levels, you can do so here:
#
# default: nil
Capybara::Chromedriver::Logger.filter_levels = %i[
severe
info
warning
debug
]
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/dbalatero/capybara-chromedriver-logger.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).