sauce 0.2.2 → 0.3.0

data/LICENSE

@@ -1,20 +1,19 @@
 Copyright (c) 2009 Sauce Labs Inc
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -7,16 +7,17 @@ Features
 --------
 Current:
 
-*   Treat tunnels like ruby objects. Find/create/destroy
+*   ActiveRecord-like interface for tunnels: Find/create/destroy
+*   Same with jobs
 
 Planned:
 
-*   ActiveRecord-like interface for video recordings, jobs logs, reverse tunnels
+*   Extend to automatic retrieval of jobs logs, videos, reverse tunnels
 *   Start/stop local instances of Sauce RC
 
 Install
 -------
-Make sure you're pulling in gems from gemcutter, and then:
+Make sure you're pulling in gems from http://rubygems.org/, and then:
 
 `gem install sauce`
 
@@ -29,20 +30,21 @@ Here's how to start a tunnel using the Sauce gem
     account = YAML.load_file "live_account.yml"
     client = Sauce::Client.new(:username => account["username"],
                                :access_key => account["access_key"])
-    tunnel = client.create_tunnel('DomainNames' => ["123.456.789.123"])
+
+    tunnel = client.tunnel.create('DomainNames' => ["example.com"])
     tunnel.refresh!
     
-    client.tunnels # => [#<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">]
-
-    tunnel.destroy # or client.destroy_all_tunnels
+    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">]
+
+    tunnel.destroy
 
 Note on Patches/Pull Requests
 ----------------------------- 

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/lib/job.rb

@@ -0,0 +1,135 @@
+require 'net/telnet'
+require 'net/ssh'
+require 'net/ssh/gateway'
+require 'gateway_ext'
+
+module Sauce
+  # Interact with a Sauce Labs selenium jobs as if it were a ruby object
+  class Job
+
+    #{"BrowserVersion": "3.", "Name": "prsel_./spec/integration/people_a_1_spec.rb", "_rev": "5-228269313", "CreationTime": 1266698090, "AssignmentTime": 1266698097, "Server": "10.212.146.145:4443", "AssignedTo": "f663372ba04444ce8cb3e6f61503f304", "ChefStartTime": 1266698101, "EndTime": 1266698139, "Type": "job", "Interactive": "true", "Status": "complete", "SeleniumServerLogUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/selenium-server.log"}, "Tags": [], "ResultId": "6337fe576deba0ba278dc1b5dfceac5f", "AttachmentRequests": {}, "ModificationTime": 1266698139, "Browser": "firefox", "StartTime": 1266698101, "Owner": "sgrove", "_id": "01fc48caba6d15b46fad79e1b0562bbe", "OS": "Linux", "VideoUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/video.flv"}}
+
+    attr_accessor :owner, :id, :name, :_rev, :server, :assigned_to, :sauce_type, :interactive, :status,:tags, :result_id
+    attr_accessor :selenium_server_log_upload_request, :attachment_requests, :videoupload_request
+    attr_accessor :creation_time, :assignment_time, :chef_start_time, :end_time, :modification_time, :start_time
+    attr_accessor :os, :browser, :browser_version
+
+    # TODO: Buckets for logs and videos
+    
+    # Get the class @@client.
+    # TODO: Consider metaprogramming this away
+    def self.client
+      @@client
+    end
+
+    # Set the class @@client.
+    # TODO: Consider metaprogramming this away
+    def self.client=(client)
+      @@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
+
+    def self.last
+      self.all.last
+    end
+
+    def self.all
+=begin
+      responses = JSON.parse @@client["jobs/recent"].get
+      return responses.collect{|response| Sauce::Job.new(response)}
+=end
+      return self.complete_jobs + self.in_progress_jobs
+    end
+
+    def self.destroy
+      self.all.each { |tunnel| tunnel.destroy }
+    end
+
+    def self.find id
+      #puts "GET-URL: #{@@client.url}jobs/#{id}"
+      Sauce::Job.new JSON.parse(@@client["jobs/#{id}"].get)
+    end
+
+    def self.complete_jobs
+      responses = JSON.parse @@client["complete-jobs"].get
+      start = Time.now
+      jobs = responses["jobs"].collect{|response| Sauce::Job.find(response["id"])}
+      lapsed = Time.now - start
+      puts "Took #{lapsed} seconds"
+      return jobs
+    end
+
+    def self.in_progress_jobs
+      responses = JSON.parse @@client["in-progress-jobs"].get
+      return [] if responses == []
+      start = Time.now
+      jobs = responses["jobs"].collect{|response| Sauce::Job.find(response["id"])}
+      lapsed = Time.now - start
+      puts "Took #{lapsed} seconds"
+      return jobs
+    end
+
+    # Creates an instance representing a job.
+    def initialize(options)
+      build!(options)
+    end
+
+    # Retrieves the latest information on this job from the Sauce Labs' server
+    def refresh!
+      response = JSON.parse @@client["jobs/#{@id}"].get
+      puts "\tjob refresh with: #{response.inspect}"
+      build! response
+      self
+    end
+
+    protected 
+
+    # Sets all internal variables from a hash
+    def build!(options)
+      #puts "\tBuild  with #{options.inspect}"
+      
+      @owner       = options["Owner"]
+      @id          = options["_id"]
+      @id          = options["id"] if @id.nil? or @id.empty?
+      @name        = options["Name"]
+      @_rev        = options["_rev"]
+      @server      = options["Server"]
+      @assigned_to = options["AssignedTo"]
+
+      @sauce_type  = options["Type"]
+      @interactive = options["Interactive"]
+      @status      = options["Status"]
+      @tags        = options["Tags"]
+      @result_id   = options["ResultId"]
+
+      @os              = options["OS"]
+      @browser         = options["Browser"]
+      @browser_version = options["BrowserVersion"]
+
+      # TODO: Should this be created_at and updated_at? Probably.
+      @creation_time     = options["CreationTime"]
+      @assignment_time   = options["AssignmentTime"]
+      @chef_start_time   = options["ChefStartTime"]
+      @end_time          = options["EndTime"]
+      @modification_time = options["ModificationTime"]
+      @start_time        = options["StartTime"]
+
+      raise NoIDError if @id.nil? or @id.empty?
+    end
+  end
+end

data/lib/rest.rb

@@ -8,7 +8,7 @@ module Sauce
     class MisconfiguredError < StandardError; end #nodoc
 
     attr_accessor :username, :access_key, :client, :ip, :api_url
-    attr_accessor :tunnels
+    attr_accessor :tunnels, :jobs
 
     def initialize(options)
       @username   = options[:username]
@@ -24,6 +24,12 @@ module Sauce
       @tunnels.account = {:username => @username,
         :access_key => @access_key,
         :ip => @ip}
+
+      @jobs = Sauce::Job
+      @jobs.client = @client
+      @jobs.account = {:username => @username,
+        :access_key => @access_key,
+        :ip => @ip}
     end
   end
 end

data/lib/sauce.rb

@@ -1,3 +1,4 @@
 require 'tunnel'
+require 'job'
 require 'rest'
 

data/lib/tunnel.rb

@@ -53,7 +53,7 @@ module Sauce
       return responses.collect{|response| Sauce::Tunnel.new(response)}
     end
 
-    def self.destroy
+    def self.destroy_all
       self.all.each { |tunnel| tunnel.destroy }
     end
 

data/test/test_jobs.rb

@@ -0,0 +1,58 @@
+require 'helper'
+require 'json'
+
+class TestSauce < Test::Unit::TestCase
+  context "A jobs instance" do
+    setup do
+      # Create this file and put in your details to run the tests
+      account = YAML.load_file "live_account.yml"
+      @username = account["username"]
+      @access_key = account["access_key"]
+      @ip = account["ip"]
+      @client = Sauce::Client.new(:username => @username,
+                                  :access_key => @access_key)
+    end    
+
+    should "initialize with passed variables" do
+      job_json = JSON.parse '{"BrowserVersion": "3.", "Name": "example_job/name.rb", "_rev": "5-228269313", "CreationTime": 1266698090, "AssignmentTime": 1266698097, "Server": "192.168.0.1:4443", "AssignedTo": "f663372ba04444ce8cb3e6f61503f304", "ChefStartTime": 1266698101, "EndTime": 1266698139, "Type": "job", "Interactive": "true", "Status": "complete", "SeleniumServerLogUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/selenium-server.log"}, "Tags": ["tag_1", "tag_2"], "ResultId": "6337fe576deba0ba278dc1b5dfceac5f", "AttachmentRequests": {}, "ModificationTime": 1266698139, "Browser": "firefox", "StartTime": 1266698101, "Owner": "sgrove", "_id": "01fc48caba6d15b46fad79e1b0562bbe", "OS": "Linux", "VideoUploadRequest": {"bucket": "sauce-userdata", "key": "sgrove/6337fe576deba0ba278dc1b5dfceac5f/video.flv"}}'
+
+      client = Sauce::Client.new(:username => "test_user",
+                                 :access_key => "abc123")
+      
+      job = client.jobs.new(job_json)
+
+      assert_equal "sgrove", job.owner
+      assert_equal "01fc48caba6d15b46fad79e1b0562bbe", job.id
+      assert_equal "example_job/name.rb", job.name 
+      assert_equal "5-228269313", job._rev 
+      assert_equal "192.168.0.1:4443", job.server
+      assert_equal "f663372ba04444ce8cb3e6f61503f304", job.assigned_to 
+
+      assert_equal "job", job.sauce_type
+      assert_equal "true", job.interactive
+      assert_equal "complete", job.status
+      assert_equal ["tag_1", "tag_2"], job.tags
+      assert_equal "6337fe576deba0ba278dc1b5dfceac5f", job.result_id
+
+      # TODO: Buckets
+      #assert_equal , job.selenium_server_log_upload_request 
+      #assert_equal , job.attachment_requests 
+      #assert_equal , job.videoupload_request
+
+      assert_equal "Linux", job.os
+      assert_equal "firefox", job.browser
+      assert_equal "3.", job.browser_version
+
+      assert_equal 1266698090, job.creation_time
+      assert_equal 1266698097, job.assignment_time
+      assert_equal 1266698101, job.chef_start_time
+      assert_equal 1266698139, job.end_time 
+      assert_equal 1266698139, job.modification_time
+      assert_equal 1266698101, job.start_time
+    end
+
+    def teardown
+      @client.tunnels.destroy
+    end
+  end
+end

data/test/test_tunnels.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+class TestSauce < Test::Unit::TestCase
+  context "A Client instance" do
+    setup do
+      # Create this file and put in your details to run the tests
+      account = YAML.load_file "live_account.yml"
+      @username = account["username"]
+      @access_key = account["access_key"]
+      @ip = account["ip"]
+      @client = Sauce::Client.new(:username => @username,
+                                  :access_key => @access_key)
+      @client.tunnels.destroy_all
+    end
+
+    should "initialize with passed variables" do
+      client = Sauce::Client.new(:username => "test_user",
+                                 :access_key => "abc123")
+      assert_equal client.api_url, "https://test_user:abc123@saucelabs.com/rest/test_user/"
+    end
+
+    should "create a tunnel with the current user" do
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.110"])
+      tunnel.refresh!
+      assert_not_nil tunnel
+      assert_equal @username, tunnel.owner
+    end
+
+    should "list current tunnels" do
+      @client.tunnels.create('DomainNames' => ["192.168.0.111"])
+      @client.tunnels.create('DomainNames' => ["192.168.0.112"])
+      @client.tunnels.create('DomainNames' => ["192.168.0.113"])
+
+      tunnels = @client.tunnels.all
+      assert_equal 3, tunnels.select{|t| t.status != "halting"}.count
+    end
+
+    should "destroy a tunnel" do
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.114"])
+      tunnel.destroy
+      assert_equal "halting", tunnel.status
+    end
+
+    should "destroy all tunnels" do
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.115"])
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.116"])
+      tunnel = @client.tunnels.create('DomainNames' => ["192.168.0.117"])
+
+      @client.tunnels.destroy_all
+
+      @client.tunnels.all.each do |tunnel|
+        assert_equal "halting", tunnel.status
+      end
+    end
+
+    should "say hello on port 1025 if healthy" do
+      tunnel = @client.tunnels.create('DomainNames' => [@ip])
+
+      max_retries = 30
+      retries = 0
+      until tunnel.status == "running" or retries >= max_retries
+        sleep 5
+        retries += 1
+        tunnel.refresh!
+      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
+      @client.tunnels.destroy_all
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sauce
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sean Grove
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-22 00:00:00 -08:00
+date: 2010-02-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,11 +48,13 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- lib/job.rb
 - lib/rest.rb
 - lib/sauce.rb
 - lib/tunnel.rb
 - test/helper.rb
-- test/test_sauce.rb
+- test/test_jobs.rb
+- test/test_tunnels.rb
 has_rdoc: true
 homepage: http://github.com/sgrove/sauce
 licenses: []
@@ -85,4 +87,6 @@ test_files:
 - test/debug.rb
 - test/helper.rb
 - test/irb_boot.rb
-- test/test_sauce.rb
+- test/test_jobs.rb
+- test/test_tunnels.rb
+- test/test_videos.rb