selenium_shots 0.2.4 → 1.0.0

data/README.rdoc

@@ -3,6 +3,53 @@
 http://www.seleniumshots.com
 Selenium Shots is an Integration Testing Service that transparently distributes your integration tests across multiple operating systems with different versions of all major browsers AND captures a screen shot. This eliminates the need to have multiple vm's on your computer or the need for multiple machines on your test to test your web application.  Running your tests remotely will dramatically speed up in-browser web testing and leave more time to  and create a slide show available to confirm visuals making it easy for you to improve your web application.
 
+== Install
+
+=== Rails 3
+
+Add this to your Gemfile:
+
+  group :development do
+    gem 'selenium_shots'
+  end
+
+=== Rails 2
+
+To install add teh following to config/environment.rb:
+
+  config.gem 'selenium_shots'
+  
+== Configure
+
+In configure/selenium_shots.yml you will need to define the application
+* api_key
+* mode
+* default_browser_url
+* application_name
+* local_browser
+* browsers
+
+== Creating Tests
+
+
+   class MyTest < SeleniumShots
+  
+     @group = "MyTestGroup"
+  
+     selenium_shot "Should run my test and pass." do
+       @name = "My Test Name"
+       browser.open "/my_site"
+       browser.type "search[query]", "Cats"
+       browser.click "find"
+     end
+   end
+   
+== Selenium Setup
+Download the latest version of selenium grid from http://seleniumhq.org/download/
+
+===Using a Custom Selenium Server
+`ant launch-remote-control -DcustomRemoteControl=/path/to/your/customer/selenium-server.jar`
+
 == Copyright
 
 Copyright (c) 2010 Kyle Ginavan. See LICENSE for details.

data/examples/google.rb

@@ -5,11 +5,10 @@ class Google < SeleniumShots
   @group = "Google"
 
   selenium_shot "should search on google" do
-    @name = "selenium shots"
-    browser.open "/"
-    browser.type "q", "Selenium Shots"
-    browser.click "btnG"
+    @name = "Google search"
+    element = driver.find_element(:name, 'q')
+    element.send_keys "Hello WebDriver!"
+    element.submit
   end
-
 end
 

data/lib/selenium_shots/cli/client.rb

@@ -7,7 +7,7 @@ class SeleniumShots::Client
 
 	attr_reader :host, :api_key
 
-	def initialize(api_key, host='seleniumshots.com')
+	def initialize(api_key, host='www.seleniumshots.com')
 		@api_key  = api_key
 		@host     = host
 	end

data/lib/selenium_shots/cli/commands/auth.rb

@@ -15,8 +15,8 @@ module SeleniumShots::Command
     end
 
     def get_api_key_from_host
-      RestClient.post 'http://seleniumshots.com/selenium_tests/get_api_key', :user_session => { :email => @api_key_hash[0],
-                                                                             :password => @api_key_hash[1]}
+      RestClient.post 'http://www.seleniumshots.com/selenium_tests/get_api_key',  :user_session => { :email => @api_key_hash[0],
+                                                                                  :password => @api_key_hash[1]}
     end
 
     def api_key_file

data/lib/selenium_shots/cli/commands/base.rb

@@ -57,7 +57,7 @@ api_key: "#{api_key}"
 mode: "remote" # "local" for run test locally
 default_browser_url: "http://www.myapp.com"
 application_name: "#{name}"
-local_browser: "*firefox3"
+local_browser: "firefox"
 browsers:
     - IE8 on XP
     - Firefox3.6 on XP

data/lib/selenium_shots/test_selenium_shots.rb

@@ -1,6 +1,7 @@
 require "test/unit"
 require "rubygems"
 require "selenium/client"
+require "selenium-webdriver"
 require 'active_support'
 require 'active_support/test_case'
 require 'ostruct'
@@ -17,7 +18,7 @@ end
 
 class SeleniumShots < ActionController::IntegrationTest
 
-  attr_reader :browser, :agent
+  attr_reader :driver, :agent, :take_screenshot
   cattr_accessor :expected_test_count
 
   if SeleniumConfig.mode == "remote"
@@ -36,7 +37,7 @@ class SeleniumShots < ActionController::IntegrationTest
   end
 
   def local_browsers
-    ["*firefox3", "*iexplore", "*safari"]
+    ["firefox", "ie", "chrome"]
   end
 
   def selected_browsers
@@ -50,38 +51,20 @@ class SeleniumShots < ActionController::IntegrationTest
      end
     end
   end
-
-  def setup
-    if(not self.class.expected_test_count)
-      self.class.expected_test_count = (self.class.instance_methods.reject{|method| method[0..3] != 'test'}).length
-      if SeleniumConfig.mode == "local"
-        FileUtils.rm(pid_file) if  File.exists?(pid_file)
-        IO.popen("selenium_shots_local_server start 2>&1")
-        sleep(2)
-      end
-    end
-  end
-
-  def teardown
-    if((self.class.expected_test_count-=1) == 0)
-      if File.exists?(pid_file) && SeleniumConfig.mode == "local"
-        IO.popen("selenium_shots_local_server stop 2>&1")
-      end
-    end
-  end
-
-  def self.selenium_shot(description, &block)
+  
+  def self.core_test(description, take_screenshot = true, &block)
     @@group = (@group || "Default")
     test_name = "test_#{description.gsub(/\s+/,'_')}".to_sym
     defined = instance_method(test_name) rescue false
     raise "#{test_name} is already defined in #{self}" if defined
     if block_given?
-     define_method(test_name) do
-       @description = description
-       run_in_all_browsers do |browser|
-         instance_eval &block
-       end
-     end
+      define_method(test_name) do
+        @description     = description
+        @take_screenshot = take_screenshot
+        run_in_all_browsers do
+          instance_eval &block
+        end
+      end
     else
       define_method(test_name) do
         flunk "No implementation provided for #{name}"
@@ -89,14 +72,22 @@ class SeleniumShots < ActionController::IntegrationTest
     end
   end
 
+  def self.selenium_test(description, &block)
+    core_test(description, nil, &block)
+  end
+
+  def self.selenium_shot(description, &block)
+    core_test(description, true, &block)
+  end
+
   def run_in_all_browsers(&block)
     @error = nil
     browsers = (@selected_browser || selected_browsers)
     browsers.each do |browser_spec|
       begin
-        run_browser(browser_spec, block)
+        run_webdriver(browser_spec, block)
       rescue  => error
-        @browser.close_current_browser_session if @browser
+        @driver.quit if @driver
         @error = error.message
         if @error.match(/Failed to start new browser session/) && SeleniumConfig.mode == "local"
           @tmp_browsers ||= local_browsers
@@ -111,48 +102,76 @@ class SeleniumShots < ActionController::IntegrationTest
     end
     assert @error.nil?, "Expected zero failures or errors, but got #{@error}\n"
   end
+  
+  def run_webdriver(browser_spec, block)
+    
+    client = Selenium::WebDriver::Remote::Http::Default.new
+    client.timeout = 20 # seconds
+    
+    if SeleniumConfig.mode == "local"
+      if /(firefox)/i.match(browser_spec)
+        profile = Selenium::WebDriver::Firefox::Profile.new
+        profile.native_events = false
+        @driver = Selenium::WebDriver.for(:firefox, :profile => profile, :http_client => client)
+      elsif /(chrome)/i.match(browser_spec)
+        @driver = Selenium::WebDriver.for(:chrome, :http_client => client)
+      elsif /(ie)/i.match(browser_spec)
+        @driver = Selenium::WebDriver.for(:ie, :http_client => client)
+      end
+    else
+      caps = nil
+      if /(firefox)/i.match(browser_spec)
+        caps = WebDriver::Remote::Capabilities.firefox
+      elsif /(chrome)/i.match(browser_spec)
+        caps = WebDriver::Remote::Capabilities.chrome
+      elsif /(ie)/i.match(browser_spec)
+        caps = WebDriver::Remote::Capabilities.internet_explorer
+      elsif /(safari)/i.match(browser_spec)
+        caps = WebDriver::Remote::Capabilities.safari
+      elsif /(htmlunit)/i.match(browser_spec)
+        caps = WebDriver::Remote::Capabilities.htmlunit
+        caps.javascript_enabled = true
+      end
+
+      @driver = Selenium::WebDriver.for(:remote, :desired_capabilities => caps, :http_client => client) if caps
+    end
+    
+    @driver.manage.timeouts.implicit_wait = 2 #seconds
+    @driver.navigate.to SeleniumConfig.default_browser_url
 
-  def run_browser(browser_spec, block)
-    @browser = Selenium::Client::Driver.new(
-                                           :host => HOST,
-                                           :port => PORT,
-                                           :browser => browser_spec,
-                                           :url => SeleniumConfig.default_browser_url,
-                                           :timeout_in_second => 200)
-    @browser.start_new_browser_session
     begin
-      block.call(@browser)
+      block.call
     rescue  => error
       @error = error.message
+      puts @error
     ensure
       save_test({:selenium_test_group_name => @@group, :selenium_test_name => @name,
                 :description => @description}) if SeleniumConfig.mode == "remote"
-      @browser.close_current_browser_session
-    end
+      @driver.quit
+    end 
   end
 
   def capture_screenshot_on(src)
     browser.window_focus
     browser.window_maximize
     sleep(2)
-    if browser.browser_string.match(/XP/)
-      browser.capture_entire_page_screenshot("#{PICS_WINDOWS_PATH}\\#{src}", "background=#FFFFFF")
-    elsif browser.browser_string.match(/SnowLeopard/)
-      browser.capture_entire_page_screenshot("#{PICS_MACOS_PATH}/#{src}", "background=#FFFFFF")
-    elsif browser.browser_string.match(/Linux/)
-      browser.capture_entire_page_screenshot("#{PICS_LINUX_PATH}/#{src}", "background=#FFFFFF")
+    if @driver.browser.to_s.match(/XP/)
+      @driver.capture_entire_page_screenshot("#{PICS_WINDOWS_PATH}\\#{src}", "background=#FFFFFF")
+    elsif @driver.browser.to_s.match(/SnowLeopard/)
+      @driver.capture_entire_page_screenshot("#{PICS_MACOS_PATH}/#{src}", "background=#FFFFFF")
+    elsif @driver.browser.to_s.match(/Linux/)
+      @driver.capture_entire_page_screenshot("#{PICS_LINUX_PATH}/#{src}", "background=#FFFFFF")
     end
   end
 
   def save_test(params)
     src = "#{SeleniumConfig.application_name}_#{params[:selenium_test_group_name]}_#{params[:selenium_test_name]}_" +
-          "#{browser.browser_string.gsub(/\s+/,"_").downcase}.png"
+           "#{@driver.browser.to_s.gsub(/\s+/,"_").downcase}.png"
 
     capture_screenshot_on(src)
 
     SeleniumTest.create(:selenium_test_name => params[:selenium_test_name], :description => params[:description],
-      :url => browser.location, :error_message => @error, :is_error => !@error.nil?, :environment => browser.browser_string,
+      :url => @driver.current_url, :error_message => @error, :is_error => !@error.nil?, :environment => @driver.browser.to_s,
       :selenium_test_group_name => params[:selenium_test_group_name], :application_name => SeleniumConfig.application_name)
   end
 end
-

metadata

@@ -3,10 +3,10 @@ name: selenium_shots
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Kyle J. Ginavan
@@ -15,8 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 -05:00
-default_executable: 
+date: 2010-12-02 00:00:00 -06:00
+default_executable: selenium_shots
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
@@ -31,23 +31,37 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: selenium-client
+  name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 12
+        version: 1.1.12
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: selenium-webdriver
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 0
         - 1
-        - 2
-        - 18
-        version: 1.2.18
+        - 0
+        version: 0.1.0
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -57,12 +71,11 @@ dependencies:
         - 2
         version: 0.8.2
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 description: Selenium Shots is an Integration Testing Service that transparently distributes your integration tests across multiple operating systems with different versions of all major browsers AND captures a screen shot
 email: kyle@4rockets.com
 executables: 
 - selenium_shots
-- selenium_shots_local_server
 extensions: []
 
 extra_rdoc_files: 
@@ -77,10 +90,8 @@ files:
 - lib/selenium_shots/cli/commands/auth.rb
 - lib/selenium_shots/cli/commands/base.rb
 - lib/selenium_shots/cli/commands/help.rb
-- lib/selenium_shots/cli/commands/server.rb
 - lib/selenium_shots/cli/init.rb
 - lib/selenium_shots/test_selenium_shots.rb
-- vendor/selenium-server-1.0.2-SNAPSHOT-standalone.jar
 - LICENSE
 - LICENSE.orig
 - README.rdoc

data/bin/selenium_shots_local_server

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require 'fileutils'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib/selenium_shots/cli/')
-
-require 'init'
-
-args = ARGV.dup
-ARGV.clear
-
-command = args.shift.strip rescue 'help'
-
-SeleniumShots::Command.run("server:#{command}", args)
-

data/lib/selenium_shots/cli/commands/server.rb

@@ -1,34 +0,0 @@
-module SeleniumShots::Command
-	class Server < Base
-
-    GEM_ROOT        = File.expand_path(File.join(File.dirname(__FILE__), '/../../../../'))
-    SELENIUM_SERVER = File.join(GEM_ROOT, 'vendor', 'selenium-server-1.0.2-SNAPSHOT-standalone.jar')
-
-    def pid_file
-      '/tmp/selenium_shots.pid'
-    end
-
-    def start
-      if File.exists?(pid_file)
-        puts "the selenium shots server is running...."
-      else
-        pipe = IO.popen("java -jar #{SELENIUM_SERVER}")
-        File.open(pid_file, 'w') {|f| f.write(pipe.pid) }
-      end
-    end
-
-    def stop
-      if File.exists?(pid_file)
-        process_id = File.open(pid_file,'r').readline
-        Process.kill 9, process_id.to_i
-        FileUtils.rm(pid_file)
-      end
-    end
-
-    def help
-      puts "selenium_shots_local_server {start|stop}"
-    end
-
-	end
-end
-