selenium-rc 0.0.1 → 2.1.0

data/CHANGES

@@ -0,0 +1,9 @@
+1.8.20090512
+  Fixed bug where bin/selenium-rc did not stay open
+
+1.7.20090512
+  Properly handling Errno::EADDRNOTAVAIL when starting on windows.
+
+1.6.20090512
+  Properly terminate server when the process exits.
+  Fixed server blocking the process issue.

data/README.markdown

@@ -0,0 +1,5 @@
+# selenium-rc #
+
+Ruby wrapper for the Selenium RC jar. Bundles the jar and provides a binary and Rake tasks to manage them.
+
+Selenium RC Home Page: [http://seleniumhq.org/projects/remote-control](http://seleniumhq.org/projects/remote-control)

data/RELEASING

@@ -0,0 +1,14 @@
+In order to build the gem you need to have Joe installed.
+The full README is located at http://github.com/djanowski/joe,
+but if you're in a rush this is the list of things to do:
+
+  $ sudo gem install rubyforge
+  $ rubyforge setup
+  $ rubyforge config
+
+  $ sudo gem install thor
+  $ thor install http://dimaion.com/joe/joe.thor
+
+And finally,
+
+  $ thor joe:release

data/Rakefile

@@ -0,0 +1,9 @@
+require "spec"
+require "spec/rake/spectask"
+
+task :default => :spec
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/Thorfile

@@ -0,0 +1,25 @@
+require "zip/zip"
+
+class Joe < Thor
+  alias_method :joe_build, :build
+  def build
+    fetch_jar
+    joe_build
+  end
+
+  def fetch_jar
+    url = "http://release.seleniumhq.org/selenium-remote-control/1.0.1/selenium-remote-control-1.0.1-dist.zip"
+    file = File.join("tmp", File.basename(url))
+
+    FileUtils.mkdir_p("tmp")
+
+    system "wget #{url} -O #{file}" unless File.exist?(file)
+
+    Zip::ZipFile.open(file) do |zipfile|
+      jar_file_entry = zipfile.entries.find {|file| file.name =~ /selenium-server\.jar$/}
+      destination = "vendor/selenium-server.jar"
+      FileUtils.rm_rf(destination)
+      zipfile.extract(jar_file_entry, destination)
+    end
+  end
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 2
+:minor: 0
+:patch: 20090610
+:jar_url: http://release.seleniumhq.org/selenium-remote-control/1.0.1/selenium-remote-control-1.0.1-dist.zip

data/bin/selenium-rc

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "selenium_rc"))
+
+SeleniumRC::Server.boot(
+  ENV["SELENIUM_SERVER_HOST"] || "0.0.0.0",
+  ENV["SELENIUM_SERVER_PORT"],
+  :args => ARGV
+)
+
+sleep

data/lib/selenium_rc/server.rb

@@ -0,0 +1,101 @@
+module SeleniumRC
+
+  class Server
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :args
+    attr_accessor :timeout
+
+    def self.boot(*args)
+      new(*args).boot
+    end
+
+    def initialize(host, port = nil, options = {})
+      @host = host
+      @port = port || 4444
+      @args = options[:args] || []
+      @timeout = options[:timeout]
+    end
+
+    def boot
+      start
+      wait
+      stop_at_exit
+      self
+    end
+
+    def log(string)
+      puts string
+    end
+
+    def start
+      command = "java -jar \"#{jar_path}\""
+      command << " -port #{port}"
+      command << " #{args.join(' ')}" unless args.empty?
+      log "Running: #{command}"
+      begin
+        fork do
+          system(command)
+        end
+      rescue NotImplementedError
+        Thread.start do
+          system(command)
+        end
+      end
+    end
+
+    def stop_at_exit
+      at_exit do
+        stop
+      end
+    end
+
+    def jar_path
+      File.expand_path("#{File.dirname(__FILE__)}/../../vendor/selenium-server.jar")
+    end
+
+    def wait
+      $stderr.print "==> Waiting for Selenium RC server on port #{port}... "
+      wait_for_service_with_timeout
+      $stderr.print "Ready!\n"
+    rescue SocketError
+      fail
+    end
+
+    def fail
+      $stderr.puts
+      $stderr.puts
+      $stderr.puts "==> Failed to boot the Selenium RC server... exiting!"
+      exit
+    end
+
+    def stop
+      Net::HTTP.get(host, '/selenium-server/driver/?cmd=shutDownSeleniumServer', port)
+    end
+
+    def service_is_running?
+      begin
+        socket = TCPSocket.new(host, port)
+        socket.close unless socket.nil?
+        true
+      rescue Errno::ECONNREFUSED,
+             Errno::EBADF,           # Windows
+             Errno::EADDRNOTAVAIL    # Windows
+        false
+      end
+    end
+
+    protected
+    def wait_for_service_with_timeout
+      start_time = Time.now
+      timeout = 15
+
+      until service_is_running?
+        if timeout && (Time.now > (start_time + timeout))
+          raise SocketError.new("Socket did not open within #{timeout} seconds")
+        end
+      end
+    end
+  end
+
+end

data/lib/selenium_rc.rb

@@ -0,0 +1,4 @@
+dir = File.dirname(__FILE__)
+require "socket"
+require "#{dir}/selenium_rc/server"
+require "net/http"

data/spec/bin_selenium_rc_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
+
+describe "bin/selenium-rc" do
+  attr_reader :root_dir
+  before do
+    dir = File.dirname(__FILE__)
+    @root_dir = File.expand_path("#{dir}/..")
+    unless File.exists?("#{root_dir}/vendor/selenium-server.jar")
+      raise "vendor/selenium-server.jar does not exist. Try running `rake download_jar_file` to install the jar file."
+    end
+  end
+
+  it "starts the SeleniumRC server from the downloaded jar file and terminates it when finished" do
+    thread = nil
+    Dir.chdir(root_dir) do
+      thread = Thread.start do
+        system("bin/selenium-rc") || raise("bin/selenium-server failed")
+      end
+    end
+
+    server = SeleniumRC::Server.new("0.0.0.0")
+
+    timeout {server.service_is_running?}
+    thread.kill
+    Lsof.kill(4444)
+    timeout {!server.service_is_running?}
+  end
+
+  def timeout
+    start_time = Time.now
+    timeout_length = 15
+    until yield
+      if Time.now > (start_time + timeout_length)
+        raise SocketError.new("Socket did not open within #{timeout_length} seconds")
+      end
+    end
+  end
+end

data/spec/selenium_rc/server_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+module SeleniumRC
+  describe Server do
+
+    def new_server(*args)
+      server = Server.new(*args)
+      stub(server).log
+      stub(server).fork.yields
+      server
+    end
+
+    describe "#start" do
+      it "launches java with the jar file and port" do
+        @server = new_server("0.0.0.0", 5555)
+
+        expected_command = %Q{java -jar "/path/to/the.jar" -port 5555}
+        mock(@server).system(expected_command)
+        mock(@server).jar_path {"/path/to/the.jar"}
+        @server.start
+      end
+
+      context "when passed additional arguments" do
+        it "adds the additional arguments to the selenium start command" do
+          @server = new_server("0.0.0.0", 4444, :args => ["-browserSideLog", "-suppressStupidness"])
+          expected_command = %Q{java -jar "/path/to/the.jar" -port 4444 -browserSideLog -suppressStupidness}
+          mock(@server).system(expected_command)
+          mock(@server).jar_path {"/path/to/the.jar"}
+          @server.start
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "rubygems"
+require "spec"
+require "spec/autorun"
+require "fileutils"
+require "timeout"
+require "tcp_socket_extension"
+require "rr"
+require "lsof"
+
+dir = File.dirname(__FILE__)
+$:.unshift(File.expand_path("#{dir}/../lib"))
+require "selenium_rc"
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

data/spec/spec_suite.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/**/*_spec.rb"].each do |file|
+  require file
+end

metadata

@@ -1,15 +1,18 @@
 --- !ruby/object:Gem::Specification 
 name: selenium-rc
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 2.1.0
 platform: ruby
 authors: 
-- Damian Janowski
+- Pivotal Labs
+- Nate Clark
+- Brian Takita
+- Chad Woolley
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-07-20 00:00:00 -03:00
+date: 2009-07-23 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,26 +25,37 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.16
     version: 
-description: ""
-email: damian.janowski@gmail.com
-executables: []
-
+description: The Selenium RC Server packaged as a gem
+email: pivotallabsopensource@googlegroups.com
+executables: 
+- selenium-rc
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.markdown
 files: 
-- LICENSE
-- lib/selenium/rc_server.rb
-- test/rc_server_test.rb
+- CHANGES
+- Rakefile
+- README.markdown
+- RELEASING
+- Thorfile
+- VERSION.yml
+- bin/selenium-rc
+- lib/selenium_rc/server.rb
+- lib/selenium_rc.rb
+- spec/bin_selenium_rc_spec.rb
+- spec/selenium_rc/server_spec.rb
+- spec/spec_helper.rb
+- spec/spec_suite.rb
+- vendor/empty.txt
 - vendor/selenium-server.jar
 has_rdoc: true
-homepage: 
+homepage: http://github.com/pivotal/selenium-rc
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -62,6 +76,9 @@ rubyforge_project: seleniumrc
 rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
-summary: Selenium RC Server
-test_files: []
-
+summary: The Selenium RC Server packaged as a gem.
+test_files: 
+- spec/bin_selenium_rc_spec.rb
+- spec/selenium_rc/server_spec.rb
+- spec/spec_helper.rb
+- spec/spec_suite.rb

data/LICENSE

@@ -1,20 +0,0 @@
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.

data/lib/selenium/rc_server.rb

@@ -1,90 +0,0 @@
-require "selenium/client"
-
-module Selenium
-  class RCServer
-    attr :host
-    attr :port
-    attr :options
-
-    def initialize(host, port, options = {})
-      @host, @port, @options = host, port, options
-    end
-
-    def boot
-      return if selenium_grid?
-
-      start
-      wait
-      stop_at_exit
-    end
-
-    def start
-      silence_stream($stdout) do
-        remote_control.start :background => true
-      end
-    end
-
-    def stop_at_exit
-      at_exit do
-        stop
-      end
-    end
-
-    def remote_control
-      @remote_control ||= begin
-        rc = ::Selenium::RemoteControl::RemoteControl.new(host, port, options)
-        rc.jar_file = jar_path
-        rc
-      end
-    end
-
-    def jar_path
-      File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "vendor", "selenium-server.jar"))
-    end
-
-    def selenium_grid?
-      !! host
-    end
-
-    def wait
-      $stderr.print "==> Waiting for Selenium RC server on port #{port}... "
-      wait_for_socket
-      $stderr.print "Ready!\n"
-    rescue SocketError
-      fail
-    end
-
-    def wait_for_socket
-      silence_stream($stdout) do
-        TCPSocket.wait_for_service_with_timeout \
-          :host     => host || "0.0.0.0",
-          :port     => port,
-          :timeout  => 15 # seconds
-      end
-    end
-
-    def fail
-      $stderr.puts
-      $stderr.puts
-      $stderr.puts "==> Failed to boot the Selenium RC server... exiting!"
-      exit
-    end
-
-    def stop
-      silence_stream($stdout) do
-        remote_control.stop
-      end
-    end
-
-  protected
-
-    def silence_stream(stream)
-      old_stream = stream.dup
-      stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
-      stream.sync = true
-      yield
-    ensure
-      stream.reopen(old_stream)
-    end
-  end
-end

data/test/rc_server_test.rb

@@ -1,57 +0,0 @@
-require "rubygems"
-
-require File.join(File.dirname(__FILE__), "..", "lib", "selenium", "rc_server")
-
-require "contest"
-require "override"
-
-# Make sure we're not trying to start or stop.
-Selenium::RemoteControl::RemoteControl = Class.new(Selenium::RemoteControl::RemoteControl) do
-  def start(*args)
-    raise "Can't actually call #start in tests."
-  end
-  
-  def stop(*args)
-    raise "Can't actually call #stop in tests."
-  end
-end
-
-class RCServerTest < Test::Unit::TestCase
-  include Override
-
-  setup do
-    @server = Selenium::RCServer.new(nil, "1234", :timeout => 10)
-    @rc = @server.remote_control
-  end
-
-  should "have a remote control instance" do
-    assert_nil @rc.host
-    assert_equal "1234", @rc.port
-    assert_equal 10, @rc.timeout_in_seconds
-    assert_equal File.expand_path(File.join(File.dirname(__FILE__), "..", "vendor", "selenium-server.jar")), @rc.jar_file
-  end
-
-  should "start" do
-    expect(@rc, :start, :with => [{:background => true}])
-    @server.start
-  end
-
-  should "stop" do
-    expect(@rc, :stop, :with => [])
-    @server.stop
-  end
-
-  should "boot" do
-    expect(@rc, :start, :with => [{:background => true}])
-    expect(TCPSocket, :wait_for_service_with_timeout, :with => [{:host => "0.0.0.0", :port => "1234", :timeout => 15}])
-    expect(@rc, :stop, :with => [])
-
-    @server.boot
-  end
-
-  should "not boot if it's a grid" do
-    server = Selenium::RCServer.new("127.0.0.1", "1234", :timeout => 10)
-
-    assert_nil server.boot
-  end
-end