Class: Selenium::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/selenium/server.rb

Overview

Wraps the remote server jar

Usage:

server = Selenium::Server.new('/path/to/selenium-server-standalone.jar')
server.start

Automatically download the given version:

server = Selenium::Server.get '2.6.0'
server.start

or the latest version:

server = Selenium::Server.get :latest
server.start

Run the server in the background:

server = Selenium::Server.new(jar, :background => true)
server.start

Add additional arguments:

server = Selenium::Server.new(jar)
server << ["--additional", "args"]
server.start

Defined Under Namespace

Classes: Error

Constant Summary collapse

CL_RESET = 
WebDriver::Platform.windows? ? '' : "\r\e[0K"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(jar, opts = {}) ⇒ Server

Returns a new instance of Server.

Parameters:

  • jar (String) —

    Path to the server jar.

  • opts (Hash) (defaults to: {}) —

    the options to create the server process with

Options Hash (opts):

  • :port (Integer) —

    Port the server should listen on (default: 4444).

  • :timeout (Integer) —

    Seconds to wait for server launch/shutdown (default: 30)

  • :background (true, false) —

    Run the server in the background (default: false)

  • :log (true, false, String) —

    Either a path to a log file, or true to pass server log to stdout.

Raises:

  • (Errno::ENOENT) —

    if the jar file does not exist



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/selenium/server.rb', line 142

def initialize(jar, opts = {})
  raise Errno::ENOENT, jar unless File.exist?(jar)

  @jar        = jar
  @host       = "127.0.0.1"
  @port       = opts.fetch(:port, 4444)
  @timeout    = opts.fetch(:timeout, 30)
  @background = opts.fetch(:background, false)
  @log        = opts[:log]

  @additional_args = []
end

Instance Attribute Details

#background ⇒ Object

Whether to launch the server in the background



122
123
124
 
# File 'lib/selenium/server.rb', line 122

def background
  @background
end

#log ⇒ Object

Path to log file, or ‘true’ for stdout.



128
129
130
 
# File 'lib/selenium/server.rb', line 128

def log
  @log
end

#port ⇒ Object

The server port



110
111
112
 
# File 'lib/selenium/server.rb', line 110

def port
  @port
end

#timeout ⇒ Object

The server timeout



116
117
118
 
# File 'lib/selenium/server.rb', line 116

def timeout
  @timeout
end

Class Method Details

.download(required_version) ⇒ Object

Download the given version of the selenium-server-standalone jar.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/selenium/server.rb', line 50

def self.download(required_version)
  required_version = latest if required_version == :latest
  download_file_name = "selenium-server-standalone-#{required_version}.jar"

  if File.exists? download_file_name
    return download_file_name
  end

  begin
    open(download_file_name, "wb") do |destination|
      net_http.start("selenium-release.storage.googleapis.com") do |http|
        resp = http.request_get("/#{required_version[/(\d+\.\d+)\./, 1]}/#{download_file_name}") do |response|
          total = response.content_length
          progress = 0
          segment_count = 0

          response.read_body do |segment|
            progress += segment.length
            segment_count += 1

            if segment_count % 15 == 0
              percent = (progress.to_f / total.to_f) * 100
              print "#{CL_RESET}Downloading #{download_file_name}: #{percent.to_i}% (#{progress} / #{total})"
              segment_count = 0
            end

            destination.write(segment)
          end
        end

        unless resp.kind_of? Net::HTTPSuccess
          raise Error, "#{resp.code} for #{download_file_name}"
        end
      end
    end
  rescue
    FileUtils.rm download_file_name if File.exists? download_file_name
    raise
  end

  download_file_name
end

.get(required_version, opts = {}) ⇒ Object 



42
43
44
 
# File 'lib/selenium/server.rb', line 42

def self.get(required_version, opts = {})
  new(download(required_version), opts)
end

.latest ⇒ Object

Ask Google Code what the latest selenium-server-standalone version is.



97
98
99
100
101
102
103
104
 
# File 'lib/selenium/server.rb', line 97

def self.latest
  require 'rexml/document'
  net_http.start("selenium-release.storage.googleapis.com") do |http|
    REXML::Document.new(http.get("/").body).root.get_elements("//Contents/Key").map { |e|
      e.text[/selenium-server-standalone-(\d+\.\d+\.\d+)\.jar/, 1]
    }.compact.max
  end
end

Instance Method Details

#<<(arg) ⇒ Object 



178
179
180
181
182
183
184
 
# File 'lib/selenium/server.rb', line 178

def <<(arg)
  if arg.kind_of?(Array)
    @additional_args += arg
  else
    @additional_args << arg.to_s
  end
end

#start ⇒ Object 



155
156
157
158
159
160
 
# File 'lib/selenium/server.rb', line 155

def start
  process.start
  poll_for_service

  process.wait unless @background
end

#stop ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/selenium/server.rb', line 162

def stop
  begin
    Net::HTTP.get(@host, "/selenium-server/driver/?cmd=shutDownSeleniumServer", @port)
  rescue Errno::ECONNREFUSED
  end

  stop_process if @process
  poll_for_shutdown

  @log_file.close if @log_file
end

#webdriver_url ⇒ Object 



174
175
176
 
# File 'lib/selenium/server.rb', line 174

def webdriver_url
  "http://#{@host}:#{@port}/wd/hub"
end