quke 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92924c30819da5865d06a787f986c377541f613d
-  data.tar.gz: 9924bc07ec76c5573448d76d6e995c7faea1eb15
+  metadata.gz: 788a40b36b5d925581baeb7a01057bde80f88c37
+  data.tar.gz: 8ff6730baa7ec2a2fd4f02d07759dc2848bd51e1
 SHA512:
-  metadata.gz: 93d1b01b7843ea02c2b2d3950d64366813b74d682bab6b8ae302ef6a35784ec0b6fa94fab08cdcd15259ed9789a358200b25a58564a7d184103bc7ae47b1549d
-  data.tar.gz: c9e70d154ccf11cead106c4d3819ae32ac2bacc2942ee3bd7d35470e25561c15b50fc99f2eaa562450c74f5273214a010370b8ab76371176c5bbfe5cecf66c2e
+  metadata.gz: 9fd084be888bc7c7d17fa3fcf3ee2bc3de23c8d735aad227cc8c15d0ed998f8d2631f35504432e3b28e1cb35aa1bebee730ef75556696c3f8f1e196abaefb36a
+  data.tar.gz: e7c0d4cf0c1f46c05173d908252cb3ff8714e868d8f6db755372a972804218b78800db70da3b10074b1217231350c17de2e4ee0b80b1a7ee126ca5aac8c2dcf1

data/exe/quke

@@ -5,7 +5,5 @@
 # rubocop:enable Layout/LeadingCommentSpace
 
 require "quke"
-require "quke/configuration"
 
-Quke::Quke.config = Quke::Configuration.new
 Quke::Quke.execute(ARGV)

data/lib/features/support/env.rb

@@ -3,12 +3,15 @@
 require "rspec/expectations"
 require "capybara/cucumber"
 require "site_prism"
+require "quke"
 require "quke/configuration"
 require "quke/driver_configuration"
 require "quke/driver_registration"
 require "browserstack/local"
 require "quke/browserstack_status_reporter"
 
+Quke::Quke.config = Quke::Configuration.new
+
 Capybara.app_host = Quke::Quke.config.app_host unless Quke::Quke.config.app_host.empty?
 
 driver_config = Quke::DriverConfiguration.new(Quke::Quke.config)

data/lib/quke.rb

@@ -2,6 +2,7 @@
 
 require "selenium/webdriver"
 require "chromedriver-helper"
+require "byebug"
 
 require "quke/version"
 require "quke/browserstack_configuration"
@@ -25,7 +26,7 @@ module Quke #:nodoc:
 
     # The entry point for Quke, it is the one call made by +exe/quke+.
     def self.execute(args = [])
-      cuke = CukeRunner.new(@config.features_folder, args)
+      cuke = CukeRunner.new(args)
       cuke.run
     end
 

data/lib/quke/configuration.rb

@@ -87,6 +87,21 @@ 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
@@ -197,6 +212,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"),
         "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,

data/lib/quke/cuke_runner.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
 require "cucumber"
+require "parallel_tests"
 
 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
+    # 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.
+    # passed in and combine them with its own default args. Those args are a mix
+    # of ones specific to ParallelTests, and ones for Cucumber.
     #
-    # The default args add the following to the parameters passed to Cucumber
+    # In essence we are getting ParallelTests to pass the following to Cucumber
+    # along with whatever args are passed in when Quke is called.
     #
     #     [my_features_folder, '-r', 'lib/features', '-r', my_features_folder]
     #
@@ -28,33 +31,55 @@ module Quke #:nodoc:
     #       firefox locally
     #   - +-r my_features_folder+, if you specify a different folder for
     #       or wish to test just specific features, you are required by Cucumber
-    #       to also require the folder which contains your steps
-    # features directory contains the +env.rb+
-    def initialize(features_folder, args = [])
-      @args = [
-        features_folder,
-        # Because cucumber is called in the context of the executing script it
-        # will take the next argument from that position, not from where the gem
-        # 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. We then pass this full path to Cucumber so it can
-        # correctly find the folder holding our predefined env.rb file.
-        "-r", __dir__.sub!("lib/quke", "lib/features"),
-        "-r", features_folder
-      ] + args
+    #       to also require the folder which contains your steps. So we always
+    #       set this to be sure to handle tagged scenarios, or features run in
+    #       parallel.
+    def initialize(passed_in_args = [])
+      Quke.config = Configuration.new
+      @args = parallel_args + test_options_args(passed_in_args)
     end
 
-    # Executes Cucumber, passing in the arguments hash set when the instance of
-    # CukeRunner was created.
+    # Executes ParallelTests, which in turn executes Cucumber passing in the
+    # arguments defined when the instance of CukeRunner was initialized.
     def run
-      Cucumber::Cli::Main.new(@args).execute!
+      ParallelTests::CLI.new.run(@args)
     rescue SystemExit => e
       # Cucumber calls @kernel.exit() killing your script unless you rescue
       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/version.rb

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

data/spec/quke/configuration_spec.rb

@@ -74,6 +74,29 @@ RSpec.describe Quke::Configuration do
     end
   end
 
+  describe "#parallel" do
+    context "when NOT specified in the config file" do
+      it "defaults to false" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.parallel).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(".parallel.yml")
+        expect(subject.parallel).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.parallel).to eq(true)
+      end
+    end
+  end
+
   describe "#pause" do
     context "when NOT specified in the config file" do
       it "defaults to 0" do

data/spec/quke/cuke_runner_spec.rb

@@ -5,32 +5,23 @@ require "spec_helper"
 RSpec.describe Quke::CukeRunner do
   let(:default_args) do
     features_folder = __dir__.sub!("spec/quke", "lib/features")
-    ["spec", "-r", features_folder, "-r", "spec"]
+    ["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("spec") }
+      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("spec", args) }
+      let!(:subject) { Quke::CukeRunner.new(args) }
       it "returns the default args plus those passed in" do
-        expect(subject.args).to eq(default_args + args)
+        expected_args = default_args
+        expected_args[-1] = expected_args.last + args.join(" ")
+        expect(subject.args).to eq(expected_args)
       end
     end
   end
-
-  describe "#run" do
-    before(:example) do
-      Quke::Configuration.file_location = data_path(".no_file.yml")
-      Quke::Quke.config = Quke::Configuration.new
-    end
-    let(:subject) { Quke::CukeRunner.new("spec") }
-    it "does not raise an error when called" do
-      expect { subject.run }.not_to raise_error
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quke
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Defra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.28'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement