quke 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a97a09f733f534285c847c3d370ece578c2bbb4
-  data.tar.gz: 20e5a6f2fa15f487fe6e091ee43270b68a29090c
+  metadata.gz: 0051a72fdd98008ae4f027109205c8d3bce58f3f
+  data.tar.gz: f15a28e5d9952605671bce3a877d4f8f87d2c668
 SHA512:
-  metadata.gz: 78ee9101a34857bc43f390e9c1355cc8c7f06af00bbbb8b59c71c023eb33699057fa30344c08bc96789d3a0de6ea3cfc8882858b111c529d5f6b37360978bd0a
-  data.tar.gz: 8b6ab52037eeeed7f7346a3712633d3eb31db261332d928979295513097630a5e6822ce45c3df47b33d18a1488eea5a6e961eef0f362d311d70633fc3a2509b7
+  metadata.gz: a3330b63b302bf6023d014498f577a5fe373550705d6ab3f1c098692bb6a55c22fc9710e24739ff0e351c2b0c89e2c1f489f8f14e821ebf1413ba1ff1772a1f8
+  data.tar.gz: 9918ae1f6936bdc891bf4c67634fa6e96f0b8b7a9f01284b183286a741cc38e5941f03a664b1fcc84fefbb333ffa9141e09c35dad1df37a79974fb0731afeb42

data/README.md

@@ -124,9 +124,11 @@ You should be aware of some default behaviours included in Quke.
 
 Capybara includes the ability to save the source of the current page at any point. Quke has been configured so that if you are not using a headless browser and a step fails it will save the source to file and then use a tool called [Launchy](https://github.com/copiousfreetime/launchy) to open it in your default browser.
 
+You can disable this behaviour using `display_failures: false` in your `.config.yml`
+
 ### Quit on 5 failures
 
-If you are running using Chrome or Firefox after the 5th failure Quke will automatically stop. This is to prevent scores of tabs being opened in the browser when an error is found, which may just be the result of an error in the test code.
+If you are running using Chrome or Firefox after the 5th failure Quke will automatically stop. This is to prevent scores of tabs being opened in the browser when an error is found and Quke is set to show failures, which may just be the result of an error in the test code.
 
 ### Automatically setting Browserstack session status
 

data/lib/features/support/after_hook.rb

@@ -14,22 +14,20 @@ After("not @nonweb") do |scenario|
   if scenario.failed?
     $fail_count = $fail_count + 1
 
-    # Tell Cucumber to quit after first failing scenario when stop_on_error is
-    # true.
-    # Also experience has shown that should a major element of your service go
+    # Experience has shown that should a major element of your service go
     # down all your tests will start failing which means you can be swamped
     # with output from `save_and_open_page`. Using a global count of the
     # number of fails, if it hits 5 it will cause cucumber to close.
-    if Quke::Quke.config.stop_on_error || $fail_count >= 5
+    if $fail_count >= 5 && !%w["chrome firefox"].include?(Quke::Quke.config.driver)
       Cucumber.wants_to_quit = true
     else
-      # If we're not using poltergiest or running in headless mode and the
-      # scenario has failed, we want to save a copy of the page and open it
-      # automatically using Launchy. We wrap this in a begin/rescue in case of
-      # any issues in which case it defaults to outputting the source to STDOUT.
+      # Depending on our config, driver and whether we are running headless we
+      # may want to save a copy of the page and open it automatically using
+      # Launchy. We wrap this in a begin/rescue in case of any issues in which
+      # case it defaults to outputting the source to STDOUT.
       begin
         # rubocop:disable Lint/Debugger
-        save_and_open_page unless Quke::Quke.config.headless
+        save_and_open_page if Quke::Quke.config.display_failures?
         # rubocop:enable Lint/Debugger
       rescue StandardError
         # handle e

data/lib/quke.rb

@@ -10,6 +10,8 @@ require "quke/configuration"
 require "quke/cuke_runner"
 require "quke/driver_registration"
 require "quke/driver_configuration"
+require "quke/parallel_configuration"
+require "quke/proxy_configuration"
 
 module Quke #:nodoc:
 

data/lib/quke/browserstack_configuration.rb

@@ -136,10 +136,10 @@ module Quke #:nodoc:
         # Rather than
         "logfile" => File.join(Dir.pwd, "/tmp/bowerstack_local_log.txt")
       }
-      return unless configuration.use_proxy?
+      return unless configuration.proxy.use_proxy?
 
-      @local_testing_args["proxyHost"] = configuration.proxy["host"]
-      @local_testing_args["proxyPort"] = configuration.proxy["port"].to_s
+      @local_testing_args["proxyHost"] = configuration.proxy.host
+      @local_testing_args["proxyPort"] = configuration.proxy.port.to_s
     end
 
   end

data/lib/quke/configuration.rb

@@ -18,6 +18,20 @@ module Quke #:nodoc:
     # returning the config for setting up Quke to use browserstack.
     attr_reader :browserstack
 
+    # Instance of +Quke::ParallelConfiguration+ which manages reading and
+    # returning the config for setting up Quke to use parallel tests.
+    #
+    # The instance will be populated based on what was set in the config.yml
+    # merged with default values.
+    #
+    # These values will then tell Quke whether to run tests in parallel, and if
+    # so how to setup the runs.
+    attr_reader :parallel
+
+    # Instance of +Quke::ProxyConfiguration+ which manages reading and
+    # returning the config for setting up Quke to use proxy server.
+    attr_reader :proxy
+
     class << self
       # Class level setter for the location of the config file.
       #
@@ -41,10 +55,13 @@ module Quke #:nodoc:
     end
 
     # When an instance is initialized it will automatically populate itself by
-    # calling a private method +load_data()+.
+    # calling a private method +default_data()+.
     def initialize
-      @data = load_data
+      @data = default_data!(load_yml_data)
+      # Order is important. @browserstack relies on @proxy being set
+      @proxy = ::Quke::ProxyConfiguration.new(@data["proxy"] || {})
       @browserstack = ::Quke::BrowserstackConfiguration.new(self)
+      @parallel = ::Quke::ParallelConfiguration.new(self)
     end
 
     # Returns the value set for +features_folder+.
@@ -87,21 +104,6 @@ module Quke #:nodoc:
       @data["headless"]
     end
 
-    # Returns the value set for +parallel+.
-    #
-    # Tells Quke whether run the features in parallel. Depending on the number
-    # of cores on the host machine, it will split the features across a given
-    # number of processes and run them in parallel.
-    #
-    # This is great if you have a large test suite (the performance improvement
-    # is negligible if you only have a few). However your scenarios must be
-    # independent, and the console output will be 'number of processes' *
-    # cucumber output. This is best used if you are just after a simple
-    # pass/fail result.
-    def parallel
-      @data["parallel"]
-    end
-
     # Return the value set for +pause+.
     #
     # Add a pause (in seconds) between steps so you can visually track how the
@@ -124,6 +126,26 @@ module Quke #:nodoc:
       # rubocop:enable Security/YAMLLoad
     end
 
+    # Returns the value set for +display_failures+.
+    #
+    # Tells Quke not to display the html for the last page when a failure
+    # happens. Quke uses Capybara to save a copy of the page as html and uses
+    # launchy to display it in the default browser.
+    def display_failures
+      @data["display_failures"]
+    end
+
+    # Returns whether failures should be displayed.
+    #
+    # If the browser is headless then we never display failures, even if the
+    # setting has been set to true. Else whether we display a failure is based
+    # on the value set for display_failures.
+    def display_failures?
+      return false if headless
+
+      display_failures
+    end
+
     # Return the value for +max_wait_time+
     #
     # +max_wait_time+ is the time Capybara will spend waiting for an element
@@ -161,22 +183,13 @@ module Quke #:nodoc:
       @data["javascript_errors"]
     end
 
-    # Return the hash of +proxy+ server settings
-    #
-    # If your environment requires you to go via a proxy server you can
-    # configure Quke to use it by setting the +host+ and +port+ in your config
-    # file.
-    def proxy
-      @data["proxy"]
-    end
-
-    # Return true if the +proxy: host+ value has been set in the +.config.yml+
-    # file, else false.
+    # Returns the value set for +print_progress+.
     #
-    # It is mainly used when determining whether to apply proxy server settings
-    # to the different drivers when registering them with Capybara.
-    def use_proxy?
-      proxy["host"] != ""
+    # If set Quke will tell Cucumber to output to the console using its
+    # 'progress' formatter, rather than the default 'pretty' which displays each
+    # scenario in detail.
+    def print_progress
+      @data["print_progress"]
     end
 
     # Return the hash of +custom+ server settings
@@ -195,14 +208,36 @@ module Quke #:nodoc:
       @data["custom"]
     end
 
-    private
-
-    def load_data
-      data = default_data!(load_yml_data)
-      data["proxy"] = proxy_data(data["proxy"])
-      data
+    # Returns a string representing the agruments that are passed to Cucumber
+    # by ParallelTests when it creates a new process and executes.
+    #
+    # Specifically its the value for ParallelTests' `--test-options` argument
+    # which will be used when generating the array of args to be passed to
+    # ParallelTests. It returns just a string rather than an array because
+    # ParallelTests needs to see this as a single argument.
+    #
+    # The additional args are whatever a user enters after the
+    # `bundle exec quke` command.
+    def cucumber_arg(additional_args)
+      # Because cucumber is called in the context of the executing project and
+      # not Quke it will take its arguments in the context of that location, and
+      # not from where the Quke currently sits. This means to Cucumber
+      # 'lib/features' doesn't exist, which means our env.rb never gets loaded.
+      # Instead we first have to determine where this file is running from when
+      # called, then we simply replace the last part of that result (which we
+      # know will be lib/quke) with lib/features. For example __dir__ returns
+      # '/Users/acruikshanks/projects/defra/quke/lib/quke' but we need Cucumber
+      # to load '/Users/acruikshanks/projects/defra/quke/lib/features'
+      # We then pass this full path to Cucumber so it can correctly find the
+      # folder holding our predefined env.rb file.
+      env_folder = __dir__.sub!("lib/quke", "lib/features")
+      fail_fast = "--fail-fast" if stop_on_error
+      print_format = print_progress ? "progress" : "pretty"
+      "#{fail_fast} --format #{print_format} -r #{env_folder} -r #{features_folder} #{additional_args.join(' ')}".strip
     end
 
+    private
+
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
@@ -212,7 +247,7 @@ module Quke #:nodoc:
         "app_host" => (data["app_host"] || "").downcase.strip,
         "driver" => (data["driver"] || "phantomjs").downcase.strip,
         "headless" => (data["headless"].to_s.downcase.strip == "true"),
-        "parallel" => (data["parallel"].to_s.downcase.strip == "true"),
+        "print_progress" => (data["print_progress"].to_s.downcase.strip == "true"),
         "pause" => (data["pause"] || "0").to_s.downcase.strip.to_i,
         "stop_on_error" => (data["stop_on_error"] || "false").to_s.downcase.strip,
         "max_wait_time" => (data["max_wait_time"] || Capybara.default_max_wait_time).to_s.downcase.strip.to_i,
@@ -224,6 +259,7 @@ module Quke #:nodoc:
         # Else the condition fails and we get 'false', which when flipped gives
         # us 'true', which is what we want the default value to be
         # rubocop:disable Style/InverseMethods
+        "display_failures" => !(data["display_failures"].to_s.downcase.strip == "false"),
         "javascript_errors" => !(data["javascript_errors"].to_s.downcase.strip == "false"),
         # rubocop:enable Style/InverseMethods
         "custom" => (data["custom"] || nil)
@@ -233,15 +269,6 @@ module Quke #:nodoc:
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
 
-    def proxy_data(data)
-      data = {} if data.nil?
-      data.merge(
-        "host" => (data["host"] || "").downcase.strip,
-        "port" => (data["port"] || "0").to_s.downcase.strip.to_i,
-        "no_proxy" => (data["no_proxy"] || "").downcase.strip
-      )
-    end
-
     def load_yml_data
       if File.exist? self.class.file_location
         # YAML.load_file returns false if the file exists but is empty. So

data/lib/quke/cuke_runner.rb

@@ -8,9 +8,6 @@ module Quke #:nodoc:
   # Handles executing Cucumber, including sorting the arguments we pass to it
   class CukeRunner
 
-    # Access the arguments used by Quke when it was executed
-    attr_reader :args
-
     # When an instance of CukeRunner is initialized it will take the arguments
     # passed in and combine them with its own default args. Those args are a mix
     # of ones specific to ParallelTests, and ones for Cucumber.
@@ -36,7 +33,7 @@ module Quke #:nodoc:
     #       parallel.
     def initialize(passed_in_args = [])
       Quke.config = Configuration.new
-      @args = parallel_args + test_options_args(passed_in_args)
+      @args = Quke.config.parallel.command_args(passed_in_args)
     end
 
     # Executes ParallelTests, which in turn executes Cucumber passing in the
@@ -48,38 +45,6 @@ module Quke #:nodoc:
       raise StandardError, "Cucumber exited in a failed state" unless e.success?
     end
 
-    private
-
-    def parallel_args
-      args = [
-        Quke.config.features_folder,
-        "--type", "cucumber",
-        "--serialize-stdout",
-        "--combine-stderr"
-      ]
-      args += ["--single", "--quiet"] unless Quke.config.parallel
-      args
-    end
-
-    def test_options_args(passed_in_args)
-      # Because cucumber is called in the context of the executing project and
-      # not Quke it will take its arguments in the context of that location, and
-      # not from where the Quke currently sits. This means to Cucumber
-      # 'lib/features' doesn't exist, which means our env.rb never gets loaded.
-      # Instead we first have to determine where this file is running from when
-      # called, then we simply replace the last part of that result (which we
-      # know will be lib/quke) with lib/features. For example __dir__ returns
-      # '/Users/acruikshanks/projects/defra/quke/lib/quke' but we need Cucumber
-      # to load '/Users/acruikshanks/projects/defra/quke/lib/features'
-      # We then pass this full path to Cucumber so it can correctly find the
-      # folder holding our predefined env.rb file.
-      env_folder = __dir__.sub!("lib/quke", "lib/features")
-      [
-        "--test-options",
-        "--format pretty -r #{env_folder} -r #{Quke.config.features_folder} #{passed_in_args.join(' ')}"
-      ]
-    end
-
   end
 
 end

data/lib/quke/driver_configuration.rb

@@ -112,7 +112,7 @@ module Quke #:nodoc:
         "--ignore-ssl-errors=yes"
       ]
 
-      options.push("--proxy=#{config.proxy['host']}:#{config.proxy['port']}") if config.use_proxy?
+      options.push("--proxy=#{config.proxy.host}:#{config.proxy.port}") if config.proxy.use_proxy?
 
       options
     end
@@ -147,15 +147,13 @@ module Quke #:nodoc:
     #     )
     #
     def chrome
-      host = config.proxy["host"]
-      port = config.proxy["port"]
-      no_proxy = config.proxy["no_proxy"].tr(",", ";")
+      no_proxy = config.proxy.no_proxy.tr(",", ";")
 
       options = Selenium::WebDriver::Chrome::Options.new
       options.headless! if config.headless
 
-      options.add_argument("--proxy-server=#{host}:#{port}") if config.use_proxy?
-      options.add_argument("--proxy-bypass-list=#{no_proxy}") unless config.proxy["no_proxy"].empty?
+      options.add_argument("--proxy-server=#{config.proxy.host}:#{config.proxy.port}") if config.proxy.use_proxy?
+      options.add_argument("--proxy-bypass-list=#{no_proxy}") unless config.proxy.no_proxy.empty?
 
       options.add_argument("--user-agent=#{config.user_agent}") unless config.user_agent.empty?
 
@@ -249,12 +247,7 @@ module Quke #:nodoc:
       profile = Selenium::WebDriver::Firefox::Profile.new
       profile["general.useragent.override"] = config.user_agent unless config.user_agent.empty?
 
-      settings = {}
-      settings[:http] = "#{config.proxy['host']}:#{config.proxy['port']}" if config.use_proxy?
-      settings[:ssl] = settings[:http] if config.use_proxy?
-      settings[:no_proxy] = config.proxy["no_proxy"] unless config.proxy["no_proxy"].empty?
-
-      profile.proxy = Selenium::WebDriver::Proxy.new(settings) if config.use_proxy?
+      profile.proxy = Selenium::WebDriver::Proxy.new(config.proxy.firefox_settings) if config.proxy.use_proxy?
 
       profile
     end

data/lib/quke/parallel_configuration.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "quke/configuration"
+
+module Quke #:nodoc:
+
+  # Manages all parallel configuration for Quke.
+  class ParallelConfiguration
+
+    # Whether use of parallel tests has been enabled
+    attr_reader :enabled
+    # How to group the tests. Default is features
+    attr_reader :group_by
+    # How many processes to start. Default is 0 which means we will leave
+    # ParallelTests to determine the number.
+    attr_reader :processes
+
+    def initialize(config)
+      @config = config
+      data = @config.data["parallel"] || {}
+      @enabled = (data["enable"].to_s.downcase.strip == "true")
+      @group_by = (data["group_by"] || "default").downcase.strip
+      @processes = (data["processes"] || "0").to_s.downcase.strip.to_i
+    end
+
+    # Returns an array of arguments, correctly ordered for passing to
+    # +ParallelTests::CLI.new.run()+.
+    #
+    # The arguments are based on the values set for the parallel configuration
+    # plus those passed in. It then orders them in an order that makes sense to
+    # parallel tests.
+    def command_args(additional_args = [])
+      args = standard_args(@config.features_folder)
+      args += ["--single", "--quiet"] unless @enabled
+      args += ["--group-by", @group_by] unless @group_by == "default"
+      args += ["-n", @processes.to_s] if @enabled && @processes.positive?
+      args + ["--test-options", @config.cucumber_arg(additional_args)]
+    end
+
+    private
+
+    def standard_args(features_folder)
+      [
+        features_folder,
+        "--type", "cucumber",
+        "--serialize-stdout",
+        "--combine-stderr"
+      ]
+    end
+
+  end
+
+end

data/lib/quke/proxy_configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Quke #:nodoc:
+
+  # Manages all parallel configuration for Quke.
+  class ProxyConfiguration
+
+    # The host address for the proxy server
+    attr_reader :host
+
+    # The port number for the proxy server
+    attr_reader :port
+
+    # In some cases you may also need to tell the driver not to use the proxy for local
+    # or specific connections. This returns a comma separated list of addresses of
+    # those addresses if set.
+    attr_reader :no_proxy
+
+    def initialize(data = {})
+      @host = (data["host"] || "").downcase.strip
+      @port = (data["port"] || "0").to_s.downcase.strip.to_i
+      @no_proxy = (data["no_proxy"] || "").downcase.strip
+    end
+
+    # Return true if the +host+ value has been set in the +.config.yml+
+    # file, else false.
+    #
+    # It is mainly used when determining whether to apply proxy server settings
+    # to the different drivers when registering them with Capybara.
+    def use_proxy?
+      @host != ""
+    end
+
+    # Returns a hash of settings specific to initialising a
+    # +Selenium::WebDriver::Proxy+ instance, which will be created as part of
+    # registering the Selenium firefox driver
+    def firefox_settings
+      settings = {}
+      return settings unless use_proxy?
+
+      settings[:http] = "#{host}:#{port}"
+      settings[:ssl] = settings[:http]
+      settings[:no_proxy] = no_proxy unless no_proxy.empty?
+
+      settings
+    end
+
+  end
+
+end

data/lib/quke/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Quke #:nodoc:
-  VERSION = "0.9.1"
+  VERSION = "0.10.0"
 end

data/spec/quke/configuration_spec.rb

@@ -74,71 +74,101 @@ RSpec.describe Quke::Configuration do
     end
   end
 
-  describe "#parallel" do
+  describe "#pause" do
     context "when NOT specified in the config file" do
-      it "defaults to false" do
+      it "defaults to 0" do
         Quke::Configuration.file_location = data_path(".no_file.yml")
-        expect(subject.parallel).to eq(false)
+        expect(subject.pause).to eq(0)
       end
     end
 
-    context "when specified in the config file" do
+    context "when specified in config file" do
       it "matches the config file" do
-        Quke::Configuration.file_location = data_path(".parallel.yml")
-        expect(subject.parallel).to eq(true)
+        Quke::Configuration.file_location = data_path(".simple.yml")
+        expect(subject.pause).to eq(1)
       end
     end
 
     context "when in the config file as a string" do
       it "matches the config file" do
         Quke::Configuration.file_location = data_path(".as_string.yml")
-        expect(subject.parallel).to eq(true)
+        expect(subject.pause).to eq(1)
       end
     end
   end
 
-  describe "#pause" do
+  describe "#stop_on_error" do
     context "when NOT specified in the config file" do
-      it "defaults to 0" do
+      it "defaults to false" do
         Quke::Configuration.file_location = data_path(".no_file.yml")
-        expect(subject.pause).to eq(0)
+        expect(subject.stop_on_error).to eq(false)
       end
     end
 
     context "when specified in config file" do
       it "matches the config file" do
         Quke::Configuration.file_location = data_path(".simple.yml")
-        expect(subject.pause).to eq(1)
+        expect(subject.stop_on_error).to eq(true)
       end
     end
 
     context "when in the config file as a string" do
       it "matches the config file" do
         Quke::Configuration.file_location = data_path(".as_string.yml")
-        expect(subject.pause).to eq(1)
+        expect(subject.stop_on_error).to eq(true)
       end
     end
   end
 
-  describe "#stop_on_error" do
+  describe "#display_failures" do
     context "when NOT specified in the config file" do
-      it "defaults to false" do
+      it "defaults to true" do
         Quke::Configuration.file_location = data_path(".no_file.yml")
-        expect(subject.stop_on_error).to eq(false)
+        expect(subject.display_failures).to eq(true)
       end
     end
 
-    context "when specified in config file" do
+    context "when specified in the config file" do
       it "matches the config file" do
-        Quke::Configuration.file_location = data_path(".simple.yml")
-        expect(subject.stop_on_error).to eq(true)
+        Quke::Configuration.file_location = data_path(".display_failures.yml")
+        expect(subject.display_failures).to eq(false)
       end
     end
 
     context "when in the config file as a string" do
       it "matches the config file" do
         Quke::Configuration.file_location = data_path(".as_string.yml")
-        expect(subject.stop_on_error).to eq(true)
+        expect(subject.display_failures).to eq(false)
+      end
+    end
+  end
+
+  describe "#display_failures?" do
+    context "when `headless` is false and `display_failures` is false" do
+      it "returns false" do
+        Quke::Configuration.file_location = data_path(".display_failures.yml")
+        expect(subject.display_failures?).to eq(false)
+      end
+    end
+
+    context "when `headless` is true and `display_failures` is false" do
+      it "returns false" do
+        Quke::Configuration.file_location = data_path(".as_string.yml")
+        expect(subject.display_failures?).to eq(false)
+      end
+    end
+
+    context "when `headless` is false and `display_failures` is true" do
+      it "returns false" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.display_failures?).to eq(true)
+      end
+    end
+
+    context "when `headless` is true and `display_failures` is true" do
+      it "returns false" do
+        Quke::Configuration.file_location = data_path(".should_display_failures.yml")
+        expect(subject.display_failures?).to eq(false)
       end
     end
   end
@@ -205,49 +235,25 @@ RSpec.describe Quke::Configuration do
     end
   end
 
-  describe "#proxy" do
+  describe "#print_progress" do
     context "when NOT specified in the config file" do
-      it "defaults to blank values" do
+      it "defaults to false" do
         Quke::Configuration.file_location = data_path(".no_file.yml")
-        expect(subject.proxy).to eq("host" => "", "port" => 0, "no_proxy" => "")
+        expect(subject.print_progress).to eq(false)
       end
     end
 
     context "when specified in the config file" do
       it "matches the config file" do
-        Quke::Configuration.file_location = data_path(".proxy.yml")
-        expect(subject.proxy).to eq(
-          "host" => "10.10.2.70",
-          "port" => 8080,
-          "no_proxy" => "127.0.0.1,192.168.0.1"
-        )
+        Quke::Configuration.file_location = data_path(".print_progress.yml")
+        expect(subject.print_progress).to eq(true)
       end
     end
 
-    context "when port is specified in the config file as a string" do
+    context "when in the config file as a string" do
       it "matches the config file" do
         Quke::Configuration.file_location = data_path(".as_string.yml")
-        expect(subject.proxy).to eq(
-          "host" => "",
-          "port" => 8080,
-          "no_proxy" => ""
-        )
-      end
-    end
-  end
-
-  describe "#use_proxy?" do
-    context "when proxy host details are NOT specified in the config file" do
-      it "returns false" do
-        Quke::Configuration.file_location = data_path(".no_file.yml")
-        expect(subject.use_proxy?).to eq(false)
-      end
-    end
-
-    context "when proxy host details are specified in the config file" do
-      it "returns true" do
-        Quke::Configuration.file_location = data_path(".proxy_basic.yml")
-        expect(subject.use_proxy?).to eq(true)
+        expect(subject.print_progress).to eq(true)
       end
     end
   end
@@ -306,6 +312,39 @@ RSpec.describe Quke::Configuration do
     end
   end
 
+  describe "#cucumber_arg" do
+    let(:default_arg) { "--format pretty -r #{File.join(Dir.pwd, 'lib', 'features')} -r features" }
+    let(:additional_args) { ["--tags", "@wip"] }
+
+    context "when there are no additional arguments" do
+      it "returns the default cucumber arg value" do
+        Quke::Configuration.file_location = data_path(".no-file.yml")
+        expect(subject.cucumber_arg([])).to eq(default_arg)
+      end
+    end
+
+    context "when `stop_on_error` is true" do
+      it "returns the default cucumber arg value including the '--fail-fast' option" do
+        Quke::Configuration.file_location = data_path(".stop_on_error.yml")
+        expect(subject.cucumber_arg([])).to eq("--fail-fast #{default_arg}")
+      end
+    end
+
+    context "when `print_progress` is true" do
+      it "returns the default cucumber arg value including the '--format progress' option" do
+        Quke::Configuration.file_location = data_path(".print_progress.yml")
+        expect(subject.cucumber_arg([])).to include("--format progress")
+      end
+    end
+
+    context "when there are additional arguments" do
+      it "returns the default cucumber arg value plus the arguments" do
+        Quke::Configuration.file_location = data_path(".no-file.yml")
+        expect(subject.cucumber_arg(additional_args)).to eq("#{default_arg} #{additional_args.join(' ')}")
+      end
+    end
+  end
+
   describe ".file_name" do
     context "environment variable not set" do
       it "returns the default value '.config.yml'" do

data/spec/quke/driver_configuration_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe Quke::DriverConfiguration do
             "--load-images=no",
             "--disk-cache=false",
             "--ignore-ssl-errors=yes",
-            "--proxy=#{config.proxy['host']}:#{config.proxy['port']}"
+            "--proxy=#{config.proxy.host}:#{config.proxy.port}"
           ],
           inspector: true
         )
@@ -88,7 +88,7 @@ RSpec.describe Quke::DriverConfiguration do
             "--load-images=no",
             "--disk-cache=false",
             "--ignore-ssl-errors=yes",
-            "--proxy=#{config.proxy['host']}:#{config.proxy['port']}"
+            "--proxy=#{config.proxy.host}:#{config.proxy.port}"
           ]
         )
       end
@@ -126,7 +126,7 @@ RSpec.describe Quke::DriverConfiguration do
         config = Quke::Configuration.new
         expect(Quke::DriverConfiguration.new(config).chrome.args).to eq(
           Set[
-            "--proxy-server=#{config.proxy['host']}:#{config.proxy['port']}"
+            "--proxy-server=#{config.proxy.host}:#{config.proxy.port}"
           ]
         )
       end
@@ -138,7 +138,7 @@ RSpec.describe Quke::DriverConfiguration do
         config = Quke::Configuration.new
         expect(Quke::DriverConfiguration.new(config).chrome.args).to eq(
           Set[
-            "--proxy-server=#{config.proxy['host']}:#{config.proxy['port']}",
+            "--proxy-server=#{config.proxy.host}:#{config.proxy.port}",
             "--proxy-bypass-list=127.0.0.1;192.168.0.1"
           ]
         )

data/spec/quke/parallel_configuration_spec.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Quke::ParallelConfiguration do
+  describe "instantiating" do
+    context "when `.config.yml` is blank or contains no parallel section" do
+      subject do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "returns an instance defaulted to blank values" do
+        expect(subject.enabled).to eq(false)
+        expect(subject.group_by).to eq("default")
+        expect(subject.processes).to eq(0)
+      end
+
+    end
+
+    context "when `.config.yml` contains a parallel section" do
+      subject do
+        Quke::Configuration.file_location = data_path(".simple.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "returns an instance with properties that match the input" do
+        expect(subject.enabled).to eq(true)
+        expect(subject.group_by).to eq("scenarios")
+        expect(subject.processes).to eq(4)
+      end
+
+    end
+
+    context "when `.config.yml` contains a parallel section where processes is entered as a string" do
+      subject do
+        Quke::Configuration.file_location = data_path(".as_string.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "returns an instance processes set as a number" do
+        expect(subject.processes).to eq(4)
+      end
+
+    end
+  end
+
+  describe "#command_args" do
+    context "when the instance has been instantiated with no data" do
+      subject do
+        Quke::Configuration.file_location = data_path(".no-file.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "returns an array of default args for ParallelTests" do
+        expect(subject.command_args).to match_array(
+          [
+            "features",
+            "--type",
+            "cucumber",
+            "--serialize-stdout",
+            "--combine-stderr",
+            "--single",
+            "--quiet",
+            "--test-options",
+            "--format pretty -r #{File.join(Dir.pwd, 'lib', 'features')} -r features"
+          ]
+        )
+      end
+
+    end
+
+    context "when the instance has been instantiated with parallel enabled" do
+      subject do
+        Quke::Configuration.file_location = data_path(".parallel.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "returns an array without the args '--single' and '--quiet'" do
+        args = subject.command_args
+        expect(args).not_to include(["--single", "--quiet"])
+      end
+
+    end
+
+    context "when the instance has been instantiated with group_by set" do
+      subject do
+        Quke::Configuration.file_location = data_path(".parallel.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "returns an array with the args '--group-by' and 'scenarios'" do
+        args = subject.command_args
+        expect(args).to include("--group-by", "scenarios")
+      end
+
+    end
+
+    context "when the instance has been instantiated with processes set" do
+      subject do
+        Quke::Configuration.file_location = data_path(".parallel.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "returns an array with the args '-n' and '4'" do
+        args = subject.command_args
+        expect(args).to include("-n", "4")
+      end
+
+    end
+
+    context "when the instance has been instantiated with processes set but parallel disabled" do
+      subject do
+        Quke::Configuration.file_location = data_path(".parallel_disabled.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "returns an array without the args '-n' and '4'" do
+        args = subject.command_args
+        expect(args).not_to include("-n", "4")
+      end
+
+    end
+
+    context "when additional arguments are passed in" do
+      let(:additional_args) { ["--tags", "@wip"] }
+      subject do
+        Quke::Configuration.file_location = data_path(".no-file.yml")
+        Quke::Configuration.new.parallel
+      end
+
+      it "the last argument contains those values" do
+        args = subject.command_args(additional_args)
+        expect(args.last).to include(additional_args.join(" "))
+      end
+
+    end
+  end
+end

data/spec/quke/proxy_configuration_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Quke::ProxyConfiguration do
+  describe "instantiating" do
+    context "when `.config.yml` is blank or contains no parallel section" do
+      subject do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        Quke::Configuration.new.proxy
+      end
+
+      it "returns an instance defaulted to blank values" do
+        expect(subject.host).to eq("")
+        expect(subject.port).to eq(0)
+        expect(subject.no_proxy).to eq("")
+      end
+
+    end
+
+    context "when `.config.yml` contains a proxy section" do
+      subject do
+        Quke::Configuration.file_location = data_path(".proxy.yml")
+        Quke::Configuration.new.proxy
+      end
+
+      it "returns an instance with properties that match the input" do
+        expect(subject.host).to eq("10.10.2.70")
+        expect(subject.port).to eq(8080)
+        expect(subject.no_proxy).to eq("127.0.0.1,192.168.0.1")
+      end
+
+    end
+
+    context "when `.config.yml` contains a proxy section where port is entered as a string" do
+      subject do
+        Quke::Configuration.file_location = data_path(".as_string.yml")
+        Quke::Configuration.new.proxy
+      end
+
+      it "returns an instance with port set as a number" do
+        expect(subject.port).to eq(8080)
+      end
+
+    end
+  end
+
+  describe "#use_proxy?" do
+    context "when the instance has been instantiated with no data" do
+      subject { Quke::ProxyConfiguration.new }
+
+      it "returns false" do
+        expect(subject.use_proxy?).to eq(false)
+      end
+    end
+
+    context "when the instance has been instantiated with 'host' set" do
+      subject { Quke::ProxyConfiguration.new("host" => "10.10.2.70") }
+
+      it "returns true" do
+        expect(subject.use_proxy?).to eq(true)
+      end
+    end
+  end
+
+  describe "#firefox_settings" do
+    context "when the instance has been instantiated with no data" do
+      subject { Quke::ProxyConfiguration.new }
+
+      it "returns an empty hash" do
+        expect(subject.firefox_settings).to eq({})
+      end
+    end
+
+    context "when the instance has been instantiated with everything but 'host'" do
+      subject { Quke::ProxyConfiguration.new("port" => "8080", "no_proxy" => "127.0.0.1") }
+
+      it "returns an empty hash" do
+        expect(subject.firefox_settings).to eq({})
+      end
+    end
+
+    context "when the instance has been instantiated with data" do
+      subject do
+        Quke::ProxyConfiguration.new(
+          "host" => "10.10.2.70",
+          "port" => "8080",
+          "no_proxy" => "127.0.0.1"
+        )
+      end
+
+      it "returns a correctly populated hash" do
+        expect(subject.firefox_settings).to eq(
+          http: "10.10.2.70:8080",
+          ssl: "10.10.2.70:8080",
+          no_proxy: "127.0.0.1"
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quke
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Defra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -305,13 +305,16 @@ files:
 - lib/quke/cuke_runner.rb
 - lib/quke/driver_configuration.rb
 - lib/quke/driver_registration.rb
+- lib/quke/parallel_configuration.rb
+- lib/quke/proxy_configuration.rb
 - lib/quke/version.rb
 - spec/quke/browserstack_configuration_spec.rb
 - spec/quke/browserstack_status_reporter_spec.rb
 - spec/quke/configuration_spec.rb
-- spec/quke/cuke_runner_spec.rb
 - spec/quke/driver_configuration_spec.rb
 - spec/quke/driver_registration_spec.rb
+- spec/quke/parallel_configuration_spec.rb
+- spec/quke/proxy_configuration_spec.rb
 - spec/quke/quke_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
@@ -344,11 +347,12 @@ specification_version: 4
 summary: A gem to simplify creating acceptance tests using Cucumber
 test_files:
 - spec/quke/browserstack_configuration_spec.rb
+- spec/quke/proxy_configuration_spec.rb
 - spec/quke/quke_spec.rb
+- spec/quke/parallel_configuration_spec.rb
 - spec/quke/browserstack_status_reporter_spec.rb
 - spec/quke/driver_registration_spec.rb
 - spec/quke/driver_configuration_spec.rb
-- spec/quke/cuke_runner_spec.rb
 - spec/quke/configuration_spec.rb
 - spec/spec_helper.rb
 - spec/support/simplecov.rb

data/spec/quke/cuke_runner_spec.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe Quke::CukeRunner do
-  let(:default_args) do
-    features_folder = __dir__.sub!("spec/quke", "lib/features")
-    ["features", "--type", "cucumber", "--serialize-stdout", "--combine-stderr", "--single", "--quiet", "--test-options", "--format pretty -r #{features_folder} -r features "]
-  end
-  describe "#initialize" do
-    context "no additional Cucumber arguments passed" do
-      let(:subject) { Quke::CukeRunner.new }
-      it "returns just the default args used by Quke" do
-        expect(subject.args).to eq(default_args)
-      end
-    end
-    context "additional Cucumber arguments passed" do
-      let(:args) { ["--tags", "test"] }
-      let!(:subject) { Quke::CukeRunner.new(args) }
-      it "returns the default args plus those passed in" do
-        expected_args = default_args
-        expected_args[-1] = expected_args.last + args.join(" ")
-        expect(subject.args).to eq(expected_args)
-      end
-    end
-  end
-end