frameworks-capybara 2.2.0 → 2.3.0

data/CHANGES

@@ -1,3 +1,6 @@
+2.3.0
+Improved support for specifying browser configurations with BrowserStack.
+
 2.2.0
 Added Capybara cookie-handling extensions.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    frameworks-capybara (2.2.0)
+    frameworks-capybara (2.3.0)
       capybara
       capybara-mechanize
       cucumber

data/README.rdoc

@@ -29,8 +29,8 @@ The following environment variables can be set to configure your tests:
   BROWSER - this must be one of either 'ie', 'firefox', 'chrome', 'headless', 'remote'
   HTTP_PROXY - url of proxy if required e.g. 'http://proxyhost:80', when running a headless browser this sets the proxy for the browser itself, when running a remote browser this sets the proxy for the client which will connect to the remote selenium server
   PLATFORM - used when specifying remote test on a grid that provides a choice of platforms, this must be one of either 'WINDOWS' or 'LINUX'
+  PLATFORM_VERSION - used to specify the OS version of the specified platform e.g. '7', '8.1'
   REMOTE_BROWSER - used when specifying remote test, must be one of either 'ie', 'firefox', 'chrome', 'headless', 'remote':w
-  
   REMOTE_BROWSER_VERSION - used when specifying remote test on a grid the provides a choice of browser versions for a given browser
   REMOTE_URL - URL of remote Selenium-Webdriver server e.g. http://yourremotehost:4444/wd/hub
   FIREFOX_PROFILE - specify a firefox profile to use when running in-browser tests (local or remote)
@@ -45,6 +45,15 @@ The following environment variables can be set to configure your tests:
   TEAM_NAME - optional team name description which gets displayed in Cucumber html reports 
   BROWSER_CLI_ARGS - optional additional arguments to pass to local browser processes
 
+The following environment variables are specific to running tests against a BrowserStack remote grid:
+
+  BS_BUILD - allows the user to specify a name for a logical group of tests e.g. 'Component A Tests'
+  BS_DEBUG - set to 'false' to disable screenshot generation ('true' by default)
+  BS_DEVICE - specify a mobile/tablet device e.g. 'iPhone 5C'
+  BS_DEVICE_ORIENTATION - specify to force the device orientation ('portrait' or 'landscape')
+  BS_PROJECT - allows the user to specify a name for a logical group of builds e.g. 'Project X'
+  BS_RESOLUTION - set the browser resolution e.g. '1024x768'
+
 Here is a sample cucumber.yml:
 
   <%intenv='ENVIRONMENT=int'%>

data/lib/frameworks/capybara.rb

@@ -24,16 +24,23 @@ class CapybaraSetup
       :args => ENV['BROWSER_CLI_ARGS']
     }
 
-    selenium_remote_opts = {:platform => ENV['PLATFORM'],
+    selenium_remote_opts = {:os => ENV['PLATFORM'],
+      :os_version => ENV['PLATFORM_VERSION'],
       :browser_name => ENV['REMOTE_BROWSER'],
-      :version => ENV['REMOTE_BROWSER_VERSION'],
+      :browser_version => ENV['REMOTE_BROWSER_VERSION'],
       :url => ENV['REMOTE_URL']
     }
 
     custom_opts = {:job_name => ENV['SAUCE_JOB_NAME'],
       :max_duration => ENV['SAUCE_MAX_DURATION'],
       :firefox_cert_path => ENV['FIREFOX_CERT_PATH'],
-      :firefox_cert_prefix => ENV['FIREFOX_CERT_PREFIX']
+      :firefox_cert_prefix => ENV['FIREFOX_CERT_PREFIX'],
+      :browserstack_build => ENV['BS_BUILD'],
+      :browserstack_debug => ENV['BS_DEBUG'] || 'true', # BrowserStack debug mode on by default
+      :browserstack_device => ENV['BS_DEVICE'],
+      :browserstack_device_orientation => ENV['BS_DEVICE_ORIENTATION'],
+      :browserstack_project => ENV['BS_PROJECT'],
+      :browserstack_resolution => ENV['BS_RESOLUTION']
     }
 
     validate_env_vars(capybara_opts.merge(selenium_remote_opts)) #validate environment variables set using cucumber.yml or passed via command line
@@ -129,6 +136,8 @@ class CapybaraSetup
 
         add_custom_caps(caps, custom_opts) if remote_opts[:url].include? 'saucelabs' #set sauce specific parameters - will this scupper other on sauce remote jobs? 
 
+        add_browserstack_caps(caps, custom_opts) if remote_opts[:url].include? 'browserstack' #set browserstack specific parameters
+
         opts[:desired_capabilities] = caps
         opts[:http_client] = client
       end
@@ -145,6 +154,15 @@ class CapybaraSetup
     #caps.custom_capabilities({:'job-name' => (custom_opts[:job_name] or 'frameworks-unamed-job'), :'max-duration' => ((sauce_time_limit if sauce_time_limit != 0) or 1800)}) 
   end
 
+  def add_browserstack_caps(caps, custom_opts)
+    caps[:'build'] = custom_opts[:browserstack_build] if custom_opts[:browserstack_build]
+    caps[:'browserstack.debug'] = custom_opts[:browserstack_debug] if custom_opts[:browserstack_debug]
+    caps[:'device'] = custom_opts[:browserstack_device] if custom_opts[:browserstack_device]
+    caps[:'deviceOrientation'] = custom_opts[:browserstack_device_orientation] if custom_opts[:browserstack_device_orientation]
+    caps[:'project'] = custom_opts[:browserstack_project] if custom_opts[:browserstack_project]
+    caps[:'resolution'] = custom_opts[:browserstack_resolution] if custom_opts[:browserstack_resolution]
+  end
+
   def set_client_proxy(opts)
     Selenium::WebDriver::Proxy.new(:http => opts[:http_proxy]) if opts[:http_proxy] && opts[:webdriver_proxy_on] != 'false' #set proxy on client connection if required, note you may use ENV['HTTP_PROXY'] for setting in browser (ff profile) but not for client conection, hence allow for PROXY_ON=false
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module FrameworksCapybara
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/spec/frameworks_capybara_spec.rb

@@ -250,8 +250,8 @@ describe CapybaraSetup do
           #Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@custom_capabilities)[:'job-name'].should == 'frameworks-unamed-job' 
           #Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@custom_capabilities)[:'max-duration'].should == 1800 
           Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:browser_name].should == :firefox
-          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:version].should == '4' 
-          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:platform].should == 'windows'
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:browser_version].should == '4'
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:os].should == 'windows'
           Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].should be_a_kind_of Selenium::WebDriver::Firefox::Profile
           Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].instance_variable_get(:@model).should include 'default'
         end
@@ -367,7 +367,63 @@ describe CapybaraSetup do
         it_behaves_like "Selenium Driver Options Array"
       end
 
+      context "with Remote Selenium driver and most minimal Capabilites for BrowserStack" do
+        before do
+          ENV['BROWSER'] = 'remote'
+          ENV['REMOTE_BROWSER'] = 'ie'
+          ENV['REMOTE_URL'] = 'http://hub.browserstack.com'
+        end
+
+        it "should be initialized correctly" do
+          Capybara.delete_session
+          CapybaraSetup.new.driver.should == :selenium
+          Capybara.current_session.driver.should be_a_kind_of Capybara::Selenium::Driver
+          Capybara.current_session.driver.options[:browser].should == :remote
+          Capybara.current_session.driver.options[:url].should == ENV['REMOTE_URL']
+          Capybara.current_session.driver.options[:desired_capabilities].should be_a_kind_of Selenium::WebDriver::Remote::Capabilities
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:'browserstack.debug'].should == 'true'
+        end
+        it_behaves_like "Selenium Driver Options Array"
+      end
 
+      context "with Remote Selenium driver and specified Custom Capabilites for BrowserStack" do
+        before do
+          ENV['BROWSER'] = 'remote'
+          ENV['BS_BUILD'] = 'browserstack build 1'
+          ENV['BS_DEBUG'] = 'false'
+          ENV['BS_DEVICE'] = 'iPhone 5C'
+          ENV['BS_DEVICE_ORIENTATION'] = 'landscape'
+          ENV['BS_PROJECT'] = 'Test BrowserStack Project'
+          ENV['BS_RESOLUTION'] = '1024x768'
+          ENV['PLATFORM'] = 'MAC'
+          ENV['PLATFORM_VERSION'] = '7'
+          ENV['REMOTE_BROWSER'] = 'iPhone'
+          ENV['REMOTE_BROWSER_VERSION'] = '7.1.2'
+          ENV['REMOTE_URL'] = 'http://hub.browserstack.com'
+        end
+
+        it "should be initialized correctly" do
+          Capybara.delete_session
+          CapybaraSetup.new.driver.should == :selenium
+          Capybara.current_session.driver.should be_a_kind_of Capybara::Selenium::Driver
+          Capybara.current_session.driver.options[:browser].should == :remote
+          Capybara.current_session.driver.options[:url].should == ENV['REMOTE_URL']
+          Capybara.current_session.driver.options[:http_client].should be_a_kind_of Selenium::WebDriver::Remote::Http::Default
+          Capybara.current_session.driver.options[:http_client].instance_variable_get(:@proxy).should == nil
+          Capybara.current_session.driver.options[:desired_capabilities].should be_a_kind_of Selenium::WebDriver::Remote::Capabilities
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:build].should == ENV['BS_BUILD']
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:'browserstack.debug'].should == ENV['BS_DEBUG']
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:device].should == ENV['BS_DEVICE']
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:deviceOrientation].should == ENV['BS_DEVICE_ORIENTATION']
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:project].should == ENV['BS_PROJECT']
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:resolution].should == ENV['BS_RESOLUTION']
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:os].should == ENV['PLATFORM']
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:os_version].should == ENV['PLATFORM_VERSION']
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:browser_name].should == :iPhone
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:browser_version].should == ENV['REMOTE_BROWSER_VERSION']
+        end
+        it_behaves_like "Selenium Driver Options Array"
+      end
     end
 
     describe "should allow Mechanize driver to be created" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frameworks-capybara
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2014-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -203,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1659617196001302746
+      hash: 4601413897972678254
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1659617196001302746
+      hash: 4601413897972678254
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2