watirgrid 0.0.8.pre → 0.0.9

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Tim Koopmans
+Copyright (c) 2009-2011 Tim Koopmans 
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -3,11 +3,7 @@
 WatirGrid allows for distributed testing across a grid network using Watir.
 
 == Getting Started
-This gem is hosted on Gemcutter. Gemcutter is the next generation of gem hosting for the Ruby community. To get started:
-  gem install gemcutter
-  gem tumble
-  
-Then to install WatirGrid:
+To install WatirGrid:
   gem install watirgrid
 
 === The Basics

data/Rakefile

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'rake'
 
 begin
@@ -10,29 +9,27 @@ begin
     gem.email = "tim.koops@gmail.com"
     gem.homepage = "http://github.com/90kts/watirgrid"
     gem.authors = ["Tim Koopmans"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.version = "0.0.8.pre"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.version = "0.0.9"
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
 require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+desc "Run unit tests"
+Spec::Rake::SpecTask.new('unit_tests_watir') do |t|
+  t.spec_files = FileList['spec/**/grid_spec.rb']
+  t.spec_opts = ["--format", "nested", "-c"]
+  t.fail_on_error = false
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+desc "Run unit tests for WebDriver"
+Spec::Rake::SpecTask.new('unit_tests_webdriver') do |t|
+  t.spec_files = FileList['spec/**/webdriver_spec.rb']
+  t.spec_opts = ["--format", "nested", "-c"]
+  t.fail_on_error = false
 end
 
-task :spec => :check_dependencies
-
-task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/bin/controller

@@ -10,8 +10,8 @@ OptionParser.new do |opts|
   opts.separator ""
   opts.separator "Specific options:"
   opts.on("-H HOST", "--drb-server-host", String, 
-  "Specify DRb Server interface to host on") do |H|
-    options[:drb_server_host] = H || nil
+  "Specify DRb Server interface to host on") do |h|
+    options[:drb_server_host] = h || nil
   end
   opts.on("-d PORT", "--drb-server-port", Integer, 
     "Specify DRb Server port to listen on") do |d|
@@ -57,4 +57,4 @@ controller = Controller.new(
   :loglevel => options[:loglevel]
 )
 controller.start
-DRb.thread.join
+DRb.thread.join

data/bin/provider

@@ -10,8 +10,8 @@ OptionParser.new do |opts|
   opts.separator ""
   opts.separator "Specific options:"
   opts.on("-H HOST", "--drb-server-host", String, 
-  "Specify DRb Server interface to host on") do |H|
-    options[:drb_server_host] = H || nil
+  "Specify DRb Server interface to host on") do |h|
+    options[:drb_server_host] = h || nil
   end
   opts.on("-d PORT", "--drb-server-port", Integer, 
     "Specify DRb Server port to listen on") do |d|
@@ -61,4 +61,4 @@ provider = Provider.new(
   :acls => options[:acls] || %w{ allow all },
   :loglevel => options[:loglevel])
 provider.start
-DRb.thread.join
+DRb.thread.join

data/examples/basic/example_safariwatir.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'watirgrid'
+
+# Here's some basic examples in plain Ruby with Watirgrid
+
+# Start a Controller using defaults
+controller = Controller.new
+controller.start
+
+# Start a Provider with SafariWatir
+provider = Provider.new(:browser_type => 'safari')
+provider.start
+
+# Start a Grid
+grid = Watir::Grid.new
+grid.start(:take_all => true)
+
+# Control the Providers via the Grid
+# We only have one Provider on the Grid so no real need for threads
+# however keeping the thread construct for example only
+threads = []
+  grid.browsers.each_with_index do |browser, index|
+    threads << Thread.new do
+      b = browser[:object].new_browser
+      b.goto("http://www.google.com")
+      b.text_field(:name, 'q').set("watirgrid")
+      b.button(:name, "btnI").click
+      b.close
+    end
+  end
+threads.each {|thread| thread.join}

data/examples/basic/example_webdriver.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'watirgrid'
+
+# Here's some basic examples in plain Ruby with Watirgrid and WebDriver
+
+# Start a Controller using defaults
+controller = Controller.new
+controller.start
+
+# Start 2 Providers with WebDriver
+1.upto(2) do
+  provider = Provider.new(:browser_type => 'webdriver')
+  provider.start
+end
+
+# Start another Grid
+grid = Watir::Grid.new
+grid.start(:take_all => true)
+
+# Control the first Provider via the Grid using Firefox
+# Note when we have a WebDriver object we also need to specify the target 
+# browser in new_browser method
+thread = Thread.new do 
+  b = grid.browsers[0][:object].new_browser(:firefox)
+  b.goto("http://google.com")
+  b.text_field(:name, 'q').set("watirgrid")
+  b.button(:name, "btnI").click
+  b.close
+end
+thread.join
+
+# Control the second Provider via the Grid, this time using Chrome
+thread = Thread.new do 
+  b = grid.browsers[1][:object].new_browser(:chrome)
+  b.goto("http://google.com")
+  b.text_field(:name, 'q').set("watirgrid")
+  b.button(:name, "btnI").click
+  b.close
+end
+thread.join

data/examples/basic/example_webdriver_remote.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'watirgrid'
+require 'extensions/remote'
+
+# Here's some basic examples in plain Ruby with Watirgrid and WebDriver Remote / HtmlUnit
+
+# Start a Controller using defaults
+controller = Controller.new
+controller.start
+
+# Start 50 Providers with WebDriver Remote
+1.upto(50) do
+  provider = Provider.new(:browser_type => 'webdriver_remote')
+  provider.start
+end
+
+# Start another Grid
+@grid = Watir::Grid.new
+@grid.start(:take_all => true)
+threads = []
+  @grid.browsers.each_with_index do |browser, index|
+    sleep 0.5 # let's sleep a little to give a more natural rampup
+    threads << Thread.new do
+      require 'selenium/server'
+      include Selenium
+
+      b = browser[:object].new_browser(:htmlunit)
+      t = Time.now
+      b.goto("http://90kts.local/")
+      puts "#{Thread.current.object_id} : #{b.title} : Elapsed #{Time.now - t}"
+      b.close
+    end
+  end
+threads.each {|thread| thread.join}

data/examples/cucumber/example.feature

@@ -0,0 +1,17 @@
+@Example
+Feature: Watirgrid using WebDriver
+  In order to use Watirgrid 
+  Users must be able to create controllers, add providers and control a grid
+
+  Scenario: Create a Controller with Providers
+    Given I have created and started a Controller
+    Then I should be able to create and start 2 "WebDriver" Providers
+
+  # Note: WebDriver can only control one instance of any particular browser on a single host.
+  # With Watirgrid, you'd typically have multiple instances across multiple hosts (Providers)
+  # For the sake of a demo, we'll just control 2 difference instances on a single host.
+  Scenario: Create a Grid and control the Providers
+    Given I have created and started a Grid with 2 Providers
+    Then I should be able to control the following browsers in parallel:
+      | Chrome |
+      | Firefox |

data/examples/cucumber/step_definitions/example_steps.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', '..', 'lib'))
+require 'watirgrid'
+require 'rspec/expectations'; 
+
+Given /^I have created and started a Controller$/ do
+  controller = Controller.new(
+    :loglevel => Logger::ERROR)
+  controller.start
+end
+
+Then /^I should be able to create and start (\d+) "(.+?)" Providers$/ do |total, browser_type|
+  1.upto(total.to_i) do 
+    provider = Provider.new(
+      :loglevel => Logger::ERROR, :browser_type => browser_type)
+    provider.start
+  end
+end
+
+Given /^I have created and started a Grid with (\d+) Providers$/ do |total|
+  @grid = Watir::Grid.new
+  @grid.start(:take_all => true)
+  @grid.browsers.size.should == total.to_i
+end
+
+Then /^I should be able to control the following browsers in parallel:$/ do |table|
+  browsers = table.raw.collect {|e| e.to_s.downcase.to_sym}
+  threads = []
+    @grid.browsers.each_with_index do |browser, index|
+      threads << Thread.new do
+        b = browser[:object].new_browser(browsers[index])
+        b.goto("http://www.google.com")
+        b.text_field(:name, 'q').set("watirgrid")
+        b.button(:name, "btnI").click
+        b.close
+      end
+    end
+    threads.each {|thread| thread.join}
+end

data/lib/controller.rb

@@ -2,7 +2,6 @@
 # controller.rb
 # Rinda Ring Server Controlller
 
-require 'rubygems'
 require 'rinda/tuplespace'
 require 'rinda/ring'
 require 'logger'
@@ -101,4 +100,3 @@ class Controller
   end
 
 end
-

data/lib/extensions/remote.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby 
+# remote.rb
+# Rinda Ring Provider
+
+require 'rinda/ring'
+require 'rinda/tuplespace'
+require 'logger'
+require 'drb/acl'
+require 'uuid'
+require 'selenium/server'
+include Selenium
+@server = Selenium::Server.new(File.expand_path(File.dirname(__FILE__)) + '/selenium-server-standalone-2.0b1.jar', :background => true)
+@server.start  
+
+module Watir
+  class Provider
+
+    include DRbUndumped # all objects will be proxied, not copied
+
+    attr_reader :browser
+
+    def initialize(browser = nil)
+      browser = (browser || 'tmp').downcase.to_sym 
+      case browser
+				when :webdriver_remote
+					require 'watir-webdriver'
+          @browser = Watir::Browser
+      end    
+    end
+  
+    def new_browser(webdriver_browser_type = nil)
+      if webdriver_browser_type == :htmlunit 
+        capabilities = WebDriver::Remote::Capabilities.htmlunit(:javascript_enabled => true)
+        @browser.new(:remote, :url => "http://127.0.0.1:4444/wd/hub", :desired_capabilities => capabilities)
+      end
+    end
+  
+  end
+end

data/lib/provider.rb

@@ -2,7 +2,6 @@
 # provider.rb
 # Rinda Ring Provider
 
-require 'rubygems'
 require 'rinda/ring'
 require 'rinda/tuplespace'
 require 'logger'
@@ -22,33 +21,29 @@ module Watir
     attr_reader :browser
 
     def initialize(browser = nil)
-      browser = (browser || 'tmp').downcase.to_sym  
+      browser = (browser || 'tmp').downcase.to_sym 
       case browser
-        when :safari
+        when :safari, :safariwatir
 					require 'safariwatir'
           @browser = Watir::Safari
-        when :firefox
+        when :firefox, :firewatir
 					require 'firewatir'
           @browser = FireWatir::Firefox 
-        when :ie
+        when :ie, :watir
 					require 'watir'
           @browser = Watir::IE
 				when :webdriver
 					require 'watir-webdriver'
           @browser = Watir::Browser
-        else
-          @browser = find_supported_browser
       end    
     end
 
-    #~ def find_supported_browser
-      #~ if Watir::IE then return Watir::IE end
-      #~ if FireWatir::Firefox then return FireWatir::Firefox end
-      #~ if Watir::Safari then return Watir::Safari end
-    #~ end
-
     def new_browser(webdriver_browser_type = nil)   
-			@browser.new(webdriver_browser_type)
+			if webdriver_browser_type 
+        @browser.new(webdriver_browser_type)
+      else
+        @browser.new
+      end
     end
     
     ##
@@ -83,7 +78,7 @@ module Watir
         browsers.each { |browser| %x[killall -r #{browser}] } 
       when /darwin/
         browsers = ['firefox-bin', 'Chrome', 'Safari']
-        browsers.each { |browser| %x[killall -m #{browser}] } 
+        browsers.each { |browser| %x[pkill -9 #{browser}] }
       end
     end
     
@@ -223,6 +218,4 @@ class Provider
       '127.0.0.1'
     end
   end
-
 end
-

data/lib/watirgrid.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'controller'
 require 'provider'
 
@@ -164,4 +163,3 @@ module Watir
   end
 
 end
-

data/spec/grid_spec.rb

@@ -1,125 +1,183 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe 'WatirGrid' do
-  before(:all) do
+describe 'Starting and Stopping Controllers on the Grid' do
+  it 'should start a DRb and Ring Server when specifying NO interface or port' do
+    controller = Controller.new(:loglevel => Logger::ERROR)
+    controller.start
+    controller.drb_server_uri.should =~ /druby/
+    controller.stop
+  end
+
+  it 'should start a DRb and Ring Server on a specified interface' do
+    controller = Controller.new(
+      :drb_server_host => '127.0.0.1', 
+      :ring_server_host => '127.0.0.1',
+      :loglevel => Logger::ERROR)
+    controller.start
+    controller.drb_server_uri.should =~ /druby/
+    controller.stop
+  end
+
+  it 'should start a DRb and Ring Server on specified ports' do
     controller = Controller.new(
-      :ring_server_port => 12351,
+      :drb_server_port => 11235, 
+      :ring_server_port => 12358,
       :loglevel => Logger::ERROR)
     controller.start
+    controller.drb_server_uri.should =~ /druby/
+    controller.stop
+  end
+end
+
+describe 'Starting and Stopping Providers on the Grid' do
+  before(:all) do
+    @controller = Controller.new(
+      :drb_server_host => '127.0.0.1', 
+      :ring_server_host => '127.0.0.1',
+      :ring_server_port => 12350,
+      :loglevel => Logger::ERROR)
+    @controller.start
+  end
+
+  it 'should register a new provider on a specified port' do
+    provider = Provider.new(
+      :drb_server_host => '127.0.0.1', 
+      :ring_server_host => '127.0.0.1',
+      :ring_server_port => 12350,
+      :loglevel => Logger::ERROR)
+    provider.start
+  end
+
+  after(:all) do
+    @controller.stop
+  end
+end
+
+describe 'Using the Grid' do
+  before(:all) do
+    @controller = Controller.new(
+      :ring_server_port => 12357,
+      :loglevel => Logger::ERROR)
+    @controller.start
     1.upto(5) do 
       provider = Provider.new(
-        :ring_server_port => 12351, 
+        :ring_server_port => 12357, 
         :loglevel => Logger::ERROR, :browser_type => 'safari')
       provider.start
     end
   end
 
-  it 'should return how many grid are available in the tuplespace' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  after(:all) do
+    @controller.stop
+  end
+
+  it 'should return how many providers are available on the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:read_all => true)
     grid.size.should == 5
   end
 
-  it 'should read any 2 grid in the tuplespace' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should read any 2 providers on the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 2, :read_all => true)
     grid.size.should == 2
   end
 
-  it 'should take any 1 browser in the tuplespace' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should take any 1 provider on the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1, :take_all => true)
     grid.size.should == 1 
   end
 
-  it 'should take all grid remaining in tuplespace' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should take all providers remaining on the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:take_all => true)
     grid.size.should == 4
   end
 
-  it 'should find no more grid in the tuplespace' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should find no more providers on the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:read_all => true)
     grid.size.should == 0
   end
 
-  it 'should register 4 new grid in the tuplespace' do
+  it 'should register 4 new providers on the grid' do
     1.upto(4) do 
-      provider = Provider.new(:ring_server_port => 12351, 
+      provider = Provider.new(:ring_server_port => 12357, 
         :loglevel => Logger::ERROR, :browser_type => 'safari')
       provider.start
     end
   end
 
-  it 'should take any 1 browser based on browser type' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should take any 1 provider based on :browser_type from the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1,
       :take_all => true, :browser_type => 'safari')
     grid.size.should == 1
   end
 
-  it 'should fail to find any grid based on a specific browser type' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should fail to find any providers on the grid based on a specific :browser_type' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1,
       :take_all => true, :browser_type => 'firefox')
     grid.size.should == 0
   end
 
-  it 'should fail to find any grid based on a unknown browser type' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should fail to find any providers on the grid based on an unknown :browser_type' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1,
       :take_all => true, :browser_type => 'penguin')
     grid.size.should == 0
   end
 
-  it 'should take any 1 browser based on specific architecture type' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should take any 1 provider on the grid based on specific :architecture' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1, 
       :take_all => true, :architecture => Config::CONFIG['arch'])
     grid.size.should == 1
   end
 
-  it 'should fail to find any grid based on unknown architecture type' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should fail to find any providers on the grid based on  an unknown :architecture' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1, 
-      :take_all => true, :architecture => 'geos-1992')
+      :take_all => true, :architecture => 'geos-2000')
     grid.size.should == 0
   end
 
-  it 'should take any 1 browser based on specific hostname' do
+  it 'should take any 1 provider on the grid based on specific :hostnames' do
     hostname = `hostname`.strip
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1,
       :take_all => true, 
-      :hostnames => { hostname => "127.0.0.1"}
+      :hostnames => { hostname => '127.0.0.1'}
       )
     grid.size.should == 1
   end
 
-  it 'should fail to find any grid based on unknown hostname' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should fail to find any providers on the grid based on unknown :hostnames' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1,
       :take_all => true, :hostnames => { 
         "tokyo" => "127.0.0.1"})
     grid.size.should == 0
   end
+
+  it 'should get the UUID of the last provider on the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
+    grid.start(:read_all => true)
+    grid.browsers.each do |browser|
+      @uuid = browser[:uuid]
+    end
+  end
+
+  it 'should be able to find a provider by its UUID on the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
+    grid.start(:read_all => true, :uuid => @uuid)
+    grid.size.should == 1
+  end
   
-  it 'should take the last browser and execute some watir commands' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should take the last provider on the grid and execute some Watir code in Safari' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:quantity => 1, :take_all => true)
     threads = []
     grid.browsers.each do |browser|
@@ -130,19 +188,17 @@ describe 'WatirGrid' do
         b = browser[:object].new_browser
         b.goto("http://www.google.com")
         b.text_field(:name, 'q').set("watirgrid")
-        b.button(:name, "btnI").click
+        #b.button(:name, "btnI").click
+        b.close
       end
     end
     threads.each {|thread| thread.join}
     grid.size.should == 1
   end
 
-  it 'should find no more tuples in the tuplespace' do
-    grid = Watir::Grid.new(:ring_server_port => 12351, 
-    :ring_server_host => '127.0.0.1')
+  it 'should find no more providers on the grid' do
+    grid = Watir::Grid.new(:ring_server_port => 12357)
     grid.start(:read_all => true)
     grid.size.should == 0
-  end
-
+  end 
 end
-

data/spec/spec_helper.rb

@@ -1,9 +1,3 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'watirgrid'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end