Class: Capybara::Selenium::Driver

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

Defined Under Namespace

Modules: ChromeDriver, MarionetteDriver

Constant Summary collapse

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

Instance Attribute Summary collapse

Attributes inherited from Driver::Base

#session

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Driver::Base

#frame_title, #frame_url, #response_headers, #session_options, #status_code

Constructor Details

#initialize(app, **options) ⇒ Driver

Returns a new instance of Driver.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/capybara/selenium/driver.rb', line 47

def initialize(app, **options)
  self.class.load_selenium
  @session = nil
  @app = app
  @browser = nil
  @exit_status = nil
  @frame_handles = {}
  @options = DEFAULT_OPTIONS.merge(options)
  @node_class = ::Capybara::Selenium::Node
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



13
14
15
 
# File 'lib/capybara/selenium/driver.rb', line 13

def app
  @app
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



13
14
15
 
# File 'lib/capybara/selenium/driver.rb', line 13

def options
  @options
end

Class Method Details

.load_selenium ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/capybara/selenium/driver.rb', line 15

def self.load_selenium
  require 'selenium-webdriver'
  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 if e.message !~ /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

Instance Method Details

#accept_modal(_type, **options) ⇒ Object 



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

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

#browser ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/capybara/selenium/driver.rb', line 23

def browser
  unless @browser
    # if firefox?
    #   options[:desired_capabilities] ||= {}
    #   options[:desired_capabilities][:unexpectedAlertBehaviour] = "ignore"
    # end

    @processed_options = options.reject { |key, _val| SPECIAL_OPTIONS.include?(key) }
    @browser = Selenium::WebDriver.for(options[:browser], @processed_options)

    extend ChromeDriver if chrome?
    extend MarionetteDriver if marionette?

    main = Process.pid
    at_exit do
      # Store the exit status of the test run since it goes away after calling the at_exit proc...
      @exit_status = $ERROR_INFO.status if $ERROR_INFO.is_a?(SystemExit)
      quit if Process.pid == main
      exit @exit_status if @exit_status # Force exit with stored status
    end
  end
  @browser
end

#close_window(handle) ⇒ Object

Raises:

  • (ArgumentError) 


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

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_url ⇒ Object 



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

def current_url
  browser.current_url
end

#current_window_handle ⇒ Object 



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

def current_window_handle
  browser.window_handle
end

#dismiss_modal(_type, **options) ⇒ Object 



251
252
253
254
255
256
257
 
# File 'lib/capybara/selenium/driver.rb', line 251

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 



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

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 



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

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

#execute_script(script, *args) ⇒ Object 



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

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

#find_css(selector) ⇒ Object 



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

def find_css(selector)
  browser.find_elements(:css, selector).map(&method(:build_node))
end

#find_xpath(selector) ⇒ Object 



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

def find_xpath(selector)
  browser.find_elements(:xpath, selector).map(&method(:build_node))
end

#fullscreen_window(handle) ⇒ Object 



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

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

#go_back ⇒ Object 



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

def go_back
  browser.navigate.back
end

#go_forward ⇒ Object 



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

def go_forward
  browser.navigate.forward
end

#html ⇒ Object 



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

def html
  browser.page_source
end

#invalid_element_errors ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/capybara/selenium/driver.rb', line 272

def invalid_element_errors
  [
    ::Selenium::WebDriver::Error::StaleElementReferenceError,
    ::Selenium::WebDriver::Error::UnhandledError,
    ::Selenium::WebDriver::Error::ElementNotVisibleError,
    ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around a race condition that can occur with chromedriver and #go_back/#go_forward
    ::Selenium::WebDriver::Error::ElementNotInteractableError,
    ::Selenium::WebDriver::Error::ElementClickInterceptedError,
    ::Selenium::WebDriver::Error::InvalidElementStateError,
    ::Selenium::WebDriver::Error::ElementNotSelectableError,
    ::Selenium::WebDriver::Error::ElementNotSelectableError,
    ::Selenium::WebDriver::Error::NoSuchElementError, # IE
    ::Selenium::WebDriver::Error::InvalidArgumentError # IE
  ]
end

#maximize_window(handle) ⇒ Object 



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

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) 


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

def needs_server?; true; end

#no_such_window_error ⇒ Object 



288
289
290
 
# File 'lib/capybara/selenium/driver.rb', line 288

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

#open_new_window ⇒ Object 



232
233
234
 
# File 'lib/capybara/selenium/driver.rb', line 232

def open_new_window
  browser.execute_script('window.open();')
end

#quit ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/capybara/selenium/driver.rb', line 259

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

#refresh ⇒ Object 



62
63
64
 
# File 'lib/capybara/selenium/driver.rb', line 62

def refresh
  browser.navigate.refresh
end

#reset! ⇒ Object 



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
 
# File 'lib/capybara/selenium/driver.rb', line 116

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
    unless navigated
      # Only trigger a navigation if we haven't done it already, otherwise it
      # can trigger an endless series of unload modals
      begin
        @browser.manage.delete_all_cookies
        clear_storage
      # rescue Selenium::WebDriver::Error::NoSuchAlertError
      #   # Handle a bug in Firefox/Geckodriver where it thinks it needs an alert modal to exist
      #   # for no good reason
      #   retry
      rescue Selenium::WebDriver::Error::UnhandledError # rubocop:disable Lint/HandleExceptions
        # delete_all_cookies fails when we've previously gone
        # to about:blank, so we rescue this error and do nothing
        # instead.
      end
      @browser.navigate.to('about:blank')
    end
    navigated = true

    # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload
    until find_xpath('/html/body/*').empty?
      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?
      sleep 0.05
    end
  rescue Selenium::WebDriver::Error::UnhandledAlertError, Selenium::WebDriver::Error::UnexpectedAlertOpenError
    # 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
    begin
      @browser.switch_to.alert.accept
      sleep 0.25 # allow time for the modal to be handled
    rescue modal_error
      # The alert is now gone
      if current_url != 'about:blank'
        begin
          # If navigation has not occurred attempt again and accept alert
          # since FF may have dismissed the alert at first attempt
          @browser.navigate.to('about:blank')
          sleep 0.1 # slight wait for alert
          @browser.switch_to.alert.accept
        rescue modal_error # rubocop:disable Metrics/BlockNesting, Lint/HandleExceptions
          # alert now gone, should mean navigation happened
        end
      end
    end
    # try cleaning up the browser again
    retry
  end
end

#resize_window_to(handle, width, height) ⇒ Object 



202
203
204
205
206
 
# File 'lib/capybara/selenium/driver.rb', line 202

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 



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

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

#switch_to_frame(frame) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/capybara/selenium/driver.rb', line 173

def switch_to_frame(frame)
  case frame
  when :top
    @frame_handles[browser.window_handle] = []
    browser.switch_to.default_content
  when :parent
    # would love to use browser.switch_to.parent_frame here
    # but it has an issue if the current frame is removed from within it
    @frame_handles[browser.window_handle].pop
    browser.switch_to.default_content
    @frame_handles[browser.window_handle].each { |fh| browser.switch_to.frame(fh) }
  else
    @frame_handles[browser.window_handle] ||= []
    @frame_handles[browser.window_handle] << frame.native
    browser.switch_to.frame(frame.native)
  end
end

#switch_to_window(handle) ⇒ Object 



236
237
238
 
# File 'lib/capybara/selenium/driver.rb', line 236

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

#title ⇒ Object 



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

def title
  browser.title
end

#visit(path) ⇒ Object 



58
59
60
 
# File 'lib/capybara/selenium/driver.rb', line 58

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

#wait? ⇒ Boolean

Returns:

  • (Boolean) 


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

def wait?; true; end

#window_handles ⇒ Object 



228
229
230
 
# File 'lib/capybara/selenium/driver.rb', line 228

def window_handles
  browser.window_handles
end

#window_size(handle) ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/capybara/selenium/driver.rb', line 195

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