sauce 0.11.3 → 0.12.0

data/README.markdown

@@ -10,13 +10,12 @@ Current:
 *   Drop-in replacement for Selenium::Client::Driver that takes care of connecting to Sauce OnDemand
 *   RSpec, Test::Unit, and Rails integration for tests, including automatic setup of Sauce Connect
 *   ActiveRecord-like interface for tunnels and jobs: Find/create/destroy
+*   Start/stop local instances of Sauce RC
 
 Planned:
 
-*   Include selenium-client RSpec/Test::Unit integration
 *   Webrat integration
 *   Extend to automatic retrieval of jobs logs, videos, reverse tunnels
-*   Start/stop local instances of Sauce RC
 
 Install
 -------

data/VERSION

@@ -1 +1 @@
-0.11.3
+0.12.0

data/lib/generators/sauce_generator.rb

@@ -0,0 +1,40 @@
+class SauceGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  argument :username, :type => nil
+  argument :api_key, :type => nil
+
+  def copy_rake_tasks
+    copy_file "sauce.rake", "lib/tasks/sauce.rake"
+  end
+
+  def setup_spec
+    if File.directory? 'spec'
+      empty_directory "spec/selenium"
+      append_file "spec/spec_helper.rb", generate_config
+    end
+  end
+
+  def setup_test
+    empty_directory "test/selenium"
+    append_file "test/test_helper.rb", generate_config
+  end
+
+  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."]
+    ]
+    conf.application_host = "127.0.0.1"
+    conf.application_port = "3001"
+end
+      CONFIG
+  end
+end

data/lib/generators/templates/sauce.rake

@@ -0,0 +1 @@
+require 'sauce/raketasks'

data/lib/sauce/integrations.rb

@@ -4,10 +4,17 @@ begin
     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 config.application_host && !config.local?
+          if @@need_tunnel && config.application_host && !config.local?
             @@tunnel = Sauce::Connect.new(:host => config.application_host, :port => config.application_port || 80)
             @@tunnel.wait_until_ready
           end
@@ -46,7 +53,66 @@ begin
     end
   end
 rescue LoadError
-  # User doesn't have RSpec installed
+  # User doesn't have RSpec 1.x installed
+end
+
+begin
+  require 'rspec'
+  module Sauce
+    module RSpec
+      module SeleniumExampleGroup
+        attr_reader :selenium
+        alias_method :page, :selenium
+        alias_method :s, :selenium
+
+        def self.included(othermod)
+          othermod.around do |the_test|
+            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
+              begin
+                the_test.run
+              ensure
+                @selenium.stop
+              end
+            end
+          end
+        end
+
+        ::RSpec.configuration.include(self, :example_group => {
+              :file_path => Regexp.compile('spec[\\\/]selenium')
+            })
+        ::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\//}
+          end
+          if need_tunnel
+            @@tunnel = Sauce::Connect.new(:host => config.application_host, :port => config.application_port || 80)
+            @@tunnel.wait_until_ready
+          end
+        end
+        ::RSpec.configuration.after :suite do
+          if defined? @@tunnel
+            @@tunnel.disconnect
+          end
+        end
+      end
+    end
+  end
+rescue LoadError
+  # User doesn't have RSpec 2.x installed
 end
 
 begin
@@ -59,7 +125,12 @@ begin
       alias_method :s, :selenium
 
       def run(*args, &blk)
-        unless name =~ /^default_test/
+        if self.respond_to? :name
+          my_name = self.name
+        else
+          my_name = self.__name__
+        end
+        unless my_name =~ /^default_test/
           config = Sauce::Config.new
           config.browsers.each do |os, browser, version|
             if config.local?
@@ -69,7 +140,7 @@ begin
                                                          :url => "http://127.0.0.1:#{config.local_application_port}/")
             else
               @selenium = Sauce::Selenium.new({:os => os, :browser => browser, :browser_version => version,
-                :job_name => "#{name}"})
+                :job_name => "#{my_name}"})
             end
             @selenium.start
             super(*args, &blk)
@@ -83,6 +154,10 @@ begin
       end
     end
   end
+rescue LoadError
+  # User doesn't have Test::Unit installed
+end
+begin
   require 'test/unit/ui/console/testrunner'
   class Test::Unit::UI::Console::TestRunner
     def attach_to_mediator_with_sauce_tunnel
@@ -111,7 +186,31 @@ begin
     end
   end
 rescue LoadError
-  # User doesn't have Test::Unit installed
+  # User is on Ruby 1.9
+end
+
+begin
+  require 'minitest/unit'
+  module MiniTest
+    class Unit
+      run_without_tunnel = self.instance_method(:run)
+
+      define_method(:run) do |args|
+        config = Sauce::Config.new
+        if config.application_host && !config.local?
+          @sauce_tunnel = Sauce::Connect.new(:host => config.application_host, :port => config.application_port || 80)
+          @sauce_tunnel.wait_until_ready
+        end
+        result = run_without_tunnel.bind(self).call(args)
+        if defined? @sauce_tunnel
+          @sauce_tunnel.disconnect
+        end
+        return result
+      end
+    end
+  end
+rescue LoadError
+  # User is not on Ruby 1.9
 end
 
 if defined?(ActiveSupport::TestCase)
@@ -123,7 +222,12 @@ if defined?(ActiveSupport::TestCase)
       alias_method :s, :selenium
 
       def run(*args, &blk)
-        unless name =~ /^default_test/
+        if self.respond_to? :name
+          my_name = self.name
+        else
+          my_name = self.__name__
+        end
+        unless my_name =~ /^default_test/
           config = Sauce::Config.new
           config.browsers.each do |os, browser, version|
             if config.local?
@@ -133,7 +237,7 @@ if defined?(ActiveSupport::TestCase)
                                                          :url => "http://127.0.0.1:#{config.local_application_port}/")
             else
               @selenium = Sauce::Selenium.new({:os => os, :browser => browser, :browser_version => version,
-                :job_name => "#{name}"})
+                :job_name => "#{my_name}"})
             end
             @selenium.start
             super(*args, &blk)

data/lib/sauce/raketasks.rb

@@ -1,9 +1,15 @@
 require 'sauce'
 
-spec_prereq = File.exist?(File.join(RAILS_ROOT, 'config', 'database.yml')) ? "db:test:prepare" : :noop
+spec_prereq = File.exist?(File.join(::Rails.root.to_s, 'config', 'database.yml')) ? "db:test:prepare" : :noop
 task :noop do
 end
 
+class Rake::Task
+  def abandon
+    @actions.clear
+  end
+end
+
 include Sauce::Utilities
 
 if defined?(Spec::Rake::SpecTask)
@@ -27,13 +33,49 @@ if defined?(Spec::Rake::SpecTask)
 
       desc "" # Hide it from rake -T
       Spec::Rake::SpecTask.new :runtests do |t|
-        t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+        t.spec_opts = ['--options', "\"#{Rails.root.join('spec', 'spec.opts')}\""]
         t.spec_files = FileList["spec/selenium/**/*_spec.rb"]
       end
     end
 
     task :selenium => "selenium:sauce"
   end
+
+  Rake::Task[:spec].abandon
+  desc "Run all specs in spec directory (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:spec => spec_prereq) do |t|
+    t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb'].exclude('spec/selenium/*')
+  end
+end
+
+if defined?(RSpec::Core::RakeTask)
+  namespace :spec do
+    namespace :selenium do
+      desc "Run the Selenium acceptance tests in spec/selenium using Sauce OnDemand"
+      task :sauce => spec_prereq do
+        with_rails_server do
+          Rake::Task["spec:selenium:runtests"].invoke
+        end
+      end
+
+      desc "Run the Selenium acceptance tests in spec/selenium using a local Selenium server"
+      task :local => spec_prereq do
+        with_rails_server do
+          with_selenium_rc do
+            Rake::Task["spec:selenium:runtests"].invoke
+          end
+        end
+      end
+
+      desc "" # Hide it from rake -T
+      RSpec::Core::RakeTask.new :runtests do |t|
+        t.pattern = "spec/selenium/**/*_spec.rb"
+      end
+    end
+
+    task :selenium => "selenium:sauce"
+  end
 end
 
 namespace :test do

data/lib/sauce/utilities.rb

@@ -1,3 +1,6 @@
+require 'timeout'
+require 'socket'
+
 module Sauce
   module Utilities
     def silence_stream(stream)
@@ -9,6 +12,22 @@ module Sauce
       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 with_selenium_rc
       ENV['LOCAL_SELENIUM'] = "true"
       STDERR.puts "Starting Selenium RC server on port 4444..."
@@ -16,7 +35,7 @@ module Sauce
       server.jar_file = File.expand_path(File.dirname(__FILE__) + "/../../support/selenium-server.jar")
       silence_stream(STDOUT) do
         server.start :background => true
-        TCPSocket.wait_for_service(:host => "127.0.0.1", :port => 4444)
+        wait_for_server_on_port(4444)
       end
       STDERR.puts "Selenium RC running!"
       begin
@@ -28,11 +47,13 @@ module Sauce
 
     def with_rails_server
       STDERR.puts "Starting Rails server on port 3001..."
-      server = IO.popen("ruby script/server RAILS_ENV=test --port 3001 --daemon")
-
-      silence_stream(STDOUT) do
-        TCPSocket.wait_for_service(:host => "127.0.0.1", :port => 3001)
+      if File.exists?('script/server')
+        server = IO.popen("ruby script/server RAILS_ENV=test --port 3001 --daemon")
+      elsif File.exists?('script/rails')
+        server = IO.popen("script/rails server -p 3001 -e test")
       end
+
+      wait_for_server_on_port(3001)
       STDERR.puts "Rails server running!"
       begin
         yield

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sauce
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 47
   prerelease: false
   segments: 
   - 0
-  - 11
-  - 3
-  version: 0.11.3
+  - 12
+  - 0
+  version: 0.12.0
 platform: ruby
 authors: 
 - Sean Grove
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-08 00:00:00 -08:00
+date: 2010-12-13 00:00:00 -08:00
 default_executable: sauce
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -147,6 +147,8 @@ files:
 - examples/test_saucelabs2.rb
 - generators/sauce/sauce_generator.rb
 - generators/sauce/templates/sauce.rake
+- lib/generators/sauce_generator.rb
+- lib/generators/templates/sauce.rake
 - lib/sauce.rb
 - lib/sauce/client.rb
 - lib/sauce/config.rb