sauce 3.5.6 → 3.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad3334a7a1d5f395f753d7cc73b4e97bed7395b9
-  data.tar.gz: 37127667da25b694701d12811745a00405499012
+  metadata.gz: cf1ac30663f0230515af484aa14d2de9a51e0dba
+  data.tar.gz: ec92ecb4788c3e81988536e62b6bd3f3048fbc20
 SHA512:
-  metadata.gz: e0be3a5702bdd62d855e2fbf577623f5ee68728909f45e78ac5f6cc869cc68619f5480b8397c04edcca6408bf01ead2e780d3371890fcfd00498cdf19518f9e1
-  data.tar.gz: 990e58494e057db7ab07b66f847b88ca4cd382f17d5cb02c691c613b384a3b1b059a3a6074e9064bad15113e835dd221b17196ee42dd40c2804e509f0a9bd445
+  metadata.gz: 2e138b92a567eb111d1e72ed556b1329c190a796f349f5a685be7833031b8ed31d789f6d504008b2474d48f65981f39859c07c338038431839c2b9ed4f57a149
+  data.tar.gz: 4cb17bcd1da62503ef940270b0b13820cfed7f039d573fea72878e6af2b21000ea158db970cc68b3fea34b60799d220f159df982ce3a8dd6b2b1ccf6d52caf82

data/lib/parallel_tests/cli_patch.rb

@@ -14,6 +14,7 @@ module ParallelTests
           run_tests(group, Sauce::TestBroker.group_index(group), num_processes, options)
         end
 
+        Sauce.logger.debug "Parallel Tests reporting results."
         report_results(test_results)
       end
 

data/lib/parallel_tests/saucecucumber/runner.rb

@@ -1,4 +1,5 @@
 require "parallel_tests/cucumber/runner"
+require "sauce/logging"
 
 module ParallelTests
   module Saucecucumber
@@ -16,6 +17,9 @@ module ParallelTests
             cucumber_opts(options[:test_options]),
             *sanitized_test_files
         ].compact.join(" ")
+        Sauce.logger.debug "Starting parallel process #{process_number} of #{num_processes}"
+        Sauce.logger.debug "  #{cmd}"
+        Sauce.logger.debug "  #{our_options}"
         execute_command(cmd, process_number, num_processes, options)
       end
 

data/lib/parallel_tests/saucerspec/runner.rb

@@ -1,5 +1,6 @@
 require "yaml"
 require "parallel_tests/rspec/runner"
+require "sauce/logging"
 
 module ParallelTests
   module Saucerspec
@@ -13,6 +14,9 @@ module ParallelTests
         env = Sauce::TestBroker.next_environment(test_files)
         env << " #{rspec_1_color}" if version == 1
         our_options.merge!(:env => env)
+        Sauce.logger.debug "Starting parallel process #{process_number} of #{num_processes}"
+        Sauce.logger.debug "  #{cmd}"
+        Sauce.logger.debug "  #{our_options}"
         execute_command(cmd, process_number, num_processes, our_options)
       end
 

data/lib/sauce.rb

@@ -14,6 +14,7 @@ require 'sauce/selenium'
 require 'sauce/test_base'
 require 'sauce/rspec/rspec'
 require 'sauce/test_unit'
+require 'sauce/logging'
 require 'parallel_tests/saucerspec/runner'
 require 'parallel_tests/saucecucumber/runner'
 

data/lib/sauce/capybara.rb

@@ -2,6 +2,7 @@ require 'capybara'
 require 'sauce/config'
 require 'sauce/selenium'
 require 'sauce/version'
+require 'sauce/logging'
 
 
 $sauce_tunnel = nil
@@ -85,6 +86,7 @@ module Sauce
           # Try to get a driver from the driver pool
           @browser = rspec_browser
           unless @browser
+            Sauce.logger.debug "Capybara creating new Selenium driver."
             @browser = Sauce::Selenium2.new
             at_exit do
               finish!
@@ -97,6 +99,7 @@ module Sauce
       # Returns the rspec created browser if it exists
       def rspec_browser
         if browser = Sauce.driver_pool[Thread.current.object_id]
+          Sauce.logger.debug "Using browser from driver_pool (browser.session_id)."
           @using_rspec_browser = true
         else
           @using_rspec_browser = false
@@ -115,6 +118,7 @@ module Sauce
       end
 
       def finish!
+        Sauce.logger.debug "Capybara integration called #finish!"
         @browser.quit if existing_browser?
         @browser = nil
 

data/lib/sauce/config.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'yaml'
 require 'uri'
+require 'sauce/logging'
 
 module Sauce
   def self.config
@@ -67,11 +68,15 @@ module Sauce
         sauce-advisor single-window user-extensions-url firefox-profile-url
         max-duration idle-timeout build custom-data tunnel-identifier
         selenium-version command-timeout prerun prerun-args screen-resolution
-        disable-popup-handler avoid-proxy public name iedriver-version parent-tunnel}
+        disable-popup-handler avoid-proxy public name iedriver-version parent-tunnel
+        time-zone device-orientation record-logs webdriver-remote-quiet-exceptions
+        iedriver-version
+    }
 
     def self.get_application_port
       port_index = ENV["TEST_ENV_NUMBER"].to_i
-      return POTENTIAL_PORTS[port_index]
+      port_to_use = POTENTIAL_PORTS[port_index]
+      return port_to_use
     end
 
     def self.called_from_integrations?
@@ -79,6 +84,7 @@ module Sauce
     end
 
     def self.called_from_integrations
+      Sauce.logger.debug "Sauce config accessed from an integration"
       @called_from_integrations = true
     end
 
@@ -150,6 +156,7 @@ module Sauce
     end
 
     def whitelist capability
+      Sauce.logger.info "Whitelisting #{capability}"
       cap = capability.to_s
       wl = whitelisted_capabilities || Set.new
       @whitelisted_capabilities = wl.add cap
@@ -291,7 +298,11 @@ module Sauce
     end
 
     def run_post_job_hooks(job_id, platform, job_name, job_success)
+      Sauce.logger.debug "Running post job hook for #{job_id}"
+      Sauce.logger.debug " - Job name #{job_name}"
+      Sauce.logger.debug " - Successful? #{job_success}"
       @opts[:after_job_hooks].each do |key, hook|
+        Sauce.logger.debug "Running #{hook}"
         hook.call job_id, platform, job_name, job_success
       end
     end
@@ -330,6 +341,7 @@ module Sauce
     def load_options_from_heroku
       @@heroku_environment ||= begin
         if File.exists?(File.expand_path('~/.heroku'))
+          Sauce.logger.debug "Heroku config found."
           heroku_app = ENV['SAUCE_HEROKU_APP']
           cmd = "heroku config #{heroku_app ? "--app #{heroku_app}": ''}"
           cmd += "--shell 2>/dev/null"
@@ -363,6 +375,7 @@ module Sauce
 
         paths.each do |path|
             if File.exist? path
+                Sauce.debug.info "Loading Sauce config from yaml file at #{path}"
                 conf = YAML.load_file(path)
                 return conf.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
             end

data/lib/sauce/logging.rb

@@ -0,0 +1,57 @@
+require "logger"
+
+module Sauce
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  # Returns the set logger or, if none is set, a default logger
+  def self.logger
+    @logger ||= default_logger
+  end
+
+  private
+
+  # Creates a default logger when the user hasn't set one.
+  # Default logger with be STDOUT _unless_ the `SAUCE_LOGFILE` environment var
+  # has been set, in which case that file will be appended to, until it is
+  # 10240 bytes, when it will be rotated.  This will happen 10 times.
+  #
+  # The default logging level is WARN, but can be set with the
+  # environment var SAUCE_LOGLEVEL
+  def self.default_logger
+    log = ::Logger.new(*default_logger_arguments)
+    log.level = default_logging_level
+    return log
+  end
+
+  def self.default_logger_arguments
+    logfile = ENV["SAUCE_LOGFILE"]
+    if logfile
+      
+      unless ENV["TEST_ENV_NUMBER"].nil?
+        logfile = "#{logfile}#{ENV["TEST_ENV_NUMBER"]}"
+
+      end
+      log = File.open logfile, File::WRONLY | File::APPEND | File::CREAT
+      return [log, 10, 10240]
+    else
+      return [STDOUT]
+    end
+  end
+
+  def self.default_logging_level
+    case ENV.fetch("SAUCE_LOGLEVEL", "").downcase
+    when 'error'
+      Logger::ERROR
+    when 'warn'
+      Logger::WARN
+    when 'info'
+      Logger::INFO
+    when 'debug'
+      Logger::DEBUG
+    else
+      Logger::WARN
+    end
+  end
+end

data/lib/sauce/parallel/test_broker.rb

@@ -92,6 +92,7 @@ module Sauce
         error_message << possible_config_files.map { |file_path| "  - #{file_path}" }.join("\n")
         raise error_message
       end
+      Sauce.logger.info "Reading configuration from #{configuration_file}"
       require configuration_file
     end
 

data/lib/sauce/parallel/test_group.rb

@@ -1,3 +1,5 @@
+require "sauce/logging"
+
 module Sauce
   class TestGroup
     def initialize(platforms)
@@ -16,7 +18,7 @@ module Sauce
         }
         caps.merge!({:caps => platform[3]}) if platform[3]
         caps
-      rescue NoMethodError => e
+      rescue NoMethodError
         puts "I don't have any config"
       end
     end

data/lib/sauce/rspec/rspec.rb

@@ -34,12 +34,15 @@ begin
       end
 
       def self.start_tools_for_sauce_tag
+        Sauce.logger.debug "Starting Tooling for 'sauce' tagged tests"
         config = Sauce::Config.new
         if config[:start_tunnel]
+          Sauce.logger.debug " - Sauce Connect"
           Sauce::Utilities::Connect.start_from_config(config)
         end
 
         unless self.server
+          Sauce.logger.debug " - Rails Server"
           self.server= Sauce::Utilities::RailsServer.start_if_required(config)
         end
       end
@@ -53,12 +56,18 @@ begin
         running_selenium_specs = files_to_run.any? {|file| file =~ /spec\/selenium\//}
         need_tunnel = running_selenium_specs && config[:application_host]
 
+        if running_selenium_specs
+          Sauce.logger.debug "Starting Tooling for Selenium directory tests"
+        end
+
         if need_tunnel && config[:start_tunnel]
+          Sauce.logger.debug " - Sauce Connect"
           Sauce::Utilities::Connect.start_from_config(config)
         end
 
         if running_selenium_specs
           unless self.server
+            Sauce.logger.debug " - Rails Server"
             self.server= Sauce::Utilities::RailsServer.start_if_required(config)
           end
         end
@@ -118,6 +127,7 @@ begin
         end
 
         def self.included(othermod)
+          Sauce.logger.debug "Sauce RSpec module was included by #{othermod.name}"
           othermod.around do |the_test|
             config = Sauce::Config.new
             description = the_test.metadata[:full_description]
@@ -125,6 +135,7 @@ begin
             exceptions = {}
             test_each config.caps_for_location(file), description do |selenium, caps|
 
+              Sauce.logger.debug "Running RSpec test for #{file} with #{caps}."
               example = SeleniumExampleGroup.current_example.call(self)
               example.instance_variable_set(:@exception, nil)
               
@@ -133,6 +144,7 @@ begin
               example.metadata[:sauce_public_link] = SauceWhisk.public_link(@selenium.session_id)
 
               begin
+                Sauce.logger.debug "About to initiate test #{description}"
                 the_test.run
                 success = example.exception.nil?
               ensure
@@ -147,8 +159,8 @@ begin
                   platform = {:os => os, :browser => browser, :version => version}
                   config.run_post_job_hooks(@selenium.session_id, platform, description, success)
                 rescue Exception => e
-                  STDERR.puts "Error running post job hooks"
-                  STDERR.puts e
+                  Sauce.logger.error "Error running post job hooks"
+                  Sauce.logger.error e
                 end
                 Sauce.driver_pool.delete Thread.current.object_id
               end
@@ -179,8 +191,9 @@ begin
     end
   end
 rescue LoadError, TypeError
+  Sauce.logger.debug "Failed to require #{__FILE__} - Likely RSpec 2+ isn't present."
   # User doesn't have RSpec 2.x installed
 rescue => e
-  STDERR.puts "Exception caught: #{e.to_s}"
+  Sauce.logger.debug "Exception caught when including #{__FILE__}: #{e.to_s}"
   exit 1
 end

data/lib/sauce/rspec/rspec_one_support.rb

@@ -3,6 +3,9 @@ require "sauce_whisk"
 
 begin
   require 'spec'
+  # any gem could export a require as 'spec' so we must explicitly check
+  # to see if the expected rspec 1 class has loaded.
+  raise LoadError unless defined?(Spec::Example::ExampleGroup)
   module Sauce
     module RSpec
       class SeleniumExampleGroup < Spec::Example::ExampleGroup
@@ -41,7 +44,7 @@ begin
             @selenium = Sauce::Selenium2.new({:os => os, :browser => browser,
                                               :browser_version => version,
                                               :job_name => description})
-            
+
             begin
               success = super(*args)
               SauceWhisk::Jobs.change_status @selenium.session_id, success
@@ -63,4 +66,4 @@ rescue LoadError
 rescue => e
   STDERR.puts "Exception occured: #{e.to_s}"
   exit 1
-end
+end

data/lib/sauce/selenium.rb

@@ -28,12 +28,18 @@ module Selenium
   end
 end
 
+module Sauce
+  class << self
+    attr_accessor :webdriver_method
+  end
+  @webdriver_method = lambda { |*args| ::Selenium::WebDriver.for *args }
+end
 
 module Sauce
   class Selenium2
     extend Forwardable
 
-    attr_reader :config, :driver
+    attr_reader :config, :driver, :watir, :raw_driver
 
     def_delegator :@driver, :execute_script
 
@@ -50,17 +56,21 @@ module Sauce
       http_client = ::Selenium::WebDriver::Remote::Http::Persistent.new
       http_client.timeout = 300 # Browser launch can take a while
 
-      @driver = ::Selenium::WebDriver.for(:remote,
+      @driver = Sauce.webdriver_method.call(:remote,
                       :url => "http://#{@config.username}:#{@config.access_key}@#{@config.host}:#{@config.port}/wd/hub",
                       :desired_capabilities => @config.to_desired_capabilities,
                       :http_client => http_client)
       http_client.timeout = 90 # Once the browser is up, commands should time out reasonably
 
-      @driver.file_detector = lambda do |args|
+      @watir = defined?(Watir::Browser) && @driver.is_a?(Watir::Browser)
+      @raw_driver = watir ? @driver.driver : @driver
+
+      raw_driver.file_detector = lambda do |args|
         file_path = args.first.to_s
         File.exist?(file_path) ? file_path : false
       end
 
+      Sauce.logger.debug "Thread #{Thread.current.object_id} created driver #{raw_driver.session_id}"
       Sauce::Selenium2.used_at_least_once
     end
 
@@ -69,15 +79,17 @@ module Sauce
     end
 
     def session_id
-      @driver.send(:bridge).session_id
+      raw_driver.send(:bridge).session_id
     end
 
     def current_url
-      @driver.current_url
+      raw_driver.current_url
     end
 
     def stop
+      Sauce.logger.debug "Thread #{Thread.current.object_id} quitting driver #{@driver.session_id}"
       @driver.quit
+      Sauce.logger.debug "Thread #{Thread.current.object_id} has quit driver #{@driver.session_id}"
     end
   end
 end

data/lib/sauce/utilities.rb

@@ -55,7 +55,7 @@ If you are using Capybara and are seeing this message, check the Capybara README
           tests = 'features'
           runner = 'Cucumber'
           tag = '@selenium'
-        else :rspec
+        else
           tests = 'specs'
           runner = 'RSpec'
           tag = ':sauce => true'

data/lib/sauce/utilities/connect.rb

@@ -1,36 +1,56 @@
 module Sauce
   module Utilities
     class Connect
+      class TunnelNeverStarted < StandardError
+      end
+
+      TIMEOUT = 90 # Magic Numbers!
+
       def self.start_from_config(config)
         self.start(:host => config[:application_host], :port => config[:application_port], :quiet => true)
       end
 
       def self.start(options={})
         begin
+          Sauce.logger.debug "Requiring Sauce Connect gem."
           require "sauce/connect"
         rescue LoadError => e
           STDERR.puts 'Please install the `sauce-connect` gem if you intend on using Sauce Connect with your tests!'
           exit(1)
         end
 
+        options[:timeout] = TIMEOUT unless options[:timeout]
         if ParallelTests.first_process?
+          Sauce.logger.debug "#{Thread.current.object_id} - First parallel process attempting to start Sauce Connect."
           unless @tunnel
             @tunnel = Sauce::Connect.new options
             @tunnel.connect
             @tunnel.wait_until_ready
+          else
+            Sauce.logger.warn "#{Thread.current.object_id} - Tunnel already existed somehow."
           end
           @tunnel
         else
-          while not File.exist? "sauce_connect.ready"
-            sleep 0.5
+          Sauce.logger.debug "#{Thread.current.object_id} - Waiting for a Sauce Connect tunnel to be ready."
+          timeout_after = Time.now + options[:timeout]
+          # Ensure first process has a change to start up
+          sleep 5
+          readyfile_found = File.exist? "sauce_connect.ready" 
+          until (Time.now > timeout_after) || readyfile_found
+            readyfile_found = File.exist? "sauce_connect.ready"
+            sleep 1
           end
+
+          raise(TunnelNeverStarted, "Sauce Connect was not started within #{TIMEOUT} seconds") unless readyfile_found
         end
       end
 
       def self.close
         if @tunnel
           if ParallelTests.first_process?
+            Sauce.logger.debug "#{Thread.current.object_id} - First parallel process waiting for other processes before closing Sauce Connect."
             ParallelTests.wait_for_other_processes_to_finish
+            Sauce.logger.debug "#{Thread.current.object_id} - All other parallel processes closed - Closing Sauce Connect tunnel #{@tunnel}."
             @tunnel.disconnect
             @tunnel = nil
           end

data/lib/sauce/utilities/rails_server.rb

@@ -8,6 +8,8 @@ module Sauce
 
       def self.start_if_required(config)
         if config[:start_local_application] && self.is_rails_app?
+          Sauce.logger.debug "App is a Rails app and config[:start_local_application] was trueish."
+          Sauce.logger.info "#{Thread.current.object_id} - Starting Rails app server."
           server = new
           server.start
 
@@ -75,19 +77,22 @@ module Sauce
         wait_for_server_on_port(@port)
 
         at_exit do
+          Sauce.logger.debug "#{Thread.current.object_id} - At exit hook called in Sauce::Utilities::RailsServer."
+          Sauce.logger.info "Stopping Rails App Server."
           @server.stop(3, "INT")
           RailsServer.server_pool.delete Thread.current.object_id
         end
-        STDERR.puts "Rails server running!"
+        Sauce.logger.info "Rails server running!"
 
         RailsServer.server_pool[Thread.current.object_id] = @server
       end
 
       def stop
+        Sauce.logger.debug "#{Thread.current.object_id} - Stopping Rails app server with #stop method."
         begin
           @server.stop(3, "INT")
         rescue
-          STDERR.puts "Rails server could not be killed. Did it fail to start?"
+          Sauce.logger.error "#{Thread.current.object_id} - Rails server could not be killed. Did it fail to start?"
         end
       end
     end

data/lib/sauce/version.rb

@@ -1,6 +1,6 @@
 module Sauce
   MAJOR_VERSION = '3.5'
-  PATCH_VERSION = '6'
+  PATCH_VERSION = '7'
 
   def version
     "#{MAJOR_VERSION}.#{PATCH_VERSION}"

data/spec/integration/connect/spec/start_tunnel_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe "Sauce::Config" do
+describe "Sauce::Config", :sauce => true do
   it "should start Connect when start_tunnel is set" do
     tunnel = Sauce::Utilities::Connect.tunnel
     tunnel.should_not be_nil

data/spec/integration/connect/spec/with_capybara_spec.rb

@@ -2,9 +2,9 @@ require "spec_helper"
 
 describe "Capybara" do
 	describe "Without :sauce tagging", :js => true, :type => :feature do
-    it "should connect using the port", :js => true do
-      visit "/"
-      expect(page).to have_content "Hello Sauce!"
-    end
+    # it "should connect using the port", :js => true do
+    #   visit "/"
+    #   expect(page).to have_content "Hello Sauce!"
+    # end
   end
 end

data/spec/integration/rspec/spec/tagging/selenium_tagging_spec.rb

@@ -3,7 +3,7 @@ require "sauce"
 require "sauce/connect"
 
 Sauce.config do |c|
-  c.browsers = [
+  c[:browsers] = [
       ["Windows 2008", "iexplore", "9"],
       ["Linux", "opera", 12]
   ]

data/spec/sauce/file_detector_spec.rb

@@ -4,6 +4,7 @@ describe Sauce::Selenium2 do
   describe "#file_detector" do
     it "should return the path of files when they exist" do
       Selenium::WebDriver::Remote::Bridge.any_instance.stub(:create_session).and_return({})
+      Selenium::WebDriver::Remote::Bridge.any_instance.stub(:session_id).and_return("FSDSDFSDF")
 
       path = __FILE__
 

data/spec/sauce/selenium_spec.rb

@@ -6,6 +6,7 @@ describe Sauce::Selenium2 do
     before :each do
       mock_driver = double(::Selenium::WebDriver::Driver)
       mock_driver.stub(:file_detector=)
+      mock_driver.stub(:session_id)
       ::Selenium::WebDriver.should_receive(:for).and_return(mock_driver)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sauce
 version: !ruby/object:Gem::Version
-  version: 3.5.6
+  version: 3.5.7
 platform: ruby
 authors:
 - Dylan Lacey
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -267,6 +267,7 @@ files:
 - lib/sauce/driver_pool.rb
 - lib/sauce/heroku.rb
 - lib/sauce/job.rb
+- lib/sauce/logging.rb
 - lib/sauce/parallel.rb
 - lib/sauce/parallel/test_broker.rb
 - lib/sauce/parallel/test_group.rb
@@ -344,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Ruby helper for running tests in Sauce Labs