sauce_rspec 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ebcde9d8a88af3ddf9bdaa23aae4ccdca3eb9e6
-  data.tar.gz: 44095666bb99f1688113407f2a3c72a00862b217
+  metadata.gz: fa25d3187d773ee9c1adc347b7946610f8d3ff0d
+  data.tar.gz: db77bc61edfd38fa244985a164e316dbfbe41a8b
 SHA512:
-  metadata.gz: 8c858d53d2d7a8c93f5e0c2a0829d1a21a3958a084d21ee30831b50fa90922f439d423e191265bdb5f1901ae028c49506bf08c398aca4ff9eaa7d1e0092577ee
-  data.tar.gz: 76b1a474dbcb7837c2ffad30945fe8d98b3458ff99bb1b809d3abb6784dc5168dc1ef586bd92abf96db750ff4b30b578590262747fc2895960e641ab6ea9687c
+  metadata.gz: 14099e4796003aea8a67f8154261754aaf8f8618198d5b88d605cd86447f849b79edfd6f69262a21c66784944539aeaff051b5bc814278883c38a8e008e07d97
+  data.tar.gz: 7c55aea04b7e70958efabf6d7fd342e298ffa8f245f0065a61209ae0f8ea6c0b6699d6ef9bf69facc25a7d09b7616d1d62a9ac8b4fe5b4ee12b45fb585010161

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
+
+.test_queue_stats

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/Documentation:
+  Enabled: false
+Style/MethodDefParentheses:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,15 @@
+sudo: false
+cache: bundler
 language: ruby
 rvm:
   - 2.2.2
+before_install: gem update --remote bundler
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec thor cop
+  - bundle exec thor spec
+notifications:
+  email:
+    on_success: never
+    on_failure: never

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in sauce_rspec.gemspec
 gemspec
+gem 'coveralls', require: false

data/README.md

@@ -1,39 +1,13 @@
-# SauceRspec
+# Sauce RSpec
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sauce_rspec`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/bootstraponline/sauce_rspec.svg)](https://travis-ci.org/bootstraponline/sauce_rspec/builds)
+[![Gem Version](https://badge.fury.io/rb/sauce_rspec.svg)](https://rubygems.org/gems/sauce_rspec)
+[![Coverage Status](https://coveralls.io/repos/bootstraponline/sauce_rspec/badge.svg?branch=master&service=github&nocache=true)](https://coveralls.io/github/bootstraponline/sauce_rspec?branch=master)
 
-TODO: Delete this and the text above, and describe your gem
+A new [Ruby gem](https://github.com/bootstraponline/meta/wiki/Sauce_Ruby_Integration_Roadmap) for using RSpec on Sauce.
 
-## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'sauce_rspec'
 ```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sauce_rspec
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/sauce_rspec/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+require 'sauce_rspec'
+require 'sauce_rspec/rspec'
+```

data/Thorfile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'appium_thor'
+
+Appium::Thor::Config.set do
+  gem_name 'sauce_rspec'
+  github_owner 'bootstraponline'
+end
+
+# Must use '::' otherwise Default will point to Thor::Sandbox::Default
+# Debug by calling Thor::Base.subclass_files via Pry
+#
+# https://github.com/erikhuda/thor/issues/484
+#
+# rubocop:disable Style/ClassAndModuleChildren
+class ::Default < Thor
+  desc 'spec', 'Run RSpec tests'
+  def spec
+    exec 'bundle exec rspec spec'
+  end
+
+  desc 'cop', 'Executes rubocop'
+  def cop
+    exec 'bundle exec rubocop --display-cop-names'
+  end
+end

data/lib/sauce_rspec/config.rb

@@ -0,0 +1,63 @@
+module SauceRSpec
+  class Config
+    attr_reader :caps
+    attr_accessor :opts, :user, :key, :host, :port
+
+    public
+
+    def initialize
+      clear
+    end
+
+    # Sauce URL
+    def url
+      fail 'Missing user' unless user
+      fail 'Missing key' unless key
+      fail 'Missing host' unless host
+      fail 'Missing port' unless port
+      "http://#{user}:#{key}@#{host}:#{port}/wd/hub"
+    end
+
+    def caps= value
+      fail 'caps must be an array' unless value && value.is_a?(Array)
+      @caps = value
+    end
+
+    def clear
+      @caps = []
+      @opts = {}
+      @user = sauce_user
+      @key  = sauce_key
+      @host = 'ondemand.saucelabs.com'
+      @port = '80'
+    end
+
+    # We're able to run on sauce if we have a user, key, host, and port
+    # caps and opts aren't required to run on sauce because the user may
+    # provide the caps outside of the SauceRSpec config.
+    def sauce?
+      @user && @key && @host && @port
+    end
+
+    def to_h
+      {
+        caps: @caps.dup,
+        opts: @opts.dup,
+        user: @user.dup,
+        key:  @key.dup,
+        host: @host.dup,
+        port: @port.dup
+      }
+    end
+  end # class Config
+
+  @config = SauceRSpec::Config.new
+
+  class << self
+    def config &block
+      return @config unless block_given?
+      block.call @config
+      @config
+    end
+  end # class << self
+end # module SauceRSpec

data/lib/sauce_rspec/jenkins.rb

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'curb'
+require 'json'
+
+module SauceRSpec
+  class << self
+    attr_reader :driver
+
+    def driver= driver
+      fail 'Driver must not be nil' unless driver
+      @driver = driver
+    end
+
+    def run_after_test_hooks timeout: 60, stdout: $stdout
+      jenkins(stdout) if jenkins?
+      update_job_status_on_sauce(timeout) if SauceRSpec.config.sauce?
+    end
+
+    private
+
+    attr_reader :update_job
+
+    # @param timeout <Integer> timeout in seconds to wait for sauce labs response
+    def update_job_status_on_sauce timeout
+      # https://docs.saucelabs.com/reference/rest-api/#update-job
+      # https://saucelabs.com/rest/v1/:username/jobs/:job_id
+      config = SauceRSpec.config
+      user   = config.user
+      unless update_job
+        key = config.key
+
+        request                 = Curl::Easy.new('')
+        request.http_auth_types = :basic
+        request.username        = user
+        request.password        = key
+
+        @update_job = request
+      end
+
+      passed = RSpec.current_example.exception.nil?
+      passed = { passed: passed }
+      url    = "https://saucelabs.com/rest/v1/#{user}/jobs/#{driver.session_id}"
+
+      update_job.url = url
+
+      wait_true(timeout) do
+        update_job.http_put passed.to_json
+        response = JSON.parse(update_job.body_str) rescue {}
+        response_passed = response['passed']
+        response_error  = response['error'] || ''
+
+        if response_error.include? 'Not authorized'
+          fail(::Errno::ECONNREFUSED, response_error)
+        end
+
+        response_passed == passed[:passed] ? true : fail(response)
+      end
+    end
+
+    def jenkins stdout
+      session_id = driver.session_id
+      job_name   = RSpec.current_example.description
+      # https://github.com/jenkinsci/sauce-ondemand-plugin/blob/2dbf9cf057d03480d020050a842aa23f595e4a3d/src/main/java/hudson/plugins/sauce_ondemand/SauceOnDemandBuildAction.java#L44
+      stdout.puts "SauceOnDemandSessionID=#{session_id} job-name=#{job_name}"
+    end
+  end
+end

data/lib/sauce_rspec/rspec.rb

@@ -0,0 +1,37 @@
+require 'rspec'
+
+module RSpec
+  module Core
+    class World
+      alias_method :rspec_register, :register
+
+      # @api private
+      #
+      # Register an example group.
+      def register(example_group)
+        # Use upstream register method if we're not configured to run on Sauce
+        config = ::SauceRSpec.config
+        return rspec_register(example_group) unless config.sauce?
+
+        examples     = example_group.examples
+        new_examples = []
+        examples.each do |ex|
+          # Use index to allow multiple duplicate caps to have unique ids
+          # ex: 1_firefox, 2_firefox
+          config.caps.each_with_index do |cap, index|
+            ex_with_cap = ex.clone
+            new_id      = "#{ex_with_cap.id}_#{index}_#{cap}"
+            ex_with_cap.instance_variable_set(:@id, new_id)
+            ex_with_cap.instance_eval "def caps; #{cap}; end"
+            new_examples << ex_with_cap
+          end
+        end
+
+        example_group.instance_variable_set(:@examples, new_examples)
+
+        # invoke original register method
+        rspec_register(example_group)
+      end
+    end
+  end
+end unless RSpec::Core::World.method_defined? :rspec_register

data/lib/sauce_rspec/version.rb

@@ -1,3 +1,4 @@
-module SauceRspec
-  VERSION = '0.0.0'
+module SauceRSpec
+  VERSION = '0.0.1' unless defined? ::SauceRSpec::VERSION
+  DATE    = '2015-10-07' unless defined? ::SauceRSpec::DATE
 end

data/lib/sauce_rspec.rb

@@ -1,5 +1,6 @@
-require "sauce_rspec/version"
+require 'rubygems'
+require 'webdriver_utils'
 
-module SauceRspec
-  # Your code goes here...
-end
+require_relative 'sauce_rspec/version'
+require_relative 'sauce_rspec/config'
+require_relative 'sauce_rspec/jenkins'

data/sauce_rspec.gemspec

@@ -1,24 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sauce_rspec/version'
+require_relative 'lib/sauce_rspec/version'
+
+# rubocop:disable Style/SpaceAroundOperators
 
 Gem::Specification.new do |spec|
-  spec.name          = "sauce_rspec"
-  spec.version       = SauceRspec::VERSION
-  spec.authors       = ["bootstraponline"]
-  spec.email         = ["code@bootstraponline.com"]
+  spec.required_ruby_version = '>= 2.2.2'
 
-  spec.summary       = 'Sauce rspec integration'
-  spec.description   = spec.summary += '.'
+  spec.name          = 'sauce_rspec'
+  spec.version       = SauceRSpec::VERSION
+  spec.date          = SauceRSpec::DATE
+  spec.license       = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+  spec.description   = spec.summary = 'Sauce rspec integration'
+  spec.description   += '.' # avoid identical warning
+  spec.authors       = spec.email = ['code@bootstraponline.com']
   spec.homepage      = 'https://github.com/bootstraponline/sauce_rspec'
+  spec.require_paths = ['lib']
 
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency 'rspec', '~> 3.3.0'
+  spec.add_runtime_dependency 'webdriver_utils', '~> 1.0.2'
+  # Recommended way of doing parallel execution
+  spec.add_runtime_dependency 'test-queue-split', '~> 0.3.2'
+  spec.add_runtime_dependency 'curb', '~> 0.8.8'
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+  spec.add_development_dependency 'appium_thor', '~> 1.0.1'
+  spec.add_development_dependency 'coveralls', '~> 0.8.2'
+  spec.add_development_dependency 'pry', '~> 0.10.2'
+  spec.add_development_dependency 'sauce_platforms', '~> 1.0.5'
+  spec.add_development_dependency 'bundler', '~> 1.10.6'
+  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.add_development_dependency 'rubocop', '~> 0.33.0'
 end

data/test_suites/one_file/spec/one_spec.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+
+describe 'describe one' do
+  it 'it one' do
+    $stdout.puts 'test one!'
+    puts 'test one'
+  end
+end

data/test_suites/two_file/spec/one_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe 'describe one' do
+  it 'it one' do
+    puts 'test one'
+  end
+end

data/test_suites/two_file/spec/sauce_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'sauce_platforms'
+
+SauceRSpec.config do |config|
+  config.caps = [
+    Platform.windows_8.firefox.v37,
+    Platform.mac_10_11.safari.v8_1
+  ]
+end

data/test_suites/two_file/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require_relative '../../../lib/sauce_rspec'
+require_relative 'sauce_helper'
+require 'pry'

data/test_suites/two_file/spec/two_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe 'describe two' do
+  it 'it two' do
+    puts 'test two'
+  end
+end

metadata

@@ -1,43 +1,183 @@
 --- !ruby/object:Gem::Specification
 name: sauce_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
-- bootstraponline
+- code@bootstraponline.com
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: webdriver_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: test-queue-split
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: appium_thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: sauce_platforms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.10.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.10.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.33.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.33.0
 description: Sauce rspec integration.
 email:
 - code@bootstraponline.com
@@ -45,18 +185,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
+- Thorfile
 - lib/sauce_rspec.rb
+- lib/sauce_rspec/config.rb
+- lib/sauce_rspec/jenkins.rb
+- lib/sauce_rspec/rspec.rb
 - lib/sauce_rspec/version.rb
 - sauce_rspec.gemspec
+- test_suites/one_file/spec/one_spec.rb
+- test_suites/two_file/spec/one_spec.rb
+- test_suites/two_file/spec/sauce_helper.rb
+- test_suites/two_file/spec/spec_helper.rb
+- test_suites/two_file/spec/two_spec.rb
 homepage: https://github.com/bootstraponline/sauce_rspec
-licenses: []
+licenses:
+- http://www.apache.org/licenses/LICENSE-2.0.txt
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -66,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -74,9 +223,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Sauce rspec integration.
+summary: Sauce rspec integration
 test_files: []
 has_rdoc: 

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "sauce_rspec"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here