selenium-connect 1.5.1 → 1.6.0

data/README.md

@@ -1,30 +1,23 @@
 #selenium-connect [![Code Climate](https://codeclimate.com/github/arrgyle/selenium-connect.png)](https://codeclimate.com/github/arrgyle/selenium-connect)
 
-This library aims to make configuring and running your Selenium tests against a Selenium Server simple for both local and remote execution.
+A stupid simple way to run your Selenium tests on your computer, against a Selenium Grid, or in the cloud (e.g. SauceLabs).  
 
 ## Getting Started
 ```ruby
 require 'selenium-connect'
 
 SeleniumConnect.configure do |c|
-  c.host         = "localhost"
-  c.port         = "4444"
+  c.host         = "localhost" #or "grid_ip_address" or "saucelabs"
   c.browser      = "firefox"
-  c.profile_path = "#{Dir.pwd}/profiles/your_custom_firefox_profile" # or c.profile_name = "profile"
 end
 
 @driver = SeleniumConnect.start
-
 @driver.get "http://www.google.com"
-
 SeleniumConnect.finish
 ```  
 
 ## Helpful bits
 
-### Selenium Actions  
-This library uses the Selenium WebDriver Remote Bridge actions. You can find them [here](http://www.ruby-doc.org/gems/docs/b/bbc-selenium-webdriver-1.17.0/Selenium/WebDriver/Remote/Bridge.html).  
-
 ### Start  
 If host is set to "localhost", it will download the latest selenium-standalone-server.jar (unless it already has) and run it. Or, you can specify your own jar (if you have one you prefer to use). If no additional parameters are set, it will be exected in the background, with logging disabled. This functionality is driven using the [Selenium Rake Server Task](http://selenium.googlecode.com/svn/trunk/docs/api/rb/Selenium/Rake/ServerTask.html). 
 
@@ -32,7 +25,10 @@ If host is set to "localhost", it will download the latest selenium-standalone-s
 Issues a quit command to the driver (and stops the local server if your host is set to "localhost").  
 
 ### Support  
-Currently, Firefox solo & with a pre-fab custom profile is all that is supported. More coming soon!  
+- Firefox (standard, profile by path, profile by name, browser binary)
+- Internet Explorer
+- Chrome
+- SauceLabs
 
 ### Versioning  
-This project loosely follows [Semantic Versioning](http://semver.org/).
+This project follows [Semantic Versioning](http://semver.org/).

data/lib/selenium-connect/configuration.rb

@@ -1,6 +1,16 @@
 module SeleniumConnect
   class Configuration
-    attr_accessor :host, :port, :browser, :browser_path, :profile_path, :profile_name, :version, :background, :log, :jar
+    #Selenium Server
+    attr_accessor :host, :port, :version,
+                  :background, :log, :jar
+
+    #Browsers
+    attr_accessor :browser, :browser_path,
+                  :profile_path, :profile_name
+
+    #SauceLabs
+    attr_accessor :sauce_username, :sauce_api_key,
+                  :os, :browser_version, :description
 
     def initialize
       defaults
@@ -9,10 +19,10 @@ module SeleniumConnect
     private
 
     def defaults
-      @host     = "localhost" unless host
-      @port     = "4444"      unless port
-      @browser  = "firefox"   unless browser
+      @host     = 'localhost' unless host
+      @port     = 4444        unless port
       @log      = false       unless log
+      @browser  = 'firefox'   unless browser
     end
   end
 end

data/lib/selenium-connect/rake.task

@@ -1,8 +1,8 @@
 require 'selenium/rake/server_task'
 
        Selenium::Rake::ServerTask.new(:server) do |t|
-         t.jar = '/Users/more/Dropbox/_dev/Arrgyle/selenium-connect/selenium-server-standalone-2.32.0.jar'
+         t.version = :latest
          t.background
-         t.log = 'false'
+         t.log = false
          t.port = 4444
        end

data/lib/selenium-connect/runner.rb

@@ -1,5 +1,8 @@
-require 'selenium-connect/runner/firefox'
-require 'selenium-connect/runner/ie'
+require 'selenium-connect/runners/firefox'
+require 'selenium-connect/runners/ie'
+require 'selenium-connect/runners/chrome'
+require 'selenium-connect/runners/no_browser'
+require 'selenium-connect/runners/saucelabs'
 
 module SeleniumConnect
   class Runner
@@ -17,21 +20,28 @@ module SeleniumConnect
     end
 
     def init_driver
-      Selenium::WebDriver.for(
-        :remote,
-        :url => set_server_url,
-        :desired_capabilities => get_browser)
+      if config.host == 'saucelabs'
+        Saucelabs.new(config).launch
+      else
+        Selenium::WebDriver.for(
+          :remote,
+          :url => set_server_url,
+          :desired_capabilities => get_browser)
+      end
     end
 
     def get_browser
-      case config.browser
-        when "firefox"
-          Firefox.new(config).capabilities
-        when "ie"
-          InternetExplorer.new(config).capabilities
-        else
-          puts "No valid browser specified"
-      end
+      browser = browsers.find { |browser| browser.match? }
+      browser.launch
+    end
+
+    def browsers
+      firefox     = Firefox.new(config)
+      ie          = InternetExplorer.new(config)
+      chrome      = Chrome.new(config)
+      no_browser  = NoBrowser.new(config)
+
+      browsers = [ firefox, ie, chrome, no_browser ]
     end
 
   end #Runner

data/lib/selenium-connect/runners/chrome.rb

@@ -0,0 +1,26 @@
+module SeleniumConnect
+  class Runner
+    class Chrome
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def match?
+        config.browser == "chrome"
+      end
+
+      def launch
+        init_browser
+      end
+
+      private
+
+      def init_browser
+        config.browser.to_sym
+      end
+
+    end #Chrome
+  end #Runner
+end #SeleniumConnect

data/lib/selenium-connect/{runner → runners}/firefox.rb

@@ -1,10 +1,17 @@
 module SeleniumConnect
   class Runner
     class Firefox
-      attr_reader :config, :capabilities
+      attr_reader :config
 
       def initialize(config)
         @config = config
+      end
+
+      def match?
+        config.browser == "firefox"
+      end
+
+      def launch
         init_browser
       end
 
@@ -18,16 +25,17 @@ module SeleniumConnect
         end
       end
 
-      def set_path
-      end
-
-      def init_browser
+      def config_browser
         profile = get_profile
         profile.assume_untrusted_certificate_issuer = false unless profile.nil?
         browser = Selenium::WebDriver::Remote::Capabilities.firefox
         browser[:firefox_binary] = config.browser_path if config.browser_path
         browser[:firefox_profile] = profile
-        @capabilities = browser
+        return browser
+      end
+
+      def init_browser
+        config_browser
       end
 
     end #Firefox

data/lib/selenium-connect/{runner → runners}/ie.rb

@@ -1,17 +1,24 @@
 module SeleniumConnect
   class Runner
     class InternetExplorer
-      attr_reader :config, :capabilities
+      attr_reader :config
 
       def initialize(config)
         @config = config
+      end
+
+      def match?
+        config.browser == "ie"
+      end
+
+      def launch
         init_browser
       end
 
       private
 
       def init_browser
-        @capabilities = config.browser.to_sym
+        config.browser.to_sym
       end
 
     end #InternetExplorer

data/lib/selenium-connect/runners/no_browser.rb

@@ -0,0 +1,21 @@
+module SeleniumConnect
+  class Runner
+    class NoBrowser
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def match?
+        true
+      end
+
+      def execute
+        puts "Please specify a valid browser."
+        exit 1
+      end
+
+    end #NoBrowser
+  end #Runner
+end #SeleniumConnect

data/lib/selenium-connect/runners/saucelabs.rb

@@ -0,0 +1,34 @@
+require 'sauce'
+
+module SeleniumConnect
+  class Runner
+    class Saucelabs
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def launch
+        init_browser
+      end
+
+      private
+
+      def get_credentials
+        ENV['SAUCE_USERNAME'] = config.sauce_username
+        ENV['SAUCE_ACCESS_KEY'] = config.sauce_api_key
+      end
+
+      def init_browser
+        get_credentials
+        Sauce::Selenium2.new({
+          :os               =>  config.os,
+          :browser          =>  config.browser,
+          :browser_version  =>  config.browser_version,
+          :job_name         =>  config.description })
+      end
+
+    end #Saucelabs
+  end #Runner
+end #SeleniumConnect

data/lib/selenium-connect/server.rb

@@ -32,7 +32,13 @@ module SeleniumConnect
             end
           }
          t.background
-         t.log = '#{configuration.log}'
+         #{
+          if configuration.log
+            "t.log = '#{configuration.log}'"
+          else
+            "t.log = false"
+          end
+         }
          t.port = #{configuration.port}
        end"
     end

data/lib/selenium-connect.rb

@@ -4,28 +4,28 @@ require 'selenium-connect/runner'
 require 'selenium-connect/server'
 
 module SeleniumConnect
+
   extend self
+  attr_reader :config, :location, :server, :driver
 
   def configure
     yield configuration
   end
 
   def configuration
-    @configuration = Configuration.new
+    @config = Configuration.new
   end
 
-  attr_reader :server, :driver
-
   def localhost?
-    @configuration.host == 'localhost'
+    config.host == 'localhost'
   end
 
   def run
     if localhost?
-      @server = Server.new(@configuration)
+      @server = Server.new(config)
       server.start
     end
-    @driver = Runner.new(@configuration).driver
+    @driver = Runner.new(config).driver
   end
 
   def finish

data/selenium-connect.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name          = 'selenium-connect'
-  s.version       = '1.5.1'
+  s.version       = '1.6.0'
   s.platform      = Gem::Platform::RUBY
   s.authors       = ['Dave Haeffner']
   s.email         = ['dave@arrgyle.com']
   s.homepage      = 'https://github.com/arrgyle/selenium-connect'
-  s.summary       = 'A configurator and runner for your Selenium tests against local and remote Selenium Servers.'
+  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.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'selenium-webdriver'
   s.add_dependency 'rake'
+  s.add_dependency 'sauce'
 
   s.add_development_dependency 'rspec'
 

data/spec/acceptance_spec.rb

@@ -60,7 +60,7 @@ describe "Acceptance Tests" do
       end
     end
 
-    it "browser path", :wip => true do
+    it "browser path" do
       #only works with Firefox
       SeleniumConnect.configure do |c|
         c.host  = "localhost"

data/spec/sauce_spec.rb

@@ -0,0 +1,21 @@
+require 'selenium-connect'
+
+describe "Sauce Labs" do
+
+  it 'hello world', :wip => true do
+    SeleniumConnect.configure do |c|
+      c.host            = 'saucelabs'
+      c.sauce_username  = 'testing_arrgyle'
+      c.sauce_api_key   = 'ab7a6e17-16df-42d2-9ef6-c8d2539cc38a'
+      c.os              = 'windows'
+      c.browser         = 'iexplore'
+      c.browser_version = '7'
+      c.description     = 'hello world from selenium-connect!'
+    end
+    driver = SeleniumConnect.start
+    driver.get 'http://google.com'
+    driver.title.should include('Google')
+    SeleniumConnect.finish
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium-connect
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sauce
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -74,11 +90,15 @@ files:
 - lib/selenium-connect/configuration.rb
 - lib/selenium-connect/rake.task
 - lib/selenium-connect/runner.rb
-- lib/selenium-connect/runner/firefox.rb
-- lib/selenium-connect/runner/ie.rb
+- lib/selenium-connect/runners/chrome.rb
+- lib/selenium-connect/runners/firefox.rb
+- lib/selenium-connect/runners/ie.rb
+- lib/selenium-connect/runners/no_browser.rb
+- lib/selenium-connect/runners/saucelabs.rb
 - lib/selenium-connect/server.rb
 - selenium-connect.gemspec
 - spec/acceptance_spec.rb
+- spec/sauce_spec.rb
 homepage: https://github.com/arrgyle/selenium-connect
 licenses:
 - MIT
@@ -103,6 +123,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A configurator and runner for your Selenium tests against local and remote
-  Selenium Servers.
+summary: A stupid simple way to run your Selenium tests on localhost, against a Selenium
+  Grid, or in the cloud (e.g. SauceLabs).
 test_files: []