saucer 0.6.5 → 1.0.0.alpha

data/lib/saucer/options.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Saucer
+  class Options
+    W3C = %i[browser_name browser_version platform_name accept_insecure_certs page_load_strategy proxy set_window_rect
+             timeouts strict_file_interactability unhandled_prompt_behavior].freeze
+
+    SAUCE = %i[access_key appium_version avoid_proxy build capture_html chromedriver_version command_timeout
+               crmuxdriver_version custom_data disable_popup_handler extended_debugging firefox_adapter_version
+               firefox_profile_url idle_timeout iedriver_version max_duration name parent_tunnel passed prerun
+               prevent_Requeue priority proxy_host public record_logs record_screenshots record_video
+               restricted_public_info screen_resolution selenium_version source tags time_zone tunnel_identifier
+               username video_upload_on_pass].freeze
+
+    VALID = W3C + SAUCE
+
+    attr_accessor :url, :scenario
+    attr_reader :data_center
+
+    def initialize(**opts)
+      VALID.each do |option|
+        self.class.__send__(:attr_accessor, option)
+        next unless opts.key?(option)
+
+        instance_variable_set("@#{option}", opts.delete(option))
+      end
+
+      validate_credentials
+      @browser_name ||= 'firefox'
+      @platform_name ||= 'Windows 10'
+      @browser_version ||= 'latest'
+      @selenium_version ||= '3.141.59'
+
+      opts.key?(:url) ? @url = opts[:url] : self.data_center = :US_WEST
+      @scenario = opts[:scenario] if opts.key?(:scenario)
+    end
+
+    def capabilities
+      w3c = W3C.each_with_object({}) do |option, hash|
+        value = instance_variable_get("@#{option}")
+        next if value.nil?
+
+        hash[option] = value
+      end
+
+      sauce = SAUCE.each_with_object({}) do |option, hash|
+        value = instance_variable_get("@#{option}")
+        next if value.nil?
+
+        hash[option] = value
+      end
+
+      w3c.merge('sauce:options' => sauce)
+    end
+    alias to_h capabilities
+
+    def data_center=(data_center)
+      @url = case data_center
+             when :US_WEST
+               'https://ondemand.saucelabs.com:443/wd/hub'
+             when :US_EAST
+               'https://us-east-1.saucelabs.com:443/wd/hub'
+             when :EU_VDC
+               'https://ondemand.eu-central-1.saucelabs.com:443/wd/hub'
+             else
+               raise ::ArgumentError, "#{data_center} is an invalid data center; specify :US_WEST, :US_EAST or :EU_VDC"
+             end
+      @data_center = data_center
+    end
+
+    private
+
+    def validate_credentials
+      @username ||= ENV['SAUCE_USERNAME']
+      msg = "No valid username found; either pass the value into `Options#new` or set with ENV['SAUCE_USERNAME']"
+      raise AuthenticationError, msg if @username.nil?
+
+      @access_key ||= ENV['SAUCE_ACCESS_KEY']
+      return unless @access_key.nil?
+
+      msg = "No valid access key found; either pass the value into `Options#new` or set with ENV['SAUCE_ACCESS_KEY']"
+      raise AuthenticationError, msg
+    end
+  end
+end

data/lib/saucer/runners.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'saucer/runners/cucumber'
+require 'saucer/runners/rspec'
+require 'saucer/runners/unknown'

data/lib/saucer/runners/cucumber.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Saucer
+  class Cucumber
+    class << self
+      def test_name
+        scenario.source.map(&:name).join(' ')
+      end
+
+      def name
+        :cucumber
+      end
+
+      def result
+        scenario.passed?
+      end
+
+      def exception
+        scenario.exception
+      end
+    end
+  end
+end

data/lib/saucer/runners/rspec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Saucer
+  class Rspec
+    class << self
+      def test_name
+        RSpec.current_example.full_description
+      end
+
+      def name
+        :rspec
+      end
+
+      def result
+        RSpec.current_example.exception.nil?
+      end
+
+      def exception
+        RSpec.current_example.exception
+      end
+    end
+  end
+end

data/lib/saucer/runners/unknown.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Saucer
+  class Unknown
+    class << self
+      def test_name
+        nil
+      end
+
+      def name
+        :unknown
+      end
+
+      def result
+        nil
+      end
+
+      def exception
+        nil
+      end
+    end
+  end
+end

data/lib/saucer/session.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'sauce_whisk'
+
+module Saucer
+  class Session
+    class << self
+      def runner
+        if RSpec.respond_to?(:current_example) && !RSpec.current_example.nil?
+          Rspec
+        elsif @scenario
+          Cucumber
+        else
+          Unknown
+        end
+      end
+
+      def begin(options = nil, scenario: nil)
+        options ||= Options.new(scenario: scenario)
+        options.name ||= test_name if test_name
+        options.build ||= build_name
+
+        driver = Selenium::WebDriver.for :remote, url: options.url, desired_capabilities: options.capabilities
+        new(driver, options)
+      end
+
+      def test_name
+        runner.test_name
+      end
+
+      def build_name
+        if ENV['BUILD_NAME']
+          ENV['BUILD_NAME']
+        elsif ENV['BUILD_TAG']
+          ENV['BUILD_TAG']
+        elsif ENV['TRAVIS_JOB_NUMBER']
+          "#{ENV['TRAVIS_REPO_SLUG'][%r{[^/]+$}]}: #{ENV['TRAVIS_JOB_NUMBER']}"
+        elsif ENV['SAUCE_BAMBOO_BUILDNUMBER']
+          ENV['SAUCE_BAMBOO_BUILDNUMBER']
+        elsif ENV['CIRCLE_BUILD_NUM']
+          "#{ENV['CIRCLE_JOB']}: #{ENV['CIRCLE_BUILD_NUM']}"
+        else
+          "Local Execution - #{Time.now.to_i}"
+        end
+      end
+    end
+
+    attr_accessor :tags, :data
+    attr_reader :driver, :options, :job_id, :scenario, :runner
+
+    include CustomCommands
+    include JobUpdate
+    include AssetManagement
+
+    def initialize(driver, options)
+      @driver = driver
+      @options = options
+      @job_id = driver.session_id
+      @tags = []
+      @scenario = options.scenario
+      @runner = self.class.runner
+      @data = generate_data
+
+      SauceWhisk.data_center = options.data_center
+    end
+
+    def generate_data
+      data_collection = DataCollection.new
+
+      opt = {selenium_version: data_collection.selenium_version,
+             test_library: data_collection.test_library,
+             page_objects: data_collection.page_objects,
+             test_runner: data_collection.test_runner(runner),
+             language: "Ruby v#{Selenium::WebDriver::Platform.ruby_version}",
+             operating_system: Selenium::WebDriver::Platform.os}
+      opt[:ci_tool] = Selenium::WebDriver::Platform.ci if Selenium::WebDriver::Platform.ci
+      opt
+    end
+
+    def end
+      self.result = runner.result unless runner.result.nil?
+
+      if runner.exception
+        data[:error] = runner.exception.inspect
+        data[:stacktrace] = runner.exception.backtrace
+      end
+
+      save
+      driver.quit
+
+      wait_until_finished
+    end
+
+    def wait_until_finished
+      start_time = Time.now
+      loop do
+        break if finished? || Time.now - start_time > 10
+      end
+    end
+
+    def finished?
+      details.end_time
+    end
+
+    def result=(res)
+      SauceWhisk::Jobs.change_status(@job_id, res)
+    end
+
+    def stop
+      SauceWhisk::Jobs.stop(@job_id)
+    end
+
+    def delete
+      start_time = Time.now
+      begin
+        response = JSON.parse SauceWhisk::Jobs.delete_job(@job_id).body
+        raise APIError, "Can not delete job: #{response['error']}" if response.key?('error')
+      rescue APIError
+        retry if Time.now - start_time < 5
+        raise
+      end
+    end
+
+    def details
+      SauceWhisk::Jobs.fetch(@job_id)
+    end
+
+    private
+
+    def job
+      @job ||= SauceWhisk::Jobs.fetch(@job_id)
+    end
+  end
+end

data/lib/saucer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Saucer
-  VERSION = "0.6.5"
+  VERSION = '1.0.0.alpha'
 end

data/saucer.gemspec

@@ -1,43 +1,43 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "saucer/version"
+require 'saucer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "saucer"
+  spec.name          = 'saucer'
   spec.version       = Saucer::VERSION
-  spec.authors       = ["Titus Fortner"]
-  spec.email         = ["titusfortner@gmail.com"]
+  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"
+  spec.summary       = 'A Ruby helper for running tests in Sauce Labs'
+  spec.description   = '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"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    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|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  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_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop', '~>0.66'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec', '~>1.32'
 
-  spec.add_dependency 'parallel_split_test'
-  spec.add_dependency 'require_all'
-  spec.add_dependency 'selenium-webdriver', "~> 3.0", ">= 3.4.4"
-  spec.add_dependency 'sauce_whisk'
-  spec.add_dependency 'sauce_platforms'
-  spec.add_dependency 'json'
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'sauce_whisk'
+  spec.add_runtime_dependency 'selenium-webdriver'
 end

metadata

@@ -1,79 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: saucer
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - Titus Fortner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-20 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.66'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.66'
 - !ruby/object:Gem::Dependency
-  name: parallel_split_test
+  name: rubocop-performance
   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
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,27 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.4
-  type: :runtime
+        version: '1.32'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.4
+        version: '1.32'
 - !ruby/object:Gem::Dependency
-  name: sauce_whisk
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sauce_platforms
+  name: sauce_whisk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,21 +132,22 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - 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/patches/sauce_whisk.rb
-- lib/saucer/platform_configuration.rb
-- lib/saucer/sauce.rb
+- lib/saucer/asset_management.rb
+- lib/saucer/custom_commands.rb
+- lib/saucer/data_collection.rb
+- lib/saucer/job_update.rb
+- lib/saucer/options.rb
+- lib/saucer/runners.rb
+- lib/saucer/runners/cucumber.rb
+- lib/saucer/runners/rspec.rb
+- lib/saucer/runners/unknown.rb
+- lib/saucer/session.rb
 - lib/saucer/version.rb
 - saucer.gemspec
 homepage: http://github.com/titusfortner/saucer
@@ -185,12 +166,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: A Ruby helper for running tests in Sauce Labs