selenium-connect 3.0.0 → 3.1.0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+#3.1.0 (2013-07-14)
+return the log file names in the report object
+
+- Bumped version to 3.1.0 to prepare for release.
+- now passing back the sauce job and log file name in the report data
+- removed mocha from gemspec as it was not being used
+- updated rakefile to include release message at the top of the changelog stuff
+
 #3.0.0 (2013-07-14)
 - updated rake file to run all the tests on a release start
 - Bumped version to 3.0.0 to prepare for release.

data/README.md

@@ -1,4 +1,4 @@
-#selenium-connect 3.0.0 (2013-07-14)
+#selenium-connect 3.1.0 (2013-07-14)
 
 [![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)
 
@@ -89,7 +89,6 @@ sauce_username: 'test_user_name'
 sauce_api_key:
 browser_version:
 description: #sauce job/test description
-
 ```
 
 You can pass parameters into the new config object like:
@@ -121,7 +120,11 @@ report = job.finish passed: true
 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.
+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}}
+```
 
 ## Contribution Guidelines
 

data/Rakefile

@@ -104,7 +104,7 @@ task :release_finish, :update_message do |t, args|
 
   changelog_contents = File.read(changelog)
   # create the new heading
-  updated_changelog = "##{version} (#{date})\n" + log + "\n" + changelog_contents
+  updated_changelog = "##{version} (#{date})\n" + message + "\n\n" + log + "\n" + changelog_contents
   # update the contents
   File.open(changelog, 'w') { |f| f.write(updated_changelog) }
   puts "Updated change log for version #{version}\n"

data/lib/selenium_connect/job.rb

@@ -32,25 +32,25 @@ class SeleniumConnect
       # extracted from the earlier main finish
       begin
         @driver.quit
+        data = {}
         job_id = @driver.session_id
         if @config.host == 'saucelabs'
           if opts.has_key?(:failed) && opts[:failed]
             fail_job job_id
             if opts.has_key?(:failshot) && opts[:failshot]
-              save_last_screenshot job_id
+              data[:failshot] = save_last_screenshot job_id
             end
           end
           if opts.has_key?(:passed) && opts[:passed]
             pass_job job_id
           end
-          data = fetch_logs(job_id)
-          report_data = symbolize_keys sauce_data: data
+          data.merge! fetch_logs(job_id)
         end
       # rubocop:disable HandleExceptions
       rescue Selenium::WebDriver::Error::WebDriverError
       # rubocop:enable HandleExceptions
       end
-
+      report_data = symbolize_keys data
       @report_factory.build :job, report_data
     end
 
@@ -62,9 +62,11 @@ class SeleniumConnect
         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, "failed_#{job_id}.png") if @config.log
+        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!'
         end
@@ -82,10 +84,11 @@ class SeleniumConnect
         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, "sauce_job_#{job_id}.log") if @config.log
+        log_file = File.join(Dir.getwd, @config.log, filename) if @config.log
         File.open(log_file, 'w') { |f| f.write server_log }
-        JSON.parse(sauce_job.to_json)
+        { server_log: filename, sauce_data: JSON.parse(sauce_job.to_json) }
       end
 
       # TODO this should be pulled out into a generic report... or something

data/selenium-connect.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name          = 'selenium-connect'
-  s.version       = '3.0.0'
+  s.version       = '3.1.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   = 'Major refactoring of the public api which now includes correct updating of sauce lab job status and fetching screenshots on failure'
+  s.description   = 'return the log file names in the report object'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'curb', '~> 0.8.4'
 
   s.add_development_dependency 'rspec', '~> 2.14.1'
-  s.add_development_dependency 'mocha', '~> 0.14.0'
   s.add_development_dependency 'rubocop', '~> 0.9.0'
   s.add_development_dependency 'guard-rspec', '~> 3.0.2'
   s.add_development_dependency 'coveralls', '~> 0.6.7'

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

@@ -28,6 +28,7 @@ describe 'Sauce Labs', selenium: true do
     sauce_id = report.data[:sauce_data][:id]
     report.data[:sauce_data][:name].should be == name
     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
   end
 
@@ -40,7 +41,7 @@ describe 'Sauce Labs', selenium: true do
     report.data[:sauce_data][:passed].should be false
   end
 
-  it 'should download save a screenshot on failure' do
+  it 'should download a screenshot on failure' do
     # pending 'need to resolve the api issues first'
     job = @sc.create_job
     name = 'failshot'
@@ -53,8 +54,10 @@ describe 'Sauce Labs', selenium: true do
       # simulate a failure situation
       report = job.finish failed: true, failshot: true
     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
   end
 
   after(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-connect
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -108,22 +108,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -172,8 +156,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.7
-description: Major refactoring of the public api which now includes correct updating
-  of sauce lab job status and fetching screenshots on failure
+description: return the log file names in the report object
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -252,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -448221364801641841
+      hash: 3213783370642047366
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25