sauce 0.9.0 → 0.10.0

data/README.markdown

@@ -7,48 +7,139 @@ Features
 --------
 Current:
 
-*   ActiveRecord-like interface for tunnels: Find/create/destroy
-*   Same with jobs
+*   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
 
 Planned:
 
 *   Extend to automatic retrieval of jobs logs, videos, reverse tunnels
 *   Start/stop local instances of Sauce RC
+*   Webrat integration
 
 Install
 -------
 `gem install sauce`
 
-Example
+`sauce config USERNAME ACCESS_KEY`
+
+Examples
 -------
-Here's how to start a tunnel using the Sauce gem
+### Selenium Client driver
     require 'rubygems'
     require 'sauce'
+    selenium = Sauce::Selenium.new(:browser_url => "http://saucelabs.com",
+        :browser => "firefox", :browser_version => "3.", :os => "Windows 2003",
+        :job_name => "My first test!")
+    selenium.start
+    selenium.open "/"
+    selenium.stop
+
+### RSpec integration
+    #!/usr/bin/env ruby
+    #
+    # Sample RSpec test case using the Sauce gem
+    #
+    require "rubygems"
+    require "sauce"
+    
+    # This should go in your spec_helper.rb file if you have one
+    Sauce.config do |config|
+      config.browser_url = "http://saucelabs.com/"
+      config.browsers = [
+        ["Linux", "firefox", "3.6."]
+      ]
+    
+      # uncomment this if your server is not publicly accessible
+      #config.application_host = "localhost"
+      #config.application_port = "80"
+    end
+    
+    # If this goes in spec/selenium/foo_spec.rb, you can omit the :type parameter
+    describe "The Sauce Labs website", :type => :selenium do
+      it "should have a home page" do
+        page.open "/"
+        page.is_text_present("Sauce Labs").should be_true
+      end
     
-    account = YAML.load_file "live_account.yml"
-    client = Sauce::Client.new(:username => account["username"],
-                               :access_key => account["access_key"])
+      it "should have a pricing page" do
+        page.open "/"
+        page.click "link=Pricing"
+        page.wait_for_page_to_load 30000
+        page.is_text_present("Free Trial").should be_true
+      end
+    end
 
-    tunnel = client.tunnel.create('DomainNames' => ["example.com"])
-    tunnel.refresh!
+### Test::Unit integration
+    #!/usr/bin/env ruby
+    #
+    # Sample Test:Unit test case using the Sauce gem
+    #
+    require "test/unit"
+    require "rubygems"
+    require "sauce"
     
-    client.tunnels.all # => [#<Sauce::Tunnel:0x1250e6c
-                                 @host=nil,
-                                 @status="running",
-                                 @id="389a1c2a3d49861474c512e9a904be9e",
-                                 @client=#<RestClient::Resource:0x1257fb4
-                                   @block=nil,
-                                   @url="https://username:access_key@saucelabs.com/rest/username/",
-                                   @options={}>,
-                                 @owner="username">]
+    # This should go in your test_helper.rb file if you have one
+    Sauce.config do |config|
+      config.browser_url = "http://saucelabs.com/"
+      config.browsers = [
+        ["Linux", "firefox", "3.6."]
+      ]
+    
+      # uncomment this if your server is not publicly accessible
+      #config.application_host = "localhost"
+      #config.application_port = "80"
+    end
+    
+    class ExampleTest < Sauce::TestCase
+        def test_sauce
+            page.open "/"
+            assert page.title.include?("Sauce Labs")
+        end
+    end
+
+### Rails integration
+You can use either RSpec or Test::Unit with Rails and Sauce OnDemand.
+The generator will take care of setting up your helpers with Sauce OnDemand
+configuration, which you can tweak inside the `Sauce.config` block.
+
+`gem install sauce`
+
+`script/generate sauce USERNAME ACCESS_KEY`
+
+For RSpec, drop something like this in spec/selenium:
+
+    require "spec_helper"
+    
+    describe "my app" do
+      it "should have a home page" do
+        page.open "/"
+        page.is_text_present("Welcome Aboard").should be_true
+      end
+    end
+
+For Test::Unit, drop something like this in test/selenium:
+
+    require "test_helper"
+    
+    class DemoTest < Sauce::RailsTestCase
+      test "my app", do
+        page.open "/"
+        page.is_text_present("Welcome Aboard").should be_true
+      end
+    end
+
+To run your tests, use rake:
+
+`rake spec:selenium:sauce`
 
-    tunnel.destroy
+`rake test:selenium:sauce`
 
 Note on Patches/Pull Requests
 ----------------------------- 
 *   Fork the project.
 *   Make your feature addition or bug fix.
-*   Add tests for it. This is important so I don't break it in a future version unintentionally.
+*   Add tests for it. This is important so we don't break it in a future version unintentionally.
 *   Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 *   Send me a pull request. Bonus points for topic branches.
 

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.10.0

data/bin/sauce

@@ -3,6 +3,7 @@
 require 'rubygems'
 require 'cmdparse'
 require 'yaml'
+require 'fileutils'
 
 sauce_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(sauce_dir) unless $LOAD_PATH.include?(sauce_dir)
@@ -30,7 +31,10 @@ else
     end
     username = args[0]
     access_key = args[1]
-    out = File.new(File.join(File.dirname(File.expand_path(File.dirname(__FILE__))), "ondemand.yml"), 'w')
+    dir = File.join(File.expand_path("~"), ".sauce")
+    FileUtils.mkdir(dir) unless File.directory?(dir)
+
+    out = File.new(File.join(dir, "ondemand.yml"), 'w')
     out.write(YAML.dump({"username" => username, "access_key" => access_key}))
     out.close()
   end

data/generators/sauce/sauce_generator.rb

@@ -0,0 +1,57 @@
+require 'sauce/config'
+
+# This generator bootstraps a Rails project for use with Sauce OnDemand
+class SauceGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    config = Sauce::Config.new
+    if config.username.nil? || config.access_key.nil?
+      if runtime_args.size < 2
+        raise "Usage: #{$0} sauce <USERNAME> <ACCESS_KEY>"
+      else
+        system("sauce config #{runtime_args[0]} #{runtime_args[1]}")
+      end
+    end
+    super
+  end
+
+  def manifest
+    record do |m|
+      if File.directory? 'spec'
+        m.directory File.join('spec', 'selenium') if File.directory? 'spec'
+        m.setup_helper(File.join('spec', 'spec_helper.rb')) if File.directory? 'spec'
+      end
+
+      m.directory File.join('lib', 'tasks')
+      m.directory File.join('test', 'selenium') if File.directory? 'test'
+      m.file      'sauce.rake', File.join('lib', 'tasks', 'sauce.rake')
+      m.setup_helper(File.join('test', 'test_helper.rb'))
+    end
+  end
+
+  def setup_helper(file)
+    contents = File.read(file)
+    if contents !~ /Sauce.config/
+      File.open(file, "a") do |file|
+        file.write <<-CONFIG
+
+require 'sauce'
+
+Sauce.config do |conf|
+    conf.browser_url = "http://#{rand(100000)}.test/"
+    conf.browsers = [
+        ["Windows 2003", "firefox", "3."]
+    ]
+    conf.application_host = "127.0.0.1"
+    conf.application_port = "3001"
+end
+        CONFIG
+      end
+    end
+  end
+
+protected
+
+  def banner
+    "Usage: #{$0} sauce [<USERNAME> <ACCESS_KEY>]"
+  end
+end

data/generators/sauce/templates/sauce.rake

@@ -0,0 +1,51 @@
+spec_prereq = File.exist?(File.join(RAILS_ROOT, 'config', 'database.yml')) ? "db:test:prepare" : :noop
+task :noop do
+end
+
+namespace :spec do
+  namespace :selenium do
+    desc "Run the Selenium acceptance tests in spec/selenium using Sauce OnDemand"
+    task :sauce => spec_prereq do
+      server = IO.popen("script/server RAILS_ENV=test --port 3001")
+      begin
+        Rake::Task["spec:selenium:runtests"].invoke
+      ensure
+        Process.kill("INT", server.pid)
+      end
+    end
+
+    desc "" # Hide it from rake -T
+    Spec::Rake::SpecTask.new :runtests do |t|
+      t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/selenium/**/*_spec.rb"]
+    end
+  end
+
+  task :selenium => "selenium:sauce"
+end
+
+namespace :test do
+  namespace :selenium do
+    desc "Run the Selenium acceptance tests in test/selenium using Sauce OnDemand"
+    task :sauce do
+      server = IO.popen("script/server --port 3001")
+      begin
+        Rake::Task["test:selenium:runtests"].invoke
+      ensure
+        Process.kill("INT", server.pid)
+      end
+    end
+
+    Rake::TestTask.new(:runtests) do |t|
+      t.libs << "test"
+      t.pattern = 'test/selenium/**/*_test.rb'
+      t.verbose = true
+    end
+    desc "" # Hide it from rake -T
+    Rake::Task['test:selenium:runtests'].instance_variable_set(:@full_comment, nil)
+    Rake::Task['test:selenium:runtests'].instance_variable_set(:@comment, nil)
+    Rake::Task['test:selenium:runtests'].enhance(["db:test:prepare"])
+  end
+
+  task :selenium => "selenium:sauce"
+end

data/lib/sauce/config.rb

@@ -92,7 +92,7 @@ module Sauce
             "ondemand.yml",
             File.join("config", "ondemand.yml"),
             File.join(File.dirname(File.dirname(File.expand_path(File.dirname(__FILE__)))), "ondemand.yml"),
-            File.join(ENV['HOME'], ".ondemand.yml")
+            File.join(File.expand_path("~"), ".sauce", "ondemand.yml")
         ]
 
         paths.each do |path|

data/lib/sauce/connect.rb

@@ -11,7 +11,7 @@ module Sauce
       options.delete(:host)
       options.delete(:port)
       config = Sauce::Config.new(options)
-      args = ['-u', config.username, '-k', config.access_key, '-s', host, '-p', port, '-d', config.domain]
+      args = ['-u', config.username, '-k', config.access_key, '-s', host, '-p', port, '-d', config.domain, '-t', '80']
       @pipe = IO.popen(([Sauce::Connect.find_sauce_connect] + args).join(' '))
       at_exit do
         Process.kill("INT", @pipe.pid)

data/lib/sauce/integrations.rb

@@ -49,7 +49,7 @@ rescue LoadError
 end
 
 begin
-  require 'test/unit'
+  require 'test/unit/testcase'
   module Sauce
     class TestCase < Test::Unit::TestCase
       attr_reader :selenium
@@ -110,3 +110,36 @@ begin
 rescue LoadError
   # User doesn't have Test::Unit installed
 end
+
+if defined?(ActiveSupport::TestCase)
+  module Sauce
+    class RailsTestCase < ::ActiveSupport::TestCase
+      attr_reader :selenium
+
+      alias_method :page, :selenium
+      alias_method :s, :selenium
+
+      def run(*args, &blk)
+        unless name =~ /^default_test/
+          config = Sauce::Config.new
+          config.browsers.each do |os, browser, version|
+            @selenium = Sauce::Selenium.new({:os => os, :browser => browser, :browser_version => version,
+              :job_name => "#{name}"})
+            @selenium.start
+            super(*args, &blk)
+            @selenium.stop
+          end
+        end
+      end
+
+      # Placeholder so test/unit ignores test cases without any tests.
+      def default_test
+      end
+
+      def self.ensure_tunnel_running
+        unless defined?(@tunnel)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sauce
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 55
   prerelease: false
   segments: 
   - 0
-  - 9
+  - 10
   - 0
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors: 
 - Sean Grove
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 -07:00
+date: 2010-11-02 00:00:00 -07:00
 default_executable: sauce
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -145,6 +145,8 @@ files:
 - examples/saucelabs_spec.rb
 - examples/test_saucelabs.rb
 - examples/test_saucelabs2.rb
+- generators/sauce/sauce_generator.rb
+- generators/sauce/templates/sauce.rake
 - lib/sauce.rb
 - lib/sauce/client.rb
 - lib/sauce/config.rb