saucelabs-adapter 0.8.4 → 0.8.5

data/README.markdown

@@ -123,6 +123,12 @@ Resources
 
 NOTABLE CHANGES
 ===============
+
+0.8.5
+-----
+- Allow application_port to be a range of form: XXXX-YYYY, e.g. 4000-5000.  The SaucelabsAdapter will find an unused port in that range.
+- Allow specification of the test framework in use.  If test_framework == :webrat and tunnel_mode == :sshtunnel, the generated unused port will also be written to tunnel_to_localhost_port
+
 0.8
 ---
 - Added new tunnel type SshTunnel (a generic reverse SSH tunnel), see selenium.yml for now to configure.

data/VERSION

@@ -1 +1 @@
-0.8.4
+0.8.5

data/generators/saucelabs_adapter/templates/selenium.yml

@@ -21,6 +21,7 @@ local_jsunit:
 #                       "googlechrome"      ""
 # "Linux"               "firefox"           "3."
 saucelabs: &saucelabs
+  test_framework: webrat
   # URL of Selenium RC server:
   selenium_server_address: "saucelabs.com"
   selenium_server_port: "4444"
@@ -43,7 +44,7 @@ saucelabs: &saucelabs
   #
   # tunnel_method: :sshtunnel
   # application_address: proxy.mycompany.com
-  # application_port: 12345
+  # application_port: 12345 # or can be a range XXXX-YYYY
   # tunnel_to_localhost_port: 4000 # Warning: application_port and tunnel_to_localhost_port must be identical if you are using Webrat
   # tunnel_username: fred
   # tunnel_keyfile: "/path/to/keyfile"  # or tunnel_password: "password"

data/lib/saucelabs_adapter/selenium_config.rb

@@ -15,7 +15,8 @@ module SaucelabsAdapter
       @configuration[attribute.to_s] = value
     end
 
-    [ :selenium_server_address, :selenium_server_port,
+    [ :test_framework,
+      :selenium_server_address, :selenium_server_port,
       :application_address, :application_port,
       :saucelabs_username, :saucelabs_access_key,
       :saucelabs_browser_os, :saucelabs_browser, :saucelabs_browser_version,
@@ -106,6 +107,11 @@ module SaucelabsAdapter
     def build_configuration(configuration_name)
       @configuration = @@selenium_configs[configuration_name]
       raise "[saucelabs-adapter] stanza '#{configuration_name}' not found in #{@selenium_yml}" unless @configuration
+      # If the Saucelabs-Adapter picked a port out of a range during this session, use it.
+      if ENV['SAUCELABS_ADAPTER_APPLICATION_PORT']
+        @configuration['application_port'] = ENV['SAUCELABS_ADAPTER_APPLICATION_PORT'].to_i
+        debug("Using application port #{application_port} from environment variable SAUCELABS_ADAPTER_APPLICATION_PORT", 2)
+      end
       check_configuration(configuration_name)
     end
 
@@ -129,6 +135,14 @@ module SaucelabsAdapter
               errors << require_attributes([:tunnel_password, :tunnel_keyfile],
                                            :when => "when tunnel_method is :sshtunnel",
                                            :any_or_all => :any)
+              if application_address && application_port.is_a?(String) && application_port =~ /(\d+)-(\d+)/
+                # We have been given a port range. Find an unused one.
+                port = find_unused_port(application_address, ($1.to_i)..($2.to_i))
+                @configuration['application_port'] = port
+                @configuration['tunnel_to_localhost_port'] = port if test_framework == :webrat
+                # Pass this calculated value on to any other instances of SeleniumConfig created
+                ENV['SAUCELABS_ADAPTER_APPLICATION_PORT'] = port.to_s
+              end
               if tunnel_keyfile && !File.exist?(File.expand_path(tunnel_keyfile))
                 errors << "tunnel_keyfile '#{tunnel_keyfile}' does not exist" 
               end

data/lib/saucelabs_adapter/tunnels/ssh_tunnel.rb

@@ -10,18 +10,25 @@ module SaucelabsAdapter
       say "Setting up SSH reverse tunnel from #{@se_config.application_address}:#{@se_config.application_port} to localhost:#{@se_config.tunnel_to_localhost_port}"
       options = @se_config.tunnel_password ? { :password => @se_config.tunnel_password } : { :keys => @se_config.tunnel_keyfile }
       @gateway = Net::SSH::Gateway.new(@se_config.application_address, @se_config.tunnel_username, options)
-      @port = @gateway.open_remote(@se_config.tunnel_to_localhost_port.to_i, "127.0.0.1", @se_config.application_port.to_i, "0.0.0.0")
+      @host_and_port = @gateway.open_remote(@se_config.tunnel_to_localhost_port.to_i, "127.0.0.1", @se_config.application_port.to_i, "0.0.0.0")
     end
 
     def shutdown
-      return
-      # just return; tunnel is all in transient memory, and we don't want to hang or abort the whole test suite anyway
-      # This could potentially be a problem when opening an SshTunnel multiple times during a single interpreter, but we'll see...
-      # if @gateway
-      #   say "Shutting down ssh reverse tunnel"
-      #   @gateway.close(@port) if @port
-      #   @gateway.shutdown! if @gateway
-      # end
+      # We have experienced problems with the tunnel shutdown hanging.
+      # Previously the method was a no-op and we just exited the process which had the effect of closing the tunnel.
+      # However we are now running multiple tunnels in one process (sequentially), so we need to actually do a shutdown.
+      # So let's add a timeout.
+      if @gateway
+        begin
+          Timeout::timeout(15) do
+            say "Shutting down ssh reverse tunnel"
+            @gateway.close_remote(*@host_and_port) if @host_and_port
+            @gateway.shutdown! if @gateway
+          end
+        rescue Timeout::Error
+          say "tunnel shutdown timed out"
+        end
+      end
     end
   end
 end

data/lib/saucelabs_adapter/utilities.rb

@@ -19,5 +19,20 @@ module SaucelabsAdapter
     def raise_with_message(message)
       raise "#{diagnostics_prefix} #{message}"
     end
+
+    def find_unused_port(hostname, range = (3000..5000))
+      debug 'searching for unused port', 2
+      range.each do |port|
+        debug "trying #{hostname}:#{port}", 2
+        begin
+          socket = TCPSocket.new(hostname, port)
+        rescue Errno::ECONNREFUSED
+          debug "it's good, returning #{port}", 2
+          return port
+        ensure
+          socket.close if socket
+        end
+      end
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 8
-  - 4
-  version: 0.8.4
+  - 5
+  version: 0.8.5
 platform: ruby
 authors: 
 - Kelly Felkins, Chad Woolley & Sam Pierson