watirgrid 1.0.4.pre → 1.0.4

data/README.rdoc

@@ -12,9 +12,9 @@ WatirGrid is built on Rinda which implements the Linda distributed computing par
 In other words, WatirGrid allows multiple parallel processes to *_provide_* remote Watir objects in the form of tuple spaces across a grid network. This grid network is *_controlled_* by a ring server.
 
 ==== Key Terminology
-The *controller* implements a repository of tuples (tuple space) that can be accessed concurrently. The controller hosts the *ring* *server* which advertises these tuples across a grid network making it loosely coupled. Typically you will host one controller on a central machine.
+The *controller* implements a repository of tuples (tuple space) that can be accessed concurrently. The controller also hosts a *ring* *server* which advertises these tuples across a grid network making it loosely coupled. Typically you will host one controller on a central machine. You will normally connect to this controller via a direct URI. You can also find this controller by its ring server, using a UDP broadcast for the ring server port.
 
-The *providers* make remote Watir objects available to the tuple space hosted by the *ring* *server*. Typically you will host one or many providers on your grid network, for example, each PC may become a single provider of a Watir tuple in the form of an Internet Explorer, Firefox or Safari browser object.
+The *providers* make remote Watir objects available to the tuple space hosted by the *controller*. Typically you will host one or many providers on your grid network, for example, each PC may become a single provider of a Watir tuple in the form of an Internet Explorer, Firefox, Safari or WebDriver browser object.
 
 === Simple Example
 
@@ -22,51 +22,51 @@ Pick a server to host the 'controller' for the ring server and execute the follo
   $ controller
 
 This should find your external facing IP and start the corresponding DRb and Ring Servers:
-  Controller started on : druby://143.238.105.61:11235
-  Ring server started on: druby://143.238.105.61:12358
+  I, [2011-04-09 18:06:19 #1971]  INFO -- : Controller started on : druby://127.0.0.1:11235
 
 On each client PC, host the 'provider' for the distributed (DRb) Watir objects
-  $  provider
+  $  provider -b ie -c druby://127.0.0.1:11235
 
 This should find the recently started Ring Server and register a tuple for the Watir object:
-  Provider started on   : druby://143.238.105.61:11236
-  Controller found on   : druby://143.238.105.61:11355
-  New tuple registered  : druby://143.238.105.61:11355
+  I, [2011-04-09 18:06:26 #1972]  INFO -- : Provider started on   : druby://127.0.0.1:11236
+  I, [2011-04-09 18:06:26 #1972]  INFO -- : Controller found on   : druby://127.0.0.1:11235
+  I, [2011-04-09 18:06:26 #1972]  INFO -- : Provider registered   : druby://127.0.0.1:11235
 
 You will now be able to execute commands across remote browsers on your grid network.
 
 e.g.
-  Watir::Grid.control(:controller_uri => 'druby://143.238.105.61:11355') do |browser, id|
-      browser.goto("http://www.google.com")
-      browser.text_field(:name, 'q').set("watirgrid")
-      browser.button(:name, "btnI").click
-    end
+  require 'watirgrid'
+
+  Watir::Grid.control(:controller_uri => 'druby://127.0.0.1:11235') do |browser, id|
+    puts "My remote browser id is #{id}"
+    browser.goto("http://www.google.com")
+    browser.text_field(:name, 'q').set("watirgrid")
+    browser.button(:name, "btnI").click
   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
   Usage: controller [options]
   Specific options:
-      -H, --drb-server-host HOST       Specify DRb Server interface to host on
-      -d, --drb-server-port PORT       Specify DRb Server port to listen on
-      -h, --ring-server-host HOST      Specify Ring Server interface to host on
-      -r, --ring-server-port PORT      Specify Ring Server port to listen on
-      -a, --access-control-list ACLS   Specify a comma separated Access Control List
-      -l, --log-level LEVEL            Specify log level {DEBUG|INFO|ERROR}
+      -H, --drb-server-host [HOST]       Specify DRb Server interface to host on
+      -d, --drb-server-port [PORT]       Specify DRb Server port to listen on
+      -h, --ring-server-host [HOST]      Specify Ring Server interface to host on
+      -r, --ring-server-port [PORT]      Specify Ring Server port to listen on
+      -a, --access-control-list [ACLS]   Specify a comma separated Access Control List
+      -l, --log-level [LEVEL]            Specify log level {DEBUG|INFO|ERROR}
           --help                       Show this message
 
   $  provider --help
-  Usage: provider [options]
+  Usage: Usage: provider -b BROWSER_TYPE [options]
   Specific options:
-      -H, --drb-server-host HOST       Specify DRb Server interface to host on
-      -d, --drb-server-port PORT       Specify DRb Server port to listen on
-      -h, --ring-server-host HOST      Specify Ring Server host to connect to
-      -r, --ring-server-port PORT      Specify Ring Server port to broadcast on
-      -c, --controller-uri URI         Specify Controller URI e.g. druby://127.0.0.1:11235 to bypass Ring Server
       -b, --browser-type TYPE          Specify browser type to register {ie|firefox|safari|webdriver}
-      -a, --access-control-list ACLS   Specify a comma separated Access Control List
-      -l, --log-level LEVEL            Specify log level {DEBUG|INFO|ERROR}
+      -c, --controller-uri [URI]       Specify Controller URI e.g. druby://127.0.0.1:11235
+      -H, --drb-server-host [HOST]     Specify DRb Server interface to host on
+      -d, --drb-server-port [PORT]     Specify DRb Server port to listen on
+      -h, --ring-server-host [HOST]    Specify Ring Server host to connect to
+      -r, --ring-server-port [PORT]    Specify Ring Server port to broadcast on
+      -a, --access-control-list [ACL]  Specify a comma separated Access Control List
+      -l, --log-level [LEVEL]          Specify log level {DEBUG|INFO|ERROR}
           --help                       Show this message
 
 == Copyright

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.email = "tim.koops@gmail.com"
     gem.homepage = "http://github.com/90kts/watirgrid"
     gem.authors = ["Tim Koopmans"]
-    gem.version = "1.0.4.pre"
+    gem.version = "1.0.4"
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"

data/bin/controller

@@ -9,33 +9,33 @@ OptionParser.new do |opts|
   opts.banner = "Usage: controller [options]"
   opts.separator ""
   opts.separator "Specific options:"
-  opts.on("-H HOST", "--drb-server-host", String, 
+  opts.on("-H", "--drb-server-host [HOST]", String,
   "Specify DRb Server interface to host on") do |h|
     options[:drb_server_host] = h || nil
   end
-  opts.on("-d PORT", "--drb-server-port", Integer, 
+  opts.on("-d", "--drb-server-port [PORT]", Integer,
     "Specify DRb Server port to listen on") do |d|
       options[:drb_server_port] = d
-  end              
-  opts.on("-h HOST", "--ring-server-host", String, 
+  end
+  opts.on("-h", "--ring-server-host [HOST]", String,
   "Specify Ring Server interface to host on") do |h|
     options[:ring_server_host] = h || nil
   end
-  opts.on("-r PORT", "--ring-server-port", Integer, 
+  opts.on("-r", "--ring-server-port [PORT]", Integer,
     "Specify Ring Server port to listen on") do |r|
-      options[:ring_server_port] = r 
+      options[:ring_server_port] = r
   end
-  opts.on("-a ACLS", "--access-control-list", Array,
+  opts.on("-a", "--access-control-list [ACLS]", Array,
     "Specify a comma separated Access Control List") do |a|
       options[:acls] = a
   end
-  opts.on("-l LEVEL", "--log-level", String, 
+  opts.on("-l", "--log-level [LEVEL]", String,
     "Specify log level {DEBUG|INFO|ERROR}") do |l|
       case l
       when 'DEBUG'
         options[:loglevel] = Logger::DEBUG
       when 'INFO'
-        options[:loglevel] = Logger::INFO 
+        options[:loglevel] = Logger::INFO
       when 'ERROR'
         options[:loglevel] = Logger::ERROR
       else
@@ -49,9 +49,9 @@ OptionParser.new do |opts|
   end.parse!
 
 controller = Controller.new(
-  :drb_server_host => options[:drb_server_host],
-  :drb_server_port  => options[:drb_server_port]  || 11235, 
-  :ring_server_host => options[:ring_server_host], 
+  :drb_server_host  => options[:drb_server_host],
+  :drb_server_port  => options[:drb_server_port]  || 11235,
+  :ring_server_host => options[:ring_server_host],
   :ring_server_port => options[:ring_server_port] || 12358,
   :acls => options[:acls] || %w{ allow all },
   :loglevel => options[:loglevel]

data/bin/provider

@@ -5,39 +5,39 @@ require 'provider'
 require 'optparse'
 
 options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: provider [options]"
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: provider -b BROWSER_TYPE [options]"
   opts.separator ""
   opts.separator "Specific options:"
-  opts.on("-H HOST", "--drb-server-host", String,
+  opts.on("-b", "--browser-type TYPE",
+  "Specify browser type to register {ie|firefox|safari|webdriver}") do |b|
+    options[:browser_type] = b
+  end
+  opts.on("-c", "--controller-uri [URI]",
+  "Specify Controller URI e.g. druby://127.0.0.1:11235") do |h|
+    options[:controller_uri] = h || nil
+  end
+  opts.on("-H", "--drb-server-host [HOST]",
   "Specify DRb Server interface to host on") do |h|
     options[:drb_server_host] = h || nil
   end
-  opts.on("-d PORT", "--drb-server-port", Integer,
+  opts.on("-d", "--drb-server-port [PORT]",
     "Specify DRb Server port to listen on") do |d|
       options[:drb_server_port] = d
   end
-  opts.on("-h HOST", "--ring-server-host", String,
+  opts.on("-h", "--ring-server-host [HOST]",
   "Specify Ring Server host to connect to") do |h|
     options[:ring_server_host] = h || nil
   end
-  opts.on("-r PORT", "--ring-server-port", Integer,
+  opts.on("-r", "--ring-server-port [PORT]",
   "Specify Ring Server port to broadcast on") do |r|
     options[:ring_server_port] = r
   end
-  opts.on("-c URI", "--controller-uri", String,
-  "Specify Controller URI e.g. druby://127.0.0.1:11235 to bypass Ring Server") do |h|
-    options[:controller_uri] = h || nil
-  end
-  opts.on("-b TYPE", "--browser-type", String,
-  "Specify browser type to register {ie|firefox|safari}") do |b|
-    options[:browser_type] = b
-  end
-  opts.on("-a ACLS", "--access-control-list", Array,
+  opts.on("-a", "--access-control-list [ACL]", Array,
     "Specify a comma separated Access Control List") do |a|
       options[:acls] = a
   end
-  opts.on("-l LEVEL", "--log-level", String,
+  opts.on("-l", "--log-level [LEVEL]",
   "Specify log level {DEBUG|INFO|ERROR}") do |l|
     case l
     when 'DEBUG'
@@ -54,7 +54,22 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
-end.parse!
+end
+
+begin
+  optparse.parse!
+  mandatory = [:browser_type]
+  missing = mandatory.select{ |param| options[param].nil? }
+  if not missing.empty?
+    puts "Missing options: #{missing.join(', ')}"
+    puts optparse
+    exit
+  end
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+  puts $!.to_s
+  puts optparse
+  exit
+end
 
 provider = Provider.new(
   :drb_server_host  => options[:drb_server_host],

data/lib/controller.rb

@@ -46,8 +46,6 @@ class Controller
     @log  = Logger.new(logfile, 'daily')
     @log.level = params[:loglevel] || Logger::INFO
     @log.datetime_format = "%Y-%m-%d %H:%M:%S "
-
-    @log.debug("DRB Server Port #{@drb_server_port}\nRing Server Port #{@ring_server_port}")
   end
 
   ##
@@ -73,7 +71,7 @@ class Controller
 
     # obtain Ring Server uri
     @ring_server_uri = ring_server.uri
-    @log.info("Ring server started on: #{@ring_server_uri}")
+    @log.debug("Ring Server started   : #{@ring_server_uri}")
 
     # abort all threads on an exception
     Thread.abort_on_exception = true
@@ -86,7 +84,7 @@ class Controller
   # Stop the controller by shutting down the DRb service
   def stop
     DRb.stop_service
-    @log.info("Controller stopped on: #{@drb_server_uri}")
+    @log.info("Controller stopped on : #{@drb_server_uri}")
   end
 
   private

data/lib/provider.rb

@@ -156,9 +156,8 @@ class Provider
   # Start providing watir objects on the ring server
   def start
     # create a DRb 'front' object
-    @log.debug("About to create a watir_provider")
     watir_provider = Watir::Provider.new(@browser_type)
-    @log.debug("watir_provider is #{watir_provider}")
+    @log.debug("Watir provider is     : #{watir_provider}")
     architecture = Config::CONFIG['arch']
     hostname = ENV['SERVER_NAME'] || %x{hostname}.strip
 
@@ -185,14 +184,14 @@ class Provider
               ]
 
     # locate the Rinda Ring Server via a UDP broadcast
-    @log.debug("Attempting to find ring server on : druby://#{@ring_server_host}:#{@ring_server_port}")
+    @log.debug("Broadcast Ring Server : druby://#{@ring_server_host}:#{@ring_server_port}")
     find_ring_server
 
     # advertise this service on the primary remote tuple space
     @ring_server.write(@tuple, @renewer)
 
     # log DRb server uri
-    @log.info("New tuple registered  : #{@controller_uri}")
+    @log.info("Provider registered   : #{@controller_uri}")
 
     # wait for explicit stop via ctrl-c
     DRb.thread.join if __FILE__ == $0
@@ -202,7 +201,7 @@ class Provider
   # Stop the provider by shutting down the DRb service
   def stop
     DRb.stop_service
-    @log.info("DRb server stopped on : #{@drb_server_uri}")
+    @log.info("Provider stopped on   : #{@drb_server_uri}")
   end
 
   private

data/lib/watirgrid.rb

@@ -107,7 +107,7 @@ module Watir
       drb_server = DRb.start_service(
         "druby://#{@drb_server_host}:#{@drb_server_port}")
       @drb_server_uri = drb_server.uri
-      @log.info("DRb server started on : #{@drb_server_uri}")
+      @log.info("Watir Grid started on : #{@drb_server_uri}")
     end
 
     ##

data/watirgrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{watirgrid}
-  s.version = "1.0.4.pre"
+  s.version = "1.0.4"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Koopmans"]
-  s.date = %q{2011-04-08}
+  s.date = %q{2011-04-09}
   s.description = %q{WatirGrid allows for distributed testing across a grid network using Watir.}
   s.email = %q{tim.koops@gmail.com}
   s.executables = ["controller", "listener", "provider"]

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: watirgrid
 version: !ruby/object:Gem::Version 
-  hash: 961915972
-  prerelease: 6
+  hash: 31
+  prerelease: 
   segments: 
   - 1
   - 0
   - 4
-  - pre
-  version: 1.0.4.pre
+  version: 1.0.4
 platform: ruby
 authors: 
 - Tim Koopmans
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-08 00:00:00 -07:00
+date: 2011-04-09 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -81,14 +80,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: