saucer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55a94b5cde4a3bf98c9a3e8975f623f42b72d01c
+  data.tar.gz: 3b792a0629f64db6eb9af000d830e3edb7d01143
+SHA512:
+  metadata.gz: 7ce5b1cfefb461d8e2d6202ab06b86bf29795d642a077c221eefb5e079a3deb61aafcc060f6ad9852155133da58881a37426cf5a0524ebfd0401fd2325b35bf6
+  data.tar.gz: 71830226607e765638ecfe360f0a902b59b528bb888a229c62c211eaf723513a1bfd15543d1954d3f5a03fb97c4a41ca7ced3ac07b036a0d032e486428405e4b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in saucer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Titus Fortner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# Saucer
+
+Convenience methods for running your Ruby tests on Sauce Labs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'saucer'
+```
+
+## Usage
+
+#### Configuration
+
+Can optionally pass in a `Config::Selenium` instance with any of the 
+[supported Test Configuration Options](https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options)
+Note that Ruby syntax is a `Symbol` with snake_case and not `String` with camelCase
+```ruby
+config_selenium = Config::Selenium.new(version: '53', browser_name: :firefox)
+@driver = Driver.new(config_selenium)
+```
+
+#### Cucumber
+RSpec doesn't need to be concerned with this, but Cucumber needs an extra step in `env.rb`:
+```ruby
+Before do |scenario|
+  Saucer::Config::Sauce.scenario = scenario
+  @driver = Saucer::Driver.new
+end
+
+After do |scenario|
+  Saucer::Config::Sauce.scenario = scenario
+  @driver.quit
+end
+```
+
+#### Parallel
+The most basic usage for parallel execution is to define the following Rake task, which 
+will every spec in the spec directory in 4 processes on the default Sauce platform (Linux with Chrome v48)
+
+```ruby
+Saucer::Parallel.new.run
+```
+
+To Specify basic number of processes, a specific subdirectory (Cucumber or RSpec), and
+reporting output file:
+
+```ruby
+Saucer::Parallel.new(number: 7,
+                     path: 'features/foo',
+                     output: 'foo').run
+```
+
+
+To specify Sauce configurations, create a Rake Task that takes parameters like this:
+
+```ruby
+task :parallel_sauce do
+  configs = [{os: :mac_10_10, browser: :chrome, browser_version: 38},
+             {os: :mac_10_11, browser: :firefox, browser_version: 46},
+             {os: :mac_10_8, browser: :chrome, browser_version: 42}]
+
+  platforms = configs.map { |c| Saucer::PlatformConfiguration.new(c) }
+
+  Saucer::Parallel.new(platforms: platforms).run
+end
+```
+
+or you can use the default rake task and define your configurations in 
+`configs/platform_configs.yml` like this:
+```yaml
+  - :os: :mac_10_10
+    :browser: :chrome
+    :browser_version: 38
+  - :os: :mac_10_11
+    :browser: :firefox
+    :browser_version: 46
+  - :os: :mac_10_8
+    :browser: :chrome
+    :browser_version: 42
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/saucer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/saucer/annotations.rb

@@ -0,0 +1,44 @@
+module Saucer
+  module Annotations
+
+    def comment(comment)
+      driver.execute_script("sauce:context=#{comment}")
+    end
+
+    def job_result(result)
+      raise ArgumentError, "invalid value for result" unless ['passed', 'failed', true, false].include?(result)
+      driver.execute_script("sauce:job-result=#{result}")
+    end
+
+    def job_name(name)
+      driver.execute_script("sauce:job-name=#{name}")
+    end
+
+    def job_tags(tags)
+      tags = tags.join(',') if tags.is_a?(Array)
+      driver.execute_script("sauce:job-tags=#{tags}")
+    end
+
+    def job_info(info)
+      raise ArgumentError, "job info must be JSON" unless info.is_a? JSON
+      driver.execute_script("sauce:job-info=#{info}")
+    end
+
+    def build_name(name)
+      driver.execute_script("sauce:job-build=#{name}")
+    end
+
+    def stop_vm
+      driver.execute_script("sauce: stop network")
+    end
+
+    def start_vm
+      driver.execute_script("sauce: start network")
+    end
+
+    def breakpoint
+      driver.execute_script("sauce: break")
+    end
+
+  end
+end

data/lib/saucer/api.rb

@@ -0,0 +1,59 @@
+require 'sauce_whisk'
+
+module Saucer
+  class API
+
+    def initialize(driver, config)
+      @driver = driver
+      @config = config
+    end
+
+    def jobs
+      SauceWhisk::Jobs
+    end
+
+    def assets
+      SauceWhisk::Assets
+    end
+
+    def accounts
+      SauceWhisk::Accounts
+    end
+
+    def tunnels
+      SauceWhisk::Tunnels.all
+    end
+
+    def job
+      jobs.fetch(@driver.session_id)
+    end
+
+    def account
+      accounts.fetch(@config.username)
+    end
+
+    def concurrency
+      accounts.concurrency_for(@config.username)
+    end
+
+    def tunnel(id)
+      tunnels.fetch(id)
+    end
+
+    def platforms
+      SauceWhisk::Sauce.platforms
+    end
+
+    def storage
+      @storage ||= SauceWhisk::Storage.new
+    end
+
+    def service_status
+      SauceWhisk::Sauce.service_status
+    end
+
+    def total_job_count
+      SauceWhisk::Sauce.total_job_count
+    end
+  end
+end

data/lib/saucer/config/common.rb

@@ -0,0 +1,22 @@
+module Saucer
+  module Config
+    class Common
+
+      CONFIG_PARAMS = %i(auto_accept_alerts name build tags custom_data max_duration
+                    command_timeout idle_timeout prerun executable args background
+                    timeout tunnel_identifier parent_tunnel screen_resolution timezone
+                    avoid_proxy public record_video video_upload_on_pass record_screenshots
+                    record_logs capture_html priority webdriver_remote_quiet_exceptions).freeze
+
+      attr_reader :config_params, :username, :access_key
+
+      def initialize(opts = {})
+        @username = opts.delete(:username) || ENV['SAUCE_USERNAME']
+        @access_key = opts.delete(:access_key) || ENV['SAUCE_ACCESS_KEY']
+
+        @opts = opts
+        @config_params = CONFIG_PARAMS
+      end
+    end
+  end
+end

data/lib/saucer/config/sauce.rb

@@ -0,0 +1,58 @@
+module Saucer
+  module Config
+    class Sauce
+
+      def self.scenario=(scenario)
+        @@scenario = scenario
+      end
+
+      def self.scenario
+        @@scenario
+      end
+
+      DATA_PARAMS = %i(name build language host_os version ci ip gems framework page_object harness).freeze
+
+      FRAMEWORKS = %w(capybara watir).freeze
+      PAGE_OBJECTS = %w(site_prism page-object watirsome watir_drops).freeze
+
+      def initialize(opt = {})
+        @gems = {}
+        Bundler.definition.dependencies.map(&:name).each do |gem_name|
+          @gems[gem_name] = Bundler.environment.specs.to_hash[gem_name].first.version.version
+        end
+
+        frameworks = @gems.select { |gem| FRAMEWORKS.include? gem }
+        @framework = frameworks.first if frameworks.size == 1
+
+        page_objects = @gems.select { |gem| PAGE_OBJECTS.include? gem }
+        @page_object = page_objects.first if page_objects.size == 1
+
+        @name = opt[:name] if opt.key? :name
+        @build = opt[:build] if opt.key? :build
+
+        if RSpec.respond_to?(:current_example) && !RSpec.current_example.nil?
+          @name ||= RSpec.current_example.full_description
+          @location = RSpec.current_example.location
+          @harness = ["rspec", @gems["rspec"]]
+        elsif @@scenario
+          @name ||= @@scenario.source.map(&:name).join(" ")
+          @location = @@scenario.location.to_s
+          @harness = ["cucumber", @gems["cucumber"]]
+        end
+
+        @language = 'Ruby'
+        @host_os = ::Selenium::WebDriver::Platform.os
+        @version = ::Selenium::WebDriver::Platform.ruby_version
+        @ci = ::Selenium::WebDriver::Platform.ci
+        @ip = ::Selenium::WebDriver::Platform.ip
+      end
+
+      def to_hash
+        DATA_PARAMS.each_with_object({}) do |name, hash|
+          var = eval("@#{name}")
+          hash[name] = var if var
+        end
+      end
+    end
+  end
+end

data/lib/saucer/config/selenium.rb

@@ -0,0 +1,37 @@
+module Saucer
+  module Config
+    class Selenium < Common
+
+      CONFIG_PARAMS = %i(browser_name version platform selenium_version
+                    chromedriver_version iedriver_version).freeze
+
+      def initialize(opt = {})
+        super
+        @config_params += CONFIG_PARAMS
+      end
+
+      def url
+        "https://#{@username}:#{@access_key}@ondemand.saucelabs.com:443/wd/hub"
+      end
+
+      def opts
+        {url: url, desired_capabilities: capabilities}
+      end
+
+      def capabilities
+        caps = @config_params.each_with_object({}) do |param, hash|
+          hash[param] = @opts[param] if @opts.key?(param)
+          hash[param] ||= ENV[param.to_s] if ENV[param.to_s]
+        end
+        sauce = Sauce.new.to_hash
+        caps[:name] = sauce.delete(:name)
+        caps[:build] = sauce.delete(:build)
+
+        caps[:"sauce:data"] = sauce.to_hash
+        browser_name = @opts[:browser_name] || :chrome
+        ::Selenium::WebDriver::Remote::Capabilities.send(browser_name, caps)
+      end
+    end
+
+  end
+end

data/lib/saucer/driver.rb

@@ -0,0 +1,39 @@
+module Saucer
+  class Driver < Selenium::WebDriver::Driver
+
+    include Annotations
+
+    attr_reader :driver, :config
+
+    def initialize(config = nil)
+      @config = config || Config::Selenium.new
+      @driver = super Selenium::WebDriver::Remote::Bridge.new(@config.opts)
+    end
+
+    def sauce
+      @api ||= API.new(self, @config)
+    end
+
+    def quit(data = nil)
+      if data.is_a?(TrueClass) || data.is_a?(FalseClass)
+        result = data
+      elsif RSpec.current_example
+        exception = RSpec.current_example.exception
+        result = exception.nil?
+      elsif Saucer::Config::Sauce.scenario
+        exception = Saucer::Config::Sauce.scenario.exception
+        result = Saucer::Config::Sauce.scenario.passed?
+      end
+
+      if exception
+        @driver.comment "Error: #{exception.inspect}"
+        @driver.comment "Error Location: #{exception.backtrace.first}"
+      end
+
+      @driver.job_result(result) unless result.nil?
+
+      super(*[])
+    end
+
+  end
+end

data/lib/saucer/parallel.rb

@@ -0,0 +1,57 @@
+require 'sauce_platforms'
+require 'yaml'
+
+module Saucer
+  class Parallel
+
+    attr_accessor :number, :path, :output
+
+    def initialize(opt = {})
+      @number = opt[:number] || ENV['PARALLEL_PROCESSES']
+      @path = opt[:path] || ENV['TEST_PATH'] || "spec"
+      @output = opt[:output] || ENV['REPORT_OUTPUT'] || 'output'
+      @platforms = opt[:platforms] || []
+      if File.exist?('configs/platform_configs.yml')
+        yaml = YAML.load_file('configs/platform_configs.yml')
+        @platforms ||= yaml.map { |c| Saucer::PlatformConfiguration.new(c) }
+      end
+      @success = true
+    end
+
+    def run
+      if @platforms.empty?
+        raise StandardError, "Tests failed!" unless execute_test
+        return
+      end
+
+      @platforms.each do |platform|
+        Rake::Task.define_task(platform.name) {
+          ENV['platform'] = platform.to_hash[:platform]
+          ENV['browser_name'] = platform.to_hash[:browserName]
+          ENV['version'] = platform.to_hash[:version]
+
+          begin
+            @result = execute_test
+          ensure
+            @success &= @result
+          end
+        }
+      end
+
+      Rake::MultiTask.define_task(sauce_tests: @platforms.map(&:name)) {
+        raise StandardError, "Tests failed!" unless @success
+      }.invoke
+    end
+
+    def execute_test
+      if path.include?('spec')
+        ENV['PARALLEL_SPLIT_TEST_PROCESSES'] = number.to_s if number
+        system "parallel_split_test #{path} --out #{@output}.xml"
+      elsif path.include?('features')
+        system "parallel_cucumber #{path} -o \"--format junit --out #{@output} --format pretty\" -n #{number.to_s}"
+      else
+        raise ArgumentError, "Unable to determine if using rspec or cucumber"
+      end
+    end
+  end
+end

data/lib/saucer/platform_configuration.rb

@@ -0,0 +1,23 @@
+require 'sauce_platforms'
+
+module Saucer
+  class PlatformConfiguration
+    attr_accessor :browser, :os, :browser_version
+
+    def initialize(opt = {})
+      @browser = opt[:browser]
+      @os = opt[:os] || opt['os'].downcase.tr(' ', '_').tr(',', '_')
+      @browser_version = opt[:browser_version] || opt['short_version']
+    end
+
+    # TODO update for defaults
+    def to_hash
+      Platform.send(@os).send(@browser).send("v#{@browser_version}")
+    end
+
+    def name
+      "#{@os}_#{@browser}_#{@browser_version}".to_sym
+    end
+
+  end
+end

data/lib/saucer/version.rb

@@ -0,0 +1,3 @@
+module Saucer
+  VERSION = "0.2.0"
+end

data/lib/saucer.rb

@@ -0,0 +1,5 @@
+require "require_all"
+require 'selenium-webdriver'
+require "saucer/version"
+require_rel "saucer"
+

data/saucer.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "saucer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "saucer"
+  spec.version       = Saucer::VERSION
+  spec.authors       = ["Titus Fortner"]
+  spec.email         = ["titusfortner@gmail.com"]
+
+  spec.summary       = %q{A Ruby helper for running tests in Sauce Labs}
+  spec.description   = %q{A Ruby helper for running tests in Sauce Labs}
+  spec.homepage      = "http://github.com/titusfortner/saucer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'parallel_split_test'
+  spec.add_dependency 'require_all'
+  spec.add_dependency 'selenium-webdriver'
+  spec.add_dependency 'sauce_whisk'
+  spec.add_dependency 'sauce_platforms'
+  spec.add_dependency 'json'
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: saucer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Titus Fortner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: parallel_split_test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sauce_whisk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sauce_platforms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby helper for running tests in Sauce Labs
+email:
+- titusfortner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/saucer.rb
+- lib/saucer/annotations.rb
+- lib/saucer/api.rb
+- lib/saucer/config/common.rb
+- lib/saucer/config/sauce.rb
+- lib/saucer/config/selenium.rb
+- lib/saucer/driver.rb
+- lib/saucer/parallel.rb
+- lib/saucer/platform_configuration.rb
+- lib/saucer/version.rb
+- saucer.gemspec
+homepage: http://github.com/titusfortner/saucer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A Ruby helper for running tests in Sauce Labs
+test_files: []