capybara-chromedriver-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 869016e895120f49aac09f57558b2284d02fd780
+  data.tar.gz: 0f0c6580fdf8a8e46f5c000328b4fbc0e10fcd2e
+SHA512:
+  metadata.gz: a7c7d9339f1271820782dd095876de97b0b45f35a762376a23a24b4a42d979733a1872038379e51f5cbc5fe27a6363d985a4382c5971b94ae12f051cfe8aec56
+  data.tar.gz: d578742ac8cd77ef15fd05a317a5475ea979d4c37ff02cc68a81b2dfb668c691ebdf6ad415ae3a451e7be1e51f4b81783ba2cb77aaad80b4c015083fd0b49e39

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+* First release!

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capybara-chromedriver-logger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    capybara-chromedriver-logger (0.1.0)
+      capybara
+      colorize
+      net-http-persistent
+      selenium-webdriver
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    archive-zip (0.11.0)
+      io-like (~> 0.3.0)
+    capybara (2.18.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (>= 2.0, < 4.0)
+    childprocess (0.8.0)
+      ffi (~> 1.0, >= 1.0.11)
+    chromedriver-helper (1.2.0)
+      archive-zip (~> 0.10)
+      nokogiri (~> 1.8)
+    colorize (0.8.1)
+    connection_pool (2.2.1)
+    diff-lcs (1.3)
+    ffi (1.9.21)
+    io-like (0.3.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    net-http-persistent (3.0.0)
+      connection_pool (~> 2.2)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    public_suffix (3.0.2)
+    rack (2.0.4)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.9.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2)
+    stub_server (0.2.1)
+      rack
+    xpath (3.0.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  capybara-chromedriver-logger!
+  chromedriver-helper
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  stub_server
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 David Balatero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# capybara-chromedriver-logger
+
+This gem provides real-time `console.log` debug output for Ruby feature specs running under Chromedriver.
+
+We currently assume you're running:
+
+* capybara
+* chromedriver
+* rspec
+* selenium-webdriver
+
+to handle your JS feature specs. I'd love to expand support for other combinations of test environments!
+
+<img src="https://raw.githubusercontent.com/dbalatero/capybara-chromedriver-logger/master/images/example.png" />
+
+## 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|
+  # Turn on browser logs
+  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
+    loggingPrefs: {
+      browser: 'ALL'
+    }
+  )
+
+  # Selenium needs to use a thread-safe HTTP client
+  client = Capybara::Chromedriver::Logger::SeleniumHttpClient.new
+
+  Capybara::Selenium::Driver.new(
+    app,
+    browser: :chrome,
+    desired_capabilities: capabilities,
+    http_client: client
+  )
+end
+
+# Use the driver we've configured
+Capybara.default_driver = :chrome
+Capybara.javascript_driver = :chrome
+
+# Setup before/after hooks for your feature specs
+Capybara::Chromedriver::Logger::TestHooks.for_rspec!
+```
+
+## 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
+]
+```
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara/chromedriver/logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara-chromedriver-logger.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "capybara/chromedriver/logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-chromedriver-logger"
+  spec.version       = Capybara::Chromedriver::Logger::VERSION
+  spec.authors       = ["David Balatero"]
+  spec.email         = ["dbalatero@gmail.com"]
+
+  spec.summary       = %q{Adds realtime console.log output to Capybara + Selenium + Chromedriver}
+  spec.homepage      = "https://github.com/dbalatero/capybara-chromedriver-logger"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capybara"
+  spec.add_dependency "colorize"
+  spec.add_dependency "net-http-persistent"
+  spec.add_dependency "selenium-webdriver"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "chromedriver-helper"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "stub_server"
+end

data/lib/capybara/chromedriver/logger.rb

@@ -0,0 +1,41 @@
+require 'capybara'
+require 'selenium-webdriver'
+require 'selenium/webdriver/remote/http/persistent'
+
+require "capybara/chromedriver/logger/test_hooks"
+require "capybara/chromedriver/logger/version"
+require "capybara/chromedriver/logger/js_error"
+require "capybara/chromedriver/logger/message"
+require "capybara/chromedriver/logger/watcher"
+require "capybara/chromedriver/logger/selenium_thread_safe_bridge"
+
+class Selenium::WebDriver::Remote::Bridge
+  prepend Capybara::Chromedriver::Logger::SeleniumThreadSafeBridge
+end
+
+module Capybara
+  module Chromedriver
+    module Logger
+      # This HTTP client is thread-safe, unlike the default client.
+      SeleniumHttpClient = ::Selenium::WebDriver::Remote::Http::Persistent
+
+      extend self
+
+      def filters
+        @filters || []
+      end
+
+      def filters=(filters)
+        @filters = filters
+      end
+
+      def raise_js_errors?
+        !!@raise_js_errors
+      end
+
+      def raise_js_errors=(value)
+        @raise_js_errors = value
+      end
+    end
+  end
+end

data/lib/capybara/chromedriver/logger/js_error.rb

@@ -0,0 +1,8 @@
+module Capybara
+  module Chromedriver
+    module Logger
+      class JsError < StandardError
+      end
+    end
+  end
+end

data/lib/capybara/chromedriver/logger/message.rb

@@ -0,0 +1,64 @@
+require 'colorize'
+
+module Capybara
+  module Chromedriver
+    module Logger
+      class Message
+        attr_reader :level, :message, :file, :location, :timestamp
+
+        def initialize(log)
+          @message = log.message.strip.gsub(/%c/, '')
+          @level = log.level
+          @file = nil
+          @location = nil
+
+          extract_file_and_location!
+        end
+
+        def to_s
+          [
+            "\u{1F4DC} ",
+            log_level,
+            file_and_location,
+            message
+          ].compact.join(' ')
+        end
+
+        def error?
+          level == 'SEVERE'
+        end
+
+        private
+
+        COLORS = {
+          'SEVERE' => :light_red,
+          'INFO' => :light_green,
+          'DEBUG' => :light_blue
+        }.freeze
+
+        def level_color
+          COLORS[level] || :light_blue
+        end
+
+        def log_level
+          " #{level.downcase} ".colorize(color: :white, background: level_color).bold
+        end
+
+        def file_and_location
+          return unless file && location
+
+          "#{file} #{location}".colorize(color: :white, background: :light_magenta)
+        end
+
+        def extract_file_and_location!
+          match = message.match(/^(.+)\s+?(\d+:\d+)\s+?(.+)$/)
+
+          return unless match
+
+          _, @file, @location, message = match.to_a
+          @message = message.gsub(/^"(.+?)"$/, '\1')
+        end
+      end
+    end
+  end
+end

data/lib/capybara/chromedriver/logger/selenium_thread_safe_bridge.rb

@@ -0,0 +1,16 @@
+module Capybara
+  module Chromedriver
+    module Logger
+      # Ensure our polling thread doesn't compete with the main spec example
+      module SeleniumThreadSafeBridge
+        def __execute_lock
+          @__execute_lock ||= Mutex.new
+        end
+
+        def execute(*args)
+          __execute_lock.synchronize { super }
+        end
+      end
+    end
+  end
+end

data/lib/capybara/chromedriver/logger/test_hooks.rb

@@ -0,0 +1,26 @@
+module Capybara
+  module Chromedriver
+    module Logger
+      class TestHooks
+        def self.for_rspec!
+          ::RSpec.configure do |config|
+            filters = { type: :feature }
+            watcher = Capybara::Chromedriver::Logger::Watcher.instance
+
+            config.before :suite do
+              watcher.before_suite!
+            end
+
+            config.before :each, filters do
+              watcher.before_example!
+            end
+
+            config.after :each, filters do
+              watcher.after_example!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capybara/chromedriver/logger/version.rb

@@ -0,0 +1,7 @@
+module Capybara
+  module Chromedriver
+    module Logger
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/capybara/chromedriver/logger/watcher.rb

@@ -0,0 +1,131 @@
+require 'thread'
+
+module Capybara
+  module Chromedriver
+    module Logger
+      class Watcher
+        def self.instance
+          @instance ||= new
+        end
+
+        def initialize(log_destination: $stdout, filters: nil)
+          @log_destination = log_destination
+          @last_timestamp = 0
+          @mutex = Mutex.new
+          @thread = nil
+          @paused = true
+          @filters = filters || Capybara::Chromedriver::Logger.filters
+          @errors = []
+        end
+
+        def before_suite!
+          @thread = Thread.new do
+            loop do
+              flush_logs! unless paused?
+              sleep 0.1
+            end
+          end
+        end
+
+        def before_example!
+          unpause!
+        end
+
+        def after_example!
+          pause!
+          flush_logs!
+
+          raise_errors_if_needed!
+          clear_errors!
+        ensure
+          thread.kill if thread
+        end
+
+        private
+
+        def raise_errors_if_needed!
+          return unless Capybara::Chromedriver::Logger.raise_js_errors?
+          return if errors.empty?
+
+          formatted_errors = errors.map(&:to_s)
+          error_list = formatted_errors.join("\n")
+
+          raise JsError,
+            "Got some JS errors during testing:\n\n#{error_list}"
+        end
+
+        def flush_logs!
+          browser_logs.each do |log|
+            next if log.timestamp < last_timestamp
+
+            @last_timestamp = log.timestamp
+
+            message = Message.new(log)
+
+            errors << message if message.error?
+            log_destination.puts message.to_s unless should_filter?(message)
+          end
+        end
+
+        def clear_errors!
+          @errors = []
+        end
+
+        def browser_logs
+          logs(:browser)
+        end
+
+        def logs(type)
+          mutex.synchronize do
+            Capybara
+              .current_session
+              .driver.browser
+              .manage
+              .logs
+              .get(type)
+          end
+        end
+
+        def should_filter?(message)
+          filters.any? { |filter| filter =~ message.message }
+        end
+
+        def errors
+          @errors
+        end
+
+        def unpause!
+          @paused = false
+        end
+
+        def pause!
+          @paused = true
+        end
+
+        def mutex
+          @mutex
+        end
+
+        def filters
+          @filters
+        end
+
+        def last_timestamp
+          @last_timestamp
+        end
+
+        def paused?
+          !!@paused
+        end
+
+        def log_destination
+          @log_destination
+        end
+
+        def thread
+          @thread
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: capybara-chromedriver-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Balatero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: stub_server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dbalatero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capybara-chromedriver-logger.gemspec
+- images/example.png
+- lib/capybara/chromedriver/logger.rb
+- lib/capybara/chromedriver/logger/js_error.rb
+- lib/capybara/chromedriver/logger/message.rb
+- lib/capybara/chromedriver/logger/selenium_thread_safe_bridge.rb
+- lib/capybara/chromedriver/logger/test_hooks.rb
+- lib/capybara/chromedriver/logger/version.rb
+- lib/capybara/chromedriver/logger/watcher.rb
+homepage: https://github.com/dbalatero/capybara-chromedriver-logger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Adds realtime console.log output to Capybara + Selenium + Chromedriver
+test_files: []