selenium-launcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47064747dcd76f242df501b3316329097660ae37
+  data.tar.gz: caae88fe2c13bceeceb425264ba2a127febd0e50
+SHA512:
+  metadata.gz: c54ce10a41be5679d2d6346a1f437ad91aa32ffa723391e94a7f0482fb83c850f5a9c8ec09e0a58af396d03c7abe6bb587cbdf5228a51c216f494b6d0f7ccb74
+  data.tar.gz: 493f73d610c50b8873b1da8cdf17e5fbd1f55a408553533479ce4142a5245c513fb317de2ec0deea1f727d53d28ece4824dc769a5d6add54417838eae7288396

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.DS_Store/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/*/.+_spec\.rb$})
+  watch(%r{^lib/selenium-connect/*/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+end

data/README.txt

@@ -0,0 +1,68 @@
+= selenium-launcher
+
+== DESCRIPTION:
+
+selenium-launcher provides a simple way to configure Selenium and launch a browser.
+
+Currently supported approachs include:
+1. Local browser execution with browser drivers (for easier test authoring)
+2. Remote execution (for a single node or a grid)
+
+== CONSIDERATIONS:
+
++ Will need to sort out the best way to handle browser driver downloads and configuration per OS. Will start by letting the user do the work and automate it later (in a separate gem).
++ Cloud execution will need to be added later, but that has additional considerations. So that will be deferred for now.
++ Mobile is also a consideration. Again, one to defer for now.
+
+== USAGE:
+
+=== Environment Variables
+
+Configuration occurs through a small set of environment variables:
+
+SL_HOST (e.g., 'grid', or nothing)
+SL_HOST_URL (e.g., URL to Standalone Remote or Grid instance)
+SL_BROWSER (e.g., 'chrome', 'firefox', 'internet-explorer', 'safari')
+
+If these values are not set properly, a RuntimeError will be returned along with a helpful message.
+
+
+selenium-launcher will return a Selenium WebDriver object.
+
+=== Local
+
+ENV['SL_BROWSER'] = 'firefox'
+driver = SeleniumLauncher.launch
+driver.quit
+
+=== Grid
+
+ENV['SL_BROWSER'] = 'firefox'
+ENV['SL_HOST'] = 'grid'
+ENV['SL_HOST_URL'] = 'http://localhost:4444/wd/hub'
+driver = SeleniumLauncher.launch
+driver.quit
+
+== LICENSE:
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Dave Haeffner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/selenium-launcher/browser.rb

@@ -0,0 +1,28 @@
+require_relative 'browsers/chrome'
+require_relative 'browsers/firefox'
+require_relative 'browsers/internet-explorer'
+require_relative 'browsers/safari'
+
+module SeleniumLauncher
+  class Browser
+
+    attr_reader :name
+
+    def match?
+      name == ENV['SL_BROWSER']
+    end
+
+    def capabilities
+      #::Selenium::WebDriver::Remote::Capabilities.send(name)
+      name.to_sym
+    end
+
+    def self.load
+      [ Chrome.new,
+        Firefox.new,
+        InternetExplorer.new,
+        Safari.new ].find { |browser| browser.match? }
+    end
+
+  end
+end

data/lib/selenium-launcher/browsers/chrome.rb

@@ -0,0 +1,11 @@
+module SeleniumLauncher
+  class Browser
+    class Chrome < Browser
+
+      def name
+        'chrome'
+      end
+
+    end
+  end
+end

data/lib/selenium-launcher/browsers/firefox.rb

@@ -0,0 +1,11 @@
+module SeleniumLauncher
+  class Browser
+    class Firefox < Browser
+
+      def name
+        'firefox'
+      end
+
+    end
+  end
+end

data/lib/selenium-launcher/browsers/internet-explorer.rb

@@ -0,0 +1,11 @@
+module SeleniumLauncher
+  class Browser
+    class InternetExplorer < Browser
+
+      def name
+        'internet-explorer'
+      end
+
+    end
+  end
+end

data/lib/selenium-launcher/browsers/safari.rb

@@ -0,0 +1,11 @@
+module SeleniumLauncher
+  class Browser
+    class Safari < Browser
+
+      def name
+        'safari'
+      end
+
+    end
+  end
+end

data/lib/selenium-launcher/launcher.rb

@@ -0,0 +1,33 @@
+require_relative 'browser'
+require 'selenium-webdriver'
+
+module SeleniumLauncher
+  class Launcher
+
+    attr_reader :browser, :driver
+
+    def initialize
+      @browser = SeleniumLauncher::Browser.load
+      @driver = launch
+    end
+
+    def quit
+      driver.quit
+    end
+
+    private
+
+      def launch
+        case ENV['SL_HOST']
+        when 'grid'
+          ::Selenium::WebDriver.for(
+            :remote,
+            url: ENV['SL_HOST_URL'],
+            desired_capabilities: browser.capabilities)
+        else
+          ::Selenium::WebDriver.for browser.name.to_sym
+        end
+      end
+
+  end
+end

data/lib/selenium-launcher/version.rb

@@ -0,0 +1,3 @@
+module SeleniumLauncher
+  VERSION = '0.1.0'
+end

data/lib/selenium-launcher.rb

@@ -0,0 +1,37 @@
+require_relative 'selenium-launcher/launcher'
+
+module SeleniumLauncher
+
+  def self.launch
+    ConfigChecker.new
+    SeleniumLauncher::Launcher.new.driver
+  end
+
+  class ConfigChecker
+
+    def initialize
+      browser_check
+      grid_check
+    end
+
+    private
+
+      ERRORS = { NoBrowserSpecified: 'You need to specify a browser (e.g., SL_BROWSER).',
+                 NoGridURLSpecified: 'You need to specify a URL when using a Grid (e.g., SL_HOST_URL).' }
+
+      def browser_check
+        if ENV['SL_BROWSER'].nil?
+          raise ERRORS[:NoBrowserSpecified]
+        end
+      end
+
+      def grid_check
+        if ENV['SL_HOST'] == 'grid'
+          if ENV['SL_HOST_URL'].nil?
+            raise ERRORS[:NoGridURLSpecified]
+          end
+        end
+      end
+
+  end
+end

data/selenium-launcher.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selenium-launcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "selenium-launcher"
+  spec.version       = SeleniumLauncher::VERSION
+  spec.authors       = ["Dave Haeffner"]
+  spec.email         = ["dhaeffner@gmail.com"]
+  spec.summary       = %q{A simple way to configure and launch a Selenium instance}
+  spec.description   = %q{See README.txt}
+  spec.homepage      = "https://github.com/tourdedave/selenium-launcher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "selenium-webdriver", "~> 2.43.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.3.1"
+end

data/spec/browser_spec.rb

@@ -0,0 +1,29 @@
+require_relative '../lib/selenium-launcher/browser'
+
+describe 'Browser returns', :unit do
+
+  it 'Chrome' do
+    ENV['SL_BROWSER'] = 'chrome'
+    browser = SeleniumLauncher::Browser.load
+    expect(browser.class).to eql SeleniumLauncher::Browser::Chrome
+  end
+
+  it 'Firefox' do
+    ENV['SL_BROWSER'] = 'firefox'
+    browser = SeleniumLauncher::Browser.load
+    expect(browser.class).to eql SeleniumLauncher::Browser::Firefox
+  end
+
+  it 'Internet Explorer' do
+    ENV['SL_BROWSER'] = 'internet-explorer'
+    browser = SeleniumLauncher::Browser.load
+    expect(browser.class).to eql SeleniumLauncher::Browser::InternetExplorer
+  end
+
+  it 'Safari' do
+    ENV['SL_BROWSER'] = 'safari'
+    browser = SeleniumLauncher::Browser.load
+    expect(browser.class).to eql SeleniumLauncher::Browser::Safari
+  end
+
+end

data/spec/launcher_spec.rb

@@ -0,0 +1,80 @@
+require_relative 'spec_helper'
+require_relative '../lib/selenium-launcher/launcher'
+
+describe 'Launcher', :integration do
+
+  after(:each) do
+    @launcher.quit
+  end
+
+  context '-> Localhost -> ' do
+
+    it 'Chrome' do
+      ENV['SL_BROWSER'] = 'chrome'
+      @launcher = SeleniumLauncher::Launcher.new
+      expect(@launcher.driver.class).to eql Selenium::WebDriver::Driver
+      expect(@launcher.driver.browser).to eql :chrome
+    end
+
+    it 'Firefox' do
+      ENV['SL_BROWSER'] = 'firefox'
+      @launcher = SeleniumLauncher::Launcher.new
+      expect(@launcher.driver.class).to eql Selenium::WebDriver::Driver
+      expect(@launcher.driver.browser).to eql :firefox
+    end
+
+    it 'Internet Explorer' do
+      pending 'Windows OS required' unless OS.windows?
+      ENV['SL_BROWSER'] = 'internet-explorer'
+      @launcher = SeleniumLauncher::Launcher.new
+      expect(@launcher.driver.class).to eql Selenium::WebDriver::Driver
+      expect(@launcher.driver.browser).to eql :"internet-explorer"
+    end
+
+    it 'Safari' do
+      ENV['SL_BROWSER'] = 'safari'
+      @launcher = SeleniumLauncher::Launcher.new
+      expect(@launcher.driver.class).to eql Selenium::WebDriver::Driver
+      expect(@launcher.driver.browser).to eql :safari
+    end
+
+  end
+
+  context '-> Grid -> ' do
+
+    before(:all) do
+      ENV['SL_HOST'] = 'grid'
+      ENV['SL_HOST_URL'] = 'http://localhost:4444/wd/hub'
+    end
+
+    it 'Chrome' do
+      ENV['SL_BROWSER'] = 'chrome'
+      @launcher = SeleniumLauncher::Launcher.new
+      expect(@launcher.driver.class).to eql Selenium::WebDriver::Driver
+      expect(@launcher.driver.browser).to eql :chrome
+    end
+
+    it 'Firefox' do
+      ENV['SL_BROWSER'] = 'firefox'
+      @launcher = SeleniumLauncher::Launcher.new
+      expect(@launcher.driver.class).to eql Selenium::WebDriver::Driver
+      expect(@launcher.driver.browser).to eql :firefox
+    end
+
+    it 'Internet Explorer' do
+      pending 'Windows OS required' unless OS.windows?
+      ENV['SL_BROWSER'] = 'internet-explorer'
+      @launcher = SeleniumLauncher::Launcher.new
+      expect(@launcher.driver.class).to eql Selenium::WebDriver::Driver
+      expect(@launcher.driver.browser).to eql :"internet-explorer"
+    end
+
+    it 'Safari' do
+      ENV['SL_BROWSER'] = 'safari'
+      @launcher = SeleniumLauncher::Launcher.new
+      expect(@launcher.driver.class).to eql Selenium::WebDriver::Driver
+      expect(@launcher.driver.browser).to eql :safari
+    end
+
+  end
+end

data/spec/selenium-connect_spec.rb

@@ -0,0 +1,37 @@
+require_relative '../lib/selenium-launcher'
+
+describe 'Selenium Launcher', :acceptance do
+
+  it 'runs' do
+    ENV['SL_BROWSER'] = 'firefox'
+    driver = SeleniumLauncher.launch
+    expect(driver.class).to eql Selenium::WebDriver::Driver
+    expect(driver.browser).to eql :firefox
+    driver.quit
+  end
+
+  context '-> Config Checker -> ' do
+
+    before(:each) do
+      ENV['SL_BROWSER'] = nil
+      ENV['SL_HOST'] = nil
+      ENV['SL_HOST_URL'] = nil
+    end
+
+    it 'no browser' do
+      expect { driver = SeleniumLauncher.launch }.to raise_error(
+        RuntimeError,
+        'You need to specify a browser (e.g., SL_BROWSER).')
+    end
+
+    it 'no Grid host URL' do
+      ENV['SL_BROWSER'] = 'firefox'
+      ENV['SL_HOST'] = 'grid'
+      expect { driver = SeleniumLauncher.launch }.to raise_error(
+        RuntimeError,
+        'You need to specify a URL when using a Grid (e.g., SL_HOST_URL).')
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+module OS
+  def OS.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.mac?
+   (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.unix?
+    !OS.windows?
+  end
+
+  def OS.linux?
+    OS.unix? and not OS.mac?
+  end
+end
+
+include OS

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: selenium-launcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Haeffner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.43.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.43.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+description: See README.txt
+email:
+- dhaeffner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- README.txt
+- Rakefile
+- lib/selenium-launcher.rb
+- lib/selenium-launcher/browser.rb
+- lib/selenium-launcher/browsers/chrome.rb
+- lib/selenium-launcher/browsers/firefox.rb
+- lib/selenium-launcher/browsers/internet-explorer.rb
+- lib/selenium-launcher/browsers/safari.rb
+- lib/selenium-launcher/launcher.rb
+- lib/selenium-launcher/version.rb
+- selenium-launcher.gemspec
+- spec/browser_spec.rb
+- spec/launcher_spec.rb
+- spec/selenium-connect_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tourdedave/selenium-launcher
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple way to configure and launch a Selenium instance
+test_files:
+- spec/browser_spec.rb
+- spec/launcher_spec.rb
+- spec/selenium-connect_spec.rb
+- spec/spec_helper.rb