sauce_bindings 1.0.0.beta1

data/spec/session_spec.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'webmock/rspec'
+
+module SauceBindings
+  describe Session do
+    let(:valid_response) do
+      {status: 200,
+       body: {value: {sessionId: '0', capabilities: Selenium::WebDriver::Remote::Capabilities.chrome}}.to_json,
+       headers: {"content_type": 'application/json'}}
+    end
+    let(:default_capabilities) do
+      {browserName: 'chrome',
+       browserVersion: 'latest',
+       platformName: 'Windows 10',
+       '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'
+      stub_request(:post, endpoint).with(body: body).to_return(valid_response)
+    end
+
+    before do
+      ENV['BUILD_TAG'] = ''
+      ENV['BUILD_NAME'] = 'TEMP BUILD'
+      ENV['BUILD_NUMBER'] = '11'
+      ENV['SAUCE_USERNAME'] = 'foo'
+      ENV['SAUCE_ACCESS_KEY'] = '123'
+    end
+
+    after do
+      ENV.delete 'BUILD_TAG'
+      ENV.delete 'BUILD_NAME'
+      ENV.delete 'BUILD_NUMBER'
+      ENV.delete 'SAUCE_USERNAME'
+      ENV.delete 'SAUCE_ACCESS_KEY'
+    end
+
+    describe '#new' do
+      it 'creates default Options instance if none is provided' do
+        session = Session.new
+
+        expected_results = {url: 'https://foo:123@ondemand.us-west-1.saucelabs.com:443/wd/hub',
+                            desired_capabilities: {'browserName' => 'chrome',
+                                                   'browserVersion' => 'latest',
+                                                   'platformName' => 'Windows 10',
+                                                   'sauce:options' => {'build' => 'TEMP BUILD: 11'}}}
+        expect(session.to_selenium).to eq expected_results
+      end
+
+      it 'uses provided Options class' do
+        sauce_opts = Options.new(browser_version: '123',
+                                 platform_name: 'Mac',
+                                 idle_timeout: 4)
+        session = Session.new(sauce_opts)
+
+        expected_results = {url: 'https://foo:123@ondemand.us-west-1.saucelabs.com:443/wd/hub',
+                            desired_capabilities: {'browserName' => 'chrome',
+                                                   'browserVersion' => '123',
+                                                   'platformName' => 'Mac',
+                                                   'sauce:options' => {'idleTimeout' => 4,
+                                                                       'build' => 'TEMP BUILD: 11'}}}
+        expect(session.to_selenium).to eq expected_results
+      end
+
+      it 'defaults to US West data Center' do
+        session = Session.new
+        expect(session.data_center).to eq :US_WEST
+      end
+
+      it 'uses provided Data Center' do
+        session = Session.new(data_center: :EU_VDC)
+
+        expected_results = {url: 'https://foo:123@ondemand.eu-central-1.saucelabs.com:443/wd/hub',
+                            desired_capabilities: {'browserName' => 'chrome',
+                                                   'browserVersion' => 'latest',
+                                                   'platformName' => 'Windows 10',
+                                                   'sauce:options' => {'build' => 'TEMP BUILD: 11'}}}
+        expect(session.to_selenium).to eq expected_results
+      end
+
+      it 'uses provided Event Listener' do
+        listener = instance_double(Selenium::WebDriver::Support::AbstractEventListener)
+        session = Session.new(listener: listener)
+
+        expect(session.to_selenium[:listener]).to eq listener
+      end
+
+      it 'uses provided HTTP Client' do
+        http_client = instance_double(Selenium::WebDriver::Remote::Http::Default)
+        session = Session.new(http_client: http_client)
+
+        expect(session.to_selenium[:http_client]).to eq http_client
+      end
+
+      it 'raises exception if data center is invalid' do
+        expect { Session.new(data_center: :FOO) }.to raise_exception(ArgumentError)
+      end
+    end
+
+    describe '#start' do
+      it 'starts the session and returns Selenium Driver instance' do
+        expect_request
+
+        driver = Session.new.start
+        expect(driver).to be_a Selenium::WebDriver::Driver
+      end
+
+      it 'uses username and access key from ENV' do
+        session = Session.new
+
+        expect(session.url).to include('foo:123')
+      end
+
+      it 'raises exception if no username set' do
+        ENV.delete('SAUCE_USERNAME')
+
+        expect { Session.new.start }.to raise_exception(ArgumentError)
+      end
+
+      it 'raises exception if no access key set' do
+        ENV.delete('SAUCE_ACCESS_KEY')
+
+        expect { Session.new.start }.to raise_exception(ArgumentError)
+      end
+    end
+
+    describe '#stop' do
+      it 'quits the driver' do
+        driver = instance_double(Selenium::WebDriver::Remote::Driver, session_id: '1234')
+        allow(Selenium::WebDriver::Driver).to receive(:for).and_return(driver)
+        allow(driver).to receive :quit
+        allow(SauceWhisk::Jobs).to receive(:change_status).with('1234', true)
+
+        session = Session.new
+        session.start
+        session.stop(true)
+
+        expect(driver).to have_received(:quit)
+        expect(SauceWhisk::Jobs).to have_received(:change_status).with('1234', true)
+      end
+    end
+
+    describe '#data_center=' do
+      it 'overrides default value for data center' do
+        session = Session.new
+        session.data_center = :US_EAST
+
+        expect(session.url).to eq('https://foo:123@ondemand.us-east-1.saucelabs.com:443/wd/hub')
+      end
+
+      it 'raises exception if data center is invalid' do
+        session = Session.new
+
+        expect { session.data_center = :FOO }.to raise_exception(ArgumentError)
+      end
+    end
+
+    describe '#http_client=' do
+      it 'uses provided HTTP Client' do
+        http_client = instance_double(Selenium::WebDriver::Remote::Http::Default)
+        session = Session.new
+        session.http_client = http_client
+
+        expect(session.to_selenium[:http_client]).to eq http_client
+      end
+    end
+
+    describe '#listner=' do
+      it 'uses provided Event Listener' do
+        listener = instance_double(Selenium::WebDriver::Support::AbstractEventListener)
+        session = Session.new
+        session.listener = listener
+
+        expect(session.to_selenium[:listener]).to eq listener
+      end
+    end
+
+    describe '#url=' do
+      it 'allows user to override default URL' do
+        session = Session.new
+        session.url = 'https://bar:321@mycustomurl/foo/wd/hub:8080'
+
+        expected_results = {url: 'https://bar:321@mycustomurl/foo/wd/hub:8080',
+                            desired_capabilities: {'browserName' => 'chrome',
+                                                   'browserVersion' => 'latest',
+                                                   'platformName' => 'Windows 10',
+                                                   'sauce:options' => {'build' => 'TEMP BUILD: 11'}}}
+        expect(session.to_selenium).to eq expected_results
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'sauce_bindings'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: sauce_bindings
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+platform: ruby
+authors:
+- Titus Fortner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.66'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.66'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: sauce_whisk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.142.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.142.7
+description: Reduces complexity in user code for running Selenium tests on Sauce Labs
+email:
+- titusfortner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sauce_bindings.rb
+- lib/sauce_bindings/capybara_session.rb
+- lib/sauce_bindings/options.rb
+- lib/sauce_bindings/session.rb
+- lib/sauce_bindings/version.rb
+- sauce_bindings.gemspec
+- spec/capybara_session_spec.rb
+- spec/options.yml
+- spec/options_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/saucelabs/sauce_bindings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple interface for interacting with Sauce Labs.
+test_files:
+- spec/capybara_session_spec.rb
+- spec/options.yml
+- spec/options_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb