selenium-connect 3.2.0 → 3.3.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+#3.3.0 (2013-07-24)
+updated configuration to support any sauce config and set default sauce selenium version
+
+- Bumped version to 3.3.0 to prepare for release.
+- updated the configuration object to support passing any arbitrary sauce configuration parameter while also supporting the original configurations for backwards compatibility, also setting a default selenium server version
+
 #3.2.0 (2013-07-15)
 added better error handling to the sauce api calls and improved naming convention for job assets
 

data/README.md

@@ -1,4 +1,4 @@
-#selenium-connect 3.2.0 (2013-07-15)
+#selenium-connect 3.3.0 (2013-07-24)
 
 [![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)
 
@@ -85,12 +85,19 @@ profile_path:
 profile_name:
 
 # Saucelabs
-os:
 sauce_username: 'test_user_name'
 sauce_api_key:
+api_timeout: #how many seconds we should try to get the assets (default 10)
+os:
 browser_version:
 description: #sauce job/test description
-api_timeout: #how many seconds we should try to get the assets (default 10)
+# set any sauce options below, they will override those above
+sauce_opts:
+    selenium_version: #default is 2.33.0
+    os:
+    browser_version:
+    job_name: #sauce job/test description
+
 ```
 
 You can pass parameters into the new config object like:

data/lib/selenium_connect/configuration.rb

@@ -1,6 +1,7 @@
 # Encoding: utf-8
 
 require 'yaml'
+require 'ostruct'
 
 # selenium connect
 class SeleniumConnect
@@ -12,20 +13,30 @@ class SeleniumConnect
                   :background, :log, :jar
 
     # Browsers
-    attr_accessor :browser, :browser_path,
-                  :profile_path, :profile_name
+    attr_accessor :browser_path, :profile_path, :profile_name
 
     # SauceLabs
-    attr_accessor :sauce_username, :sauce_api_key,
-                  :os, :browser_version, :description, :api_timeout
+    attr_accessor :sauce_username, :sauce_api_key, :api_timeout
+
+    attr_reader :sauce_opts, :browser, :description, :os, :browser_version
 
     def initialize(opts = {})
       @host     = 'localhost'
       @port     = 4444
       @browser  = 'firefox'
+      @sauce_opts = OpenStruct.new
+      @sauce_opts.selenium_version = '2.33.0'
       populate_with_hash opts unless opts.empty?
     end
 
+    # TODO eventually roll all sauce options under this node
+    # and deprecate setting them at the top level
+    def sauce_opts=(opts = {})
+      opts.each do |key, value|
+        @sauce_opts.send("#{key}=", value) unless value.nil?
+      end
+    end
+
     def populate_with_hash(hash)
       hash.each do |key, value|
         begin
@@ -40,6 +51,29 @@ class SeleniumConnect
         populate_with_hash YAML.load_file file
     end
 
+    # The below methods are setters for the explicitly defined sauce and browser
+    # options, the is support future refactoring to a strutted config
+    # but maintains compatability for now.
+    def os=(os)
+      @os = os
+      @sauce_opts.os = os
+    end
+
+    def browser_version=(browser_version)
+      @browser_version = browser_version
+      @sauce_opts.browser_version = browser_version if @sauce_opts.browser_version.nil?
+    end
+
+    def description=(description)
+      @description = description
+      @sauce_opts.job_name = description if @sauce_opts.job_name.nil?
+    end
+
+    def browser=(browser)
+      @browser = browser
+      @sauce_opts.browser = browser if @sauce_opts.browser.nil?
+    end
+
     alias_method :config_file=, :populate_with_yaml
 
   end # Configuration

data/lib/selenium_connect/runners/saucelabs.rb

@@ -27,11 +27,7 @@ class SeleniumConnect
 
       def init_browser
         get_credentials
-        Sauce::Selenium2.new({
-          os:                 config.os,
-          browser:            config.browser,
-          browser_version:    config.browser_version,
-          job_name:           config.description })
+        Sauce::Selenium2.new(config.sauce_opts.marshal_dump)
       end
 
     end # Saucelabs

data/selenium-connect.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name          = 'selenium-connect'
-  s.version       = '3.2.0'
+  s.version       = '3.3.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   = 'added better error handling to the sauce api calls and improved naming convention for job assets'
+  s.description   = 'updated configuration to support any sauce config and set default sauce selenium version'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)

data/spec/support/example.yaml

@@ -16,9 +16,13 @@ profile_name:
 
 
 # Saucelabs
-os:
 sauce_username: 'test_user_name'
 sauce_api_key:
+api_timeout: 10
+
+os:
 browser_version:
 description:
-api_timeout: 10
+
+sauce_opts:
+    selenium_version: '2.32.0'

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

@@ -45,4 +45,41 @@ describe SeleniumConnect::Configuration do
     @configuration.port.should eq     4444
     @configuration.browser.should eq  'firefox'
   end
+
+  it 'should allow for an arbitrary hash of sauce configuration' do
+    @configuration.populate_with_hash sauce_opts: { record_video: true, capture_html: true }
+    @configuration.sauce_opts.record_video.should be_true
+    @configuration.sauce_opts.capture_html.should be_true
+  end
+
+  it 'should use selenium version 2.33.0 version by default for sauce' do
+    @configuration.sauce_opts.selenium_version.should eq '2.33.0'
+  end
+
+  # the goal here is to allow internal refactoring to use the new configuration pattern
+  # to support deprecating the top level configs later
+  it 'should merge the explicitly configured sauce options into the strut' do
+    os = 'Linux'
+    browser_version = '10'
+    browser = 'chrome'
+    description = 'test'
+    @configuration.populate_with_hash os: os, browser_version: browser_version, browser: browser, description: description
+    @configuration.sauce_opts.os.should eq os
+    @configuration.sauce_opts.browser.should eq browser
+    @configuration.sauce_opts.browser_version.should eq browser_version
+    @configuration.sauce_opts.job_name.should eq description
+  end
+
+  it 'should take the sauce_opts as priority' do
+    @configuration.populate_with_hash sauce_opts: { browser: 'ie', job_name: 'cool' }, browser: 'chrome', description: 'other'
+    @configuration.sauce_opts.browser.should eq 'ie'
+    @configuration.description.should eq 'other'
+    @configuration.sauce_opts.job_name.should eq 'cool'
+  end
+
+  it 'should use the description as the job name if no job name is specified' do
+    @configuration.populate_with_hash description: 'other'
+    @configuration.description.should eq 'other'
+    @configuration.sauce_opts.job_name.should eq 'other'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-connect
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -140,8 +140,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.7
-description: added better error handling to the sauce api calls and improved naming
-  convention for job assets
+description: updated configuration to support any sauce config and set default sauce
+  selenium version
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3833046545710782296
+      hash: -3401162280561917445
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25