Class: Capybara::Selenium::Driver

Inherits:
Driver::Base show all
Includes:
Find
Defined in:
lib/capybara/selenium/driver.rb

Defined Under Namespace

Modules: ChromeDriver, EdgeDriver, FirefoxDriver, InternetExplorerDriver, SafariDriver, W3CFirefoxDriver

Constant Summary collapse

DEFAULT_OPTIONS =
{
  browser: :firefox,
  clear_local_storage: nil,
  clear_session_storage: nil
}.freeze
SPECIAL_OPTIONS =
%i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Find

#find_css, #find_xpath

Methods inherited from Driver::Base

#find_css, #find_xpath, #frame_title, #frame_url, #response_headers, #session_options, #status_code

Constructor Details

#initialize(app, **options) ⇒ Driver

Returns a new instance of Driver


57
58
59
60
61
62
63
64
65
# File 'lib/capybara/selenium/driver.rb', line 57

def initialize(app, **options)
  self.class.load_selenium
  @app = app
  @browser = nil
  @exit_status = nil
  @frame_handles = Hash.new { |hash, handle| hash[handle] = [] }
  @options = DEFAULT_OPTIONS.merge(options)
  @node_class = ::Capybara::Selenium::Node
end

Class Attribute Details

.specializationsObject (readonly)

Returns the value of attribute specializations


30
31
32
# File 'lib/capybara/selenium/driver.rb', line 30

def specializations
  @specializations
end

Instance Attribute Details

#appObject (readonly)

Returns the value of attribute app


15
16
17
# File 'lib/capybara/selenium/driver.rb', line 15

def app
  @app
end

#optionsObject (readonly)

Returns the value of attribute options


15
16
17
# File 'lib/capybara/selenium/driver.rb', line 15

def options
  @options
end

Class Method Details

.load_seleniumObject


18
19
20
21
22
23
24
25
26
27
28
# File 'lib/capybara/selenium/driver.rb', line 18

def load_selenium
  require 'selenium-webdriver'
  require 'capybara/selenium/logger_suppressor'
  require 'capybara/selenium/patches/atoms'
  require 'capybara/selenium/patches/is_displayed'
  warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade." if Gem.loaded_specs['selenium-webdriver'].version < Gem::Version.new('3.5.0')
rescue LoadError => e
  raise e unless e.message.match?(/selenium-webdriver/)

  raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
end

.register_specialization(browser_name, specialization) ⇒ Object


32
33
34
35
# File 'lib/capybara/selenium/driver.rb', line 32

def register_specialization(browser_name, specialization)
  @specializations ||= {}
  @specializations[browser_name] = specialization
end

Instance Method Details

#accept_modal(_type, **options) ⇒ Object


220
221
222
223
224
225
226
227
228
229
# File 'lib/capybara/selenium/driver.rb', line 220

def accept_modal(_type, **options)
  yield if block_given?
  modal = find_modal(options)

  modal.send_keys options[:with] if options[:with]

  message = modal.text
  modal.accept
  message
end

#browserObject


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/capybara/selenium/driver.rb', line 38

def browser
  unless @browser
    options[:http_client] ||= begin
      require 'capybara/selenium/patches/persistent_client'
      if options[:timeout]
        ::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])
      else
        ::Capybara::Selenium::PersistentClient.new
      end
    end
    processed_options = options.reject { |key, _val| SPECIAL_OPTIONS.include?(key) }
    @browser = Selenium::WebDriver.for(options[:browser], processed_options)

    specialize_driver
    setup_exit_handler
  end
  @browser
end

#close_window(handle) ⇒ Object

Raises:

  • (ArgumentError)

197
198
199
200
201
202
203
# File 'lib/capybara/selenium/driver.rb', line 197

def close_window(handle)
  raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first

  within_given_window(handle) do
    browser.close
  end
end

#current_urlObject


91
92
93
# File 'lib/capybara/selenium/driver.rb', line 91

def current_url
  browser.current_url
end

#current_window_handleObject


167
168
169
# File 'lib/capybara/selenium/driver.rb', line 167

def current_window_handle
  browser.window_handle
end

#dismiss_modal(_type, **options) ⇒ Object


231
232
233
234
235
236
237
# File 'lib/capybara/selenium/driver.rb', line 231

def dismiss_modal(_type, **options)
  yield if block_given?
  modal = find_modal(options)
  message = modal.text
  modal.dismiss
  message
end

#evaluate_async_script(script, *args) ⇒ Object


107
108
109
110
111
# File 'lib/capybara/selenium/driver.rb', line 107

def evaluate_async_script(script, *args)
  browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time
  result = browser.execute_async_script(script, *native_args(args))
  unwrap_script_result(result)
end

#evaluate_script(script, *args) ⇒ Object


102
103
104
105
# File 'lib/capybara/selenium/driver.rb', line 102

def evaluate_script(script, *args)
  result = execute_script("return #{script}", *args)
  unwrap_script_result(result)
end

#execute_script(script, *args) ⇒ Object


98
99
100
# File 'lib/capybara/selenium/driver.rb', line 98

def execute_script(script, *args)
  browser.execute_script(script, *native_args(args))
end

#frame_obscured_at?(x:, y:) ⇒ Boolean

Returns:

  • (Boolean)

140
141
142
143
144
145
146
147
148
149
150
# File 'lib/capybara/selenium/driver.rb', line 140

def frame_obscured_at?(x:, y:)
  frame = @frame_handles[current_window_handle].last
  return false unless frame

  switch_to_frame(:parent)
  begin
    return frame.base.obscured?(x: x, y: y)
  ensure
    switch_to_frame(frame)
  end
end

#fullscreen_window(handle) ⇒ Object


191
192
193
194
195
# File 'lib/capybara/selenium/driver.rb', line 191

def fullscreen_window(handle)
  within_given_window(handle) do
    browser.manage.window.full_screen
  end
end

#go_backObject


75
76
77
# File 'lib/capybara/selenium/driver.rb', line 75

def go_back
  browser.navigate.back
end

#go_forwardObject


79
80
81
# File 'lib/capybara/selenium/driver.rb', line 79

def go_forward
  browser.navigate.forward
end

#htmlObject


83
84
85
# File 'lib/capybara/selenium/driver.rb', line 83

def html
  browser.page_source
end

#invalid_element_errorsObject


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/capybara/selenium/driver.rb', line 252

def invalid_element_errors
  @invalid_element_errors ||= begin
    [
      ::Selenium::WebDriver::Error::StaleElementReferenceError,
      ::Selenium::WebDriver::Error::ElementNotInteractableError,
      ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition
      ::Selenium::WebDriver::Error::ElementClickInterceptedError,
      ::Selenium::WebDriver::Error::NoSuchElementError, # IE
      ::Selenium::WebDriver::Error::InvalidArgumentError # IE
    ].tap do |errors|
      unless selenium_4?
        ::Selenium::WebDriver.logger.suppress_deprecations do
          errors.concat [
            ::Selenium::WebDriver::Error::UnhandledError,
            ::Selenium::WebDriver::Error::ElementNotVisibleError,
            ::Selenium::WebDriver::Error::InvalidElementStateError,
            ::Selenium::WebDriver::Error::ElementNotSelectableError
          ]
        end
      end
    end
  end
end

#maximize_window(handle) ⇒ Object


184
185
186
187
188
189
# File 'lib/capybara/selenium/driver.rb', line 184

def maximize_window(handle)
  within_given_window(handle) do
    browser.manage.window.maximize
  end
  sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405
end

#needs_server?Boolean

Returns:

  • (Boolean)

96
# File 'lib/capybara/selenium/driver.rb', line 96

def needs_server?; true; end

#no_such_window_errorObject


276
277
278
# File 'lib/capybara/selenium/driver.rb', line 276

def no_such_window_error
  Selenium::WebDriver::Error::NoSuchWindowError
end

#open_new_window(kind = :tab) ⇒ Object


209
210
211
212
213
214
# File 'lib/capybara/selenium/driver.rb', line 209

def open_new_window(kind = :tab)
  browser.manage.new_window(kind)
rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError
  # If not supported by the driver or browser default to using JS
  browser.execute_script('window.open();')
end

#quitObject


239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/capybara/selenium/driver.rb', line 239

def quit
  @browser&.quit
rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED # rubocop:disable Lint/HandleExceptions
  # Browser must have already gone
rescue Selenium::WebDriver::Error::UnknownError => e
  unless silenced_unknown_error_message?(e.message) # Most likely already gone
    # probably already gone but not sure - so warn
    warn "Ignoring Selenium UnknownError during driver quit: #{e.message}"
  end
ensure
  @browser = nil
end

#refreshObject


71
72
73
# File 'lib/capybara/selenium/driver.rb', line 71

def refresh
  browser.navigate.refresh
end

#reset!Object


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/capybara/selenium/driver.rb', line 117

def reset!
  # Use instance variable directly so we avoid starting the browser just to reset the session
  return unless @browser

  navigated = false
  timer = Capybara::Helpers.timer(expire_in: 10)
  begin
    # Only trigger a navigation if we haven't done it already, otherwise it
    # can trigger an endless series of unload modals
    reset_browser_state unless navigated
    navigated = true
    # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload
    wait_for_empty_page(timer)
  rescue *unhandled_alert_errors
    # This error is thrown if an unhandled alert is on the page
    # Firefox appears to automatically dismiss this alert, chrome does not
    # We'll try to accept it
    accept_unhandled_reset_alert
    # try cleaning up the browser again
    retry
  end
end

#resize_window_to(handle, width, height) ⇒ Object


178
179
180
181
182
# File 'lib/capybara/selenium/driver.rb', line 178

def resize_window_to(handle, width, height)
  within_given_window(handle) do
    browser.manage.window.resize_to(width, height)
  end
end

#save_screenshot(path, **_options) ⇒ Object


113
114
115
# File 'lib/capybara/selenium/driver.rb', line 113

def save_screenshot(path, **_options)
  browser.save_screenshot(path)
end

#switch_to_frame(frame) ⇒ Object


152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/capybara/selenium/driver.rb', line 152

def switch_to_frame(frame)
  handles = @frame_handles[current_window_handle]
  case frame
  when :top
    handles.clear
    browser.switch_to.default_content
  when :parent
    handles.pop
    browser.switch_to.parent_frame
  else
    handles << frame
    browser.switch_to.frame(frame.native)
  end
end

#switch_to_window(handle) ⇒ Object


216
217
218
# File 'lib/capybara/selenium/driver.rb', line 216

def switch_to_window(handle)
  browser.switch_to.window handle
end

#titleObject


87
88
89
# File 'lib/capybara/selenium/driver.rb', line 87

def title
  browser.title
end

#visit(path) ⇒ Object


67
68
69
# File 'lib/capybara/selenium/driver.rb', line 67

def visit(path)
  browser.navigate.to(path)
end

#wait?Boolean

Returns:

  • (Boolean)

95
# File 'lib/capybara/selenium/driver.rb', line 95

def wait?; true; end

#window_handlesObject


205
206
207
# File 'lib/capybara/selenium/driver.rb', line 205

def window_handles
  browser.window_handles
end

#window_size(handle) ⇒ Object


171
172
173
174
175
176
# File 'lib/capybara/selenium/driver.rb', line 171

def window_size(handle)
  within_given_window(handle) do
    size = browser.manage.window.size
    [size.width, size.height]
  end
end