saucelabs-adapter 0.7.6

data/lib/saucelabs_adapter/test_unit_adapter.rb

@@ -0,0 +1,49 @@
+if defined?(ActiveSupport)
+  puts "[saucelabs-adapter] Inserting ActiveSupport::TestCase before_setup :configure_selenium hook" if ENV['SAUCELABS_ADAPTER_DEBUG']
+
+  module ::ActiveSupport
+    class TestCase
+      setup :configure_selenium # 'before_setup' callback from ActiveSupport::TestCase
+
+      def configure_selenium
+        puts "[saucelabs-adapter] gem is loading..." if ENV['SAUCELABS_ADAPTER_DEBUG']
+        selenium_config = SaucelabsAdapter::SeleniumConfig.new(ENV['SELENIUM_ENV'])
+        if defined?(Polonium)
+          polonium_config = Polonium::Configuration.instance
+          selenium_config.configure_polonium(polonium_config)
+        elsif defined?(Webrat)
+          webrat_config = Webrat.configuration
+          selenium_config.configure_webrat(webrat_config)
+        end
+      end
+    end
+  end
+end
+
+if defined?(Test)
+  puts "[saucelabs-adapter] Inserting Test::Unit::UI::Console::TestRunner attach_to_mediator tunnel start hook" if ENV['SAUCELABS_ADAPTER_DEBUG']
+
+  class Test::Unit::UI::Console::TestRunner
+
+    private
+
+    def attach_to_mediator_with_sauce_tunnel
+      attach_to_mediator_without_sauce_tunnel
+      @selenium_config = SaucelabsAdapter::SeleniumConfig.new(ENV['SELENIUM_ENV'])
+      if @selenium_config.start_sauce_tunnel?
+        @mediator.add_listener(Test::Unit::UI::TestRunnerMediator::STARTED, &method(:setup_tunnel))
+        @mediator.add_listener(Test::Unit::UI::TestRunnerMediator::FINISHED, &method(:teardown_tunnel))
+      end
+    end
+
+    alias_method_chain :attach_to_mediator, :sauce_tunnel unless private_method_defined?(:attach_to_mediator_without_sauce_tunnel)
+
+    def setup_tunnel(suite_name)
+      @tunnel = SaucelabsAdapter::SauceTunnel.new(@selenium_config)
+    end
+
+    def teardown_tunnel(suite_name)
+      @tunnel.shutdown
+    end
+  end
+end

data/lib/saucerest-ruby/gateway.rb

@@ -0,0 +1,35 @@
+# http://groups.google.com/group/capistrano/browse_thread/thread/455c0c8a6faa9cc8?pli=1
+class Net::SSH::Gateway
+  # Opens a SSH tunnel from a port on a remote host to a given host and port
+  # on the local side
+  # (equivalent to openssh -R parameter)
+  def open_remote(port, host, remote_port, remote_host = "127.0.0.1")
+    ensure_open!
+
+    @session_mutex.synchronize do
+      @session.forward.remote(port, host, remote_port, remote_host)
+    end
+
+    if block_given?
+      begin
+        yield [remote_port, remote_host]
+      ensure
+        close_remote(remote_port, remote_host)
+      end
+    else
+      return [remote_port, remote_host]
+    end
+  rescue Errno::EADDRINUSE
+    retry
+  end
+
+  # Cancels port-forwarding over an open port that was previously opened via
+  # #open_remote.
+  def close_remote(port, host = "127.0.0.1")
+    ensure_open!
+
+    @session_mutex.synchronize do
+      @session.forward.cancel_remote(port, host)
+    end
+  end
+end

data/lib/saucerest-ruby/saucerest.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rest_client'
+require 'json'
+
+module SauceREST
+
+  # A simple class for using the Sauce Labs REST API
+  class Client
+    @@roots = {
+      :script => 'scripts',
+      :job => 'jobs',
+      :result => 'results',
+      :tunnel => 'tunnels'
+    }
+
+    def initialize base_url
+      @base_url = base_url
+      @resource = RestClient::Resource.new @base_url
+    end
+
+    def create type, *args
+      doc = args[-1]
+      doc_json = doc.to_json
+      resp_json = @resource[@@roots[type]].post(doc_json,
+                                                :content_type =>
+                                                'application/octet-stream')
+      resp = JSON.parse resp_json
+      return resp
+    end
+
+    def get type, docid
+      resp_json = @resource[@@roots[type] + '/' + docid].get
+      resp = JSON.parse resp_json
+      return resp
+    end
+
+    def attach docid, name, data
+      resp_json = @resource[@@roots[:script] + '/' + docid + '/' + name].put data
+      resp = JSON.parse resp_json
+      return resp
+    end
+
+    def delete type, docid
+      resp_json = @resource[@@roots[type] + '/' + docid].delete
+      resp = JSON.parse resp_json
+      return resp
+    end
+
+    def list type
+      resp_json = @resource[@@roots[type] + '/'].get
+      resp = JSON.parse resp_json
+      return resp
+    end
+  end
+
+end

data/spec/selenium_config_spec.rb

@@ -0,0 +1,151 @@
+require 'rubygems'
+require 'active_support/core_ext/object' # for .blank?
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'saucelabs_adapter')
+SELENIUM_YML_FIXTURE_FILE = File.join(File.dirname(__FILE__), 'fixtures', 'selenium.yml')
+
+# Doing this to capture args because I seriously doubt we can mock out .new()
+module Selenium
+  module Client
+    class Driver
+      attr_reader :args
+      def initialize(args)
+        @args = args
+      end
+    end
+  end
+end
+
+describe "SeleniumConfig" do
+
+  context "given a local configuration" do
+    before do
+      @selenium_config = SaucelabsAdapter::SeleniumConfig.new('local', SELENIUM_YML_FIXTURE_FILE)
+    end
+
+    describe "#start_sauce_tunnel?" do
+      it "should return false" do
+        @selenium_config.start_sauce_tunnel?.should be_false
+      end
+    end
+
+    describe "selenium_browser_key" do
+      it "should contain just the string from the yml file" do
+        @selenium_config.selenium_browser_key.should == "*chrome /Applications/Firefox.app/Contents/MacOS/firefox-bin"
+      end
+    end
+
+    describe "#configure_polonium" do
+      before do
+        @polonium_configuration = mock("Polonium::Configuration")
+      end
+
+      it "should call the appropriate configuration methods on the polonium configuration object" do
+        @polonium_configuration.should_receive(:'selenium_server_host=').with("127.0.0.1")
+        @polonium_configuration.should_receive(:'selenium_server_port=').with("4444")
+        @polonium_configuration.should_receive(:'browser=').with(@selenium_config.selenium_browser_key)
+        @polonium_configuration.should_receive(:'external_app_server_host=').with("127.0.0.1")
+        @polonium_configuration.should_receive(:'external_app_server_port=').with("4000")
+
+        @selenium_config.configure_polonium(@polonium_configuration)
+      end
+    end
+
+    describe "#configure_webrat" do
+      before do
+        @webrat_configuration = mock("Webrat::Configuration")
+      end
+
+      it "should call the appropriate configuration methods on the webrat configuration object" do
+        @webrat_configuration.should_receive(:'selenium_server_address=').with("127.0.0.1")
+        @webrat_configuration.should_receive(:'selenium_server_port=').with("4444")
+        @webrat_configuration.should_receive(:'selenium_browser_key=').with(@selenium_config.selenium_browser_key)
+        @webrat_configuration.should_receive(:'application_address=').with("127.0.0.1")
+        @webrat_configuration.should_receive(:'application_port=').with("4000")
+
+        @selenium_config.configure_webrat(@webrat_configuration)
+      end
+    end
+  end
+
+  context "given a saucelabs/firefix/linux configuration" do
+    before do
+      @selenium_config = SaucelabsAdapter::SeleniumConfig.new('stanza_saucelabs_firefox_linux_saucetunnel', SELENIUM_YML_FIXTURE_FILE)
+    end
+
+    describe "#start_sauce_tunnel?" do
+      it "should return true" do
+        @selenium_config.start_sauce_tunnel?.should be_true
+      end
+    end
+
+    describe "selenium_browser_key" do
+      before do
+        @browser_data = JSON.parse(@selenium_config.selenium_browser_key)
+      end
+
+      {
+        'username'        => "YOUR-SAUCELABS-USERNAME",
+        'access-key'      => "YOUR-SAUCELABS-ACCESS-KEY",
+        'os'              => "Linux",
+        'browser'         => "firefox",
+        'browser-version' => "3.",
+        'max-duration'    => 1234
+      }.each do |browser_data_key, browser_data_value|
+        it "should contain a #{browser_data_key} of #{browser_data_value}" do
+          @browser_data[browser_data_key].should == browser_data_value
+        end
+      end
+
+      it "should contain a job_name of our hostname" do
+        @browser_data['job-name'].should == Socket.gethostname
+      end
+    end
+
+    describe "#configure_polonium" do
+      before do
+        @polonium_configuration = mock("Polonium::Configuration")
+      end
+
+      it "should call the appropriate configuration methods on the polonium configuration object" do
+        @polonium_configuration.should_receive(:'selenium_server_host=').with("saucelabs.com")
+        @polonium_configuration.should_receive(:'selenium_server_port=').with("4444")
+        @polonium_configuration.should_receive(:'browser=').with(@selenium_config.selenium_browser_key)
+        @polonium_configuration.should_receive(:'external_app_server_host=').with(@selenium_config.application_address)
+        @polonium_configuration.should_receive(:'external_app_server_port=').with("80")
+
+        @selenium_config.configure_polonium(@polonium_configuration)
+      end
+    end
+
+    describe "#configure_webrat" do
+      before do
+        @webrat_configuration = mock("Webrat::Configuration")
+      end
+
+      it "should call the appropriate configuration methods on the webrat configuration object" do
+        @webrat_configuration.should_receive(:'selenium_server_address=').with("saucelabs.com")
+        @webrat_configuration.should_receive(:'selenium_server_port=').with("4444")
+        @webrat_configuration.should_receive(:'selenium_browser_key=').with(@selenium_config.selenium_browser_key)
+        @webrat_configuration.should_receive(:'application_address=').with(@selenium_config.application_address)
+        @webrat_configuration.should_receive(:'application_port=').with("80")
+
+        @selenium_config.configure_webrat(@webrat_configuration)
+      end
+    end
+
+    describe "#create_driver" do
+      before do
+        @driver = @selenium_config.create_driver
+      end
+
+      it "should call Driver.new with the correct arguments" do
+        @driver.args[:host].should == 'saucelabs.com'
+        @driver.args[:port].should == '4444'
+        @driver.args[:browser].should_not be_blank
+        @driver.args[:url].should == "http://#{@selenium_config.application_address}:80"
+        @driver.args[:timeout_in_seconds].should == 600        
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'saucelabs-adapter'
+
+class Test::Unit::TestCase
+end

data/test/test_saucelabs-adapter.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+class TestSaucelabsAdapter < Test::Unit::TestCase
+  should "test happy paths" do
+    flunk "Practically, it's usually not useful to unit test stuff like saucelabs adapter.  You just end up " +
+    "debugging the implementation and making the tests match.  We really should have some happy path tests " +
+    "run under CI which run some dummy happy-path integration tests against the real sauce environment. " +
+    "Unfortunately, we don't have those.  Yet."
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: saucelabs-adapter
+version: !ruby/object:Gem::Version 
+  version: 0.7.6
+platform: ruby
+authors: 
+- Kelly Felkins, Chad Woolley & Sam Pierson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh-gateway
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: selenium-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.17
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: lsof
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+description: "This gem augments Test::Unit and Polonium/Webrat to run Selenium tests in the cloud. "
+email: pair+kelly+sam@pivotallabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- Rakefile
+- VERSION
+- generators/saucelabs_adapter/saucelabs_adapter_generator.rb
+- generators/saucelabs_adapter/templates/jsunit.rake
+- generators/saucelabs_adapter/templates/jsunit_suite_example.rb
+- generators/saucelabs_adapter/templates/saucelabs_adapter.rake
+- generators/saucelabs_adapter/templates/selenium.yml
+- lib/saucelabs-adapter.rb
+- lib/saucelabs_adapter.rb
+- lib/saucelabs_adapter/jsunit_selenium_support.rb
+- lib/saucelabs_adapter/run_utils.rb
+- lib/saucelabs_adapter/sauce_tunnel.rb
+- lib/saucelabs_adapter/selenium_config.rb
+- lib/saucelabs_adapter/test_unit_adapter.rb
+- lib/saucerest-ruby/gateway.rb
+- lib/saucerest-ruby/saucerest.rb
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/pivotal/saucelabs-adapter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Adapter for running Selenium tests using SauceLabs.com
+test_files: 
+- spec/selenium_config_spec.rb
+- test/helper.rb
+- test/test_saucelabs-adapter.rb