selenium-rc 2.2.4 → 2.3.0

data/.gitignore

@@ -0,0 +1,5 @@
+.idea
+.rvmrc
+/pkg
+/tmp
+/vendor/selenium-server.jar

data/CHANGES

@@ -1,3 +1,14 @@
+2.3.0
+  Updating Selenium jar to v2.0 [b1]
+  fixes bug on some Linux machines where server would not actually be ready for connections even though it was reported as ready
+  renaming library to the same name as the gem ('selenium-rc')
+  exposes the selenium-server.jar path as a class method (SeleniumRC::Server.jar_path)
+  adding Gemfile and development/test dependencies
+  adding more detailed documentation
+
+2.2.4
+  Updating Selenium jar to v2.0 [a4]
+
 1.8.20090512
   Fixed bug where bin/selenium-rc did not stay open
 

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    selenium-rc (2.3.0)
+      selenium-client (>= 1.2.18)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    gem-release (0.0.16)
+    lsof (0.3.0)
+    rr (1.0.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rubyzip (0.9.4)
+    selenium-client (1.2.18)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gem-release
+  lsof
+  rr
+  rspec (>= 2.5.0)
+  rubyzip
+  selenium-rc!
+  thor

data/MIT.LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Pivotal Labs
+
+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/README.markdown

@@ -1,5 +1,49 @@
 # selenium-rc #
 
-Ruby wrapper for the Selenium RC jar. Bundles the jar and provides a binary and Rake tasks to manage them.
+_selenium-rc_ is a convenient ruby wrapper for the Selenium Standalone Server jar (formerly Selenium RC Server) packaged as a gem. This gem bundles the latest selenium-server-standalone-{version}.jar file and provides a binary and Ruby library to manage it.
 
-Selenium RC Home Page: [http://seleniumhq.org/projects/remote-control](http://seleniumhq.org/projects/remote-control)
+### Version ###
+
+The current version of this gem (2.3.0) packages **Selenium Standalone Server 2.0 [b1]**
+
+### Basic Ruby Usage ###
+
+    server = SeleniumRC::Server.boot('localhost')
+    #=> Starts a Selenium Server accessible via http://localhost:4444 (the default port)
+
+    server = SeleniumRC::Server.boot('localhost', 8888)
+    #=> Starts a Selenium Server accessible via http://localhost:8888
+
+    server = SeleniumRC::Server.boot('localhost', 8888, :args => ["-browserSideLog", "-suppressStupidness"])
+    #=> Starts a Selenium Server accessible via http://localhost:8888 and passes arbitrary options to Selenium
+
+    server = SeleniumRC::Server.boot('localhost', 8888, :timeout => 120)
+    #=> Starts a Selenium Server accessible via http://localhost:8888 and waits 120 seconds before timing out
+
+    server.stop
+    #=> Stops the running Selenium Server
+
+### Basic Command Line Usage ###
+
+    $ selenium-rc
+    #=> Starts a Selenium Server on localhost and the default port (4444)
+
+    $ export SELENIUM_SERVER_PORT=8888
+    $ selenium-rc
+    #=> Starts a Selenium Server on localhost on port 8888
+
+### License ###
+This software redistributes the Selenium Standalone Server (selenium-server.jar) in an *unmodified* form.
+The Selenium Server is licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+All other software contained within is licensed under the MIT License. See the MIT.LICENSE file in this project for details
+
+### Links & More Info ###
+
+[SeleniumHQ](http://seleniumhq.org/)
+
+[Selenium Project on Google Code](http://code.google.com/p/selenium/)
+
+[Pivotal Labs](http://pivotallabs.com)
+
+Copyright (c) 2010-2011 Pivotal Labs. This software is licensed under the MIT License.

data/RELEASING

@@ -1,14 +1,7 @@
-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:
+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
+  $ bundle install      #=> Get yer dependencies
+  * edit Thorfile with the path to the latest Selenium Jar
+  $ thor joe:download   #=> downloads the latest Selenium Jar file
+  $ rake                #=> make sure they're green
+  $ gem build selenium-rc.gemspec

data/Rakefile

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

data/Thorfile

@@ -1,13 +1,9 @@
 require "zip/zip"
 
 class Joe < Thor
-  desc "build", "builds the selenium-rc gem"
-  def build
-    fetch_jar
-  end
-
-  def fetch_jar
-    url = "http://selenium.googlecode.com/files/selenium-server-standalone-2.0a4.jar"
+  desc "download", "download the Selenium jar file from Google Code repository"
+  def download
+    url = "http://selenium.googlecode.com/files/selenium-server-standalone-2.0b1.jar"
     file = File.join("tmp", File.basename(url))
 
     FileUtils.mkdir_p("tmp")

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
 :major: 2
-:minor: 2
-:patch: 4
+:minor: 3
+:patch: 0

data/bin/selenium-rc

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "selenium_rc"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "selenium-rc"))
 
 SeleniumRC::Server.boot(
   ENV["SELENIUM_SERVER_HOST"] || "0.0.0.0",

data/lib/selenium-rc.rb

@@ -0,0 +1,2 @@
+require 'selenium_rc/server'
+require 'net/http'

data/lib/selenium_rc.rb

@@ -1,4 +1,2 @@
-dir = File.dirname(__FILE__)
-require "socket"
-require "#{dir}/selenium_rc/server"
-require "net/http"
+warn '[DEPRECATION] the library for selenium-rc has been changed to \'selenium-rc.rb\' instead of \'selenium_rc.rb\'. Please update your `require` statements, or use Bundler to automatically require the correct library.'
+require 'selenium-rc'

data/lib/selenium_rc/server.rb

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

data/selenium-rc.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name                = %q{selenium-rc}
+  s.version             = "2.3.0"
+  s.platform            = Gem::Platform::RUBY
+
+  s.description         = %q{The Selenium Server packaged as a gem}
+  s.summary             = %q{The Selenium Server packaged as a gem}
+  s.authors             = ["Pivotal Labs, Inc.", "Nate Clark", "Brian Takita", "Chad Woolley", "Matthew Kocher"]
+  s.email               = %q{pivotallabsopensource@googlegroups.com}
+  s.homepage            = %q{http://github.com/pivotal/selenium-rc}
+
+  s.rdoc_options        = ["--charset=UTF-8"]
+  s.extra_rdoc_files    = ["README.markdown"]
+
+  s.files               = `git ls-files`.split("\n").unshift('vendor/selenium-server.jar')
+  s.executables         = %w{selenium-rc}
+  s.default_executable  = %q{selenium-rc}
+  s.test_files          = `git ls-files -- spec/*`.split("\n")
+  s.require_paths       = %w{lib}
+
+  s.add_dependency "selenium-client", ">= 1.2.18"
+  s.add_development_dependency 'rspec', '>= 2.5.0'
+  s.add_development_dependency 'rr'
+  s.add_development_dependency 'thor'
+  s.add_development_dependency 'lsof'
+  s.add_development_dependency 'rubyzip'
+  s.add_development_dependency 'gem-release'  
+end

data/spec/bin_selenium_rc_spec.rb

@@ -1,12 +1,10 @@
-require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
+require 'spec_helper'
 
 describe "bin/selenium-rc" do
-  attr_reader :root_dir
+  let(:root_dir) { File.expand_path("#{File.dirname(__FILE__)}/..") }
   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."
+      raise "vendor/selenium-server.jar does not exist. Try running `thor joe:download` to install the jar file."
     end
   end
 
@@ -20,18 +18,18 @@ describe "bin/selenium-rc" do
 
     server = SeleniumRC::Server.new("0.0.0.0")
 
-    timeout {server.service_is_running?}
+    timeout { server.ready? }
     thread.kill
     Lsof.kill(4444)
-    timeout {!server.service_is_running?}
+    timeout { !server.ready? }
   end
 
   def timeout
     start_time = Time.now
-    timeout_length = 15
+    timeout = 15
     until yield
-      if Time.now > (start_time + timeout_length)
-        raise SocketError.new("Socket did not open/close within #{timeout_length} seconds")
+      if Time.now > (start_time + timeout)
+        raise SeleniumRC::ServerNotStarted.new("Selenium Server was not ready for connections after #{timeout} seconds")
       end
     end
   end

data/spec/selenium_rc/server_spec.rb

@@ -1,33 +1,52 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+require 'spec_helper'
 
-module SeleniumRC
-  describe Server do
+describe SeleniumRC::Server do
 
-    def new_server(*args)
-      server = Server.new(*args)
-      stub(server).log
-      stub(server).fork.yields
-      server
+  def new_server(*args)
+    server = SeleniumRC::Server.new(*args)
+    stub(server).log
+    stub(server).fork.yields
+    server
+  end
+
+  describe ".boot" do
+    let(:server) { new_server('localhost', 5555, {:timeout => 1}) }
+
+    before do
+      mock(server).start { true }
     end
 
-    describe "#start" do
-      it "launches java with the jar file and port" do
-        @server = new_server("0.0.0.0", 5555)
+    context "when the selenium server starts successfully" do
+      it "returns an instance of the server" do
+        mock(server).ready? { true }
+        server.boot.should == server
+      end
+    end
 
-        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
+    context "when the selenium server fails to start" do
+      it "raises an exception after 60 seconds" do
+        mock(server).ready?.any_number_of_times { false }
+        expect { server.boot.should }.to raise_error(SystemExit)
       end
+    end
+  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(SeleniumRC::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
+    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(SeleniumRC::Server).jar_path {"/path/to/the.jar"}
+        server.start
       end
     end
   end

data/spec/spec_helper.rb

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

metadata

@@ -4,12 +4,12 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
-  - 2
-  - 4
-  version: 2.2.4
+  - 3
+  - 0
+  version: 2.3.0
 platform: ruby
 authors: 
-- Pivotal Labs
+- Pivotal Labs, Inc.
 - Nate Clark
 - Brian Takita
 - Chad Woolley
@@ -18,13 +18,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-17 00:00:00 -07:00
-default_executable: 
+date: 2011-02-16 00:00:00 +08:00
+default_executable: selenium-rc
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: selenium-client
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -35,7 +36,87 @@ dependencies:
         version: 1.2.18
   type: :runtime
   version_requirements: *id001
-description: The Selenium RC Server packaged as a gem
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: lsof
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: gem-release
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: The Selenium Server packaged as a gem
 email: pivotallabsopensource@googlegroups.com
 executables: 
 - selenium-rc
@@ -44,21 +125,26 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
-- Thorfile
-- Rakefile
+- vendor/selenium-server.jar
+- .gitignore
+- CHANGES
+- Gemfile
+- Gemfile.lock
+- MIT.LICENSE
 - README.markdown
 - RELEASING
-- CHANGES
+- Rakefile
+- Thorfile
 - VERSION.yml
 - bin/selenium-rc
-- lib/selenium_rc/server.rb
+- lib/selenium-rc.rb
 - lib/selenium_rc.rb
-- spec/spec_suite.rb
-- spec/selenium_rc/server_spec.rb
+- lib/selenium_rc/server.rb
+- selenium-rc.gemspec
 - spec/bin_selenium_rc_spec.rb
+- spec/selenium_rc/server_spec.rb
 - spec/spec_helper.rb
 - vendor/empty.txt
-- vendor/selenium-server.jar
 has_rdoc: true
 homepage: http://github.com/pivotal/selenium-rc
 licenses: []
@@ -69,6 +155,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -76,6 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -85,12 +173,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: The Selenium RC Server packaged as a gem.
+summary: The Selenium 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/spec/spec_suite.rb

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