sauce_ruby 3.5.6

data/lib/sauce/rspec/rspec_formatter.rb

@@ -0,0 +1,20 @@
+begin
+  require 'rspec/core/formatters/base_text_formatter'
+  module RSpec
+    module Core
+      module Formatters
+        class BaseTextFormatter
+          def dump_failure(example, index)
+            output.puts "#{short_padding}#{index.next}) #{example.full_description}"
+            puts "#{short_padding}Sauce public job link: #{example.metadata[:sauce_public_link]}"
+            dump_failure_info(example)
+          end
+        end
+      end
+    end
+  end
+rescue LoadError
+  # User isn't using RSpec
+rescue NameError
+  # User is using RSpec 3
+end

data/lib/sauce/rspec/rspec_one_support.rb

@@ -0,0 +1,66 @@
+require 'sauce/utilities'
+require "sauce_whisk"
+
+begin
+  require 'spec'
+  module Sauce
+    module RSpec
+      class SeleniumExampleGroup < Spec::Example::ExampleGroup
+        attr_reader :selenium
+        @@need_tunnel = false
+
+        def self.inherited(subclass)
+          # only setup tunnel if somebody needs it
+          @@need_tunnel = true
+          super(subclass)
+        end
+
+        before :suite do
+          config = Sauce::Config.new
+          if @@need_tunnel
+            if config[:application_host]
+              Sauce::Utilities::Connect.start(:host => config[:application_host], :port => config[:application_port])
+            end
+            if config[:start_local_application] &&
+              Sauce::Utilities::RailsServer.is_rails_app?
+              @@server = Sauce::Utilities::RailsServer.new
+              @@server.start
+            end
+          end
+        end
+
+        after :suite do
+          Sauce::Utilities::Connect.close
+          @@server.stop if defined? @@server
+        end
+
+        def execute(*args)
+          config = Sauce::Config.new
+          description = [self.class.description, self.description].join(" ")
+          config[:browsers].each do |os, browser, version|
+            @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
+            ensure
+              @selenium.stop
+            end
+          end
+        end
+
+        alias_method :page, :selenium
+        alias_method :s, :selenium
+
+        Spec::Example::ExampleGroupFactory.register(:selenium, self)
+      end
+    end
+  end
+rescue LoadError
+  # User doesn't have RSpec 1.x installed
+rescue => e
+  STDERR.puts "Exception occured: #{e.to_s}"
+  exit 1
+end

data/lib/sauce/selenium.rb

@@ -0,0 +1,95 @@
+require "forwardable"
+require "sauce/driver_pool"
+
+require "selenium/client"
+require "selenium/webdriver"
+
+require 'selenium/webdriver/remote/http/persistent'
+
+module Selenium
+  module WebDriver
+    class Proxy
+      class << self
+        alias :existing_json_create :json_create
+
+        def json_create(data)
+          # Some platforms derp up JSON encoding proxy details,
+          # notably Appium.
+          if (data.class == String)
+            data = JSON.parse data if data.start_with? "{\"proxy"
+          end
+
+          dup = data.dup.delete_if {|k,v| v.nil?}
+          dup.delete_if {|k,v| k == "autodetect" && v == false}
+          existing_json_create(dup)
+        end
+      end
+    end
+  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, :watir
+
+    def_delegator :@driver, :execute_script
+
+    def self.used_at_least_once?
+      @used_at_least_once || false
+    end
+
+    def self.used_at_least_once
+      @used_at_least_once = true
+    end
+
+    def initialize(opts={})
+      @config = Sauce::Config.new(opts)
+      http_client = ::Selenium::WebDriver::Remote::Http::Persistent.new
+      http_client.timeout = 300 # Browser launch can take a while
+
+      @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
+
+      @watir = defined?(Watir::Browser) && @driver.is_a?(Watir::Browser)
+
+      raw_driver.file_detector = lambda do |args|
+        file_path = args.first.to_s
+        File.exist?(file_path) ? file_path : false
+      end
+
+      Sauce::Selenium2.used_at_least_once
+    end
+
+    def raw_driver
+      watir ? @driver.driver : @driver
+    end
+
+    def method_missing(meth, *args)
+      @driver.send(meth, *args)
+    end
+
+    def session_id
+      raw_driver.send(:bridge).session_id
+    end
+
+    def current_url
+      raw_driver.current_url
+    end
+
+    def stop
+      @driver.quit
+    end
+  end
+end

data/lib/sauce/test_base.rb

@@ -0,0 +1,21 @@
+module Sauce
+  module TestBase
+
+    # Run a block with every platform
+    def test_each(platforms, description)
+      platforms.each do |platform|
+        capabilities = {
+          :os => platform[0],
+          :browser => platform[1],
+          :browser_version => platform[2],
+          :job_name => description
+        }
+
+        capabilities.merge! platform[3] if platform[3]
+        selenium = Sauce::Selenium2.new(capabilities)
+
+        yield selenium, capabilities
+      end
+    end
+  end
+end

data/lib/sauce/test_unit.rb

@@ -0,0 +1,111 @@
+require 'sauce/utilities'
+require "sauce_whisk"
+
+module Sauce
+  module SeleniumForTestUnit
+    attr_reader :browser
+
+    alias_method :page, :browser
+    alias_method :s, :browser
+    alias_method :selenium, :browser
+
+    def run(*args, &blk)
+      if self.respond_to? :name
+        my_name = self.name
+      else
+        my_name = self.__name__
+      end
+      unless my_name =~ /^default_test/
+        config = Sauce::Config.new
+        if config[:application_host]
+          unless ENV['TEST_ENV_NUMBER'].to_i > 1
+            Sauce::Connect.ensure_connected(:host => config[:application_host], :port => config[:application_port] || 80)
+          end
+        end
+
+        unless defined?(@@server)
+          unless ENV['TEST_ENV_NUMBER'].to_i > 1
+            if config[:start_local_application] &&
+                Sauce::Utilities::RailsServer.is_rails_app?
+              @@server = Sauce::Utilities::RailsServer.new
+              @@server.start
+              at_exit do
+                @@server.stop
+              end
+            end
+          end
+        end
+
+        config[:browsers].each do |os, browser, version|
+          options = self.class.sauce_config
+          options.merge!({:os => os, :browser => browser,
+                          :browser_version => version,
+                          :job_name => my_name.to_s})
+          @browser = Sauce::Selenium2.new(options)
+          Sauce.driver_pool[Thread.current.object_id] = @browser
+
+          super(*args, &blk)
+
+          SauceWhisk::Jobs.change_status @browser.session_id, passed?
+          @browser.stop
+          Sauce.driver_pool.delete Thread.current.object_id
+        end
+      end
+    end
+  end
+end
+
+module Sauce
+  module SeleniumForTestUnitClassMethods
+    def selenium_flags=(options)
+      @selenium_flags = options
+    end
+
+    def selenium_flags
+      return @selenium_flags
+    end
+
+    def sauce_config=(config)
+      @sauce_config = config
+    end
+
+    def sauce_config
+      @sauce_config || {}
+    end
+  end
+end
+
+if defined?(ActiveSupport::TestCase)
+  module Sauce
+    class RailsTestCase < ::ActiveSupport::TestCase
+      include SeleniumForTestUnit
+      extend SeleniumForTestUnitClassMethods
+
+      # Placeholder so test/unit ignores test cases without any tests.
+      def default_test
+      end
+    end
+  end
+end
+
+begin
+  if Object.const_defined? :Test
+    if Test.const_defined? :Unit
+      require 'test/unit/testcase'
+      module Sauce
+        class TestCase < Test::Unit::TestCase
+          include SeleniumForTestUnit
+          extend SeleniumForTestUnitClassMethods
+
+          # Placeholder so test/unit ignores test cases without any tests.
+          def default_test
+          end
+        end
+      end
+    end
+  end
+rescue LoadError
+  # User doesn't have Test::Unit installed
+rescue => e
+  STDERR.puts "Exception caught: #{e.to_s}"
+end

data/lib/sauce/utilities.rb

@@ -0,0 +1,80 @@
+require 'timeout'
+require 'socket'
+require 'net/http'
+require 'sauce/parallel'
+require 'sauce/utilities/rails_server'
+require 'sauce/utilities/connect'
+
+module Sauce
+  module Utilities
+    def silence_stream(stream)
+      old_stream = stream.dup
+      stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+    end
+
+    def wait_for_server_on_port(port)
+      while true
+        begin
+          Timeout::timeout(2) do
+              socket = TCPSocket.new('127.0.0.1', port)
+              socket.close unless socket.nil?
+              return
+          end
+        rescue Errno::ECONNREFUSED,
+          Errno::EBADF,           # Windows
+          Timeout::Error
+        end
+        sleep 2
+      end
+    end
+
+    def self.warn_if_suspect_misconfiguration(style = :rspec)
+      if Sauce::Selenium2.used_at_least_once?
+        integrated = Sauce::Config.called_from_integrations?
+        warnings_on = Sauce::Config.new[:warn_on_skipped_integration]
+        unless (integrated && warnings_on)
+          STDERR.puts Sauce::Utilities.incorrectly_integrated_warning(style)
+        end
+      end
+    end
+
+    def self.page_deprecation_message
+      return <<-MESSAGE
+[DEPRECATED] Using the #page method is deprecated for RSpec tests without Capybara.  Please use the #s or #selenium method instead.
+If you are using Capybara and are seeing this message, check the Capybara README for information on how to include the Capybara DSL in your tests.
+      MESSAGE
+    end
+
+    def self.incorrectly_integrated_warning(style = :rspec)
+      case style
+        when :cuke
+          tests = 'features'
+          runner = 'Cucumber'
+          tag = '@selenium'
+        else :rspec
+          tests = 'specs'
+          runner = 'RSpec'
+          tag = ':sauce => true'
+      end
+
+      return <<-stringend
+
+===============================================================================
+Your #{tests} used the Sauce Selenium driver, but not the #{runner} integration.
+This may result in undesired behaviour, such as configured platforms being
+skipped.
+
+You can correct this by tagging #{tests} intended for Sauce with
+'#{tag}'.
+
+You can disable this message by setting the 'warn_on_skipped_integration'
+config option to false.
+===============================================================================
+      stringend
+    end
+  end
+end

data/lib/sauce/utilities/connect.rb

@@ -0,0 +1,45 @@
+module Sauce
+  module Utilities
+    class Connect
+      def self.start_from_config(config)
+        self.start(:host => config[:application_host], :port => config[:application_port], :quiet => true)
+      end
+
+      def self.start(options={})
+        begin
+          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
+
+        if ParallelTests.first_process?
+          unless @tunnel
+            @tunnel = Sauce::Connect.new options
+            @tunnel.connect
+            @tunnel.wait_until_ready
+          end
+          @tunnel
+        else
+          while not File.exist? "sauce_connect.ready"
+            sleep 0.5
+          end
+        end
+      end
+
+      def self.close
+        if @tunnel
+          if ParallelTests.first_process?
+            ParallelTests.wait_for_other_processes_to_finish
+            @tunnel.disconnect
+            @tunnel = nil
+          end
+        end
+      end
+
+      class << self
+        attr_reader :tunnel
+      end
+    end
+  end
+end