selenium-connect 3.6.0 → 3.7.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+#3.7.0 (2013-08-26)
+Can now pass run time sauce options to a job and will capture all open window doms
+
+- Bumped version to 3.7.0 to prepare for release.
+- upgraded chromedriver and moved the tests to the right place
+- updated tests and doc for additional configurations
+- added the ability to pass in a hash of sauce opts to the job start array in order to set team permissions and what have
+- first crack at multi window assets
+
 #3.6.0 (2013-08-18)
 upgraded selenium version and improved chrome log storage
 

data/README.md

@@ -1,4 +1,4 @@
-#selenium-connect 3.6.0 (2013-08-18)
+#selenium-connect 3.7.0 (2013-08-26)
 
 [![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)
 
@@ -45,9 +45,13 @@ sc.finish
 ### Start
 If host is set to "localhost" and no jar file is specified, it will run the version of [selenium-standalone-server.jar](https://code.google.com/p/selenium/downloads/list) that is bundled with the library (currently 2.33.0). Or, you can specify your own jar if you have one you prefer to use. This is done with c.jar = 'path-to-jar-file'.
 
-If no additional parameters are set, the Selenium Server will be run in the background with logging disabled. If a logging directory is provided (with c.log = 'path-to-log-dir') then 2 output files will be generated:
-+ Selenium Server JSON Wire Protocol output (server.log)
-+ Browser output (browser.log) -- currently only available for Firefox
+If no additional parameters are set, the Selenium Server will be run in the background with logging disabled. If a logging directory is provided (with c.log = 'path-to-log-dir') then the following output files will be generated:
+
+- Selenium Server JSON Wire Protocol output (server.log)
+- firefox.log (If using Firefox as the browser)
+- chrome.log (If using Chrome as the browser)
+- dom_0.html (Or dom_1.html etc for each open window at the time the job is finished, a dump of the html)
+- failshot.png (If failshot is marked as true, a screenshot of the end state)
 
 This localhost functionality is driven using the [Selenium Rake Server Task](http://selenium.googlecode.com/svn/trunk/docs/api/rb/Selenium/Rake/ServerTask.html).
 
@@ -116,10 +120,13 @@ When you create your job you can pass in parameters, right now just `:name` that
 
 ```Ruby
 #…
-job.start name: 'website should load'
+job.start name: 'website should load', sauce_opts: { public: 'team' }
 #…
 ```
 
+Note you can also pass a hash of `sauce_opts` to the job start function that will let you do additional run time configuration with options as detailed here: [https://saucelabs.com/docs/additional-config](https://saucelabs.com/docs/additional-config)
+
+
 Similarly, when you finish your job you can pass in parameters. You can use the `failshot` parameter to turn on the saving of the last screenshot. For SauceLabs you can mark the tests as passed or failed:
 
 ```Ruby

data/lib/selenium_connect/job.rb

@@ -19,9 +19,12 @@ class SeleniumConnect
 
     # 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.sauce_opts.job_name = @job_name ||= 'unnamed_job'
+      @job_name = opts.key?(:name) ? slugify_name(opts[:name]) : 'unnamed_job'
+      sauce_config = {}
+      sauce_config.merge!(opts[:sauce_opts]) if opts.key? :sauce_opts
+      sauce_config.merge!(job_name: @job_name)
+      @config.sauce_opts = sauce_config
       @driver = Runner.new(@config).driver
     end
 
@@ -31,7 +34,7 @@ class SeleniumConnect
       # extracted from the earlier main finish
       begin
         save_html
-        if opts.has_key?(:failshot) && opts[:failshot] && @config.host != 'saucelabs'
+        if opts.key?(:failshot) && opts[:failshot] && @config.host != 'saucelabs'
           save_screenshot
         end
         @driver.quit
@@ -52,21 +55,26 @@ class SeleniumConnect
       end
 
       def save_html
-        save_asset('dom.html', @driver.page_source)
+        dom_number = 0
+        @driver.window_handles.each do |handle|
+          @driver.switch_to.window(handle)
+          save_asset("dom_#{dom_number}.html", @driver.page_source)
+          dom_number += 1
+        end
       end
 
       def process_sauce_logs(opts = {})
         job_id = @driver.session_id
         @sauce_facade.job_id = job_id
-        if opts.has_key?(:failed) && opts[:failed]
+        if opts.key?(:failed) && opts[:failed]
           status = 'failed'
           @sauce_facade.fail_job
-          if opts.has_key?(:failshot) && opts[:failshot]
+          if opts.key?(:failshot) && opts[:failshot]
             screenshot = @sauce_facade.fetch_last_screenshot
           @data[:assets][:failshot] = save_asset('failshot.png', screenshot) if screenshot
           end
         end
-        if opts.has_key?(:passed) && opts[:passed]
+        if opts.key?(:passed) && opts[:passed]
           status = 'passed'
           @sauce_facade.pass_job
         end

data/selenium-connect.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name          = 'selenium-connect'
-  s.version       = '3.6.0'
+  s.version       = '3.7.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   = 'upgraded selenium version and improved chrome log storage'
+  s.description   = 'Can now pass run time sauce options to a job and will capture all open window doms'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)

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

@@ -30,7 +30,7 @@ describe 'Chrome', selenium: true do
     sc.finish
 
     File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'chrome.log')).should be_true
-    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'dom.html')).should be_true
+    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'dom_0.html')).should be_true
     File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'failshot.png')).should be_true
   end
 end

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

@@ -25,7 +25,7 @@ describe 'Firefox', selenium: true do
     sc.finish
 
     File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'firefox.log')).should be_true
-    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'dom.html')).should be_true
+    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'dom_0.html')).should be_true
     File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'failshot.png')).should be_true
     File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'server.log')).should be_true
   end
@@ -68,4 +68,21 @@ describe 'Firefox', selenium: true do
     job.finish
     sc.finish
   end
+
+  it 'should download all the dom dumps if there are multiple windows open' do
+    config = SeleniumConnect::Configuration.new browser: 'firefox', log: '/build/tmp'
+    sc = SeleniumConnect.start config
+    job = sc.create_job
+    driver = job.start
+
+    driver.get 'http://the-internet.herokuapp.com/windows'
+    driver.find_element(css: '.example a').click
+    unless driver.title =~ /Poogle/
+      # simulate a failure situation
+      job.finish failed: true, failshot: true
+    end
+    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'dom_0.html')).should be_true
+    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'dom_1.html')).should be_true
+    sc.finish
+  end
 end

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

@@ -24,14 +24,15 @@ describe 'Sauce Labs', selenium: true do
   it 'just execute a sauce job successfully' do
     job = @sc.create_job
     name = 'successful sauce job'
-    driver = job.start name: name
+    driver = job.start name: name, sauce_opts: { public: 'share' }
     execute_simple_test driver
     report = job.finish passed: true
     report.data[:sauce_data][:name].should be == 'successful_sauce_job'
     report.data[:sauce_data][:passed].should be_true
-    report.data[:assets][:server_log].should be == 'server.log'
+    report.data[:sauce_data][:public].should eq 'share'
+    report.data[:assets][:server_log].should eq 'server.log'
     File.exist?(File.join(Dir.pwd, 'build', 'tmp', 'server.log')).should be_true
-    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'dom.html')).should be_true
+    File.exist?(File.join(ENV['BUILD_PATH'], 'tmp', 'dom_0.html')).should be_true
   end
 
   it 'should mark a sauce job as failed' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-connect
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -76,7 +76,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.8
-description: upgraded selenium version and improved chrome log storage
+description: Can now pass run time sauce options to a job and will capture all open
+  window doms
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -156,9 +157,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2907860851704269908
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25