Module: Selenium::WebDriver::Platform Private

Defined in:
lib/selenium/webdriver/common/platform.rb

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

Class Method Summary collapse

Class Method Details

.assert_executable(path) ⇒ 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:



128
129
130
131
132
133
 
# File 'lib/selenium/webdriver/common/platform.rb', line 128

def assert_executable(path)
  assert_file(path)

  return if File.executable? path
  raise Error::WebDriverError, "not executable: #{path.inspect}"
end

.assert_file(path) ⇒ 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:



123
124
125
126
 
# File 'lib/selenium/webdriver/common/platform.rb', line 123

def assert_file(path)
  return if File.file? path
  raise Error::WebDriverError, "not a file: #{path.inspect}"
end

.bitsize ⇒ 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. 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/selenium/webdriver/common/platform.rb', line 59

def bitsize
  @bitsize ||= if defined?(FFI::Platform::ADDRESS_SIZE)
                 FFI::Platform::ADDRESS_SIZE
               elsif defined?(FFI)
                 FFI.type_size(:pointer) == 4 ? 32 : 64
               elsif jruby?
                 Integer(ENV_JAVA['sun.arch.data.model'])
               else
                 1.size == 4 ? 32 : 64
               end
end

.ci ⇒ 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. 



54
55
56
57
 
# File 'lib/selenium/webdriver/common/platform.rb', line 54

def ci
  return :travis if ENV['TRAVIS']
  :jenkins if ENV['JENKINS']
end

.cygwin? ⇒ Boolean

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:

  • (Boolean) 


95
96
97
98
 
# File 'lib/selenium/webdriver/common/platform.rb', line 95

def cygwin?
  RUBY_PLATFORM =~ /cygwin/
  !Regexp.last_match.nil?
end

.cygwin_path(path, opts = {}) ⇒ 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. 



112
113
114
115
116
117
 
# File 'lib/selenium/webdriver/common/platform.rb', line 112

def cygwin_path(path, opts = {})
  flags = []
  opts.each { |k, v| flags << "--#{k}" if v }

  `cygpath #{flags.join ' '} "#{path}"`.strip
end

.engine ⇒ 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. 



34
35
36
 
# File 'lib/selenium/webdriver/common/platform.rb', line 34

def engine
  @engine ||= defined?(RUBY_ENGINE) ? RUBY_ENGINE.to_sym : :ruby
end

.exit_hook ⇒ 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. 



135
136
137
138
139
 
# File 'lib/selenium/webdriver/common/platform.rb', line 135

def exit_hook
  pid = Process.pid

  at_exit { yield if Process.pid == pid }
end

.find_binary(*binary_names) ⇒ 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. 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/selenium/webdriver/common/platform.rb', line 141

def find_binary(*binary_names)
  paths = ENV['PATH'].split(File::PATH_SEPARATOR)

  if windows?
    binary_names.map! { |n| "#{n}.exe" }
    binary_names.dup.each { |n| binary_names << n.gsub('exe', 'bat') }
  end

  binary_names.each do |binary_name|
    paths.each do |path|
      full_path = File.join(path, binary_name)
      full_path.tr!('\\', '/') if windows?
      exe = Dir.glob(full_path).find { |f| File.executable?(f) }
      return exe if exe
    end
  end

  nil
end

.find_in_program_files(*binary_names) ⇒ 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. 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/selenium/webdriver/common/platform.rb', line 161

def find_in_program_files(*binary_names)
  paths = [
    ENV['PROGRAMFILES'] || '\\Program Files',
    ENV['ProgramFiles(x86)'] || '\\Program Files (x86)'
  ]

  paths.each do |root|
    binary_names.each do |name|
      exe = File.join(root, name)
      return exe if File.executable?(exe)
    end
  end

  nil
end

.home ⇒ 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. 



29
30
31
32
 
# File 'lib/selenium/webdriver/common/platform.rb', line 29

def home
  # jruby has an issue with ENV['HOME'] on Windows
  @home ||= jruby? ? ENV_JAVA['user.home'] : ENV['HOME']
end

.interfaces ⇒ 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. 



200
201
202
203
204
205
 
# File 'lib/selenium/webdriver/common/platform.rb', line 200

def interfaces
  interfaces = Socket.getaddrinfo('localhost', 8080).map { |e| e[3] }
  interfaces += ['0.0.0.0', Platform.ip]

  interfaces.compact.uniq
end

.ip ⇒ 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. 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/selenium/webdriver/common/platform.rb', line 184

def ip
  orig = Socket.do_not_reverse_lookup
  Socket.do_not_reverse_lookup = true

  begin
    UDPSocket.open do |s|
      s.connect '8.8.8.8', 53
      return s.addr.last
    end
  ensure
    Socket.do_not_reverse_lookup = orig
  end
rescue Errno::ENETUNREACH, Errno::EHOSTUNREACH
  # no external ip
end

.ironruby? ⇒ Boolean

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:

  • (Boolean) 


75
76
77
 
# File 'lib/selenium/webdriver/common/platform.rb', line 75

def ironruby?
  engine == :ironruby
end

.jruby? ⇒ Boolean

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:

  • (Boolean) 


71
72
73
 
# File 'lib/selenium/webdriver/common/platform.rb', line 71

def jruby?
  engine == :jruby
end

.linux? ⇒ Boolean

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:

  • (Boolean) 


91
92
93
 
# File 'lib/selenium/webdriver/common/platform.rb', line 91

def linux?
  os == :linux
end

.localhost ⇒ 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:



177
178
179
180
181
182
 
# File 'lib/selenium/webdriver/common/platform.rb', line 177

def localhost
  info = Socket.getaddrinfo 'localhost', 80, Socket::AF_INET, Socket::SOCK_STREAM

  return info[0][3] unless info.empty?
  raise Error::WebDriverError, "unable to translate 'localhost' for TCP + IPv4"
end

.mac? ⇒ Boolean

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:

  • (Boolean) 


87
88
89
 
# File 'lib/selenium/webdriver/common/platform.rb', line 87

def mac?
  os == :macosx
end

.make_writable(file) ⇒ 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. 



119
120
121
 
# File 'lib/selenium/webdriver/common/platform.rb', line 119

def make_writable(file)
  File.chmod 0766, file
end

.null_device ⇒ 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. 



100
101
102
103
104
105
106
 
# File 'lib/selenium/webdriver/common/platform.rb', line 100

def null_device
  @null_device ||= if defined?(File::NULL)
                     File::NULL
                   else
                     Platform.windows? ? 'NUL' : '/dev/null'
                   end
end

.os ⇒ 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. 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/selenium/webdriver/common/platform.rb', line 38

def os
  host_os = RbConfig::CONFIG['host_os']
  @os ||= case host_os
          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
            :windows
          when /darwin|mac os/
            :macosx
          when /linux/
            :linux
          when /solaris|bsd/
            :unix
          else
            raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
          end
end

.ruby_version ⇒ 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. 



79
80
81
 
# File 'lib/selenium/webdriver/common/platform.rb', line 79

def ruby_version
  RUBY_VERSION
end

.windows? ⇒ Boolean

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:

  • (Boolean) 


83
84
85
 
# File 'lib/selenium/webdriver/common/platform.rb', line 83

def windows?
  os == :windows
end

.wrap_in_quotes_if_necessary(str) ⇒ 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. 



108
109
110
 
# File 'lib/selenium/webdriver/common/platform.rb', line 108

def wrap_in_quotes_if_necessary(str)
  windows? && !cygwin? ? %("#{str}") : str
end