sauce_bindings 1.1.0 → 1.1.1

data/spec/examples/basic_options_spec.rb

@@ -4,11 +4,9 @@ require 'sauce_bindings'
 require 'rspec'
 
 describe 'Basic Options' do
-  before { WebMock.allow_net_connect! }
-
   it 'creates session' do
     # 1. Create a SauceOptions instance with the 3 primary parameters
-    sauce_options = SauceBindings::Options.firefox(browser_version: '73.0',
+    sauce_options = SauceBindings::Options.firefox(browser_version: '88.0',
                                                    platform_name: 'Windows 8')
 
     # 2. Create Session object with SauceOptions object instance

data/spec/examples/browser_options_spec.rb

@@ -4,8 +4,6 @@ require 'sauce_bindings'
 require 'rspec'
 
 describe 'Browser Options' do
-  before { WebMock.allow_net_connect! }
-
   it 'creates session' do
     # 1. Create Selenium Browser Options instance
     browser_options = Selenium::WebDriver::Firefox::Options.new(args: ['--foo'])

data/spec/examples/create_session_spec.rb

@@ -4,8 +4,6 @@ require 'sauce_bindings'
 require 'rspec'
 
 describe 'Create Session' do
-  before { WebMock.allow_net_connect! }
-
   it 'starts session' do
     # 1. Create Session object with the defaults
     session = SauceBindings::Session.new

data/spec/examples/data_center_spec.rb

@@ -4,8 +4,6 @@ require 'sauce_bindings'
 require 'rspec'
 
 describe 'Create Session' do
-  before { WebMock.allow_net_connect! }
-
   it 'starts session' do
     # 1. Create Session object with the desired Data Center
     session = SauceBindings::Session.new(data_center: :EU_CENTRAL)

data/spec/examples/sauce_options_spec.rb

@@ -4,8 +4,6 @@ require 'sauce_bindings'
 require 'rspec'
 
 describe 'Sauce Options' do
-  before { WebMock.allow_net_connect! }
-
   it 'creates session' do
     # 1. Create a SauceOptions instance with Sauce Labs Specific Options
     sauce_options = SauceBindings::Options.firefox(extended_debugging: true,

data/spec/integration/desktop_spec.rb

@@ -8,33 +8,28 @@ module SauceBindings
       before { WebMock.allow_net_connect! }
 
       it 'defaults to US West' do
-        session = Session.new
-        driver = session.start
+        @session = Session.new
+        driver = @session.start
 
         expect(driver).not_to be_nil
-        expect(session.url).to include('us-west-1')
-        session.stop(true)
+        expect(@session.url).to include('us-west-1')
       end
 
       it 'executes on US East' do
-        options = Options.new(platform_name: 'Linux')
-        session = Session.new(options, data_center: :US_EAST)
-        driver = session.start
+        options = Options.chrome(platform_name: 'Linux')
+        @session = Session.new(options, data_center: :US_EAST)
+        driver = @session.start
 
         expect(driver).not_to be_nil
-        expect(session.url).to include('us-east-1')
-
-        session.stop(true)
+        expect(@session.url).to include('us-east-1')
       end
 
       it 'executes on EU Central' do
-        session = Session.new(data_center: :EU_CENTRAL)
-        driver = session.start
+        @session = Session.new(data_center: :EU_CENTRAL)
+        driver = @session.start
 
         expect(driver).not_to be_nil
-        expect(session.url).to include('eu-central-1')
-
-        session.stop(true)
+        expect(@session.url).to include('eu-central-1')
       end
     end
   end

data/spec/options.yml

@@ -7,21 +7,17 @@ example_values:
   set_window_rect: true
   unhandled_prompt_behavior: "accept"
   strict_file_interactability: true
-  timeouts:
-    implicit: 1
-    page_load: 59
-    script: 29
-  avoid_proxy: true
+  implicit_wait_timeout: 1
+  page_load_timeout: 59
+  script_timeout: 29
   build: 'Sample Build Name'
-  capture_performance: true
-  chromedriver_version: '71'
   command_timeout: 2
   custom_data:
     foo: 'foo'
     bar: 'bar'
   extended_debugging: true
+  geckodriver_version: '0.23'
   idle_timeout: 3
-  iedriver_version: '3.141.0'
   max_duration: 300
   name: 'Sample Test Name'
   parent_tunnel: 'Mommy'

data/spec/spec_helper.rb

@@ -8,4 +8,8 @@ RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
+
+  config.after do |example|
+    @session&.stop(!example.exception)
+  end
 end

data/spec/unit/capybara_session_spec.rb

@@ -17,10 +17,14 @@ module SauceBindings
        'sauce:options': {build: 'TEMP BUILD: 11'}}
     end
 
-    def expect_request(body: nil, endpoint: nil)
-      body = (body || {desiredCapabilities: default_capabilities,
-                       capabilities: {firstMatch: [default_capabilities]}}).to_json
-      endpoint ||= 'https://ondemand.us-west-1.saucelabs.com/wd/hub/session'
+    def expect_request
+      se3 = {desiredCapabilities: default_capabilities,
+             capabilities: {firstMatch: [default_capabilities]}}.to_json
+      se4 = {capabilities: {alwaysMatch: default_capabilities}}.to_json
+
+      body = Selenium::WebDriver::VERSION[0] == '3' ? se3 : se4
+
+      endpoint = 'https://ondemand.us-west-1.saucelabs.com/wd/hub/session'
       stub_request(:post, endpoint).with(body: body).to_return(valid_response)
     end
 

data/spec/unit/deprecated_options_spec.rb

@@ -0,0 +1,472 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module SauceBindings
+  describe Options do
+    before do
+      allow(ENV).to receive(:[]).with('BUILD_TAG').and_return('')
+      allow(ENV).to receive(:[]).with('BUILD_NAME').and_return('TEMP BUILD')
+      allow(ENV).to receive(:[]).with('BUILD_NUMBER').and_return('11')
+    end
+
+    describe '#new' do
+      let(:default_options) do
+        {'browserName' => 'chrome',
+         'browserVersion' => 'latest',
+         'platformName' => 'Windows 10',
+         'sauce:options' => {'build' => 'TEMP BUILD: 11'}}
+      end
+
+      it 'uses latest Chrome version on Windows 10 by default' do
+        options = Options.new
+
+        expect(options.browser_name).to eq 'chrome'
+        expect(options.browser_version).to eq 'latest'
+        expect(options.platform_name).to eq 'Windows 10'
+      end
+
+      it 'accepts provided values for browser, browser version and platform name' do
+        options = Options.new(browser_name: 'firefox',
+                              browser_version: '123',
+                              platform_name: 'Mac')
+
+        expect(options.browser_name).to eq 'firefox'
+        expect(options.browser_version).to eq '123'
+        expect(options.platform_name).to eq 'Mac'
+      end
+
+      it 'accepts other w3c values' do
+        proxy = Selenium::WebDriver::Proxy.new(ssl: 'foo')
+        timeouts = {implicit: 1,
+                    page_load: 59,
+                    script: 29}
+        options = Options.new(accept_insecure_certs: true,
+                              page_load_strategy: 'eager',
+                              proxy: proxy,
+                              set_window_rect: true,
+                              unhandled_prompt_behavior: 'accept',
+                              strict_file_interactability: true,
+                              timeouts: timeouts)
+
+        expect(options.accept_insecure_certs).to eq true
+        expect(options.page_load_strategy).to eq 'eager'
+        expect(options.proxy).to eq proxy
+        expect(options.set_window_rect).to eq true
+        expect(options.unhandled_prompt_behavior).to eq 'accept'
+        expect(options.strict_file_interactability).to eq true
+        expect(options.timeouts).to eq timeouts
+      end
+
+      it 'accepts Sauce Labs specific settings' do
+        custom_data = {foo: 'foo',
+                       bar: 'bar'}
+        prerun = {executable: 'http://url.to/your/executable.exe',
+                  args: ['--silent', '-a', '-q'],
+                  background: false,
+                  timeout: 120}
+        tags = %w[foo bar foobar]
+        sauce_options = {
+          avoid_proxy: true,
+          build: 'Sample Build Name',
+          capture_performance: true,
+          chromedriver_version: '71',
+          command_timeout: 2,
+          custom_data: custom_data,
+          extended_debugging: true,
+          idle_timeout: 3,
+          iedriver_version: '3.141.0',
+          max_duration: 300,
+          name: 'Sample Test Name',
+          parent_tunnel: 'Mommy',
+          prerun: prerun,
+          priority: 0,
+          public: 'team',
+          record_logs: false,
+          record_screenshots: false,
+          record_video: false,
+          screen_resolution: '10x10',
+          selenium_version: '3.141.59',
+          tags: tags,
+          time_zone: 'San Francisco',
+          tunnel_identifier: 'tunnelname',
+          video_upload_on_pass: false
+        }
+
+        options = Options.new(**sauce_options)
+
+        expect(options.avoid_proxy).to eq true
+        expect(options.build).to eq 'Sample Build Name'
+        expect(options.capture_performance).to eq true
+        expect(options.chromedriver_version).to eq '71'
+        expect(options.command_timeout).to eq 2
+        expect(options.custom_data).to eq custom_data
+        expect(options.extended_debugging).to eq true
+        expect(options.idle_timeout).to eq 3
+        expect(options.iedriver_version).to eq '3.141.0'
+        expect(options.max_duration).to eq 300
+        expect(options.name).to eq 'Sample Test Name'
+        expect(options.parent_tunnel).to eq 'Mommy'
+        expect(options.prerun).to eq prerun
+        expect(options.priority).to eq 0
+        expect(options.public).to eq 'team'
+        expect(options.record_logs).to eq false
+        expect(options.record_screenshots).to eq false
+        expect(options.record_video).to eq false
+        expect(options.screen_resolution).to eq '10x10'
+        expect(options.selenium_version).to eq '3.141.59'
+        expect(options.tags).to eq tags
+        expect(options.time_zone).to eq 'San Francisco'
+        expect(options.tunnel_identifier).to eq 'tunnelname'
+        expect(options.video_upload_on_pass).to eq false
+      end
+
+      it 'accepts Selenium Capabilities and overrides default browser' do
+        caps = Selenium::WebDriver::Remote::Capabilities.firefox(accept_insecure_certs: true,
+                                                                 page_load_strategy: 'eager')
+        options = Options.new(selenium_options: caps)
+
+        expect(options.browser_name).to eq 'firefox'
+        expect(options.accept_insecure_certs).to eq true
+        expect(options.page_load_strategy).to eq 'eager'
+      end
+
+      it 'accepts Selenium Options and overrides default browser' do
+        browser_opts = Selenium::WebDriver::Firefox::Options.new(args: ['--foo'])
+        options = Options.new(selenium_options: browser_opts)
+
+        expect(options.browser_name).to eq 'firefox'
+        expect(options.selenium_options['moz:firefoxOptions']).to eq('args' => ['--foo'])
+      end
+
+      it 'accepts Selenium Capabilities and Options class instances' do
+        caps = Selenium::WebDriver::Remote::Capabilities.chrome(accept_insecure_certs: true,
+                                                                page_load_strategy: 'eager')
+        browser_opts = Selenium::WebDriver::Chrome::Options.new(args: ['--foo'])
+        options = Options.new(selenium_options: [caps, browser_opts])
+
+        expect(options.page_load_strategy).to eq 'eager'
+        expect(options.accept_insecure_certs).to eq true
+        expect(options.selenium_options['goog:chromeOptions']).to eq('args' => ['--foo'])
+      end
+
+      it 'accepts W3C, Sauce, Browser Options and Capabilities at the same time' do
+        caps = Selenium::WebDriver::Remote::Capabilities.chrome(page_load_strategy: 'eager')
+        browser_opts = Selenium::WebDriver::Firefox::Options.new(args: ['--foo'])
+
+        options = Options.new(browser_version: '77',
+                              accept_insecure_certs: true,
+                              command_timeout: 2,
+                              time_zone: 'Alaska',
+                              selenium_options: [caps, browser_opts])
+
+        expect(options.browser_name).to eq 'firefox'
+        expect(options.browser_version).to eq '77'
+        expect(options.platform_name).to eq 'Windows 10'
+        expect(options.accept_insecure_certs).to eq true
+        expect(options.command_timeout).to eq 2
+        expect(options.time_zone).to eq 'Alaska'
+        expect(options.page_load_strategy).to eq 'eager'
+
+        expect(options.selenium_options['moz:firefoxOptions']).to eq('args' => ['--foo'])
+      end
+
+      it 'creates a default build value' do
+        options = Options.new
+        expect(options.build).to eq 'TEMP BUILD: 11'
+      end
+
+      it 'raises ArgumentError if parameter is not recognized as valid' do
+        expect { Options.new(foo: 'bar') }.to raise_exception(ArgumentError)
+      end
+    end
+
+    describe '#accessors' do
+      it 'parses w3c values' do
+        proxy = Selenium::WebDriver::Proxy.new(ssl: 'foo')
+        timeouts = {implicit: 1,
+                    page_load: 59,
+                    script: 29}
+
+        options = Options.new
+
+        options.browser_name = 'firefox'
+        options.browser_version = '7'
+        options.platform_name = 'macOS 10.14'
+        options.accept_insecure_certs = true
+        options.page_load_strategy = 'eager'
+        options.proxy = proxy
+        options.set_window_rect = true
+        options.unhandled_prompt_behavior = 'accept'
+        options.strict_file_interactability = true
+        options.timeouts = timeouts
+
+        expect(options.browser_name).to eq 'firefox'
+        expect(options.browser_version).to eq '7'
+        expect(options.platform_name).to eq 'macOS 10.14'
+        expect(options.accept_insecure_certs).to eq true
+        expect(options.page_load_strategy).to eq 'eager'
+        expect(options.proxy).to eq proxy
+        expect(options.set_window_rect).to eq true
+        expect(options.unhandled_prompt_behavior).to eq 'accept'
+        expect(options.strict_file_interactability).to eq true
+        expect(options.timeouts).to eq timeouts
+      end
+
+      it 'parses Sauce values' do
+        custom_data = {foo: 'foo',
+                       bar: 'bar'}
+        prerun = {executable: 'http://url.to/your/executable.exe',
+                  args: ['--silent', '-a', '-q'],
+                  background: false,
+                  timeout: 120}
+        tags = %w[foo bar foobar]
+
+        options = Options.new
+
+        options.avoid_proxy = true
+        options.build = 'Sample Build Name'
+        options.capture_performance = true
+        options.chromedriver_version = '71'
+        options.command_timeout = 2
+        options.custom_data = custom_data
+        options.extended_debugging = true
+        options.idle_timeout = 3
+        options.iedriver_version = '3.141.0'
+        options.max_duration = 300
+        options.name = 'Sample Test Name'
+        options.parent_tunnel = 'Mommy'
+        options.prerun = prerun
+        options.priority = 0
+        options.public = 'team'
+        options.record_logs = false
+        options.record_screenshots = false
+        options.record_video = false
+        options.screen_resolution = '10x10'
+        options.selenium_version = '3.141.59'
+        options.tags = tags
+        options.time_zone = 'San Francisco'
+        options.tunnel_identifier = 'tunnelname'
+        options.video_upload_on_pass = false
+
+        expect(options.avoid_proxy).to eq true
+        expect(options.build).to eq 'Sample Build Name'
+        expect(options.capture_performance).to eq true
+        expect(options.chromedriver_version).to eq '71'
+        expect(options.command_timeout).to eq 2
+        expect(options.custom_data).to eq custom_data
+        expect(options.extended_debugging).to eq true
+        expect(options.idle_timeout).to eq 3
+        expect(options.iedriver_version).to eq '3.141.0'
+        expect(options.max_duration).to eq 300
+        expect(options.name).to eq 'Sample Test Name'
+        expect(options.parent_tunnel).to eq 'Mommy'
+        expect(options.prerun).to eq prerun
+        expect(options.priority).to eq 0
+        expect(options.public).to eq 'team'
+        expect(options.record_logs).to eq false
+        expect(options.record_screenshots).to eq false
+        expect(options.record_video).to eq false
+        expect(options.screen_resolution).to eq '10x10'
+        expect(options.selenium_version).to eq '3.141.59'
+        expect(options.tags).to eq tags
+        expect(options.time_zone).to eq 'San Francisco'
+        expect(options.tunnel_identifier).to eq 'tunnelname'
+        expect(options.video_upload_on_pass).to eq false
+      end
+    end
+
+    describe '#merge_capabilities' do
+      it 'loads options from configuration' do
+        timeouts = {implicit: 1,
+                    page_load: 59,
+                    script: 29}
+        custom_data = {foo: 'foo',
+                       bar: 'bar'}
+        prerun = {executable: 'http://url.to/your/executable.exe',
+                  args: ['--silent', '-a', '-q'],
+                  background: false,
+                  timeout: 120}
+        tags = %w[foo bar foobar]
+
+        options = Options.new
+        yaml = YAML.load_file('spec/deprecated_options.yml')
+        options.merge_capabilities(yaml['example_values'])
+
+        expect(options.browser_name).to eq 'firefox'
+        expect(options.browser_version).to eq '123'
+        expect(options.platform_name).to eq 'Mac'
+        expect(options.accept_insecure_certs).to eq true
+        expect(options.page_load_strategy).to eq 'eager'
+        expect(options.set_window_rect).to eq true
+        expect(options.unhandled_prompt_behavior).to eq 'accept'
+        expect(options.strict_file_interactability).to eq true
+        expect(options.timeouts).to eq timeouts
+        expect(options.avoid_proxy).to eq true
+        expect(options.build).to eq 'Sample Build Name'
+        expect(options.capture_performance).to eq true
+        expect(options.chromedriver_version).to eq '71'
+        expect(options.command_timeout).to eq 2
+        expect(options.custom_data).to eq custom_data
+        expect(options.extended_debugging).to eq true
+        expect(options.idle_timeout).to eq 3
+        expect(options.iedriver_version).to eq '3.141.0'
+        expect(options.max_duration).to eq 300
+        expect(options.name).to eq 'Sample Test Name'
+        expect(options.parent_tunnel).to eq 'Mommy'
+        expect(options.prerun).to eq prerun
+        expect(options.priority).to eq 0
+        expect(options.public).to eq 'team'
+        expect(options.record_logs).to eq false
+        expect(options.record_screenshots).to eq false
+        expect(options.record_video).to eq false
+        expect(options.screen_resolution).to eq '10x10'
+        expect(options.selenium_version).to eq '3.141.59'
+        expect(options.tags).to eq tags
+        expect(options.time_zone).to eq 'San Francisco'
+        expect(options.tunnel_identifier).to eq 'tunnelname'
+        expect(options.video_upload_on_pass).to eq false
+      end
+
+      it 'raises exception if value not recognized' do
+        options = Options.new
+        yaml = YAML.load_file('spec/deprecated_options.yml')
+
+        msg = 'foo is not a valid parameter for Options class'
+        expect { options.merge_capabilities(yaml['invalid_option']) }.to raise_exception(ArgumentError, msg)
+      end
+    end
+
+    describe '#capabilities' do
+      it 'correctly generates capabilities for w3c values' do
+        proxy = Selenium::WebDriver::Proxy.new(ssl: 'foo')
+        timeouts = {implicit: 1,
+                    page_load: 59,
+                    script: 29}
+
+        options = Options.new(browser_name: 'firefox',
+                              platform_name: 'Mac',
+                              accept_insecure_certs: true,
+                              page_load_strategy: 'eager',
+                              proxy: proxy,
+                              set_window_rect: true,
+                              unhandled_prompt_behavior: 'accept',
+                              strict_file_interactability: true,
+                              timeouts: timeouts)
+
+        proxy_type = Selenium::WebDriver::VERSION[0] == '3' ? 'MANUAL' : 'manual'
+
+        expect(options.capabilities).to eq('browserName' => 'firefox',
+                                           'browserVersion' => 'latest',
+                                           'platformName' => 'Mac',
+                                           'acceptInsecureCerts' => true,
+                                           'pageLoadStrategy' => 'eager',
+                                           'proxy' => {'proxyType' => proxy_type, 'sslProxy' => 'foo'},
+                                           'setWindowRect' => true,
+                                           'unhandledPromptBehavior' => 'accept',
+                                           'strictFileInteractability' => true,
+                                           'timeouts' => {'implicit' => 1,
+                                                          'pageLoad' => 59,
+                                                          'script' => 29},
+                                           'sauce:options' => {'build' => 'TEMP BUILD: 11'})
+      end
+
+      it 'correctly generates capabilities for sauce values' do
+        custom_data = {foo: 'foo',
+                       bar: 'bar'}
+        prerun = {executable: 'http://url.to/your/executable.exe',
+                  args: ['--silent', '-a', '-q'],
+                  background: false,
+                  timeout: 120}
+        tags = %w[foo bar foobar]
+        sauce_options = {avoid_proxy: true,
+                         build: 'Sample Build Name',
+                         capture_performance: true,
+                         chromedriver_version: '71',
+                         command_timeout: 2,
+                         custom_data: custom_data,
+                         extended_debugging: true,
+                         idle_timeout: 3,
+                         iedriver_version: '3.141.0',
+                         max_duration: 300,
+                         name: 'Sample Test Name',
+                         parent_tunnel: 'Mommy',
+                         prerun: prerun,
+                         priority: 0,
+                         public: 'team',
+                         record_logs: false,
+                         record_screenshots: false,
+                         record_video: false,
+                         screen_resolution: '10x10',
+                         selenium_version: '3.141.59',
+                         tags: tags,
+                         time_zone: 'San Francisco',
+                         tunnel_identifier: 'tunnelname',
+                         video_upload_on_pass: false}
+
+        options = Options.new(**sauce_options)
+
+        prerun_caps = {'executable' => 'http://url.to/your/executable.exe',
+                       'args' => ['--silent', '-a', '-q'],
+                       'background' => false,
+                       'timeout' => 120}
+
+        expect(options.capabilities).to eq('browserName' => 'chrome',
+                                           'browserVersion' => 'latest',
+                                           'platformName' => 'Windows 10',
+                                           'sauce:options' => {'build' => 'Sample Build Name',
+                                                               'avoidProxy' => true,
+                                                               'capturePerformance' => true,
+                                                               'chromedriverVersion' => '71',
+                                                               'commandTimeout' => 2,
+                                                               'customData' => {'foo' => 'foo',
+                                                                                'bar' => 'bar'},
+                                                               'extendedDebugging' => true,
+                                                               'idleTimeout' => 3,
+                                                               'iedriverVersion' => '3.141.0',
+                                                               'maxDuration' => 300,
+                                                               'name' => 'Sample Test Name',
+                                                               'parentTunnel' => 'Mommy',
+                                                               'prerun' => prerun_caps,
+                                                               'priority' => 0,
+                                                               'public' => 'team',
+                                                               'recordLogs' => false,
+                                                               'recordScreenshots' => false,
+                                                               'recordVideo' => false,
+                                                               'screenResolution' => '10x10',
+                                                               'seleniumVersion' => '3.141.59',
+                                                               'tags' => %w[foo bar foobar],
+                                                               'timeZone' => 'San Francisco',
+                                                               'tunnelIdentifier' => 'tunnelname',
+                                                               'videoUploadOnPass' => false})
+      end
+
+      it 'correctly generates capabilities for selenium object values' do
+        caps = Selenium::WebDriver::Remote::Capabilities.chrome(accept_insecure_certs: true,
+                                                                page_load_strategy: 'eager')
+        browser_opts = Selenium::WebDriver::Chrome::Options.new(args: ['--foo'])
+        options = Options.new(selenium_options: [caps, browser_opts])
+
+        jwp_defaults = {'cssSelectorsEnabled' => true,
+                        'javascriptEnabled' => true,
+                        'nativeEvents' => false,
+                        'platform' => 'ANY',
+                        'rotatable' => false,
+                        'takesScreenshot' => false,
+                        'version' => ''}
+
+        expected_caps = {'browserName' => 'chrome',
+                         'browserVersion' => 'latest',
+                         'platformName' => 'Windows 10',
+                         'acceptInsecureCerts' => true,
+                         'pageLoadStrategy' => 'eager',
+                         'sauce:options' => {'build' => 'TEMP BUILD: 11'},
+                         'goog:chromeOptions' => {'args' => ['--foo']}}
+
+        expected = Selenium::WebDriver::VERSION[0] == '3' ? jwp_defaults.merge(expected_caps) : expected_caps
+
+        expect(options.capabilities).to eq expected
+      end
+    end
+  end
+end