sauce 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/rest.rb

@@ -7,12 +7,13 @@ module Sauce
     class BadAccessError < StandardError; end #nodoc
     class MisconfiguredError < StandardError; end #nodoc
 
-    attr_accessor :username, :access_key, :client, :api_url
+    attr_accessor :username, :access_key, :client, :ip, :api_url
     attr_accessor :tunnels
 
     def initialize(options)
       @username   = options[:username]
       @access_key = options[:access_key]
+      @ip         = options[:ip]
 
       raise MisconfiguredError if @username.nil? or @access_key.nil?
       @api_url = "https://#{@username}:#{@access_key}@saucelabs.com/rest/#{@username}/"
@@ -20,6 +21,9 @@ module Sauce
 
       @tunnels = Sauce::Tunnel
       @tunnels.client = @client
+      @tunnels.account = {:username => @username,
+        :access_key => @access_key,
+        :ip => @ip}
     end
   end
 end

data/lib/sauce.rb

@@ -1,2 +1,3 @@
-require 'rest'
 require 'tunnel'
+require 'rest'
+

data/lib/tunnel.rb

@@ -1,19 +1,20 @@
+require 'net/telnet'
+require 'net/ssh'
+require 'net/ssh/gateway'
+require 'gateway_ext'
+
 module Sauce
   # Interact with a Sauce Labs tunnel as if it were a ruby object
   class Tunnel
     class NoIDError < StandardError; end #nodoc
 
-    attr_accessor :application_address, :username, :access_key, :timeout
-    attr_accessor :status, :owner, :creation_time, :id, :host
+    #{"Status": "running", "CreationTime": 1266545716, "ModificationTime": 1266545793, "Host": "ec2-184-73-16-13.compute-1.amazonaws.com", "LaunchTime": 1266545726, "Owner": "sgrove", "_id": "1090b4b0b50477cf40fc44c146b408a4", "Type": "tunnel", "id": "1090b4b0b50477cf40fc44c146b408a4", "DomainNames": ["sgrove.tst"]}
 
-    def self.create(options)
-      response = JSON.parse @@client[:tunnels].post(options.to_json, :content_type => 'application/json')
-      Tunnel.new response
-    end
-
-    def initialize(options)
-      build!(options)
-    end
+    attr_accessor :owner, :access_key, :status
+    attr_accessor :id, :host, :domain_names, :timeout
+    attr_accessor :launch_time, :created_at, :updated_at
+    
+    attr_accessor :application_address, :gateway, :port, :thread
 
     # Get the class @@client.
     # TODO: Consider metaprogramming this away
@@ -27,6 +28,18 @@ module Sauce
       @@client = client
     end
 
+    # Get the class @@client.
+    # TODO: Consider metaprogramming this away
+    def self.account
+      @@account
+    end
+
+    # Set the class @@client.
+    # TODO: Consider metaprogramming this away
+    def self.account=(account)
+      @@account = account
+    end
+
     def self.first
       self.all.first
     end
@@ -44,8 +57,21 @@ module Sauce
       self.all.each { |tunnel| tunnel.destroy }
     end
 
+    # Creates a new tunnel machine
+    def self.create(options)
+      response = JSON.parse @@client[:tunnels].post(options.to_json, :content_type => 'application/json')
+      #puts response.inspect
+      Tunnel.new response
+    end
+
+    # Creates an instance representing a machine, but does not actually create the machine. See #create for that.
+    def initialize(options)
+      build!(options)
+    end
+
     # Hits the destroy url for this tunnel, and then refreshes. Keep in mind it takes some time to completely teardown a tunnel.
     def destroy
+      close_gateway
       response = @@client["tunnels/#{@id}"].delete
       refresh!
     end
@@ -53,11 +79,47 @@ module Sauce
     # Retrieves the latest information on this tunnel from the Sauce Labs' server
     def refresh!
       response = JSON.parse @@client["tunnels/#{@id}"].get
+      #puts "\Tunnel refresh with: #{response.inspect}"
       build! response
+      self
+    end
+
+    # Shortcut method to find out if a tunnel is marked as dead
+    def preparing?
+      refresh!
+      status == "new" or status == "booting"
+    end
+
+    # Shortcut method to find out if a tunnel is marked as dead
+    def halting?
+      refresh!
+      status == "halting"
+    end
+
+    # Shortcut method to find out if a tunnel is marked as dead
+    def terminated?
+      refresh!
+      status == "terminated"
+    end
+
+    # A tunnel is healthy if 1.) its status is "running" and 2.) It says hello
+    def healthy?
+      # TODO: Implement 3.) We can reach through and touch a service on the reverse end of the tunnel
+      refresh!
+=begin
+      puts "\tRunning? #{self.status == 'running'}"
+      puts "\tSays hello? #{self.says_hello?}"
+      puts "\tThread running? #{self.still_running?}"
+=end
+      return true if not self.terminated? and self.status == "running" and self.says_hello? and self.still_running?
+      return false
     end
 
-    # Sauce Labs' server will say hello on port 1025 as a sanity check. If no hello, something is wrong. TODO: Make it say hello on port 1025. Currently a hack.
+    # Sauce Labs' server will say hello on port 1025 as a sanity check. If no hello, something is wrong.
+    # TODO: Make it say hello on port 1025. Currently a hack.
     def says_hello?(options={})
+      return false unless self.status == "running"
+
       # TODO: Read from options if necessary
       connection = {}
       connection[:host]        = @host
@@ -66,6 +128,8 @@ module Sauce
       connection[:telnet_mode] = true
       connection[:timeout]     = 10
 
+      #puts "telnet: #{connection.inspect}"
+
       host = Net::Telnet::new("Host"       => connection[:host],
                               "Port"       => connection[:port],
                               "Prompt"     => connection[:prompt],
@@ -78,15 +142,77 @@ module Sauce
       line[0,prefix.length] == prefix
     end
 
+    # Debug method
+    def mini_repair
+      refresh!
+      if not self.terminated? and self.status == "running" and self.says_hello?
+        if not self.still_running?
+          open_gateway
+          return true if self.still_running?
+        end
+      end
+      return false
+    end
+
+    # Opens a reverse ssh tunnel to the tunnel machine
+    def open_gateway
+      # TODO: Make ports configurable
+
+      @gateway = Net::SSH::Gateway.new(host, owner, {:password => @@account[:access_key]})
+
+      # Notes for anyone looking at this method
+      # gateway.open_remote(3000,        # Port where your local application is running. Usually 3000 for rails dev
+      #                     "localhost", # Hostname/local ip your rails app is running on. Usually "localhost" for rails dev
+      #                     80,          # This is the port to run your selenium tests against, i.e. :url => "http://<some_host>:80"
+      #                                  #   <some_host> is the DomainNames you started the tunnel machine with.
+      #                     "0.0.0.0")   # Do not change this unless your god has commanded you to do so. I'm serious.
+      port = 3000
+      local_host = "localhost"
+      remote_port = 80
+      #puts "This is the experimental non-blocking gateway_open. Well done."
+      #puts "gateway.open_remote(#{port}, #{local_host}, #{remote_port}, 0.0.0.0)"
+      #gateway.open_remote(pair[0], local_host, pair[1], "0.0.0.0") do |rp, rh|
+
+      @thread = Thread.new(host, port, remote_port, owner, @@account[:access_key]) do
+        Thread.pass
+        @gateway.open_remote(3000,
+                             "localhost",
+                             80,
+                             "0.0.0.0") do |rp, rh|
+          while true do
+            sleep 10
+          end
+        end
+      end
+
+      @thread.run
+    end
+
+    # Closes the reverse ssh tunnel if open
+    def close_gateway
+      @thread.kill if @thread
+    end
+
+    # Returns true if this tunnel has a thread that needs to be monitored
+    def still_running?
+      #puts "\t\t#{@thread.inspect}.nil?"
+      not @thread.nil?
+    end
+
     protected 
 
     # Sets all internal variables from a hash
     def build!(options)
+      #puts "\tBuild with #{options.inspect}"
       @status = options["Status"]
-      @owner = options["Owner"]
-      @id = options["_id"]
-      @id = options["id"] if @id.nil? or @id.empty?
-      @host = options["Host"]
+      @owner  = options["Owner"]
+      @id     = options["_id"]
+      @id     = options["id"] if @id.nil? or @id.empty?
+      @host   = options["Host"]
+      @created_at = options["CreationTime"]
+      @updated_at = options["ModificationTime"]
+      @launch_time = options["LaunchTime"]
+      @domain_names = options["DomainNames"]
 
       raise NoIDError if @id.nil? or @id.empty?
     end

data/test/debug.rb

@@ -1,11 +1,34 @@
-require 'helper'
+require 'irb_boot'
 
 c = Sauce::Client.new(:username => "sgrove",
-                      :access_key => "4c592ce3-8f45-4cd6-8e3e-65b9f0b173d0")
+                      :access_key => "733a44e2-4226-488f-8126-6f6d59bdf386",
+                      :ip => "67.188.3.10")
+
+=begin
+t = c.tunnels.first
 
 c.destroy_all_tunnels
 t = c.create_tunnel('DomainNames' => ["111.111.111.111"])
 
 puts c.tunnels.inspect
+=end
 
-c.destroy_all_tunnels
+t = c.tunnels.first
+
+if t.nil?
+  puts "Starting a new tunnel"
+  t = c.tunnels.create("DomainNames" => ["sgrove.tst"])
+  until t.status == "running"
+    print "." ; STDOUT.flush
+    t.refresh!
+    sleep 1
+  end
+end
+
+puts t.inspect
+t.open_gateway
+
+puts "Checking to see if thread is running."
+puts t.still_running?
+puts t.thread.inspect
+t.thread.join if t.still_running?

data/test/irb_boot.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'net/telnet'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'sauce'

data/test/test_sauce.rb

@@ -65,6 +65,15 @@ class TestSauce < Test::Unit::TestCase
       end
 
       assert_equal true, tunnel.says_hello?
+
+      tunnel.destroy # cleanup
+    end
+
+    should "not attempt to telnet if status is not running" do
+      tunnel = @client.tunnels.create('DomainNames' => [@ip])
+
+      tunnel.status = "booting"
+      assert_equal false, tunnel.says_hello?
     end
 
     def teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sauce
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Sean Grove
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 -08:00
+date: 2010-02-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,4 +84,5 @@ summary: Ruby access to Sauce Labs' features
 test_files: 
 - test/debug.rb
 - test/helper.rb
+- test/irb_boot.rb
 - test/test_sauce.rb