selenium-connect 3.1.2 → 3.2.0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+#3.2.0 (2013-07-15)
+added better error handling to the sauce api calls and improved naming convention for job assets
+
+- Bumped version to 3.2.0 to prepare for release.
+- cleaned up the way the job log was saving
+- added one more error check around the sauce data
+- refactored the log saving and sauce api access, now can configure the api time out and the requests will poll when trying to fetch the data from the server
+
 #3.1.2 (2013-07-14)
 removed references to curb
 

data/README.md

@@ -1,4 +1,4 @@
-#selenium-connect 3.1.2 (2013-07-14)
+#selenium-connect 3.2.0 (2013-07-15)
 
 [![Gem Version](https://badge.fury.io/rb/selenium-connect.png)](http://badge.fury.io/rb/selenium-connect) [![Build Status](https://travis-ci.org/arrgyle/selenium-connect.png?branch=develop)](https://travis-ci.org/arrgyle/selenium-connect) [![Code Climate](https://codeclimate.com/github/arrgyle/selenium-connect.png)](https://codeclimate.com/github/arrgyle/selenium-connect) [![Coverage Status](https://coveralls.io/repos/arrgyle/selenium-connect/badge.png?branch=develop)](https://coveralls.io/r/arrgyle/selenium-connect?branch=develop)
 
@@ -90,6 +90,7 @@ sauce_username: 'test_user_name'
 sauce_api_key:
 browser_version:
 description: #sauce job/test description
+api_timeout: #how many seconds we should try to get the assets (default 10)
 ```
 
 You can pass parameters into the new config object like:
@@ -124,7 +125,7 @@ report = job.finish failed: true, failshot: true
 The `report` is simply a container for arbitrary data. Right now we are passing back the sauce details. Here is an example of `report.data` for a failed job:
 
 ```
-{:failshot=>"failed_e8ebfe9fc5004df7865b6a6f9f1f5491.png", :server_log=>"sauce_job_e8ebfe9fc5004df7865b6a6f9f1f5491.log", :sauce_data=>{:id=>"e8ebfe9fc5004df7865b6a6f9f1f5491", :"custom-data"=>nil, :owner=>"testing_arrgyle", :status=>"complete", :error=>nil, :name=>"failshot", :browser=>"iexplore", :browser_version=>"7.0.5730.13", :os=>"Windows 2003", :creation_time=>1373831090, :start_time=>1373831090, :end_time=>1373831105, :video_url=>"http://saucelabs.com/jobs/e8ebfe9fc5004df7865b6a6f9f1f5491/video.flv", :log_url=>"http://saucelabs.com/jobs/e8ebfe9fc5004df7865b6a6f9f1f5491/selenium-server.log", :public=>nil, :tags=>[], :passed=>false}}
+{:assets=>{:server_log=>"failed_serverlog_failing_sauce_job_3ee1fddf4032476fa3f9de94298766ae.log", :job_data_log=>"failed_saucejob_failing_sauce_job_3ee1fddf4032476fa3f9de94298766ae.log"}, :sauce_data=>{:id=>"3ee1fddf4032476fa3f9de94298766ae", :"custom-data"=>nil, :owner=>"testing_arrgyle", :status=>"in progress", :error=>nil, :name=>"failing_sauce_job", :browser=>"iexplore", :browser_version=>"7.0.5730.13", :os=>"Windows 2003", :creation_time=>1373916900, :start_time=>1373916901, :end_time=>0, :video_url=>"http://saucelabs.com/jobs/3ee1fddf4032476fa3f9de94298766ae/video.flv", :log_url=>"http://saucelabs.com/jobs/3ee1fddf4032476fa3f9de94298766ae/selenium-server.log", :public=>nil, :tags=>[], :passed=>false}}
 ```
 
 ## Contribution Guidelines

data/lib/sauce/sauce_facade.rb

@@ -0,0 +1,73 @@
+# Encoding: utf-8
+
+require 'json'
+require 'sauce_whisk'
+require 'rest_client'
+require 'sauce/client'
+
+module Sauce
+# wrapps the sauce whick api accessor with sane error handling
+  class SauceFacade
+
+    attr_accessor :job_id, :timeout
+
+    def initialize(timeout = 10)
+      @timeout  = timeout ||= 10
+    end
+
+    def fail_job
+      requires_job_id
+      SauceWhisk::Jobs.fail_job @job_id
+    end
+
+    def pass_job
+      requires_job_id
+      SauceWhisk::Jobs.pass_job @job_id
+    end
+
+    def fetch_last_screenshot
+      requires_job_id
+      polling_api_request @timeout do
+        SauceWhisk::Jobs.fetch_asset @job_id, 'final_screenshot.png'
+      end
+    end
+
+    def fetch_server_log
+      requires_job_id
+      polling_api_request @timeout do
+        SauceWhisk::Jobs.fetch_asset @job_id, 'selenium-server.log'
+      end
+    end
+
+    def fetch_job_data
+      requires_job_id
+      # TODO let's switch this over to use whisk as well
+      # This is used because it's easy to get all the data out of the job
+      begin
+        job = Sauce::Job.find @job_id
+        JSON.parse job.to_json
+      rescue StandardError => e
+        puts "An error occured while fetching the job data: #{e.message}"
+      end
+    end
+
+    private
+
+      def requires_job_id
+        raise ArgumentError, "#{caller[0][/`.*'/][1..-2]} requires that the job_id be set in this object." unless @job_id
+      end
+
+      def polling_api_request(timeout)
+        begin
+          sleep 1
+          yield
+        rescue RestClient::Exception => e
+          if timeout > 0
+            polling_api_request(timeout - 1) { yield }
+          else
+            puts "Request timed out after #{timeout} with: #{e.message}"
+          end
+        end
+      end
+  end
+end

data/lib/selenium_connect/configuration.rb

@@ -17,7 +17,7 @@ class SeleniumConnect
 
     # SauceLabs
     attr_accessor :sauce_username, :sauce_api_key,
-                  :os, :browser_version, :description
+                  :os, :browser_version, :description, :api_timeout
 
     def initialize(opts = {})
       @host     = 'localhost'

data/lib/selenium_connect/job.rb

@@ -1,26 +1,27 @@
 # Encoding: utf-8
+
 require 'selenium_connect/runner'
 require 'sauce/client'
 require 'rest_client'
 require 'selenium-webdriver'
 require 'json'
 require 'sauce_whisk'
-
 # selenium connect
 class SeleniumConnect
   # encapsulates the creation of a driver and a run
   class Job
 
-    def initialize(config, report_factory)
+    def initialize(config, report_factory, sauce_facade)
       @config = config
       @report_factory = report_factory
+      @sauce_facade = sauce_facade
     end
 
     # Creates and returns the driver, using options passed in
     def start(opts = {})
-
+      @job_name = slugify_name opts[:name] if opts.has_key? :name
       # TODO this could be refactored out into an options parser of sorts
-      @config.description = opts[:name] if opts.has_key? :name
+      @config.description = @job_name ||= 'unnamed_job'
       @driver = Runner.new(@config).driver
     end
 
@@ -30,63 +31,54 @@ class SeleniumConnect
       # extracted from the earlier main finish
       begin
         @driver.quit
-        data = {}
-        if @config.host == 'saucelabs'
-          job_id = @driver.session_id
-          if opts.has_key?(:failed) && opts[:failed]
-            fail_job job_id
-            if opts.has_key?(:failshot) && opts[:failshot]
-              data[:failshot] = save_last_screenshot job_id
-            end
-          end
-          if opts.has_key?(:passed) && opts[:passed]
-            pass_job job_id
-          end
-          data.merge! fetch_logs(job_id)
-        end
+        @data = { assets: {} }
+        process_sauce_logs(opts) if @config.host == 'saucelabs'
       # rubocop:disable HandleExceptions
       rescue Selenium::WebDriver::Error::WebDriverError
       # rubocop:enable HandleExceptions
       end
-      report_data = symbolize_keys data
-      @report_factory.build :job, report_data
+      @report_factory.build :job, @data
     end
 
     private
 
-      # TODO all this sauce stuff needs to be pulled out of the job class
-      # TODO need to put error handling around the sauce api requests
-      def save_last_screenshot(job_id)
-        begin
-        # Seemingly need to wait slightly for the images to be processed
-        sleep(2)
-        filename = "failed_#{job_id}.png"
-        image = SauceWhisk::Jobs.fetch_asset job_id, 'final_screenshot.png'
-        image_file = File.join(Dir.getwd, @config.log, filename) if @config.log
-        File.open(image_file, 'w') { |f| f.write image }
-        filename
-        rescue RestClient::ResourceNotFound
-          puts 'Unable to download image!'
+      def process_sauce_logs(opts = {})
+        job_id = @driver.session_id
+        @sauce_facade.job_id = job_id
+        if opts.has_key?(:failed) && opts[:failed]
+          status = 'failed'
+          @sauce_facade.fail_job
+          if opts.has_key?(:failshot) && opts[:failshot]
+          screenshot = @sauce_facade.fetch_last_screenshot
+          @data[:assets][:failshot] = save_asset("#{status}_failshot_#{@job_name}_#{job_id}.png", screenshot) if screenshot
+          end
         end
-      end
+        if opts.has_key?(:passed) && opts[:passed]
+          status = 'passed'
+          @sauce_facade.pass_job
+        end
+        server_log = @sauce_facade.fetch_server_log
+        @data[:assets][:server_log] = save_asset("#{status}_serverlog_#{@job_name}_#{job_id}.log", server_log) if server_log
 
-      def fail_job(job_id)
-        SauceWhisk::Jobs.fail_job job_id
+        job_data = @sauce_facade.fetch_job_data
+        @data[:sauce_data] = job_data if job_data
+
+        job_data_log_file = "#{status}_saucejob_#{@job_name}_#{job_id}.log"
+        @data[:assets][:job_data_log] = job_data_log_file
+        @data = symbolize_keys @data
+        save_asset(job_data_log_file, @data)
       end
 
-      def pass_job(job_id)
-        SauceWhisk::Jobs.pass_job job_id
+      def save_asset(filename, asset)
+        if @config.log
+          asset_file = File.join(Dir.getwd, @config.log, filename)
+          File.open(asset_file, 'w') { |f| f.write asset }
+          filename
+        end
       end
 
-      def fetch_logs(job_id)
-        sauce_job = Sauce::Job.find(job_id)
-        # Seemingly need to wait slightly for the images to be processed
-        sleep(2)
-        filename = "sauce_job_#{job_id}.log"
-        server_log = SauceWhisk::Jobs.fetch_asset job_id, 'selenium-server.log'
-        log_file = File.join(Dir.getwd, @config.log, filename) if @config.log
-        File.open(log_file, 'w') { |f| f.write server_log }
-        { server_log: filename, sauce_data: JSON.parse(sauce_job.to_json) }
+      def slugify_name(name)
+        name.downcase.strip.gsub(' ', '_').gsub(/[^\w-]/, '')
       end
 
       # TODO this should be pulled out into a generic report... or something

data/lib/selenium_connect.rb

@@ -3,6 +3,7 @@
 require 'selenium_connect/job'
 require 'selenium_connect/server'
 require 'selenium_connect/configuration'
+require 'sauce/sauce_facade'
 require 'selenium_connect/report/report_factory'
 
 # Selenium Connect main module
@@ -24,7 +25,8 @@ class SeleniumConnect
   end
 
   def create_job(opts = {})
-    SeleniumConnect::Job.new @config, @report_factory
+    sauce_facade = Sauce::SauceFacade.new @config.api_timeout
+    SeleniumConnect::Job.new @config, @report_factory, sauce_facade
   end
 
   def finish

data/selenium-connect.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name          = 'selenium-connect'
-  s.version       = '3.1.2'
+  s.version       = '3.2.0'
   s.platform      = Gem::Platform::RUBY
   s.authors       = ['Dave Haeffner', 'Jason Fox']
   s.email         = ['dave@arrgyle.com', 'jason@arrgyle.com']
   s.homepage      = 'https://github.com/arrgyle/selenium-connect'
   s.summary       = 'A stupid simple way to run your Selenium tests on localhost, against a Selenium Grid, or in the cloud (e.g. SauceLabs).'
-  s.description   = 'removed references to curb'
+  s.description   = 'added better error handling to the sauce api calls and improved naming convention for job assets'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)

data/spec/integration/lib/selenium_connect/runners/sauce_spec.rb

@@ -26,10 +26,10 @@ describe 'Sauce Labs', selenium: true do
     execute_simple_test driver
     report = job.finish passed: true
     sauce_id = report.data[:sauce_data][:id]
-    report.data[:sauce_data][:name].should be == name
+    report.data[:sauce_data][:name].should be == 'successful_sauce_job'
     report.data[:sauce_data][:passed].should be_true
-    report.data[:server_log].should be == "sauce_job_#{sauce_id}.log"
-    File.exist?(File.join(Dir.pwd, 'build', 'tmp', "sauce_job_#{sauce_id}.log")).should be_true
+    report.data[:assets][:server_log].should be == "passed_serverlog_successful_sauce_job_#{sauce_id}.log"
+    File.exist?(File.join(Dir.pwd, 'build', 'tmp', "passed_serverlog_successful_sauce_job_#{sauce_id}.log")).should be_true
   end
 
   it 'should mark a sauce job as failed' do
@@ -56,8 +56,8 @@ describe 'Sauce Labs', selenium: true do
     end
     sauce_id = report.data[:sauce_data][:id]
     report.data[:sauce_data][:passed].should be false
-    report.data[:failshot].should be == "failed_#{sauce_id}.png"
-    File.exist?(File.join(Dir.pwd, 'build', 'tmp', "failed_#{sauce_id}.png")).should be_true
+    report.data[:assets][:failshot].should be == "failed_failshot_failshot_#{sauce_id}.png"
+    File.exist?(File.join(Dir.pwd, 'build', 'tmp', "failed_failshot_failshot_#{sauce_id}.png")).should be_true
   end
 
   after(:each) do

data/spec/support/example.yaml

@@ -21,3 +21,4 @@ sauce_username: 'test_user_name'
 sauce_api_key:
 browser_version:
 description:
+api_timeout: 10

data/spec/unit/lib/sauce/sauce_facade_spec.rb

@@ -0,0 +1,55 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'sauce/sauce_facade'
+
+describe Sauce::SauceFacade do
+
+  before(:each) do
+    @facade = Sauce::SauceFacade.new
+  end
+
+  it 'should be initialized' do
+    @facade.should be_an_instance_of Sauce::SauceFacade
+    @facade.timeout.should be == 10
+  end
+
+  it 'can be initialized with an optional time out value' do
+    facade = Sauce::SauceFacade.new 30
+    facade.timeout.should be == 30
+  end
+
+  it 'should respond to fail_job' do
+    @facade.should respond_to :fail_job
+  end
+
+  it 'should respond to pass_job' do
+    @facade.should respond_to :pass_job
+  end
+
+  it 'should respond to fetch_last_screenshot' do
+    @facade.should respond_to :fetch_last_screenshot
+  end
+
+  it 'should respond to fetch_server_log' do
+    @facade.should respond_to :fetch_server_log
+  end
+
+  it 'should respoind to fetch_job_data' do
+    @facade.should respond_to :fetch_job_data
+  end
+
+  it 'should respond to job_id' do
+    @facade.should respond_to :job_id
+    @facade.should respond_to :job_id=
+  end
+
+  it 'should raise and exception if a function is called that requires an id but it is not set' do
+    [:fail_job, :pass_job, :fetch_last_screenshot, :fetch_server_log, :fetch_job_data].each do |method|
+      expect do
+        @facade.send method
+      end.to raise_error ArgumentError, "#{method.to_s} requires that the job_id be set in this object."
+    end
+  end
+end
+

data/spec/unit/lib/selenium_connect/job_spec.rb

@@ -8,9 +8,10 @@ describe SeleniumConnect::Job do
   before(:each) do
     config = double 'SeleniumConnect::Configuration'
     report_factory = double 'SeleniumConnect::Report::ReportFactory'
+    sauce_facade = double 'Sauce::SauceFacade'
     @report = double 'SeleniumConnect::Report::JobReport'
     allow(report_factory).to receive(:build).and_return(@report)
-    @job = SeleniumConnect::Job.new config, report_factory
+    @job = SeleniumConnect::Job.new config, report_factory, sauce_facade
   end
 
   it 'should be initialized' do

data/spec/unit/lib/selenium_connect_spec.rb

@@ -9,6 +9,7 @@ describe SeleniumConnect do
     @config = double 'SeleniumConnect::Configuration'
     allow(@config).to receive(:is_a?).and_return(true)
     allow(@config).to receive(:host).and_return(false)
+    allow(@config).to receive(:api_timeout).and_return(10)
 
     report_factory = double 'SeleniumConnect::Report::ReportFactory'
     @report = double 'SeleniumConnect::Report::MainReport'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-connect
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-14 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -140,7 +140,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.7
-description: removed references to curb
+description: added better error handling to the sauce api calls and improved naming
+  convention for job assets
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -163,6 +164,7 @@ files:
 - bin/chromedriver
 - bin/phantomjs
 - bin/selenium-server-standalone-2.33.0.jar
+- lib/sauce/sauce_facade.rb
 - lib/selenium-connect.rb
 - lib/selenium_connect.rb
 - lib/selenium_connect/configuration.rb
@@ -190,6 +192,7 @@ files:
 - spec/support/example.yaml
 - spec/support/example_page_object.rb
 - spec/support/integration_helper.rb
+- spec/unit/lib/sauce/sauce_facade_spec.rb
 - spec/unit/lib/selenium-connect_spec.rb
 - spec/unit/lib/selenium_connect/configuration_spec.rb
 - spec/unit/lib/selenium_connect/job_spec.rb
@@ -219,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2083194116376404584
+      hash: -3833046545710782296
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25