govuk_test 0.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7aa0bc205bc8af3b07ef3cc7dc46ddabc9a59a60035dd2997ae182b6050c99e
-  data.tar.gz: bd0beb6fc201a1a7c773d19cb7dd50e7c78a7b6f7d9ce5cdf1c4dd727282e2f2
+  metadata.gz: e879e0b4e1b39bcd4287be0ff735b5901eb53144c2cfca98a5024c1e82ce5253
+  data.tar.gz: 74ba5e2ccd6fd805be749f289281eb5d2d4030446d8ff2b3f191f53a1f374cae
 SHA512:
-  metadata.gz: c6a977ed71f33dc8c17511185747d8bc0b5b85e866544b6032760349b7aca5d7b410707f501b945efdadbc8984cc30e4a5b653bf77f8d424e99d6220f88dd866
-  data.tar.gz: fa0c884c6e0177443431077b3b896e18ad27284c78d6820a42b6c158f016fda26f68929cb06959f62591f2c165a6f0906d7c7b6f39f418bd0b8fa26fec6b7a05
+  metadata.gz: da484c3a777accc15e51e51f1221a5f3263c7d6b3d22fb4ce53e445b2dbd5607a02fdfa6477a0fd9b3db6af9ff44e71e13e735634052b5812ca6e5b247892e3b
+  data.tar.gz: 230861fa63836ce22c11eb2ef621bdc5be61ed5728059e2840369b072db637f12eb4f80bfb5128c135f6675851dcd96942ed2356cecaea22c7567f374b4a251c

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.6

data/CHANGELOG.md

@@ -7,6 +7,36 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
+## 2.0.0
+
+* BREAKING: `.configure` no longer accepts options. If you need to modify the
+  headless_chrome selenium driver you can re-register the driver with
+  `Capybara.register_driver`.
+* `GovukTest.headless_chrome_selenium_options` added to allow accessing the
+  headless Chrome selenium options for other contexts (such as configuring
+  Jasmine).
+* `GOVUK_TEST_CHROME_NO_SANDBOX` can be set to default Chrome to be running
+  with the `--no-sandbox` argument.
+
+## 1.0.3
+
+* Add Brakeman as a dependency.
+
+## 1.0.2
+
+* Allow new versions of 'webdrivers' above 4
+
+## 1.0.1
+
+* Ensure version of 'webdrivers' is at least 4
+
+## 1.0.0
+
+* BREAKING: `.configure` accepts a `chrome_options` argument of an instance of
+  `Selenium::Webdriver::Chrome::Options` rather than a hash. The `window_size`
+  argument is dropped and can be done by configuring the `chrome_options`
+  instance, [example](https://github.com/alphagov/govuk_test/blob/dfd1a82e0114dbf1c668957fbea19cea04fd0d90/spec/govuk_test_spec.rb#L12-L22).
+
 ## 0.5.0
 
 * No changes: new release for semantic versioning purposes (0.4.4 should have been 0.5.0)

data/README.md

@@ -5,36 +5,67 @@ Gem to package test dependencies and config for GOV.UK applications. Cousin of [
 ## Installation
 
 ```ruby
-gem 'govuk_test'
+gem "govuk_test"
 ```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 ## Usage
 
-Somewhere in your `spec_helper`, `rails_helper`, or `spec/support/govuk_test.rb` put:
+Somewhere in your `spec_helper.rb`, `rails_helper.rb`, or
+`spec/support/govuk_test.rb` put:
 
-```rb
+```ruby
 GovukTest.configure
 ```
 
-It's also possible to pass optional arguments `:chrome_options` and/or `:window_size `
-to `GovukTest.configure`:
+This will configure [Capybara][] to run any JavaScript enabled tests
+against a [Selenium][] driven instance of
+[headless Google Chrome][headless-chrome].
 
-```rb
-GovukTest.configure(chrome_options: { some_key: "some value" })
+If you need to use this as a root user (such as within some docker containers)
+you will need to set a `GOVUK_TEST_CHROME_NO_SANDBOX` environment variable.
 
-# or
+You can reuse the Selenium options for headless Google Chrome for configuring
+other Selenium driven tests, such as [Jasmine][]:
 
-GovukTest.configure(window_size: "1366,768")
+```ruby
+class ChromeHeadlessJasmineConfigurer < JasmineSeleniumRunner::ConfigureJasmine
+  def selenium_options
+    { options: GovukTest.headless_chrome_selenium_options }
+  end
+end
+```
 
-# or
+Should you need to configure the options for your application the recommended
+approach is to re-register the headless Google Chrome driver:
 
-GovukTest.configure(chrome_options: { some_key: "some value" }, window_size: "800,600")
+```ruby
+GovukTest.configure
+
+Capybara.register_driver :headless_chrome do |app|
+  chrome_options = GovukTest.headless_chrome_selenium_options
+  chrome_options.add_argument("--disable-web-security")
+  chrome_options.add_argument("--window-size=1400,1400")
+
+  Capybara::Selenium::Driver.new(
+    app,
+    browser: :chrome,
+    desired_capabilities: { acceptInsecureCerts: true },
+    options: chrome_options,
+  )
+end
 ```
 
+[Capybara]: https://github.com/teamcapybara/capybara
+[Selenium]: https://selenium.dev
+[headless-chrome]: https://developers.google.com/web/updates/2017/04/headless-chrome
+[Jasmine]: https://github.com/jasmine/jasmine_selenium_runner
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/govuk_test.gemspec

@@ -23,11 +23,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "capybara"
-  spec.add_dependency "webdrivers"
+  spec.add_dependency "webdrivers", ">= 4"
   spec.add_dependency "puma"
-  spec.add_dependency "selenium-webdriver"
+  spec.add_dependency "selenium-webdriver", ">= 3.142"
+  spec.add_dependency "brakeman", "~> 4.6"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/govuk_test.rb

@@ -4,36 +4,30 @@ require "capybara"
 require "puma"
 require "selenium-webdriver"
 
-unless ENV['GOVUK_TEST_USE_SYSTEM_CHROMEDRIVER']
-  require 'webdrivers'
+unless ENV["GOVUK_TEST_USE_SYSTEM_CHROMEDRIVER"]
+  require "webdrivers"
 
   # This stop webdrivers doing a lazy check for new versions
   # of chromedriver, which interferes with WebMock.disable_net_connect
-  if ::Selenium::WebDriver::Service.respond_to? :driver_path=
-    Selenium::WebDriver::Chrome::Service.driver_path = Webdrivers::Chromedriver.update
-  else
-    Selenium::WebDriver::Chrome.driver_path = Webdrivers::Chromedriver.update
-  end
+  Selenium::WebDriver::Chrome::Service.driver_path = Webdrivers::Chromedriver.update
 end
 
 module GovukTest
-  def self.configure(options = {})
-    chrome_options = %w(headless disable-gpu)
-    chrome_options << "--window-size=#{options[:window_size]}" if options[:window_size]
-
+  def self.configure
     Capybara.register_driver :headless_chrome do |app|
-      capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
-        chromeOptions: { args: chrome_options }.merge(options.fetch(:chrome_options, {}))
-      )
-
-      Capybara::Selenium::Driver.new(
-        app,
-        browser: :chrome,
-        desired_capabilities: capabilities
-      )
+      Capybara::Selenium::Driver.new(app,
+                                     browser: :chrome,
+                                     options: headless_chrome_selenium_options)
     end
 
     Capybara.javascript_driver = :headless_chrome
     Capybara.server = :puma, { Silent: true }
   end
+
+  def self.headless_chrome_selenium_options
+    Selenium::WebDriver::Chrome::Options.new.tap do |options|
+      options.headless!
+      options.add_argument("--no-sandbox") if ENV["GOVUK_TEST_CHROME_NO_SANDBOX"]
+    end
+  end
 end

data/lib/govuk_test/version.rb

@@ -1,3 +1,3 @@
 module GovukTest
-  VERSION = "0.5.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_test
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +58,70 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.142'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.142'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: brakeman
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '4.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: climate_control
+  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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement