watirgrid 0.0.2 → 0.0.3b

data/.gitignore

@@ -16,6 +16,7 @@ tmtags
 ## PROJECT::GENERAL
 coverage
 rdoc
+doc
 pkg
 
 ## PROJECT::SPECIFIC

data/EXAMPLES.rdoc

@@ -91,22 +91,27 @@ Watir has been extended with a Grid class that can be used as follows:
   require 'rubygems'
   require 'watirgrid'
 
-  browsers = Watir::Grid.new(:ring_server_port => 12358)
-  browsers.start(:quantity => 1, :read_all => true, :browser_type => 'ie')
-  browsers.each do |browser, browser_id, hostname, arch, type|
-    browser.goto("http://www.google.com")
-    browser.text_field(:name, 'q').set("watirgrid")
-    browser.button(:name, "btnI").click
+  grid = Watir::Grid.new(:ring_server_port => 12358)
+  grid.start(:quantity => 1, :read_all => true, :browser_type => 'ie')
+  threads = []
+  grid.browsers.each do |browser|
+    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
+    end
   end
+  threads.each {|thread| thread.join}
 
 Stepping through this example we first instantiate a browsers object, specifying which ring server port to broadcast on when looking for available providers:
-  browsers = Watir::Grid.new(:ring_server_port => 12358)
+  grid = Watir::Grid.new(:ring_server_port => 12358)
 
 You may also need to tell the code which host the ring server is on:
-  browsers = Watir::Grid.new(:ring_server_port => 12358, :ring_server_host => 143.238.105.61)
+  grid = Watir::Grid.new(:ring_server_port => 12358, :ring_server_host => 143.238.105.61)
 
 Next we start up the grid, specifying the number of browsers we wish to use, and the method of accessing the tuple space:
-  browsers.start(:quantity => 1, :read_all => true)
+  grid.start(:quantity => 1, :read_all => true)
   
 There are two methods for accessing the tuple space. 
   :read_all => true

data/README.rdoc

@@ -40,14 +40,18 @@ This should find the recently started Ring Server and register a tuple for the W
 You will now be able to execute commands across remote browsers on your grid network.
 
 e.g.
-  browsers = Watir::Grid.new(:ring_server_port => 12358)
-  browsers.start(:quantity => 1, :read_all => true)
-  browsers.size.should == 1
-  browsers.each do |browser, browser_id|
-    browser.goto("http://www.google.com")
-    browser.text_field(:name, 'q').set("watirgrid")
-    browser.button(:name, "btnI").click
+  grid = Watir::Grid.new(:ring_server_port => 12358)
+  grid.start(:quantity => 1, :read_all => true)
+  threads = []
+  grid.browsers.each do |browser|
+    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
+    end
   end
+  threads.each {|thread| thread.join}
 
 You may wish to host the controller and providers on different machines in a real scenario. You can specify things like server hostnames, ports and access control lists for each of the different types of servers. For more help see:
   $  controller --help

data/Rakefile

@@ -11,7 +11,7 @@ begin
     gem.homepage = "http://github.com/90kts/watirgrid"
     gem.authors = ["Tim Koopmans"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.version = "0.0.2"
+    gem.version = "0.0.3b"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/examples/simple.rb

@@ -1,10 +1,17 @@
 require 'rubygems'
 require '../lib/watirgrid'
 
-browsers = Watir::Grid.new(:ring_server_port => 12358, :loglevel => Logger::DEBUG)
-browsers.start(:quantity => 1, :read_all => true, :browser_type => 'ie')
-browsers.each do |browser, browser_id, hostname, arch, type|
-  browser.goto("http://www.google.com")
-  browser.text_field(:name, 'q').set("watirgrid")
-  browser.button(:name, "btnI").click
-end
+grid = Watir::Grid.new(:ring_server_port => 12358, 
+:ring_server_host => '192.168.1.101', :loglevel => Logger::DEBUG)
+grid.start(:quantity => 1, :read_all => true)
+
+threads = []
+grid.browsers.each do |browser|
+  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
+  end
+end
+threads.each {|thread| thread.join}

data/lib/watirgrid.rb

@@ -23,32 +23,19 @@ module Watir
       @log  = Logger.new(logfile, 'daily')
       @log.level = params[:loglevel] || Logger::ERROR
       @log.datetime_format = "%Y-%m-%d %H:%M:%S "   
+      
+      @browsers = []
+      @tuples = []
     end
 
     ##
     # Start required services
-    def start(params = {})
+    def start(params = {})      
       start_drb_server
       find_ring_server
       get_tuples(params)
     end
 
-    ##
-    # Yield a browser object when iterating over the grid of browsers
-    def each
-      threads = []
-      id = 0
-      @browsers.each do |browser|
-        threads << Thread.new do 
-          id += 1
-          @log.debug(browser)
-          # yields a browser object, ID, hostname, architecture, type
-          yield(browser[2].new_browser, id, browser[4],browser[5],browser[6])
-        end
-      end
-      threads.each {|thread| thread.join}
-    end
-
     ##
     # Return the size (quantity) of browsers started on the grid
     def size
@@ -88,15 +75,37 @@ module Watir
     ##
     # Get all tuple spaces on ringserver
     def get_tuples(params = {})
-      if (params[:quantity].nil? or params[:quantity] == 0) then
+      quantity = calculate_quantity(params[:quantity]) 
+      read_tuples(params[:architecture], params[:browser_type])
+      @log.info("Found #{@tuples.size} tuples.")
+      if @tuples.size > -1 then
+        @tuples[0..quantity].each do |tuple|
+          if params[:hostnames]
+            filter_tuple_by_hostname(tuple, params)
+          else
+            add_tuple_to_browsers(tuple)
+            take_tuple(tuple) if params[:take_all] == true
+          end      
+        end
+      end
+    end
+
+    ##
+    # Sets the quantity (upper limit of array) of tuples to retrieve
+    # This is because some users prefer not to specify a zero based
+    # index when asking for n browsers
+    def calculate_quantity(quantity)
+      if (quantity.nil? or quantity == 0) then
         quantity = -1 
       else
-        quantity = params[:quantity] - 1
+        quantity -= 1
       end
-      architecture = params[:architecture] || nil
-      browser_type = params[:browser_type] || nil
-      
-      @browsers = []
+    end
+
+    ##
+    # Read all tuples filtered by architecture and browser type
+    # then populate the tuples accessor
+    def read_tuples(architecture, browser_type)
       @tuples = @ring_server.read_all([
         :name,
         nil, # watir provider
@@ -105,28 +114,44 @@ module Watir
         nil, # hostname
         architecture,
         browser_type])
+    end
 
-      @log.info("Found #{@tuples.size} tuples.")
-      if @tuples.size > 0 then
-         @log.debug("Iterating from 0 to #{quantity}")
-        @tuples[0..quantity].each do |tuple|
-          @log.debug("Iterating through #{@tuples.size} tuples")
-          hostname = tuple[4]
-          if params[:hostnames] then
-            if params[:hostnames][hostname] then
-              @browsers << tuple
-              @ring_server.take(tuple)if params[:take_all] == true
-            end
-          else
-            @browsers << tuple
-            @ring_server.take(tuple)if params[:take_all] == true
-          end
-        end
-      else
-        @browsers
+    ##
+    # Filter tuple by hostnames
+    def filter_tuple_by_hostname(tuple, params={})
+      hostname = tuple[4]
+      if (params[:hostnames][hostname]) then
+        add_tuple_to_browsers(tuple)
+        take_tuple(tuple) if params[:take_all] == true
       end
-      @browsers
     end
+
+    ##
+    # Add a tuple to the browsers accessor
+    def add_tuple_to_browsers(tuple)
+      @browsers <<  tuple_to_hash(tuple)
+    end
+
+    ##
+    # Take a tuple from the tuple space
+    def take_tuple(tuple)
+      @ring_server.take(tuple)
+    end
+
+    ##
+    # Convert tuple into a hash for easier handling
+    def tuple_to_hash(tuple)
+      tuple_hash = {}
+      tuple_hash[:name]         = tuple[0]
+      tuple_hash[:class]        = tuple[1]
+      tuple_hash[:object]       = tuple[2]
+      tuple_hash[:description]  = tuple[3]
+      tuple_hash[:hostname]     = tuple[4]
+      tuple_hash[:architecture] = tuple[5]
+      tuple_hash[:browser_type] = tuple[6]
+      tuple_hash
+    end
+  
   end
 
 end

data/spec/grid_spec.rb

@@ -14,37 +14,37 @@ describe 'WatirGrid' do
     end
   end
 
-  it 'should return how many browsers are available in the tuplespace' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:read_all => true)
-    browsers.size.should == 5
+  it 'should return how many grid are available in the tuplespace' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:read_all => true)
+    grid.size.should == 5
   end
 
-  it 'should read any 2 browsers in the tuplespace' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 2, :read_all => true)
-    browsers.size.should == 2
+  it 'should read any 2 grid in the tuplespace' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 2, :read_all => true)
+    grid.size.should == 2
   end
 
   it 'should take any 1 browser in the tuplespace' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1, :take_all => true)
-    browsers.size.should == 1 
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1, :take_all => true)
+    grid.size.should == 1 
   end
 
-  it 'should take all browsers remaining in tuplespace' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:take_all => true)
-    browsers.size.should == 4
+  it 'should take all grid remaining in tuplespace' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:take_all => true)
+    grid.size.should == 4
   end
 
-  it 'should find no more browsers in the tuplespace' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:read_all => true)
-    browsers.size.should == 0
+  it 'should find no more grid in the tuplespace' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:read_all => true)
+    grid.size.should == 0
   end
 
-  it 'should register 4 new browsers in the tuplespace' do
+  it 'should register 4 new grid in the tuplespace' do
     1.upto(4) do 
       provider = Provider.new(:ring_server_port => 12351, 
         :loglevel => Logger::ERROR, :browser_type => 'safari')
@@ -53,82 +53,86 @@ describe 'WatirGrid' do
   end
 
   it 'should take any 1 browser based on browser type' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1,
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1,
       :take_all => true, :browser_type => 'safari')
-    browsers.size.should == 1
+    grid.size.should == 1
   end
 
-  it 'should fail to find any browsers based on a specific browser type' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1,
+  it 'should fail to find any grid based on a specific browser type' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1,
       :take_all => true, :browser_type => 'firefox')
-    browsers.size.should == 0
+    grid.size.should == 0
   end
 
-  it 'should fail to find any browsers based on a unknown browser type' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1,
+  it 'should fail to find any grid based on a unknown browser type' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1,
       :take_all => true, :browser_type => 'penguin')
-    browsers.size.should == 0
+    grid.size.should == 0
   end
 
   it 'should take any 1 browser based on specific architecture type' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1, 
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1, 
       :take_all => true, :architecture => 'universal-darwin10.0')
-    browsers.size.should == 1
+    grid.size.should == 1
   end
 
-  it 'should fail to find any browsers based on unknown architecture type' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1, 
+  it 'should fail to find any grid based on unknown architecture type' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1, 
       :take_all => true, :architecture => 'geos-1992')
-    browsers.size.should == 0
+    grid.size.should == 0
   end
 
   it 'should take any 1 browser based on specific hostname' do
     hostname = `hostname`.strip
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1,
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1,
       :take_all => true, 
       :hostnames => { hostname => "127.0.0.1"}
       )
-    browsers.size.should == 1
+    grid.size.should == 1
   end
 
-  it 'should fail to find any browsers based on unknown hostname' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1,
+  it 'should fail to find any grid based on unknown hostname' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1,
       :take_all => true, :hostnames => { 
         "tokyo" => "127.0.0.1"})
-    browsers.size.should == 0
+    grid.size.should == 0
   end
 
   it 'should take the last browser and execute some watir commands' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:quantity => 1,
-      :take_all => true)
-      browsers.each do |browser, browser_id, hostname, arch, type|
-        browser_id.should == 1
-        hostname.should == `hostname`.strip
-        arch.should == Config::CONFIG['arch']
-        type.should == 'safari'
-        browser.goto(
-          "http://localhost:4567/load/#{browser_id}/#{browser.object_id}")
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:quantity => 1, :take_all => true)
+    threads = []
+    grid.browsers.each do |browser|
+      threads << Thread.new do 
+        browser[:hostname].should == `hostname`.strip
+        browser[:architecture].should == Config::CONFIG['arch']
+        browser[:browser_type].should == 'safari'
+        b = browser[:object].new_browser
+        b.goto("http://www.google.com")
+        b.text_field(:name, 'q').set("watirgrid")
+        b.button(:name, "btnI").click
       end
-    browsers.size.should == 1
+    end
+    threads.each {|thread| thread.join}
+    grid.size.should == 1
   end
 
-  it 'should find no more browsers in the tuplespace' do
-    browsers = Watir::Grid.new(:ring_server_port => 12351)
-    browsers.start(:read_all => true)
-    browsers.size.should == 0
+  it 'should find no more grid in the tuplespace' do
+    grid = Watir::Grid.new(:ring_server_port => 12351)
+    grid.start(:read_all => true)
+    grid.size.should == 0
   end
 
   it 'should register a new browser on a remote provider' do
     pending('provision of remote registration') do
-      browsers.size.should == 0
+      grid.size.should == 0
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: watirgrid
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3b
 platform: ruby
 authors: 
 - Tim Koopmans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-16 00:00:00 +11:00
+date: 2009-12-05 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,6 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- TODO.rdoc
 - bin/controller
 - bin/provider
 - examples/simple.rb
@@ -70,9 +69,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
   version: 
 requirements: []
 

data/TODO.rdoc

@@ -1,16 +0,0 @@
-=== Grid
-- Specify rampup times
- 
-=== Providers
-- Remote registration of providers
-- Re-write tuple space during tear down
-- Response times
-- Network breakdown times
-
-=== Protocols
-- Support for tcp or http?
-
-=== Tests
-- How many providers is possible with druby?
-- Performance comparison proxied objects (DRbUndumped) vs. copied objects
-