quke 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd7aa28081edfc9cce4400842782f1c8e853a1b7
-  data.tar.gz: d99e4eacf100a69a276323a80617c15d8534fdb7
+SHA256:
+  metadata.gz: 5b2936d4f14ba229cb09e51e452e38e7bec283d4f451cff78c6e1bdd7db14753
+  data.tar.gz: 23fac38b040117047d0153a53d015e91d7f17d74a55884f7b0dd1efd1b8af597
 SHA512:
-  metadata.gz: cea424d7ee59455d0496808b0b7c6e442984f37db9c834b8c06e75d24c11b6d1414a007fa83a1f988c7e3f1c5c395a880d102912c14b64140ca209f395819ece
-  data.tar.gz: 3d41f20f1c49d414f44f0bd573b8540bcfae9bdecfd4dc1e974cad8d6751f75569e075a52799df4045e13072deb1cf249a12d1c3ab19cb8de0b23b7b3c3a26d6
+  metadata.gz: 1444e484da2cbaca94f551a75dcae882b909762cf090d653edd8cbf0bf1161ad6d6c6a5ceadd41f1cdddd8d4744d601b723a64610288cc76f678a555b9cd8081
+  data.tar.gz: c061de8ca68f54f5063264182e2a340f6f8f0819f47c3e991e6e97cdfaf3e2daf11d8662f9ad402277c97099ced4a1f7b58ef0e7d3212b4f10a98f7880308502

data/.config.example.yml

@@ -96,63 +96,88 @@ proxy:
 # Please see https://www.browserstack.com/automate/capabilities for more details
 browserstack:
   # To run your tests with browserstack you must provide a username and auth_key
-  # as a minimum
+  # as a minimum.
+  # If you don't want to put these credentials in the config file (because you
+  # want to commit it to source control), Quke will also check for the existance
+  # of the environment variables BROWSERSTACK_USERNAME and BROWSERSTACK_AUTH_KEY
   username: jdoe
   auth_key: 123456789ABCDE
 
-  # Keep track of all your automated tests using the build and project
-  # capabilities. Group your tests into builds, and builds further into projects
-  build: 'Version 1'
-  project: 'Adding browserstack support'
-
-  # Allows you to specify an identifier for the test run.
-  # If you intend to repeat a test this might not be that applicable, but in the
-  # case of one off tests it might be useful
-  name: 'Testing google search'
-
-  # MOBILE testing
-  # The docs are a little confusing but essentially if you want to test against
-  # mobile devices you need to define 1 set of capabilities, and if desktop
-  # another
-  # -----
-  # OS you want to test. Accepted values are MAC, WIN8, XP, WINDOWS, ANY, ANDROID
-  # Browserstack default is ANY
-  platform: MAC
-  # Browser you want to test. Accepted values firefox, chrome, internet explorer,
-  # safari, opera, iPad, iPhone, android. Browserstack default is chrome
-  browserName: iPhone
-  # Browser version you want to test. See the docs for the full list of available
-  # versions. Browserstack default is latest stable version of browser selected
-  version: '49'
-  # Device you want to test on. See the docs for the full list of available.
-  device: 'iPhone 5'
-
-  # DESKTOP testing
-  # -----
-  # OS you want to test. Accepted values are WINDOWS, OS X. If both OS and
-  # platform are set, OS will take precedence
-  os: WINDOWS
-  # OS version you want to test. Accepted values are
-  # Windows: XP, 7, 8, 8.1 and 10
-  # OS X: Snow Leopard, Lion, Mountain Lion, Mavericks, Yosemite, El Capitan
-  os_version: '8.1'
-  # Browser you want to test. Accepted values are Firefox, Safari, IE, Chrome,
-  # Opera
-  browser: chrome
-  # Browser version you want to test. See the docs for the full list of
-  # available versions
-  browser_version: '49'
-  # Set the resolution of VM before beginning of your test.
-  # See docs https://www.browserstack.com/automate/capabilities for full list of
-  # accepted values, as it is also OS dependent
-  resolution: '1024x768'
-
-  # To avoid invalid certificate errors while testing set acceptSslCerts to true
-  acceptSslCerts: true
-
-  # Required if you want to generate screenshots at various steps in your test.
-  # Browserstack default is false
-  debug: true
-  # Required if you want to enable video recording during your test.
-  # Browserstack default is true
-  video: true
+  # Anything set under capabilities will be passed directly by Quke to
+  # browserstack as means of configuring the test.
+  # So the config keys (e.g. build, project, name) you set should match a real
+  # browserstack capability, and the value exist in the range it expects. See
+  # for further reference on browserstack capabilities
+  # https://www.browserstack.com/automate/capabilities
+  # https://www.browserstack.com/automate/ruby#configure-capabilities
+  capabilities:
+    # Keep track of all your automated tests using the build and project
+    # capabilities. Group your tests into builds, and builds further into
+    # projects
+    project: 'Adding browserstack support'
+    build: 'Version 1'
+    # Allows you to specify an identifier for the test run.
+    # If you intend to repeat a test this might not be that applicable, but in
+    # the case of one off tests it might be useful
+    name: 'Testing google search'
+
+    # To avoid invalid certificate errors while testing set acceptSslCerts to
+    # true. This is not listed on the general capabilities page but is here
+    # https://www.browserstack.com/automate/ruby#self-signed-certificates
+    acceptSslCerts: true
+    # Required if you want to generate screenshots at various steps in your test
+    # test. Browserstack default is false
+    browserstack.debug: true
+    # Required if you want to enable video recording during your test.
+    # Browserstack default is true
+    browserstack.video: true
+    # Another setting not listed, setting the following will prevent any values
+    # you pass in, for example when filling in a form, from appearing in the
+    # logs. General use case is to prevent passwords being exposed, but beware
+    # that all input will be masked in the logs if set.
+    browserstack.maskSendKeys: true
+
+    # MOBILE testing and DESKTOP testing are essentially diametric; you set one
+    # or the other but not both. Some examples seem to put logic in place to
+    # test the options passed in and then set the capabilities accordingly,
+    # however Browserstack handles this and has what will happen documented
+    # https://www.browserstack.com/automate/capabilities#capabilities-parameter-override
+    #
+    # MOBILE testing
+    # The docs are a little confusing but essentially if you want to test against
+    # mobile devices you need to define 1 set of capabilities, and if desktop
+    # another
+    # -----
+    # OS you want to test. Accepted values are MAC, WIN8, XP, WINDOWS, ANY,
+    # ANDROID. Browserstack default is ANY
+    platform: MAC
+    # Browser you want to test. Accepted values firefox, chrome, internet
+    # explorer,safari, opera, iPad, iPhone, android. Browserstack default is
+    # chrome
+    browserName: iPhone
+    # Browser version you want to test. See the docs for the full list of
+    # available versions. Browserstack default is latest stable version of
+    # browser selected
+    version: '49'
+    # Device you want to test on. See the docs for the full list of available.
+    device: 'iPhone 5'
+    #
+    # DESKTOP testing
+    # -----
+    # OS you want to test. Accepted values are WINDOWS, OS X. If both OS and
+    # platform are set, OS will take precedence
+    os: WINDOWS
+    # OS version you want to test. Accepted values are
+    # Windows: XP, 7, 8, 8.1 and 10
+    # OS X: Snow Leopard, Lion, Mountain Lion, Mavericks, Yosemite, El Capitan
+    os_version: '8.1'
+    # Browser you want to test. Accepted values are Firefox, Safari, IE, Chrome,
+    # Opera
+    browser: chrome
+    # Browser version you want to test. See the docs for the full list of
+    # available versions
+    browser_version: '49'
+    # Set the resolution of VM before beginning of your test.
+    # See docs https://www.browserstack.com/automate/capabilities for full list
+    # of accepted values, as it is also OS dependent
+    resolution: '1024x768'

data/CHANGELOG.md

@@ -1,11 +1,16 @@
 # Change Log
 
-## [Unreleased](https://github.com/DEFRA/quke/tree/HEAD)
+## [v0.3.2](https://github.com/DEFRA/quke/tree/v0.3.2) (2017-06-12)
+[Full Changelog](https://github.com/DEFRA/quke/compare/v0.3.1...v0.3.2)
 
-[Full Changelog](https://github.com/DEFRA/quke/compare/v0.3.1...HEAD)
+**Closed issues:**
+
+- Enable ability to override driver settings [\#58](https://github.com/DEFRA/quke/issues/58)
 
 **Merged pull requests:**
 
+- Add option to override js\_errors for phantomjs [\#65](https://github.com/DEFRA/quke/pull/65) ([Cruikshanks](https://github.com/Cruikshanks))
+- \[ci skip\] Updating CHANGELOG.md [\#63](https://github.com/DEFRA/quke/pull/63) ([Cruikshanks](https://github.com/Cruikshanks))
 - Update version number \(forgot during last change!\) [\#62](https://github.com/DEFRA/quke/pull/62) ([Cruikshanks](https://github.com/Cruikshanks))
 
 ## [v0.3.1](https://github.com/DEFRA/quke/tree/v0.3.1) (2017-06-12)

data/lib/quke/configuration.rb

@@ -129,7 +129,7 @@ module Quke #:nodoc:
       @data['javascript_errors']
     end
 
-    # Return the hash of +browserstack+ options.
+    # Return the hash of all +browserstack+ options.
     #
     # If you select the browserstack driver, there are a number of options you
     # can pass through to setup your browserstack tests, username and auth_key
@@ -156,7 +156,7 @@ module Quke #:nodoc:
     # 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'] == '' ? false : true
+      proxy['host'] != ''
     end
 
     def custom
@@ -180,6 +180,7 @@ module Quke #:nodoc:
 
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/PerceivedComplexity
     def default_data!(data)
       data.merge(
@@ -196,29 +197,27 @@ module Quke #:nodoc:
         # will be 'true', so we flip it back to 'false' with !.
         # 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
         'javascript_errors' => !(data['javascript_errors'].to_s.downcase.strip == 'false'),
+        # rubocop:enable Style/InverseMethods
         'custom' =>            (data['custom'] || nil)
       )
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/PerceivedComplexity
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
     def browserstack_data(data)
       data = {} if data.nil?
       data.merge(
-        'username' => (ENV['BROWSERSTACK_USERNAME'] ||
-                       data['username'] ||
-                       ''
-                      ),
-        'auth_key' => (ENV['BROWSERSTACK_AUTH_KEY'] ||
-                       data['auth_key'] ||
-                       ''
-                      )
+        'username' => (ENV['BROWSERSTACK_USERNAME'] || data['username'] || ''),
+        'auth_key' => (ENV['BROWSERSTACK_AUTH_KEY'] || data['auth_key'] || ''),
+        'capabilities' => data['capabilities'] || {}
       )
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def proxy_data(data)
       data = {} if data.nil?

data/lib/quke/driver_configuration.rb

@@ -268,46 +268,20 @@ module Quke #:nodoc:
     # For further reference on browserstack capabilities
     # https://www.browserstack.com/automate/capabilities
     # https://www.browserstack.com/automate/ruby#configure-capabilities
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
     def browserstack
+      # Documentation and the code for this class can be found here
+      # http://www.rubydoc.info/gems/selenium-webdriver/0.0.28/Selenium/WebDriver/Remote/Capabilities
+      # https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/remote/capabilities.rb
       capabilities = Selenium::WebDriver::Remote::Capabilities.new
 
-      capabilities['build'] = config.browserstack['build']
-      capabilities['project'] = config.browserstack['project']
-      capabilities['name'] = config.browserstack['name']
-
-      # This and the following section are essentially diametric; you set one
-      # or the other but not both. Some examples seem to put logic in place to
-      # test the options passed in and then set the capabilities accordingly,
-      # however Browserstack handles this and has what will happen documented
-      # https://www.browserstack.com/automate/capabilities#capabilities-parameter-override
-      capabilities['platform'] = config.browserstack['platform']
-      capabilities['browserName'] = config.browserstack['browserName']
-      capabilities['version'] = config.browserstack['version']
-      capabilities['device'] = config.browserstack['device']
-
-      capabilities['os'] = config.browserstack['os']
-      capabilities['os_version'] = config.browserstack['os_version']
-      capabilities['browser'] = config.browserstack['browser']
-      capabilities['browser_version'] = config.browserstack['browser_version']
-      capabilities['resolution'] = config.browserstack['resolution']
-      # -----
+      browserstack_capabilities = config.browserstack['capabilities']
 
-      # This is not listed on the general capabilities page but is here
-      # https://www.browserstack.com/automate/ruby#self-signed-certificates
-      capabilities['acceptSslCerts'] = config.browserstack['acceptSslCerts']
+      browserstack_capabilities.each do |key, value|
+        capabilities[key] = value
+      end
 
-      capabilities['browserstack.debug'] = config.browserstack['debug']
-      capabilities['browserstack.video'] = config.browserstack['video']
-
-      # At this point Quke does not support local testing so we specifically
-      # tell Browserstack we're not doing this
-      capabilities['browserstack.local'] = 'false'
       capabilities
     end
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/MethodLength
 
   end
 

data/lib/quke/version.rb

@@ -1,3 +1,3 @@
 module Quke #:nodoc:
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quke
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Alan Cruikshanks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -279,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A gem to simplify creating acceptance tests using Cucumber