sauce 1.0.2 → 2.0.0

data/gemfiles/rails2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source :gemcutter
+
+gem "rspec", "1.3.2"
+gem "rspec-rails", "1.3.4"
+gem "rails", "2.3.14"
+gem "sqlite3"
+
+gemspec :path=>"../"

data/gemfiles/rails2.gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: /home/tyler/source/github/sauce_ruby
+  specs:
+    sauce (1.1.0)
+      childprocess (>= 0.1.6)
+      cmdparse (>= 2.0.2)
+      highline (>= 1.5.0)
+      json (>= 1.2.0)
+      net-http-persistent
+      net-ssh
+      net-ssh-gateway
+      rest-client
+      selenium-webdriver (>= 0.1.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.14)
+      actionpack (= 2.3.14)
+    actionpack (2.3.14)
+      activesupport (= 2.3.14)
+      rack (~> 1.1.0)
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activeresource (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    appraisal (0.4.1)
+      bundler
+      rake
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    cmdparse (2.0.3)
+    ffi (1.0.11)
+    highline (1.6.11)
+    json (1.6.6)
+    mime-types (1.18)
+    multi_json (1.2.0)
+    net-http-persistent (2.6)
+    net-ssh (2.3.0)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    rack (1.1.3)
+    rails (2.3.14)
+      actionmailer (= 2.3.14)
+      actionpack (= 2.3.14)
+      activerecord (= 2.3.14)
+      activeresource (= 2.3.14)
+      activesupport (= 2.3.14)
+      rake (>= 0.8.3)
+    rake (0.9.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (1.3.2)
+    rspec-rails (1.3.4)
+      rack (>= 1.0.0)
+      rspec (~> 1.3.1)
+    rubyzip (0.9.6.1)
+    selenium-webdriver (2.20.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      multi_json (~> 1.0)
+      rubyzip
+    sqlite3 (1.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler
+  rails (= 2.3.14)
+  rake
+  rspec (= 1.3.2)
+  rspec-rails (= 1.3.4)
+  sauce!
+  sqlite3

data/gemfiles/rails3.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source :gemcutter
+
+gem "rspec"
+gem "rspec-rails"
+gem "rails", "3.2.0"
+
+gemspec :path=>"../"

data/gemfiles/rails3.gemfile.lock

@@ -0,0 +1,137 @@
+PATH
+  remote: /home/tyler/source/github/sauce_ruby
+  specs:
+    sauce (1.1.0)
+      childprocess (>= 0.1.6)
+      cmdparse (>= 2.0.2)
+      highline (>= 1.5.0)
+      json (>= 1.2.0)
+      net-http-persistent
+      net-ssh
+      net-ssh-gateway
+      rest-client
+      selenium-webdriver (>= 0.1.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.0)
+      actionpack (= 3.2.0)
+      mail (~> 2.4.0)
+    actionpack (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.0)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.0)
+      activesupport (= 3.2.0)
+      builder (~> 3.0.0)
+    activerecord (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+    activesupport (3.2.0)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    cmdparse (2.0.3)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ffi (1.0.11)
+    highline (1.6.11)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.6.6)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.2.0)
+    net-http-persistent (2.6)
+    net-ssh (2.3.0)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.0)
+      actionmailer (= 3.2.0)
+      actionpack (= 3.2.0)
+      activerecord (= 3.2.0)
+      activeresource (= 3.2.0)
+      activesupport (= 3.2.0)
+      bundler (~> 1.0)
+      railties (= 3.2.0)
+    railties (3.2.0)
+      actionpack (= 3.2.0)
+      activesupport (= 3.2.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rspec-rails (1.3.2)
+      rack (>= 1.0.0)
+      rspec (>= 1.3.0)
+    rubyzip (0.9.6.1)
+    selenium-webdriver (2.20.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      multi_json (~> 1.0)
+      rubyzip
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.32)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler
+  rails (= 3.2.0)
+  rake
+  rspec
+  rspec-rails
+  sauce!

data/lib/generators/sauce/install/install_generator.rb

@@ -35,18 +35,17 @@ module Sauce
       private
 
       def generate_config
-        @random_id ||= rand(100000)
         return <<-CONFIG
 
 require 'sauce'
 
 Sauce.config do |conf|
-    conf.browser_url = "http://#{@random_id}.test/"
     conf.browsers = [
         ["Windows 2003", "firefox", "3.6."]
     ]
     conf.application_host = "127.0.0.1"
     conf.application_port = "3001"
+    conf.browser_url = "http://localhost:3001/"
 end
           CONFIG
       end

data/lib/sauce.rb

@@ -7,26 +7,4 @@ require 'sauce/integrations'
 require 'sauce/connect'
 
 module Sauce
-  @@cached_sessions = {}
-
-  def self.cached_session(opts)
-    @@cached_sessions[opts] or new_session(opts)
-  end
-
-  private
-
-  def self.new_session(opts)
-    session = nil
-    if Sauce::Config.new.local?
-      session = ::Selenium::Client::Driver.new(opts)
-    else
-      session = Sauce::Selenium.new(opts)
-    end
-    at_exit do
-      session.stop
-    end
-    session.start
-    @@cached_sessions[opts] = session
-    return session
-  end
 end

data/lib/sauce/capybara.rb

@@ -1,40 +1,86 @@
 require 'capybara'
-require 'uri'
 
-$uri = URI.parse Capybara.app_host || ""
+require 'sauce/config'
+require 'sauce/connect'
+require 'sauce/selenium'
+
+
+$sauce_tunnel = nil
 
 module Sauce
   module Capybara
+    def connect_tunnel(options={})
+      unless $sauce_tunnel.nil?
+        return $sauce_tunnel
+      end
+      $sauce_tunnel = Sauce::Connect.new(options)
+      $sauce_tunnel.connect
+      $sauce_tunnel.wait_until_ready
+      $sauce_tunnel
+    end
+    module_function :connect_tunnel
+
     class Driver < ::Capybara::Selenium::Driver
-      def browser
-        unless @browser
-          puts "[Connecting to Sauce OnDemand...]"
-          config = Sauce::Config.new
-          @domain = "#{rand(10000)}.test"
-          @sauce_tunnel = Sauce::Connect.new(:host => $uri.host || rack_server.host,
-                                             :port => $uri.port || rack_server.port,
-                                             :domain => @domain,
-                                             :quiet => true)
-          @sauce_tunnel.wait_until_ready
-          @browser = Sauce::Selenium2.new(:name => "Capybara test",
-                                          :browser_url => "http://#{@domain}")
-          at_exit do
-            @browser.quit
-            @sauce_tunnel.disconnect
+      RETRY_ON = [::Selenium::WebDriver::Error::UnhandledError,
+                  ::Selenium::WebDriver::Error::UnknownError]
+      MAX_RETRIES = 3
+
+      def handle_retry(method, *args)
+        retries = 0
+
+        # Disable retries only when we really really want to, this will remain
+        # an undocomented hack for the time being
+        if ENV['SAUCE_DISABLE_RETRY']
+          retries = MAX_RETRIES
+        end
+
+        begin
+          send("base_#{method}".to_sym, *args)
+        rescue *RETRY_ON => e
+          if retries < MAX_RETRIES
+            puts "Received an exception (#{e}), retrying"
+            retries = retries + 1
+            retry
+          else
+            raise
           end
         end
-        @browser
       end
 
-      private
+      alias :base_find :find
+      alias :base_visit :visit
+      alias :base_current_url :current_url
+      alias :base_reset! :reset!
+      alias :base_within_frame :within_frame
+      alias :base_within_window :within_window
+      alias :base_find_window :find_window
+      alias :base_body :body
+      alias :base_source :source
+      alias :base_execute_script :execute_script
+      alias :base_evaluate_script :evaluate_script
 
-      def url(path)
-        if path =~ /^http/
-          path
-        else
-          "http://#{@domain}#{path}"
+      [:find, :visit, :current_url, :reset!, :within_frame,
+       :within_window, :find_window, :body, :source,
+       :execute_script, :evaluate_script].each do |method|
+        define_method(method) do |*args|
+          handle_retry(method, *args)
         end
       end
+
+      def browser
+        unless @browser
+          if Sauce.get_config[:start_tunnel]
+            Sauce::Capybara.connect_tunnel(:quiet => true)
+          end
+
+          @browser = Sauce::Selenium2.new
+          at_exit do
+            @browser.quit if @browser
+            $sauce_tunnel.disconnect if $sauce_tunnel
+          end
+        end
+        @browser
+      end
     end
   end
 end
@@ -50,11 +96,3 @@ module Capybara
     @javascript_driver || :sauce
   end
 end
-
-# Switch Cucumber stories tagged with @selenium to use sauce
-begin
-  Before("@selenium") do
-    Capybara.current_driver = :sauce
-  end
-rescue NoMethodError
-end

data/lib/sauce/capybara/cucumber.rb

@@ -0,0 +1,121 @@
+require 'capybara'
+require 'cucumber'
+require 'sauce/job'
+
+module Sauce
+  module Capybara
+    module Cucumber
+      def use_sauce_driver
+        ::Capybara.current_driver = :sauce
+      end
+      module_function :use_sauce_driver
+
+      def name_from_scenario(scenario)
+        # Special behavior to handle Scenario Outlines
+        if scenario.instance_of? ::Cucumber::Ast::OutlineTable::ExampleRow
+          table = scenario.instance_variable_get(:@table)
+          outline = table.instance_variable_get(:@scenario_outline)
+          return "#{outline.feature.file} - #{outline.title} - #{table.headers} -> #{scenario.name}"
+        end
+        scenario, feature = _scenario_and_feature_name(scenario)
+        return "#{feature} - #{scenario}"
+      end
+      module_function :name_from_scenario
+
+      def jenkins_name_from_scenario(scenario)
+        # Special behavior to handle Scenario Outlines
+        if scenario.instance_of? ::Cucumber::Ast::OutlineTable::ExampleRow
+          table = scenario.instance_variable_get(:@table)
+          outline = table.instance_variable_get(:@scenario_outline)
+          return "#{outline.feature.short_name}.#{outline.title}.#{outline.title} (outline example: #{scenario.name})"
+        end
+        scenario, feature = _scenario_and_feature_name(scenario)
+        return "#{feature}.#{scenario}.#{scenario}"
+      end
+      module_function :jenkins_name_from_scenario
+
+      def _scenario_and_feature_name(scenario)
+        scenario_name = scenario.name.split("\n").first
+        feature_name = scenario.feature.short_name
+        return scenario_name, feature_name
+      end
+      module_function :_scenario_and_feature_name
+
+      def before_hook
+        Sauce::Capybara::Cucumber.use_sauce_driver
+      end
+      module_function :before_hook
+
+      def using_jenkins?
+        # JENKINS_SERVER_COOKIE seems to be as good as any sentinel value to
+        # determine whether we're running under Jenkins or not.
+        ENV['JENKINS_SERVER_COOKIE']
+      end
+      module_function :using_jenkins?
+
+      def around_hook(scenario, block)
+        ::Capybara.current_driver = :sauce
+        driver = ::Capybara.current_session.driver
+        # This session_id is the job ID used by Sauce Labs, we're pulling it
+        # off of the driver now to make sure we have it after `block.call`
+        session_id = driver.browser.session_id
+        job_name = Sauce::Capybara::Cucumber.name_from_scenario(scenario)
+        custom_data = {}
+
+        if using_jenkins?
+          custom_data.merge!({:commit => ENV['GIT_COMMIT'] || ENV['SVN_COMMIT'],
+                       :jenkins_node => ENV['NODE_NAME'],
+                       :jenkins_job => ENV['JOB_NAME']})
+        end
+
+        job = Sauce::Job.new('id' => session_id,
+                             'name' => job_name,
+                             'custom-data' => custom_data)
+        job.save unless job.nil?
+
+        Sauce.config do |c|
+          c[:name] = Sauce::Capybara::Cucumber.name_from_scenario(scenario)
+        end
+
+        if using_jenkins?
+          # If we're running under Jenkins, we should dump the
+          # `SauceOnDemandSessionID` into the Console Output for the Sauce OnDemand
+          # Jenkins plugin.
+          # See: <https://github.com/saucelabs/sauce_ruby/issues/48>
+          output = []
+          output << "\nSauceOnDemandSessionID=#{session_id}"
+          # The duplication in the scenario_name comes from the fact that the
+          # JUnit formatter seems to do the same, so in order to get the sauce
+          # OnDemand plugin for Jenkins to co-operate, we need to double it up as
+          # well
+          output << "job-name=#{Sauce::Capybara::Cucumber.jenkins_name_from_scenario(scenario)}"
+          puts output.join(' ')
+        end
+
+        block.call
+
+        # Quit the driver to allow for the generation of a new session_id
+        driver.browser.quit
+        driver.instance_variable_set(:@browser, nil)
+
+        unless job.nil?
+          job.passed = !scenario.failed?
+          job.save
+        end
+      end
+      module_function :around_hook
+    end
+  end
+end
+
+
+begin
+  Before('@selenium') do
+    Sauce::Capybara::Cucumber.before_hook
+  end
+
+  Around('@selenium') do |scenario, block|
+    Sauce::Capybara::Cucumber.around_hook(scenario, block)
+  end
+rescue NoMethodError # This makes me sad
+end