forked from SeleniumHQ/selenium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
driver.rb
347 lines (288 loc) · 8.5 KB
/
driver.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# frozen_string_literal: true
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module Selenium
module WebDriver
#
# The main class through which you control the browser.
#
# @see SearchContext
# @see Navigation
# @see TargetLocator
# @see Options
#
class Driver
include SearchContext
include TakesScreenshot
class << self
#
# @api private
#
# @see Selenium::WebDriver.for
#
# @return [Driver]
#
def for(browser, opts = {})
case browser
when :chrome, :chrome_headless_shell
Chrome::Driver.new(**opts)
when :internet_explorer, :ie
IE::Driver.new(**opts)
when :safari
Safari::Driver.new(**opts)
when :firefox, :ff
Firefox::Driver.new(**opts)
when :edge, :microsoftedge, :msedge
Edge::Driver.new(**opts)
when :remote
Remote::Driver.new(**opts)
else
raise ArgumentError, "unknown driver: #{browser.inspect}"
end
end
end
#
# A new Driver instance with the given bridge.
# End users should use Selenium::WebDriver.for instead of using this directly.
#
# @api private
#
def initialize(bridge: nil, listener: nil, **opts)
@devtools = nil
@bidi = nil
bridge ||= create_bridge(**opts)
add_extensions(bridge.browser)
@bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
end
def inspect
format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2,
browser: bridge.browser.inspect
end
#
# information about whether a remote end is in a state in which it can create new sessions,
# and may include additional meta information.
#
# @return [Hash]
#
def status
@bridge.status
end
#
# @return [Navigation]
# @see Navigation
#
def navigate
@navigate ||= WebDriver::Navigation.new(bridge)
end
#
# @return [TargetLocator]
# @see TargetLocator
#
def switch_to
@switch_to ||= WebDriver::TargetLocator.new(bridge)
end
#
# @return [Manager]
# @see Manager
#
def manage
bridge.manage
end
#
# @return [ActionBuilder]
# @see ActionBuilder
#
def action(**opts)
bridge.action(**opts)
end
#
# Opens the specified URL in the browser.
#
def get(url)
navigate.to(url)
end
#
# Get the URL of the current page
#
# @return [String]
#
def current_url
bridge.url
end
#
# Get the title of the current page
#
# @return [String]
#
def title
bridge.title
end
#
# Get the source of the current page
#
# @return [String]
#
def page_source
bridge.page_source
end
#
# Quit the browser
#
def quit
bridge.quit
ensure
@service_manager&.stop
@devtools&.close
@bidi&.close
end
#
# Close the current window, or the browser if no windows are left.
#
def close
# If no top-level browsing contexts are open after calling close,
# it indicates that the WebDriver session is closed.
# If the WebDriver session is closed, the BiDi session also needs to be closed.
bridge.close.tap { |handles| @bidi&.close if handles&.empty? }
end
#
# Get the window handles of open browser windows.
#
# @return [Array]
# @see TargetLocator#window
#
def window_handles
bridge.window_handles
end
#
# Get the current window handle
#
# @return [String]
#
def window_handle
bridge.window_handle
end
#
# Execute the given JavaScript
#
# @param [String] script
# JavaScript source to execute
# @param [WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array] args
# Arguments will be available in the given script in the 'arguments' pseudo-array.
#
# @return [WebDriver::Element,Integer,Float,Boolean,NilClass,String,Array]
# The value returned from the script.
#
def execute_script(script, *args)
bridge.execute_script(script, *args)
end
# Execute an asynchronous piece of JavaScript in the context of the
# currently selected frame or window. Unlike executing
# execute_script (synchronous JavaScript), scripts
# executed with this method must explicitly signal they are finished by
# invoking the provided callback. This callback is always injected into the
# executed function as the last argument.
#
# @param [String] script
# JavaScript source to execute
# @param [WebDriver::Element,Integer, Float, Boolean, NilClass, String, Array] args
# Arguments to the script. May be empty.
#
# @return [WebDriver::Element,Integer,Float,Boolean,NilClass,String,Array]
#
def execute_async_script(script, *args)
bridge.execute_async_script(script, *args)
end
#
# @return [VirtualAuthenticator]
# @see VirtualAuthenticator
#
def add_virtual_authenticator(options)
bridge.add_virtual_authenticator(options)
end
#-------------------------------- sugar --------------------------------
#
# driver.first(id: 'foo')
#
alias first find_element
#
# driver.all(class: 'bar') #=> [#<WebDriver::Element:0x1011c3b88, ...]
#
alias all find_elements
#
# driver.script('function() { ... };')
#
alias script execute_script
# Get the first element matching the given selector. If given a
# String or Symbol, it will be used as the id of the element.
#
# @param [String,Hash] sel id or selector
# @return [WebDriver::Element]
#
# Examples:
#
# driver['someElementId'] #=> #<WebDriver::Element:0x1011c3b88>
# driver[:tag_name => 'div'] #=> #<WebDriver::Element:0x1011c3b88>
#
def [](sel)
sel = {id: sel} if sel.is_a?(String) || sel.is_a?(Symbol)
find_element sel
end
def browser
bridge.browser
end
def capabilities
bridge.capabilities
end
#
# @api private
# @see SearchContext
#
def ref
[:driver, nil]
end
private
attr_reader :bridge
def create_bridge(caps:, url:, http_client: nil)
Remote::Bridge.new(http_client: http_client, url: url).tap do |bridge|
bridge.create_session(caps)
end
end
def service_url(service)
@service_manager = service.launch
@service_manager.uri
end
def screenshot
bridge.screenshot
end
def add_extensions(browser)
extensions = case browser
when :chrome, :chrome_headless_shell, :msedge, :microsoftedge
Chromium::Driver::EXTENSIONS
when :firefox
Firefox::Driver::EXTENSIONS
when :safari, :safari_technology_preview
Safari::Driver::EXTENSIONS
when :ie, :internet_explorer
IE::Driver::EXTENSIONS
else
[]
end
extensions.each { |extension| extend extension }
end
end # Driver
end # WebDriver
end # Selenium