govuk_test 1.0.2 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8eba7b1ec95fab62087227289584f0ddd640dfc79d9bf27751f260cb973e84
-  data.tar.gz: e3920b930381b5a12c30cdc674c08071cf93d37e44d091ba7306a5218f144719
+  metadata.gz: f378d699ec748a453ddd32bb832380ade5ea79443f1b7c924e87a7b222d1df59
+  data.tar.gz: b2a57cd8d08cfd92b7b04d898c1cafbbabddce770658f6fdf45387d80fb311fa
 SHA512:
-  metadata.gz: 8d76f7dea4a549bad5aaf35e26786332b6a8d6c8198f9013ae06138b3e39e76c025261c3799654efc5ab20f936e52aef3ad60fd5399822f258ee0a9fedd4d51d
-  data.tar.gz: e4bf850a4b50c3939de503ec02280ea90b3610897f522e6043e526853e2749bbc78fa9a052872f57eebb54e2250bff3311cc2f3640921bc1cecbbbfc99f66be9
+  metadata.gz: 65d78123feab40eaecfc759d6e1902984bb786c1cfa6cfa3a3c248c1f9063557f4c8dd8046faa183f974ad1619959ad0d64055d3c3ebad3dfd76e46eae747d85
+  data.tar.gz: 1a9b61be599ddc06ff86ad9197591c13bdb25af331da073b424a0f225dc40875d5e5bdea62de5e05214706eeddb37bb06841c3582390e2c65bdcad0114596d30

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.6.6

data/CHANGELOG.md

@@ -7,6 +7,34 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
+## 2.1.2
+
+* Mark `climate_control` as a dependency (rather than dev dependency)
+
+## 2.1.1
+
+* Add `pact` as a dependency
+
+## 2.1.0
+
+* Add pact test branch verify rake task
+* Add Railtie to load rake tasks
+
+## 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

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

@@ -22,12 +22,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "brakeman", "~> 4.6"
   spec.add_dependency "capybara"
-  spec.add_dependency "webdrivers", ">= 4"
+  spec.add_dependency "climate_control"
+  spec.add_dependency "pact"
   spec.add_dependency "puma"
   spec.add_dependency "selenium-webdriver", ">= 3.142"
+  spec.add_dependency "webdrivers", ">= 4"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/govuk_test.rb

@@ -1,3 +1,4 @@
+require "govuk_test/railtie" if defined?(Rails)
 require "govuk_test/version"
 
 require "capybara"
@@ -13,15 +14,21 @@ unless ENV["GOVUK_TEST_USE_SYSTEM_CHROMEDRIVER"]
 end
 
 module GovukTest
-  def self.configure(chrome_options: nil)
-    chrome_options ||= Selenium::WebDriver::Chrome::Options.new
-    chrome_options.headless!
-
+  def self.configure
     Capybara.register_driver :headless_chrome do |app|
-      Capybara::Selenium::Driver.new(app, browser: :chrome, options: chrome_options)
+      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/railtie.rb

@@ -0,0 +1,9 @@
+require "govuk_test"
+
+module GovukTest
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.expand_path('../tasks/**/*.rake', File.dirname(__FILE__))].each { |f| load f }
+    end
+  end
+end

data/lib/govuk_test/version.rb

@@ -1,3 +1,3 @@
 module GovukTest
-  VERSION = "1.0.2"
+  VERSION = "2.1.2"
 end

data/lib/tasks/pact.rake

@@ -0,0 +1,19 @@
+require "govuk_test"
+
+require "pact/tasks"
+require "pact/tasks/task_helper"
+
+namespace :pact do
+  desc "Verify the API contract for a specific branch"
+  task "verify:branch", [:branch_name] => :environment do |t, args|
+    abort "Please provide a branch name. eg rake #{t.name}[my_feature_branch]" unless args[:branch_name]
+  
+    pact_version = args[:branch_name] == "master" ? args[:branch_name] : "branch-#{args[:branch_name]}"
+  
+    ClimateControl.modify(GDS_API_ADAPTERS_PACT_VERSION: pact_version) do
+      Pact::TaskHelper.handle_verification_failure do
+        Pact::TaskHelper.execute_pact_verify
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: govuk_test
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.1.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -25,19 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webdrivers
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pact
+  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: puma
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +94,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.142'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        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
@@ -128,7 +170,9 @@ files:
 - bin/setup
 - govuk_test.gemspec
 - lib/govuk_test.rb
+- lib/govuk_test/railtie.rb
 - lib/govuk_test/version.rb
+- lib/tasks/pact.rake
 homepage: https://github.com/alphagov/govuk_test
 licenses:
 - MIT
@@ -148,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Test setup for GOV.UK