govuk_test 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8276e6e82a7ad5a58b4ce9d56708764ddbae8d2da8fbd5ffc884ce38fa7d01dd
-  data.tar.gz: f2b427a36610b2fd4893214cbcafa9f110e80029c87d60e1a5e4270ffa180f3f
+  metadata.gz: 7ded68d62fdb899e1ecc47a033c38c414c5ee2871c939c7387aeba566ccfca61
+  data.tar.gz: 659eda878476cd8b4e8bac4bd36988fa598f2712eee90e3ef3a8fab9466f685a
 SHA512:
-  metadata.gz: c587caff573491202172b1a267a272fe5469d7fdbe3d3b787716ca99815a7e177a4cb0d8d9d3a8c6f51fb063a3fff6a8649453f2c4c7d05b2353164f338c4bfd
-  data.tar.gz: 30c61e499af46fc0823f379e58cdbe5ebd39c9b4ea799dfd18e4d3419de5b6ee505cb7fe755d9908c8019bdc25a82cc09229ea6bc5369e855d74903d429a5f5b
+  metadata.gz: 29264cb3a71621d27ec1133521723c5aa74c24aac128079b8f39e0f71bd699a50ce06c9acdb5dcdf96a54457fa59d71ec0c751451cc3d6928c38a2da6288b280
+  data.tar.gz: b5bce1dc80ceffc74588f9fc96d7c68064a388a326028db082c6d6dde027d324da849ce729fdbe6365046ac3fb997f557157b65434d7fdd802bd64b890cf1c87

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.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
+
+## 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

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", ">= 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

@@ -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.0"
+  VERSION = "2.1.0"
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_test
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2021-04-06 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
@@ -67,33 +67,61 @@ dependencies:
       - !ruby/object:Gem::Version
         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
@@ -128,7 +156,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 +178,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