quke 0.6.0 → 0.7.0

data/spec/quke/configuration_spec.rb

@@ -0,0 +1,270 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Quke::Configuration do
+  describe "#features_folder" do
+    context "when specified NOT specified in config file" do
+      it "defaults to 'features'" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.features_folder).to eq("features")
+      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.features_folder).to eq("spec")
+      end
+    end
+  end
+
+  describe "#app_host" do
+    context "when NOT specified in the config file" do
+      it "defaults to ''" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.app_host).to eq("")
+      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.app_host).to eq("http://localhost:4567")
+      end
+    end
+  end
+
+  describe "#driver" do
+    context "when NOT specified in the config file" do
+      it "defaults to 'phantomjs'" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.driver).to eq("phantomjs")
+      end
+    end
+
+    context "when specified in the config file" do
+      it "matches the config file" do
+        Quke::Configuration.file_location = data_path(".simple.yml")
+        expect(subject.driver).to eq("chrome")
+      end
+    end
+  end
+
+  describe "#pause" do
+    context "when NOT specified in the config file" do
+      it "defaults to 0" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.pause).to eq(0)
+      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)
+      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)
+      end
+    end
+  end
+
+  describe "#stop_on_error" 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.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.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.stop_on_error).to eq(true)
+      end
+    end
+  end
+
+  describe "#max_wait_time" do
+    context "when NOT specified in the config file" do
+      it "defaults to whatever the Capybara default is" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.max_wait_time).to eq(Capybara.default_max_wait_time)
+      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.max_wait_time).to eq(3)
+      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.max_wait_time).to eq(3)
+      end
+    end
+  end
+
+  describe "#user_agent" do
+    context "when NOT specified in the config file" do
+      it "defaults to ''" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.user_agent).to eq("")
+      end
+    end
+
+    context "when specified in the config file" do
+      it "matches the config file" do
+        Quke::Configuration.file_location = data_path(".user_agent.yml")
+        expect(subject.user_agent).to eq("Mozilla/5.0 (MSIE 10.0; Windows NT 6.1; Trident/5.0)")
+      end
+    end
+  end
+
+  describe "#javascrip_errors" do
+    context "when NOT specified in the config file" do
+      it "defaults to true" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.javascript_errors).to eq(true)
+      end
+    end
+
+    context "when specified in config file" do
+      it "matches the config file" do
+        Quke::Configuration.file_location = data_path(".javascript_errors.yml")
+        expect(subject.javascript_errors).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.javascript_errors).to eq(false)
+      end
+    end
+  end
+
+  describe "#proxy" do
+    context "when NOT specified in the config file" do
+      it "defaults to blank values" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.proxy).to eq("host" => "", "port" => 0, "no_proxy" => "")
+      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"
+        )
+      end
+    end
+
+    context "when port is specified 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)
+      end
+    end
+  end
+
+  describe "#custom" do
+    context "when NOT specified in the config file" do
+      it "defaults to nothing" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        expect(subject.custom).to be(nil)
+      end
+    end
+
+    context "when 'custom' in the config file holds simple key value pairs" do
+      it "returns the key value pair if there is just one" do
+        Quke::Configuration.file_location = data_path(".custom_key_value_pair.yml")
+        expect(subject.custom).to eq("my_key" => "my_value")
+      end
+
+      it "returns all key value pairs if there are multiples" do
+        Quke::Configuration.file_location = data_path(".custom_key_value_pairs.yml")
+        expect(subject.custom).to eq(
+          "my_key1" => "my_value1",
+          "my_key2" => "my_value2",
+          "my_key3" => "my_value3",
+          "my_key4" => "my_value4",
+          "my_key5" => "my_value5"
+        )
+      end
+    end
+
+    context "when 'custom' in the config file holds a hierachical object" do
+      it "returns a representation of the object" do
+        Quke::Configuration.file_location = data_path(".custom_complex_object.yml")
+        expect(subject.custom).to eq(
+          "my_key" => "my_value",
+          "accounts" => {
+            "account1" => {
+              "username" => "yoda",
+              "password" => "greenisgood"
+            },
+            "account2" => {
+              "username" => "vadar",
+              "password" => "redrules"
+            },
+            "account3" => {
+              "username" => "luke",
+              "password" => "fatherissues"
+            }
+          },
+          "troop_numbers" => {
+            "dark_side_count" => 1_000_000,
+            "light_side_count" => 5
+          }
+        )
+      end
+    end
+  end
+
+  describe ".file_name" do
+    context "environment variable not set" do
+      it "returns the default value '.config.yml'" do
+        expect(Quke::Configuration.file_name).to eq(".config.yml")
+      end
+    end
+  end
+end

data/spec/quke/cuke_runner_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+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"]
+  end
+  describe "#initialize" do
+    context "no additional Cucumber arguments passed" do
+      let(:subject) { Quke::CukeRunner.new("spec") }
+      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) }
+      it "returns the default args plus those passed in" do
+        expect(subject.args).to eq(default_args + 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

data/spec/quke/driver_configuration_spec.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Quke::DriverConfiguration do
+
+  describe "#poltergeist" do
+
+    context "proxy details have NOT been set in the .config.yml" do
+      it "returns a hash containing only the default options" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).poltergeist).to eq(
+          js_errors: true,
+          timeout: 30,
+          debug: false,
+          phantomjs_options: [
+            "--load-images=no",
+            "--disk-cache=false",
+            "--ignore-ssl-errors=yes"
+          ],
+          inspector: true
+        )
+      end
+    end
+
+    context "proxy details have been set in the .config.yml" do
+      it "returns a hash containing both default options and proxy settings" do
+        Quke::Configuration.file_location = data_path(".proxy_basic.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).poltergeist).to eq(
+          js_errors: true,
+          timeout: 30,
+          debug: false,
+          phantomjs_options: [
+            "--load-images=no",
+            "--disk-cache=false",
+            "--ignore-ssl-errors=yes",
+            "--proxy=#{config.proxy['host']}:#{config.proxy['port']}"
+          ],
+          inspector: true
+        )
+      end
+    end
+
+    context "user has set javascript_errors to false in the .config.yml" do
+      it "returns a hash where js_errors is set to 'false'" do
+        Quke::Configuration.file_location = data_path(".javascript_errors.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).poltergeist).to eq(
+          js_errors: false,
+          timeout: 30,
+          debug: false,
+          phantomjs_options: [
+            "--load-images=no",
+            "--disk-cache=false",
+            "--ignore-ssl-errors=yes"
+          ],
+          inspector: true
+        )
+      end
+    end
+
+  end
+
+  describe "#phantomjs" do
+
+    context "proxy details have NOT been set in the .config.yml" do
+      it "returns an array containing only the default options" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).phantomjs).to eq(
+          [
+            "--load-images=no",
+            "--disk-cache=false",
+            "--ignore-ssl-errors=yes"
+          ]
+        )
+      end
+    end
+
+    context "proxy details have been set in the .config.yml" do
+      it "returns an array containing both default options and proxy settings" do
+        Quke::Configuration.file_location = data_path(".proxy_basic.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).phantomjs).to eq(
+          [
+            "--load-images=no",
+            "--disk-cache=false",
+            "--ignore-ssl-errors=yes",
+            "--proxy=#{config.proxy['host']}:#{config.proxy['port']}"
+          ]
+        )
+      end
+    end
+
+    context "a user agent has been set in the .config.yml" do
+      it "is not in the array returned. Unlike the other drivers we can only override the user agent when registering the driver" do
+        Quke::Configuration.file_location = data_path(".user_agent.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).phantomjs).to eq(
+          [
+            "--load-images=no",
+            "--disk-cache=false",
+            "--ignore-ssl-errors=yes"
+          ]
+        )
+      end
+    end
+
+  end
+
+  describe "#chrome" do
+
+    context "proxy details have NOT been set in the .config.yml" do
+      it "returns an empty array if no proxy has been set" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).chrome).to eq([])
+      end
+    end
+
+    context "basic proxy details have been set in the .config.yml" do
+      it "returns an array containing basic proxy settings" do
+        Quke::Configuration.file_location = data_path(".proxy_basic.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).chrome).to eq(
+          [
+            "--proxy-server=#{config.proxy['host']}:#{config.proxy['port']}"
+          ]
+        )
+      end
+    end
+
+    context "proxy details including addresses not to connect via the proxy server have been set in the .config.yml" do
+      it "returns an array containing proxy settings including no-proxy details" do
+        Quke::Configuration.file_location = data_path(".proxy.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).chrome).to eq(
+          [
+            "--proxy-server=#{config.proxy['host']}:#{config.proxy['port']}",
+            "--proxy-bypass-list=127.0.0.1;192.168.0.1"
+          ]
+        )
+      end
+    end
+
+    context "a user agent has been set in the .config.yml" do
+      it "returns an array containing the specified user-agent" do
+        Quke::Configuration.file_location = data_path(".user_agent.yml")
+        config = Quke::Configuration.new
+        expect(Quke::DriverConfiguration.new(config).chrome).to eq(
+          [
+            "--user-agent=#{config.user_agent}"
+          ]
+        )
+      end
+    end
+
+  end
+
+  describe "#firefox" do
+
+    context "proxy details have NOT been set in the .config.yml" do
+      it "returns a profile where the proxy details are NOT set" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        config = Quke::Configuration.new
+        profile = Quke::DriverConfiguration.new(config).firefox
+
+        # See spec/helpers.rb#read_profile_preferences for details of why we
+        # need to test the profile's properties in this way
+        preferences = read_profile_preferences(profile)
+
+        expect(preferences).not_to include('user_pref("network.proxy.http", "")')
+        expect(preferences).not_to include('user_pref("network.proxy.http_port", 8080)')
+      end
+    end
+
+    context "basic proxy details have been set in the .config.yml" do
+      it "returns a profile where the basic proxy details are set" do
+        Quke::Configuration.file_location = data_path(".proxy_basic.yml")
+        config = Quke::Configuration.new
+        profile = Quke::DriverConfiguration.new(config).firefox
+
+        # See spec/helpers.rb#read_profile_preferences for details of why we
+        # need to test the profile's properties in this way
+        preferences = read_profile_preferences(profile)
+
+        expect(preferences).to include('user_pref("network.proxy.http", "10.10.2.70")')
+        expect(preferences).to include('user_pref("network.proxy.http_port", 8080)')
+      end
+    end
+
+    context "proxy details including addresses not to connect via the proxy server have been set in the .config.yml" do
+      it "returns a profile where the proxy details are set including no-proxy details" do
+        Quke::Configuration.file_location = data_path(".proxy.yml")
+        config = Quke::Configuration.new
+        profile = Quke::DriverConfiguration.new(config).firefox
+
+        # See spec/helpers.rb#read_profile_preferences for details of why we
+        # need to test the profile's properties in this way
+        preferences = read_profile_preferences(profile)
+
+        expect(preferences).to include('user_pref("network.proxy.http", "10.10.2.70")')
+        expect(preferences).to include('user_pref("network.proxy.http_port", 8080)')
+        expect(preferences).to include('user_pref("network.proxy.no_proxies_on", "127.0.0.1,192.168.0.1")')
+      end
+    end
+
+    context "a user agent has been set in the .config.yml" do
+      it "returns an array containing the specified user-agent" do
+        Quke::Configuration.file_location = data_path(".user_agent.yml")
+        config = Quke::Configuration.new
+        profile = Quke::DriverConfiguration.new(config).firefox
+
+        # See spec/helpers.rb#read_profile_preferences for details of why we
+        # need to test the profile's properties in this way
+        preferences = read_profile_preferences(profile)
+
+        expect(preferences).to include(
+          'user_pref("general.useragent.override", "Mozilla/5.0 (MSIE 10.0; Windows NT 6.1; Trident/5.0)")'
+        )
+      end
+    end
+
+  end
+
+  describe "#browserstack" do
+
+    context "browserstack details have NOT been set in the .config.yml" do
+      it "returns capabilities set to Selenium::WebDriver::Remote::Capabilities defaults" do
+        Quke::Configuration.file_location = data_path(".no_file.yml")
+        config = Quke::Configuration.new
+        capabilities = Quke::DriverConfiguration.new(config).browserstack
+
+        expect(capabilities.as_json.keys.count).to eq(8)
+        expect(capabilities["browserName"]).to eq(nil)
+        expect(capabilities["version"]).to eq(nil)
+        expect(capabilities["platform"]).to eq(nil)
+        expect(capabilities["javascriptEnabled"]).to eq(nil)
+        expect(capabilities["cssSelectorsEnabled"]).to eq(nil)
+        expect(capabilities["takesScreenshot"]).to eq(nil)
+        expect(capabilities["nativeEvents"]).to eq(nil)
+        expect(capabilities["rotatable"]).to eq(nil)
+      end
+    end
+
+    context "browserstack details have been set in the .config.yml" do
+      it "returns capabilities that match those set" do
+        Quke::Configuration.file_location = data_path(".browserstack.yml")
+        config = Quke::Configuration.new
+        capabilities = Quke::DriverConfiguration.new(config).browserstack
+        expected_capabilities = YAML.load_file(data_path(".browserstack.yml"))["browserstack"]["capabilities"]
+
+        expect(capabilities["build"]).to eq(expected_capabilities["build"])
+        expect(capabilities["project"]).to eq(expected_capabilities["project"])
+        expect(capabilities["name"]).to eq(expected_capabilities["name"])
+
+        expect(capabilities["acceptSslCerts"]).to eq(expected_capabilities["acceptSslCerts"])
+        expect(capabilities["browserstack.debug"]).to eq(expected_capabilities["browserstack.debug"])
+        expect(capabilities["browserstack.video"]).to eq(expected_capabilities["browserstack.video"])
+        expect(capabilities["browserstack.local"]).to eq(expected_capabilities["browserstack.local"])
+        expect(capabilities["browserstack.maskSendKeys"]).to eq(expected_capabilities["browserstack.maskSendKeys"])
+
+        expect(capabilities["platform"]).to eq(expected_capabilities["platform"])
+        expect(capabilities["browserName"]).to eq(expected_capabilities["browserName"])
+        expect(capabilities["version"]).to eq(expected_capabilities["version"])
+        expect(capabilities["device"]).to eq(expected_capabilities["device"])
+        expect(capabilities["os"]).to eq(expected_capabilities["os"])
+        expect(capabilities["os_version"]).to eq(expected_capabilities["os_version"])
+        expect(capabilities["browser"]).to eq(expected_capabilities["browser"])
+        expect(capabilities["browser_version"]).to eq(expected_capabilities["browser_version"])
+        expect(capabilities["resolution"]).to eq(expected_capabilities["resolution"])
+      end
+    end
+
+  end
+
+end