sauce 1.0.2 → 2.0.0

data/lib/sauce/config.rb

@@ -4,12 +4,15 @@ require 'uri'
 
 module Sauce
   def self.config
-    @cfg = Sauce::Config.new(false)
-    yield @cfg
+    yield get_config
   end
 
   def self.get_config
-    @cfg
+    @cfg ||= Sauce::Config.new(false)
+  end
+
+  def self.clear_config
+    @cfg = nil
   end
 
   class Config
@@ -24,7 +27,8 @@ module Sauce
         :browser_version => "3.6.",
         :job_name => "Unnamed Ruby job",
         :local_application_port => "3001",
-        :capture_traffic => false
+        :capture_traffic => false,
+        :start_tunnel => true
     }
 
     ENVIRONMENT_VARIABLES = %w{SAUCE_HOST SAUCE_PORT SAUCE_BROWSER_URL SAUCE_USERNAME
@@ -60,7 +64,22 @@ module Sauce
       end
     end
 
+    def [](key)
+      @opts[key]
+    end
+
+    def []=(key, value)
+      @opts[key] = value
+    end
+
+    def silence_warnings
+      false
+    end
+
     def method_missing(meth, *args)
+      unless self.silence_warnings
+        warn "[DEPRECATED] This method (#{meth}) is deprecated, please use the [] and []= accessors instead"
+      end
       if meth.to_s =~ /(.*)=$/
         @opts[$1.to_sym] = args[0]
         return args[0]
@@ -144,29 +163,54 @@ module Sauce
       return ENV['LOCAL_SELENIUM']
     end
 
+    def username
+      @opts[:username]
+    end
+
+    def access_key
+      @opts[:access_key]
+    end
+
+    def host
+      @opts[:host]
+    end
+
+    def port
+      @opts[:port]
+    end
+
     private
 
     def load_options_from_environment
       return extract_options_from_hash(ENV)
     end
 
+    # Heroku supports multiple apps per $PWD.  Specify $SAUCE_HEROKU_APP if
+    # needed otherwise this can still time out.
     def load_options_from_heroku
-      @@herkou_environment ||= begin
-        buffer = IO.popen("heroku config --shell 2>/dev/null") { |out| out.read }
-        if $?.exitstatus == 0
-          env = {}
-          buffer.split("\n").each do |line|
-            key, value = line.split("=")
-            env[key] = value
+      @@heroku_environment ||= begin
+        if File.exists?(File.expand_path('~/.heroku'))
+          heroku_app = ENV['SAUCE_HEROKU_APP']
+          cmd = "heroku config #{heroku_app ? "--app #{heroku_app}": ''}"
+          cmd += "--shell 2>/dev/null"
+          buffer = IO.popen(cmd) { |out| out.read }
+          if $?.exitstatus == 0
+            env = {}
+            buffer.split("\n").each do |line|
+              key, value = line.split("=")
+              env[key] = value
+            end
+            extract_options_from_hash(env)
+          else
+            {}
           end
-          extract_options_from_hash(env)
         else
           {}
         end
       rescue Errno::ENOENT
         {} # not a Heroku environment
       end
-      return @@herkou_environment
+      return @@heroku_environment
     end
 
     def load_options_from_yaml

data/lib/sauce/connect.rb

@@ -1,6 +1,8 @@
+require 'sauce/config'
+
 module Sauce
   class Connect
-    TIMEOUT = 300
+    TIMEOUT = 90
 
     attr_reader :status, :error
 
@@ -8,21 +10,25 @@ module Sauce
       @ready = false
       @status = "uninitialized"
       @error = nil
+      @quiet = options[:quiet]
       host = options[:host] || '127.0.0.1'
       port = options[:port] || '3000'
       tunnel_port = options[:tunnel_port] || '80'
       options.delete(:host)
       options.delete(:port)
       options.delete(:tunnel_port)
-      config = Sauce::Config.new(options)
-      if config.username.nil?
+      @config = Sauce::Config.new(options)
+      if @config.username.nil?
         raise ArgumentError, "Username required to launch Sauce Connect. Please set the environment variable $SAUCE_USERNAME"
       end
-      if config.access_key.nil?
+      if @config.access_key.nil?
         raise ArgumentError, "Access key required to launch Sauce Connect. Please set the environment variable $SAUCE_ACCESS_KEY"
       end
-      args = ['-u', config.username, '-k', config.access_key, '-s', host, '-p', port, '-d', config.domain, '-t', tunnel_port]
-      @pipe = IO.popen((["exec", "\"#{Sauce::Connect.find_sauce_connect}\""] + args + ["2>&1"]).join(' '))
+    end
+
+    def connect
+      puts "[Connecting to Sauce OnDemand...]"
+      @pipe = IO.popen("exec #{Sauce::Connect.connect_command} #{@config.username} #{@config.access_key} 2>&1")
       @process_status = $?
       at_exit do
         Process.kill("INT", @pipe.pid)
@@ -32,7 +38,7 @@ module Sauce
       end
       Thread.new {
         while( (line = @pipe.gets) )
-          if line =~ /Tunnel host is (.*) (\.\.|at)/
+          if line =~ /Tunnel remote VM is (.*) (\.\.|at)/
             @status = $1
           end
           if line =~/You may start your tests\./
@@ -43,9 +49,9 @@ module Sauce
           end
           if line =~ /== Missing requirements ==/
             @error = "Missing requirements"
-            options[:quiet] = false
+            @quiet = false
           end
-          $stderr.puts line unless options[:quiet]
+          $stderr.puts line unless @quiet
         end
         @ready = false
       }
@@ -54,7 +60,7 @@ module Sauce
     def wait_until_ready
       start = Time.now
       while !@ready and (Time.now-start) < TIMEOUT and @error != "Missing requirements"
-        sleep 0.4
+        sleep 0.5
       end
 
       if @error == "Missing requirements"
@@ -76,7 +82,11 @@ module Sauce
     end
 
     def self.find_sauce_connect
-      File.join(File.dirname(File.dirname(File.expand_path(File.dirname(__FILE__)))), "support", "sauce_connect")
+      File.expand_path(File.dirname(__FILE__) + '/../../support/Sauce-Connect.jar')
+    end
+
+    def self.connect_command
+      "java -jar #{Sauce::Connect.find_sauce_connect}"
     end
 
     # Global Sauce Connect-ness
@@ -84,6 +94,7 @@ module Sauce
 
     def self.connect!(*args)
       @connection = self.new(*args)
+      @connection.connect
       @connection.wait_until_ready
       at_exit do
         @connection.disconnect

data/lib/sauce/integrations.rb

@@ -1,3 +1,5 @@
+require 'sauce/utilities'
+
 begin
   require 'spec'
   module Sauce
@@ -15,8 +17,9 @@ begin
         before :suite do
           config = Sauce::Config.new
           if @@need_tunnel
-            if config.application_host && !config.local?
+            if config.application_host
               @@tunnel = Sauce::Connect.new(:host => config.application_host, :port => config.application_port || 80)
+              @@tunnel.connect
               @@tunnel.wait_until_ready
             end
             if Sauce::Utilities::RailsServer.is_rails_app?
@@ -35,29 +38,11 @@ begin
           config = Sauce::Config.new
           description = [self.class.description, self.description].join(" ")
           config.browsers.each do |os, browser, version|
-            if config.single_session?
-              if config.local?
-                @selenium = Sauce.cached_session(:host => "127.0.0.1", :port => 4444, :browser => "*" +
-                                                browser, :url => "http://127.0.0.1:#{config.local_application_port}/")
-              else
-                @selenium = Sauce.cached_session({:os => os, :browser => browser, :browser_version => version,
-                               :job_name => self.class.description})
-              end
-              super(*args)
-            else
-              if config.local?
-                @selenium = ::Selenium::Client::Driver.new(:host => "127.0.0.1",
-                                                           :port => 4444,
-                                                           :browser => "*" + browser,
-                                                           :url => "http://127.0.0.1:#{config.local_application_port}/")
-              else
-                @selenium = Sauce::Selenium.new({:os => os, :browser => browser, :browser_version => version,
-                                                :job_name => "#{description}"})
-              end
-              @selenium.start_new_browser_session(:captureNetworkTraffic => config.capture_traffic?)
-              super(*args)
-              @selenium.stop
-            end
+            @selenium = Sauce::Selenium2.new({:os => os, :browser => browser,
+                                              :browser_version => version,
+                                              :job_name => description})
+            super(*args)
+            @selenium.stop
           end
         end
 
@@ -86,16 +71,10 @@ begin
             config = Sauce::Config.new
             description = the_test.metadata[:full_description]
             config.browsers.each do |os, browser, version|
-              if config.local?
-                @selenium = ::Selenium::Client::Driver.new(:host => "127.0.0.1",
-                                                           :port => 4444,
-                                                           :browser => "*" + browser,
-                                                           :url => "http://127.0.0.1:#{config.local_application_port}/")
-              else
-                @selenium = Sauce::Selenium.new({:os => os, :browser => browser, :browser_version => version,
-                                                :job_name => "#{description}"})
-              end
-              @selenium.start_new_browser_session(:captureNetworkTraffic => config.capture_traffic?)
+              @selenium = Sauce::Selenium2.new({:os => os,
+                                                :browser => browser,
+                                                :browser_version => version,
+                                                :job_name => description})
               begin
                 the_test.run
               ensure
@@ -111,15 +90,18 @@ begin
         ::RSpec.configuration.before :suite do
           need_tunnel = false
           config = Sauce::Config.new
-          if config.application_host && !config.local?
-            need_tunnel = ::RSpec.configuration.settings[:files_to_run].any? {|file| file =~ /spec\/selenium\//}
+          files_to_run = ::RSpec.configuration.respond_to?(:files_to_run) ? ::RSpec.configuration.files_to_run :
+            ::RSpec.configuration.settings[:files_to_run]
+          if config.application_host
+            need_tunnel = files_to_run.any? {|file| file =~ /spec\/selenium\//}
           end
           if need_tunnel
             @@tunnel = Sauce::Connect.new(:host => config.application_host, :port => config.application_port || 80)
+            @@tunnel.connect
             @@tunnel.wait_until_ready
           end
 
-          if ::RSpec.configuration.settings[:files_to_run].any? {|file| file =~ /spec\/selenium\//} &&
+          if files_to_run.any? {|file| file =~ /spec\/selenium\//} &&
             Sauce::Utilities::RailsServer.is_rails_app?
             @@server = Sauce::Utilities::RailsServer.new
             @@server.start
@@ -152,7 +134,7 @@ module Sauce
       end
       unless my_name =~ /^default_test/
         config = Sauce::Config.new
-        if config.application_host && !config.local?
+        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
@@ -171,37 +153,13 @@ module Sauce
         end
 
         config.browsers.each do |os, browser, version|
-          if config.single_session?
-            if config.local?
-              @browser = Sauce.cached_session(:host => "127.0.0.1", :port => 4444, :browser => "*" +
-                                              browser, :url => "http://127.0.0.1:#{config.local_application_port}/")
-            else
-              options = self.class.sauce_config
-              options.merge!({:os => os, :browser => browser, :browser_version => version,
-                             :job_name => "#{Rails.root.split[1].to_s} test suite"})
-              @browser = Sauce.cached_session(options)
-            end
-            super(*args, &blk)
-          else
-            if config.local?
-              @browser = ::Selenium::Client::Driver.new(:host => "127.0.0.1",
-                                                        :port => 4444,
-                                                        :browser => "*" + browser,
-                                                        :url => "http://127.0.0.1:#{config.local_application_port}/")
-            else
-              options = self.class.sauce_config
-              options.merge!({:os => os, :browser => browser, :browser_version => version,
-                                             :job_name => "#{my_name}"})
-              @browser = Sauce::Selenium.new(options)
-            end
-            if self.class.selenium_flags
-              @browser.start_new_browser_session(self.class.selenium_flags.merge(:captureNetworkTraffic => config.capture_traffic?))
-            else
-              @browser.start_new_browser_session(:captureNetworkTraffic => config.capture_traffic?)
-            end
-            super(*args, &blk)
-            @browser.stop
-          end
+          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)
+          super(*args, &blk)
+          @browser.stop
         end
       end
     end

data/lib/sauce/jasmine.rb

@@ -0,0 +1,35 @@
+require 'jasmine'
+
+module Sauce
+  module Jasmine
+    class Driver < ::Jasmine::SeleniumDriver
+      attr_reader :http_address, :driver, :browser
+
+      def initialize(browser, http_address)
+        @browser = browser
+        @http_address = http_address
+        @driver = Sauce::Selenium2.new(:browser => browser, :job_name => job_name)
+        puts "Starting job named: #{job_name}"
+      end
+
+      def job_name
+        "Jasmine Test Run #{Time.now.utc.to_i}"
+      end
+    end
+  end
+end
+
+module Jasmine
+  class Config
+    def jasmine_port
+      '3001'
+    end
+
+    def start
+      @client = Sauce::Jasmine::Driver.new(browser, "#{jasmine_host}:#{jasmine_port}/")
+      @client.connect
+    end
+  end
+end
+
+

data/lib/sauce/jasmine/rake.rb

@@ -0,0 +1,47 @@
+require 'jasmine'
+require 'rspec/core/rake_task'
+
+namespace :jasmine do
+  def run_jasmine_server
+    ENV['JASMINE_PORT'] = '3001'
+    Jasmine::Config.new.start_jasmine_server
+  end
+
+  desc "Execute Jasmine tests in a Chrome browser on Sauce Labs"
+  task :sauce do
+    run_jasmine_server
+    Rake::Task['jasmine:sauce:chrome'].execute
+  end
+
+  namespace :sauce do
+    desc "Execute Jasmine tests in Chrome, Firefox and Internet Explorer on Sauce Labs"
+    task :all do
+      run_jasmine_server
+      threads = []
+      [:firefox, :chrome, :iexplore].each do |browser|
+        t = Thread.new do
+          Rake::Task["jasmine:sauce:#{browser}"].invoke
+        end
+        t.abort_on_exception = true
+        threads << t
+      end
+
+      threads.each do |t|
+        t.join
+      end
+    end
+
+    [[:firefox, 8], [:chrome, nil], [:iexplore, 8]].each do |browser, version|
+      desc "Execute Jasmine tests in #{browser}"
+      RSpec::Core::RakeTask.new(browser) do |t|
+        ENV['SAUCE_BROWSER'] = browser.to_s
+        unless version.nil?
+          ENV['SAUCE_BROWSER_VERSION'] = version.to_s
+        end
+        t.rspec_opts = '--color'
+        t.pattern = [File.expand_path(File.dirname(__FILE__) + '/runner.rb')]
+      end
+    end
+  end
+end
+

data/lib/sauce/jasmine/runner.rb

@@ -0,0 +1,4 @@
+require 'sauce'
+require 'sauce/jasmine'
+ENV['JASMINE_PORT'] = '3001'
+require 'jasmine/runner'

data/lib/sauce/job.rb

@@ -1,3 +1,5 @@
+require 'sauce/client'
+
 module Sauce
   # Interact with a Sauce Labs selenium jobs as if it were a ruby object
   class Job
@@ -8,14 +10,14 @@ module Sauce
     attr_accessor :name, :browser, :browser_version, :os
     attr_accessor :creation_time, :start_time, :end_time
     attr_accessor :public, :video_url, :log_url, :tags
-    attr_accessor :passed
+    attr_accessor :passed, :custom_data
 
     # Get the class @@client.
     # TODO: Consider metaprogramming this away
     def self.client
       @@client
     end
-    
+
     # Set the class @@client.
     # TODO: Consider metaprogramming this away
     def self.client=(client)
@@ -64,7 +66,7 @@ module Sauce
       end
 
       @@client ||= Sauce::Client.new
-      
+
       #puts "GET-URL: #{@@client.url}jobs/#{id}"
       response = @@client["jobs/#{id}"].get
 
@@ -75,6 +77,7 @@ module Sauce
     # Creates an instance representing a job.
     def initialize(options)
       build!(options)
+      @client = Sauce::Client.new
     end
 
     # Retrieves the latest information on this job from the Sauce Labs' server
@@ -88,7 +91,7 @@ module Sauce
     # Save/update the current information for the job
     def save
       #puts "Saving job:\n -X PUT #{@@client['jobs']}/#{@id} -H 'Content-Type: application/json' -d '#{self.to_json}'"
-      response = @@client["jobs/#{@id}"].put(self.to_json,
+      response = @client["jobs/#{@id}"].put(self.to_json,
                                              {:content_type => :json,
                                                :accept => :json}).body
       JSON.parse(response)
@@ -97,6 +100,7 @@ module Sauce
     def to_json(options={})
       json = {
         :id =>              @id,
+        :'custom-data' =>   @custom_data,
         :owner =>           @owner,
         :status =>          @status,
         :error =>           @error,
@@ -116,7 +120,7 @@ module Sauce
 
       options[:except].each { |key| json.delete(key) } if options[:except]
       json = json.select { |key,value| options[:only].include? key } if options[:only]
-      
+
       return json.to_json
     end
 
@@ -128,7 +132,6 @@ module Sauce
 
     # Sets all internal variables from a hash
     def build!(options)
-      #puts "\tBuild with: #{options.inspect}"
       # Massage JSON
       options.each { |key,value| options[key] = false if options[key] == "false" }
 
@@ -148,6 +151,7 @@ module Sauce
       @public          = options["public"]
       @tags            = options["tags"]
       @passed          = options["passed"]
+      @custom_data     = options['custom-data']
 
       raise NoIDError if @id.nil? or @id.empty?
     end