Class: Selenium::WebDriver::Firefox::Launcher Private

Inherits:
Object
  • Object
show all
Defined in:
lib/selenium/webdriver/firefox/launcher.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Constant Summary collapse

SOCKET_LOCK_TIMEOUT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

45
STABLE_CONNECTION_TIMEOUT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

60

Instance Method Summary collapse

Constructor Details

#initialize(binary, port, profile = nil) ⇒ Launcher

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Launcher.

Raises:

[View source]

11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 11

def initialize(binary, port, profile = nil)
  @binary = binary
  @port   = Integer(port)

  raise Error::WebDriverError, "invalid port: #{@port}" if @port < 1

  if profile.kind_of? Profile
    @profile = profile
  else
    @profile_name = profile
    @profile = nil
  end

  @host = "127.0.0.1"
end

Instance Method Details

#assert_profile ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:

[View source]

93
94
95
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 93

def assert_profile
  raise Error::WebDriverError, "must create_profile first" unless @profile && @profile_dir
end

#connect_until_stable ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

72
73
74
75
76
77
78
79
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 72

def connect_until_stable
  poller = SocketPoller.new(@host, @port, STABLE_CONNECTION_TIMEOUT)

  unless poller.connected?
    @binary.quit
    raise Error::WebDriverError, "unable to obtain stable firefox connection in #{STABLE_CONNECTION_TIMEOUT} seconds (#{@host}:#{@port})"
  end
end

#create_profile ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

52
53
54
55
56
57
58
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 52

def create_profile
  fetch_profile unless @profile

  @profile.add_webdriver_extension
  @profile.port = @port
  @profile_dir = @profile.layout_on_disk
end

#fetch_profile ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 81

def fetch_profile
  if @profile_name
    @profile = Profile.from_name @profile_name

    unless @profile
      raise Error::WebDriverError, "unable to find profile named: #{@profile_name.inspect}"
    end
  else
    @profile = Profile.new
  end
end

#find_free_port ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

48
49
50
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 48

def find_free_port
  @port = PortProber.above @port
end

#launch ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 31

def launch
  socket_lock.locked do
    find_free_port
    create_profile
    start_silent_and_wait
    start
    connect_until_stable
  end

  self
end

#quit ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

43
44
45
46
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 43

def quit
  @binary.quit
  FileReaper.reap(@profile_dir) if @profile_dir
end

#socket_lock ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

97
98
99
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 97

def socket_lock
  @socket_lock ||= SocketLock.new(@port - 1, SOCKET_LOCK_TIMEOUT)
end

#start ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

60
61
62
63
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 60

def start
  assert_profile
  @binary.start_with @profile, @profile_dir
end

#start_silent_and_wait ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

65
66
67
68
69
70
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 65

def start_silent_and_wait
  assert_profile

  @binary.start_with @profile, @profile_dir, "-silent"
  @binary.wait
end

#url ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

[View source]

27
28
29
 
# File 'lib/selenium/webdriver/firefox/launcher.rb', line 27

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