quke 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25034d29ab8437b5aacb33aaa97f41c34dc15068752eadfc09a85768e0dc2e60
-  data.tar.gz: 5cd03338c46d2bcae6797688d812ef2416442bf6326241a6fde6597b7a4c7a62
+  metadata.gz: b1912f6775017bdec69bd6e8b15f15b95829a6593910a0c27f0330fdb0f66774
+  data.tar.gz: 88777a66fabbd0fa786b47dd45d56a6c7a24d797f6289dd2803abc9ae058f6a2
 SHA512:
-  metadata.gz: c78cb8fe4e373e89806fd0b8d12329e1954a22861ccc59d02c01ad3646da7782c145445c62c076f862bdc324309b18e5ae2be49f0cc1338bc7231639242c37a9
-  data.tar.gz: 032b80527d91463412de0c97a6ae4b70ec050ee2dc6b71d2a1a6be2f316cc690f4f0b5fdb74e41e02fdb85c2a394f8bd388b61038ddd6635a3fa30abc807b013
+  metadata.gz: 836c1c82284d6960b2dab3ecfecfe4c6053ad2361576ff891146ace43dd2188d168a5573ca4abeb11891a574a001617a775a97fc619f46f9e7c5dfd70d7a0b57
+  data.tar.gz: 8c906791e4c8d0b54115de9684606dd9363eb4bf7cc92708ef7445aa0e5f9ab3dc097774f5803dd60ef7f02540c033f9af0cd606760798380b611a1b5b598332

data/.browserstack.yml

@@ -0,0 +1,11 @@
+driver: browserstack
+
+browserstack:
+  username: alancruikshanks3
+  auth_key: PCTFnDxjvJpjypoyF1iu
+  local_key: PCTFnDxjvJpjypoyF1iu
+
+  capabilities:
+    build: 'Version 1'
+    project: 'Adding browserstack support'
+    name: 'Testing google search'

data/.config.example.yml

@@ -105,7 +105,10 @@ browserstack:
 
   # If you want to use local testing you must provide a key. You can find this
   # in Browserstack once logged in under settings. Its typically the same value
-  # as the auth_key above
+  # as the auth_key above.
+  # If you don't want to put this credential in the config file (because you
+  # want to commit it to source control), Quke will also check for the existance
+  # of the environment variable BROWSERSTACK_LOCAL_KEY
   local_key: 123456789ABCDE
 
   # Anything set under capabilities will be passed directly by Quke to

data/.rubocop.yml

@@ -46,9 +46,9 @@ Metrics/MethodLength:
   Max: 15
   Exclude:
 
-# It is our opinion that in the specs 80 characters is too restrictive. Do to
-# the nature of some statements that it can be both difficult, and make more
-# simple statements complex if we are forced to split them over multiple lines.
+# It is our opinion that in the specs 80 characters is too restrictive. Due to
+# the nature of some statements it can be both difficult, and make more simple
+# statements complex if we are forced to split them over multiple lines.
 # Therefore we have upped this limit to 120 chars in the specs only.
 Metrics/LineLength:
   Max: 120
@@ -56,6 +56,6 @@ Metrics/LineLength:
     - spec/quke/*.rb
 
 # Disable this rubocop style because we want to make the arguments passed into
-# Freakin available to anywhere when the code is executed
+# Quke available to anywhere when the code is executed
 Style/GlobalVars:
   Enabled: false

data/.travis.yml

@@ -2,7 +2,6 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.1
-before_install: gem install bundler -v 1.12.5
 
 # Travis CI clones repositories to a depth of 50 commits, which is only really
 # useful if you are performing git operations.
@@ -14,6 +13,13 @@ git:
 # https://docs.travis-ci.com/user/languages/ruby#Caching-Bundler
 cache: bundler
 
+# Needed as part of submitting test coverage statistics to CodeClimate as part
+# of the build
+# https://docs.codeclimate.com/v1.0/docs/travis-ci-test-coverage
+env:
+  global:
+    - CC_TEST_REPORTER_ID=1d329b5215a2aa892214c7705d36de6e99608a8649616c93f93464aa06776f4a
+
 # Using the ability to customise the Travis build to check for 'focus' labels
 # i.e. labels used when working on a spec but which we don't want appearing in
 # the final commit to master
@@ -21,17 +27,19 @@ cache: bundler
 # If grep returns 0 (match found), test 0 -eq 1 will return 1.
 # If grep returns 1 (no match found), test 1 -eq 1 will return 0.
 # If grep returns 2 (error), test 2 -eq 1 will return 1.
-before_script: >-
-  echo "Checking for use of 'focus' labels in specs" && grep -r --include="*_spec.rb" "focus: true" spec/; test $? -eq 1
+before_script:
+  - echo "Checking for use of 'focus' labels in specs" && grep -r --include="*_spec.rb" "focus: true" spec/; test $? -eq 1
+  # Setup to support the CodeClimate test coverage submission
+  # As per CodeClimate's documentation, they suggest only running
+  # ./cc-test-reporter commands on travis-ci push builds only. Hence we wrap all
+  # the codeclimate test coverage related commands in a check that tests if we
+  # are in a pull request or not.
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter; fi
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then chmod +x ./cc-test-reporter; fi
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter before-build; fi
 
-# This section was added as per https://docs.travis-ci.com/user/code-climate/
-# To protect our codeclimate stats rather than adding the Codeclimate API key for ea-area_lookup
-# in the open we used this guide https://docs.travis-ci.com/user/encryption-keys/ to encryt the
-# value. Essentially install travis gem, then run `travis encrypt <my_code_climate_api_key>`
-addons:
-  code_climate:
-    repo_token:
-      secure: "TULHMA2Zmp0ntRGBVbLAJqSa9XWSm6gOunAEESbEUZYXt9eTuwvCHLOk1kz/EPq+3s60JokYOpGPB5iTGY4HxS/3gAmNR1Eo1smHqXDXqHjDb0X1l+w4mPUtdTRxTzzYJCaGkDptyCRv7p55LstfnZWlseQjlO1Er1TvQzzOb0XpsM+bO1ZiFNYZQcK8lAp2IrEcZNi0AEr96djc8vFymhV8ZocK39FythTwUBsw4eHitdFRTJwHZUUToatzN4R2Tl8rRNvj+xL3SmTqF1QZQovBGluuiewR0sddzU0vfQEB9tg7v+sMOoIK5ANYJ8SmabmsMa5zjnKEpxK0tgyD/vN9VWNH8qTY8yrGVg1wkQUmabV+1XSXNeHHuvHtlGp76OOqvNVCzlqspn0XsiS0TmcFhQlnNnhfQqFXXaMkt3ToPWDZfiXdmm5EMP5tqkNMhu/OtF1r99k7LbmDA0SMm3OK4TqTDLYDiDYJpwGYyWbWh9eCBgSyOzTW0sKvu0cxjznFd7NVx845lcfWLcDYGAyLEXm1WE1uULRjJgzabi4MkTz0DPBRxFP0STfXf96+NGxkSnKI5akQgyO4I+ITLS07pU6G16lcc8LNhqXFWdMVvPXSqzzLNqcV9U6zIyWaaf1whBO7/RPks3hKWw9GMwun49pR6GJ2wLeMnbnVsAQ="
+after_script:
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi
 
 deploy:
   provider: rubygems

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [v0.5.0](https://github.com/DEFRA/quke/tree/v0.5.0) (2017-12-06)
+[Full Changelog](https://github.com/DEFRA/quke/compare/v0.4.0...v0.5.0)
+
+**Merged pull requests:**
+
+- Add support for browserstack local testing [\#69](https://github.com/DEFRA/quke/pull/69) ([Cruikshanks](https://github.com/Cruikshanks))
+- Update CHANGELOG for 0.4.0 release [\#68](https://github.com/DEFRA/quke/pull/68) ([Cruikshanks](https://github.com/Cruikshanks))
+
 ## [v0.4.0](https://github.com/DEFRA/quke/tree/v0.4.0) (2017-12-04)
 [Full Changelog](https://github.com/DEFRA/quke/compare/v0.3.2...v0.4.0)
 

data/README.md

@@ -86,6 +86,32 @@ QUKE_CONFIG='chrome.config.yml' bundle exec quke
 
 The use case is to allow you to have different configs setup ready to go, and enable you to switch between them. For example when testing with Chrome and Firefox you set a 1 second delay between steps so you can observe the tests as they run through, but in your default `.config.yml` you want no pauses and use **phantomjs**.
 
+### Security
+
+If you are testing a site that requires some form of login, or you are using **Browserstack** you'll need to tell Quke about the credentials. Generally we advise not committing your `.config.yml` to source control, but we understand you may well build up a suite of them that you want to store with the project and share with others.
+
+If that's the case make use of the following features.
+
+#### Browserstack environment variables
+
+[.config.example.yml](.config.example.yml) is an example of a config file which contains `username`, `auth_key`, and if local testing `local_key`. You really don't want these becoming known so if you have to commit the config file, remove them and instead set the following environment variables wherever you need to run the tests.
+
+- BROWSERSTACK_USERNAME
+- BROWSERSTACK_AUTH_KEY
+- BROWSERSTACK_LOCAL_KEY
+
+Quke looks for them when configuring the **Browserstack** driver and only if not found does it then go looking in the config file.
+
+#### Ruby's ENV classs
+
+You can access any environment variable from within your project using [ENV](https://ruby-doc.org/core-2.4.2/ENV.html).
+
+```ruby
+secret_key = ENV['SUPER_SECRET_KEY']
+```
+
+You can set them by calling `export SUPER_SECRET_KEY="password123"` in your terminal prior to running Quke. In this way for example, the passwords featured in the custom section in [.config.example.yml](.config.example.yml) could be removed, and instead your step could read the value it needs to submit from an environment variable.
+
 ## Usage
 
 TODO: Write usage instructions here
@@ -102,6 +128,10 @@ Capybara includes the ability to save the source of the current page at any poin
 
 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.
 
+### Automatically setting Browserstack session status
+
+If you are using the Browserstack driver, Quke will automatically update the status of the session recorded in Browserstack for you. If all tests pass, it will be marked as 'passed', else it will be marked as 'failed' (it defaults to 'completed').
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/console

@@ -3,6 +3,8 @@
 require 'bundler/setup'
 require 'quke'
 require 'quke/version'
+require 'quke/browserstack_configuration'
+require 'quke/browserstack_status_reporter'
 require 'quke/configuration'
 require 'quke/cuke_runner'
 require 'quke/driver_registration'

data/lib/features/support/after_hook.rb

@@ -1,9 +1,13 @@
 require 'quke/configuration'
 
 After('~@nonweb') do |scenario|
-  if scenario.failed?
+  $fail_count ||= 0
+
+  if Quke::Quke.config.browserstack.using_browserstack?
+    $session_id = page.driver.browser.session_id
+  end
 
-    $fail_count ||= 0
+  if scenario.failed?
     $fail_count = $fail_count + 1
 
     # Tell Cucumber to quit after first failing scenario when stop_on_error is

data/lib/features/support/env.rb

@@ -5,6 +5,7 @@ require 'quke/configuration'
 require 'quke/driver_configuration'
 require 'quke/driver_registration'
 require 'browserstack/local'
+require 'quke/browserstack_status_reporter'
 
 unless Quke::Quke.config.app_host.empty?
   Capybara.app_host = Quke::Quke.config.app_host
@@ -14,6 +15,12 @@ driver_config = Quke::DriverConfiguration.new(Quke::Quke.config)
 driver_reg = Quke::DriverRegistration.new(driver_config, Quke::Quke.config)
 driver = driver_reg.register(Quke::Quke.config.driver)
 
+# We need bs_local to be declared outside of the AfterConfiguration block below
+# so that it's available in the at_exit block.
+# Did try simply calling it @bs_local inside the AfterConfiguration but that
+# just kept causing Quke to crash immediately (shrug!)
+bs_local = nil
+
 Capybara.default_driver = driver
 Capybara.javascript_driver = driver
 
@@ -62,9 +69,21 @@ end
 
 # This is the very last thing Cucumber calls that we can hook onto. Typically
 # used for final cleanup, we make use of it to kill our browserstack local
-# testing binary
+# testing binary, and update the status of the session in browserstack
 at_exit do
-  if Quke::Quke.config.browserstack.test_locally?
+  if $fail_count && Quke::Quke.config.browserstack.using_browserstack?
+    reporter = Quke::BrowserstackStatusReporter.new(Quke::Quke.config.browserstack)
+    begin
+      if $fail_count == 0
+        puts reporter.passed($session_id)
+      else
+        puts reporter.failed($session_id)
+      end
+    rescue StandardError => err
+      puts err
+    end
+  end
+  if bs_local && Quke::Quke.config.browserstack.test_locally?
     # stop the local instance
     bs_local.stop
   end

data/lib/quke.rb

@@ -1,5 +1,6 @@
 require 'quke/version'
 require 'quke/browserstack_configuration'
+require 'quke/browserstack_status_reporter'
 require 'quke/configuration'
 require 'quke/cuke_runner'
 require 'quke/driver_registration'

data/lib/quke/browserstack_configuration.rb

@@ -13,7 +13,10 @@ module Quke #:nodoc:
 
     # To use local testing users must provide a key. They will find this in
     # Browserstack once logged in under settings. Its typically the same value
-    # as the auth_key above
+    # as the auth_key above.
+    # If you don't want to put this credential in the config file (because you
+    # want to commit it to source control), Quke will also check for the
+    # existance of the environment variable BROWSERSTACK_LOCAL_KEY
     attr_reader :local_key
 
     # Capabilities are what configure the test in browserstack, for example
@@ -39,20 +42,25 @@ module Quke #:nodoc:
 
     # Initialize's the instance based in the +Quke::Configuration+ instance
     # passed in.
-    #
+    #--
+    # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    #++
     def initialize(configuration)
       @using_browserstack = configuration.data['driver'] == 'browserstack'
       data = validate_input_data(configuration.data)
       @username = ENV['BROWSERSTACK_USERNAME'] || data['username'] || ''
       @auth_key = ENV['BROWSERSTACK_AUTH_KEY'] || data['auth_key'] || ''
-      @local_key = data['local_key'] || ''
+      @local_key = ENV['BROWSERSTACK_LOCAL_KEY'] || data['local_key'] || ''
       @capabilities = data['capabilities'] || {}
       determine_local_testing_args(configuration)
     end
+    # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
-    # Return true if the +browserstack.local: true+ value has been set in the
+    # Return true if the +browserstack.local+ value has been set to true in the
     # +.config.yml+ file and the driver is set to 'browserstack', else false.
     #
     # It is used when determing whether to start and stop the binary
@@ -67,7 +75,7 @@ module Quke #:nodoc:
     # to use in order to correctly determine is the browserstack local testing
     # binary needs to be stopped and started for the tests.
     #
-    # However it also serves as a clean and simple way ton determine if
+    # However it also serves as a clean and simple way to determine if
     # browserstack is the selected dribver.
     def using_browserstack?
       @using_browserstack

data/lib/quke/browserstack_status_reporter.rb

@@ -0,0 +1,73 @@
+module Quke #:nodoc:
+
+  # Used to update the status of a session in Browserstack to mark it as passed
+  # or failed. It does this by making a PUT request to Browserstack's REST API
+  # requesting the status of a specified session is set to 'passed' or 'failed'
+  # (only those values are accepted).
+  #
+  # https://www.browserstack.com/automate/rest-api
+  #
+  # A session ID is only available when we configure Quke to work with
+  # Browserstack, and can only be obtained when in the context of running a
+  # scenario. It's unique to the overall session (it doesn't change for each
+  # scenario or feature), but we have to set it as a global variable in
+  # after_hook.rb in order to access it in the after_exit block in env.rb
+  class BrowserstackStatusReporter
+
+    # Initialize's the instance based in the +Quke::BrowserstackConfiguration+
+    # instance passed in.
+    #
+    # The values its interested in are username and auth_key as it will use
+    # these to authenticate with Browserstacks REST API.
+    def initialize(config)
+      @username = config.username
+      @auth_key = config.auth_key
+    end
+
+    # Connects to the Browserstack REST API and makes a PUT request to update
+    # the session with the matching +session_id+ to 'passed'.
+    #
+    # It returns a string which can be used as a message for output confirming
+    # the action.
+    def passed(session_id)
+      check_before_update(session_id, status: 'passed')
+      "Browserstack session #{session_id} status set to \e[32mpassed\e[0m 😀"
+    end
+
+    # Connects to the Browserstack REST API and makes a PUT request to update
+    # the session with the matching +session_id+ to 'failed'.
+    #
+    # It returns a string which can be used as a message for output confirming
+    # the action.
+    def failed(session_id)
+      check_before_update(session_id, status: 'failed')
+      "Browserstack session #{session_id} status set to \e[31mfailed\e[0m 😢"
+    end
+
+    private
+
+    def check_before_update(session_id, body)
+      raise(ArgumentError, 'Need a session ID to update browserstack status') if session_id.nil?
+
+      uri = URI("https://www.browserstack.com/automate/sessions/#{session_id}.json")
+      set_status(uri, body)
+    end
+
+    def set_status(uri, body)
+      request = Net::HTTP::Put.new(uri)
+      request.basic_auth @username, @auth_key
+      request.content_type = 'application/json'
+      request.body = body.to_json
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+
+      return if response.is_a? Net::HTTPSuccess
+
+      raise(StandardError, "Failed to update browserstack status: #{uri}")
+    end
+
+  end
+
+end

data/lib/quke/configuration.rb

@@ -152,6 +152,18 @@ module Quke #:nodoc:
       proxy['host'] != ''
     end
 
+    # Return the hash of +custom+ server settings
+    #
+    # This returns a hash of all the key/values in the custom section of your
+    # +.config.yml+ file. You can then access it in your steps/page objects with
+    #
+    #     Quke::Quke.config.custom["default_org_name"] # = "Testy Ltd"
+    #     Quke::Quke.config.custom["accounts"]["account2"]["username"] # = "john.doe@example.gov.uk"
+    #     Quke::Quke.config.custom["urls"]["front_office"] # = "http://myservice.service.gov.uk"
+    #
+    # As long as what you add is valid YAML (check with a tool like
+    # http://www.yamllint.com/) Quke will be able to pick it up and make it
+    # available in your tests.
     def custom
       @data['custom']
     end

data/lib/quke/cuke_runner.rb

@@ -22,8 +22,8 @@ module Quke #:nodoc:
     #   - +-r 'lib/features'+, tells Cucumber to require our features folder.
     #       This is how we get it to use our +env.rb+ which handles all the
     #       setup on behalf of the user (the point of Quke) to do things like
-    #       use Browserstack, or switch between running against Chrom or firefox
-    #       locally
+    #       use Browserstack, or switch between running against Chrome or
+    #       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
@@ -35,7 +35,7 @@ module Quke #:nodoc:
         # 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
-        # determing where this file is running from when called, then we simply
+        # 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.

data/lib/quke/version.rb

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

data/quke.gemspec

@@ -95,11 +95,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'browserstack-local'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.5'
   spec.add_development_dependency 'rdoc', '~> 4.2'
   spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'simplecov', '~> 0.13'
+  spec.add_development_dependency 'webmock', '~> 3.1'
 end
 # rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quke
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Alan Cruikshanks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -150,20 +150,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +212,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '3.1'
 description: Quke tries to simplify the process of writing and running acceptance
   tests by setting up Cucumber for you. It handles the config to allow you to run
   your tests in Firefox and Chrome, or the headless browser PhantomJS. It also has
@@ -246,6 +246,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".browserstack.yml"
 - ".codeclimate.yml"
 - ".config.example.yml"
 - ".gitignore"
@@ -266,6 +267,7 @@ files:
 - lib/features/support/env.rb
 - lib/quke.rb
 - lib/quke/browserstack_configuration.rb
+- lib/quke/browserstack_status_reporter.rb
 - lib/quke/configuration.rb
 - lib/quke/cuke_runner.rb
 - lib/quke/driver_configuration.rb