quke 0.6.0 → 0.7.0

data/lib/quke/cuke_runner.rb

@@ -1,4 +1,6 @@
-require 'cucumber'
+# frozen_string_literal: true
+
+require "cucumber"
 
 module Quke #:nodoc:
 
@@ -39,8 +41,8 @@ module Quke #:nodoc:
         # 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
+        "-r", __dir__.sub!("lib/quke", "lib/features"),
+        "-r", features_folder
       ] + args
     end
 
@@ -50,7 +52,7 @@ module Quke #:nodoc:
       Cucumber::Cli::Main.new(@args).execute!
     rescue SystemExit => e
       # Cucumber calls @kernel.exit() killing your script unless you rescue
-      raise StandardError, 'Cucumber exited in a failed state' unless e.success?
+      raise StandardError, "Cucumber exited in a failed state" unless e.success?
     end
 
   end

data/lib/quke/driver_configuration.rb

@@ -1,4 +1,6 @@
-require 'quke/configuration'
+# frozen_string_literal: true
+
+require "quke/configuration"
 
 module Quke #:nodoc:
 
@@ -105,9 +107,9 @@ module Quke #:nodoc:
       # mirror those you can actually supply on the command line.
       # http://phantomjs.org/api/command-line.html
       options = [
-        '--load-images=no',
-        '--disk-cache=false',
-        '--ignore-ssl-errors=yes'
+        "--load-images=no",
+        "--disk-cache=false",
+        "--ignore-ssl-errors=yes"
       ]
 
       options.push("--proxy=#{config.proxy['host']}:#{config.proxy['port']}") if config.use_proxy?
@@ -140,22 +142,20 @@ module Quke #:nodoc:
     #       switches: my_driver_config.chrome
     #     )
     #
-    # rubocop:disable Metrics/AbcSize
     def chrome
       result = []
 
-      host = config.proxy['host']
-      port = config.proxy['port']
-      no_proxy = config.proxy['no_proxy'].tr(',', ';')
+      host = config.proxy["host"]
+      port = config.proxy["port"]
+      no_proxy = config.proxy["no_proxy"].tr(",", ";")
 
       result.push("--proxy-server=#{host}:#{port}") if config.use_proxy?
-      result.push("--proxy-bypass-list=#{no_proxy}") unless config.proxy['no_proxy'].empty?
+      result.push("--proxy-bypass-list=#{no_proxy}") unless config.proxy["no_proxy"].empty?
 
       result.push("--user-agent=#{config.user_agent}") unless config.user_agent.empty?
 
       result
     end
-    # rubocop:enable Metrics/AbcSize
 
     # Returns an instance of Selenium::WebDriver::Remote::Capabilities to be
     # used when registering an instance of Capybara::Selenium::Driver,
@@ -184,7 +184,6 @@ module Quke #:nodoc:
     #       profile: my_driver_config.firefox
     #     )
     #
-    # rubocop:disable Metrics/AbcSize
     def firefox
       profile = Selenium::WebDriver::Firefox::Profile.new
 
@@ -192,15 +191,14 @@ module Quke #:nodoc:
 
       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?
+      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['general.useragent.override'] = config.user_agent unless config.user_agent.empty?
+      profile["general.useragent.override"] = config.user_agent unless config.user_agent.empty?
 
       profile
     end
-    # rubocop:enable Metrics/AbcSize
 
     # Returns an instance of Selenium::WebDriver::Remote::Capabilities to be
     # used when registering an instance of Capybara::Selenium::Driver,

data/lib/quke/driver_registration.rb

@@ -1,6 +1,8 @@
-require 'quke/configuration'
-require 'capybara/poltergeist'
-require 'selenium/webdriver'
+# frozen_string_literal: true
+
+require "quke/configuration"
+require "capybara/poltergeist"
+require "selenium/webdriver"
 
 module Quke #:nodoc:
 
@@ -29,11 +31,11 @@ module Quke #:nodoc:
     # When called registers with Capybara the driver specified.
     def register(driver)
       case driver
-      when 'firefox'
+      when "firefox"
         firefox
-      when 'chrome'
+      when "chrome"
         chrome
-      when 'browserstack'
+      when "browserstack"
         browserstack
       else
         phantomjs

data/lib/quke/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Quke #:nodoc:
-  VERSION = '0.6.0'.freeze
+  VERSION = "0.7.0"
 end

data/spec/quke/browserstack_configuration_spec.rb

@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Quke::BrowserstackConfiguration do
+  describe "instantiating" do
+    context "when `.config.yml` is blank or contains no browserstack section" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns an instance defaulted to blank values" do
+        expect(subject.username).to eq("")
+        expect(subject.auth_key).to eq("")
+        expect(subject.local_key).to eq("")
+        expect(subject.capabilities).to eq({})
+      end
+
+    end
+
+    context "when `.config.yml` contains a browserstack section" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".simple.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns an instance with properties that match the input" do
+        expect(subject.username).to eq("jdoe")
+        expect(subject.auth_key).to eq("123456789ABCDE")
+        expect(subject.local_key).to eq("123456789ABCDE")
+        expect(subject.capabilities).to eq(
+          "build" => "Version 1",
+          "project" => "Adding browserstack support",
+          "browserstack.local" => true
+        )
+      end
+
+    end
+
+    context "when `.config.yml` contains a browserstack section but credentials are in env vars" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".browserstack_no_credentials.yml")
+        Quke::Configuration.new
+      end
+      subject do
+        stub_const(
+          "ENV",
+          "BROWSERSTACK_USERNAME" => "tstark",
+          "BROWSERSTACK_AUTH_KEY" => "123456789VWXYZ",
+          "BROWSERSTACK_LOCAL_KEY" => "123456789REDRU"
+        )
+        Quke::BrowserstackConfiguration.new(config)
+      end
+
+      it "returns an instance with properties that match the input" do
+        expect(subject.username).to eq("tstark")
+        expect(subject.auth_key).to eq("123456789VWXYZ")
+        expect(subject.local_key).to eq("123456789REDRU")
+        expect(subject.capabilities).to eq(
+          "build" => "Version 1",
+          "project" => "Adding browserstack support",
+          "browserstack.local" => true
+        )
+      end
+
+    end
+  end
+
+  describe "#test_locally?" do
+    context "when `.config.yml` is blank or contains no browserstack section" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns false" do
+        expect(subject.test_locally?).to eq(false)
+      end
+
+    end
+
+    context "when the driver is not set to 'browserstack' in `.config.yml`" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".simple.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns false" do
+        expect(subject.test_locally?).to eq(false)
+      end
+
+    end
+
+    # Unlike some aspects of Quke's configuration where we handle users mixing
+    # strings and booleans ('true' and true) for setting values, because the
+    # browserstack capabilities are passed straight through we return false
+    # in this scenario to reflect what browserstack's behaviour would be
+    # i.e. it would fail to recognise that running locally is needed.
+    context "when the driver is 'browserstack' and use local testing is set to 'true' (a string) in `.config.yml`" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".as_string.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns false" do
+        expect(subject.test_locally?).to eq(false)
+      end
+
+    end
+
+    context "when the driver is 'browserstack' and use local testing is set to true in `.config.yml`" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".browserstack.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns true" do
+        expect(subject.test_locally?).to eq(true)
+      end
+
+    end
+  end
+
+  describe "local_testing_args" do
+    context "when `.config.yml` is blank or contains no browserstack section" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "defaults to a blank key, and our standard args for the local binary" do
+        expect(subject.local_testing_args).to eq(
+          "key" => "",
+          "force" => "true",
+          "onlyAutomate" => "true",
+          "v" => "true",
+          "logfile" => File.join(Dir.pwd, "/tmp/bowerstack_local_log.txt")
+        )
+      end
+
+    end
+
+    context "when `.config.yml` contains just proxy details" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".proxy_basic.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "defaults to a blank key, our standard args for the local binary, plus the proxy values" do
+        expect(subject.local_testing_args).to eq(
+          "key" => "",
+          "force" => "true",
+          "onlyAutomate" => "true",
+          "v" => "true",
+          "logfile" => File.join(Dir.pwd, "/tmp/bowerstack_local_log.txt"),
+          "proxyHost" => "10.10.2.70",
+          "proxyPort" => "8080"
+        )
+      end
+    end
+
+    context "when `.config.yml` contains both browserstack and proxy details" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".browserstack.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "defaults to a blank key, our standard args for the local binary, plus the proxy values" do
+        expect(subject.local_testing_args).to eq(
+          "key" => "123456789ABCDE",
+          "force" => "true",
+          "onlyAutomate" => "true",
+          "v" => "true",
+          "logfile" => File.join(Dir.pwd, "/tmp/bowerstack_local_log.txt"),
+          "proxyHost" => "10.10.2.70",
+          "proxyPort" => "8080"
+        )
+      end
+
+    end
+  end
+
+  describe "#using_browserstack?" do
+    context "when `.config.yml` is blank" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns false" do
+        expect(subject.using_browserstack?).to eq(false)
+      end
+
+    end
+
+    context "when `.config.yml` DOES NOT specify 'browserstack' as the driver" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".simple.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns false" do
+        expect(subject.using_browserstack?).to eq(false)
+      end
+    end
+
+    context "when `.config.yml` specifies 'browserstack' as the driver" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".browserstack.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns true" do
+        expect(subject.using_browserstack?).to eq(true)
+      end
+
+    end
+  end
+
+  describe "#url" do
+
+    context "when `.config.yml` is blank or contains no browserstack section" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns nil" do
+        expect(subject.url).to eq(nil)
+      end
+    end
+
+    context "when `.config.yml` contains a browserstack section" do
+      let(:config) do
+        Quke::Configuration.file_location = data_path(".browserstack.yml")
+        Quke::Configuration.new
+      end
+      subject { Quke::BrowserstackConfiguration.new(config) }
+
+      it "returns a string for the url to browserstack including the username and password" do
+        expect(subject.url).to eq(
+          "http://jdoe:123456789ABCDE@hub.browserstack.com/wd/hub"
+        )
+      end
+    end
+
+  end
+end

data/spec/quke/browserstack_status_reporter_spec.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Quke::BrowserstackStatusReporter do
+  subject do
+    Quke::Configuration.file_location = data_path(".no_file.yml")
+    config = Quke::BrowserstackConfiguration.new(Quke::Configuration.new)
+    Quke::BrowserstackStatusReporter.new(config)
+  end
+
+  describe "#passed" do
+    context "when the session_id is null" do
+      it "raises an ArgumentError" do
+        expect { subject.passed }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when the session_id is valid" do
+      before(:each) do
+        stub_request(:put, /browserstack/)
+          .with(
+            body: /passed/,
+            headers: {
+              "Accept" => "*/*",
+              "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+              "Authorization" => /Basic/,
+              "Content-Type" => "application/json",
+              "Host" => "www.browserstack.com",
+              "User-Agent" => "Ruby"
+            }
+          )
+          .to_return(status: 200, body: "", headers: {})
+      end
+
+      it "succesfully updates the status to 'passed'" do
+        expect { subject.passed("6a22fe36d84d90ef18858f90f2c9cd2882eb082f") }.not_to raise_error
+      end
+
+      it "returns a message stating a given session's status was set to 'passed'" do
+        result = subject.passed("6a22fe36d84d90ef18858f90f2c9cd2882eb082f")
+        expect(result).to eq("Browserstack session 6a22fe36d84d90ef18858f90f2c9cd2882eb082f status set to \e[32mpassed\e[0m 😀")
+      end
+    end
+
+    context "when the request fails" do
+      before(:each) do
+        stub_request(:put, /browserstack/)
+          .with(
+            body: /passed/,
+            headers: {
+              "Accept" => "*/*",
+              "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+              "Authorization" => /Basic/,
+              "Content-Type" => "application/json",
+              "Host" => "www.browserstack.com",
+              "User-Agent" => "Ruby"
+            }
+          )
+          .to_return(status: 500, body: "", headers: {})
+      end
+
+      it "raises an error" do
+        expect { subject.passed("6a22fe36d84d90ef18858f90f2c9cd2882eb082f") }.to raise_error(StandardError)
+      end
+
+    end
+  end
+
+  describe "#failed" do
+    context "when the session_id is null" do
+      it "raises an ArgumentError" do
+        expect { subject.failed }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when the session_id is valid" do
+      before(:each) do
+        stub_request(:put, /browserstack/)
+          .with(
+            body: /failed/,
+            headers: {
+              "Accept" => "*/*",
+              "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+              "Authorization" => /Basic/,
+              "Content-Type" => "application/json",
+              "Host" => "www.browserstack.com",
+              "User-Agent" => "Ruby"
+            }
+          )
+          .to_return(status: 200, body: "", headers: {})
+      end
+
+      it "succesfully updates the status to 'failed'" do
+        expect { subject.failed("6a22fe36d84d90ef18858f90f2c9cd2882eb082f") }.not_to raise_error
+      end
+
+      it "returns a message stating a given session's status was set to 'failed'" do
+        result = subject.failed("6a22fe36d84d90ef18858f90f2c9cd2882eb082f")
+        expect(result).to eq("Browserstack session 6a22fe36d84d90ef18858f90f2c9cd2882eb082f status set to \e[31mfailed\e[0m 😢")
+      end
+
+    end
+
+    context "when the request fails" do
+      before(:each) do
+        stub_request(:put, /browserstack/)
+          .with(
+            body: /passed/,
+            headers: {
+              "Accept" => "*/*",
+              "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+              "Authorization" => /Basic/,
+              "Content-Type" => "application/json",
+              "Host" => "www.browserstack.com",
+              "User-Agent" => "Ruby"
+            }
+          )
+          .to_return(status: 500, body: "", headers: {})
+      end
+
+      it "raises an error" do
+        expect { subject.passed("6a22fe36d84d90ef18858f90f2c9cd2882eb082f") }.to raise_error(StandardError)
+      end
+
+    end
+
+  end
+end