Class: Capybara::Selenium::Driver

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

Defined Under Namespace

Modules: ChromeDriver, FirefoxDriver

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].freeze

Instance Attribute Summary collapse

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



38
39
40
41
42
43
44
45
46
 
# File 'lib/capybara/selenium/driver.rb', line 38

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

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
22
 
# 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 => err
  raise err if err.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 



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

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 



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/capybara/selenium/driver.rb', line 24

def browser
  @browser ||= begin
    if options[:timeout]
      options[:http_client] ||= Selenium::WebDriver::Remote::Http::Default.new(read_timeout: options[:timeout])
    end
    processed_options = options.reject { |key, _val| SPECIAL_OPTIONS.include?(key) }
    Selenium::WebDriver.for(options[:browser], processed_options).tap do |driver|
      specialize_driver(driver)
      setup_exit_handler
    end
  end
  @browser
end

#close_window(handle) ⇒ Object

Raises:

  • (ArgumentError) 


174
175
176
177
178
179
180
 
# File 'lib/capybara/selenium/driver.rb', line 174

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 



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

def current_url
  browser.current_url
end

#current_window_handle ⇒ Object 



144
145
146
 
# File 'lib/capybara/selenium/driver.rb', line 144

def current_window_handle
  browser.window_handle
end

#dismiss_modal(_type, **options) ⇒ Object 



205
206
207
208
209
210
211
 
# File 'lib/capybara/selenium/driver.rb', line 205

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 



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

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 



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

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

#execute_script(script, *args) ⇒ Object 



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

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

#find_css(selector) ⇒ Object 



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

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

#find_xpath(selector) ⇒ Object 



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

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

#fullscreen_window(handle) ⇒ Object 



168
169
170
171
172
 
# File 'lib/capybara/selenium/driver.rb', line 168

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

#go_back ⇒ Object 



56
57
58
 
# File 'lib/capybara/selenium/driver.rb', line 56

def go_back
  browser.navigate.back
end

#go_forward ⇒ Object 



60
61
62
 
# File 'lib/capybara/selenium/driver.rb', line 60

def go_forward
  browser.navigate.forward
end

#html ⇒ Object 



64
65
66
 
# File 'lib/capybara/selenium/driver.rb', line 64

def html
  browser.page_source
end

#invalid_element_errors ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/capybara/selenium/driver.rb', line 226

def invalid_element_errors
  [
    ::Selenium::WebDriver::Error::StaleElementReferenceError,
    ::Selenium::WebDriver::Error::UnhandledError,
    ::Selenium::WebDriver::Error::ElementNotVisibleError,
    ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around a chromedriver go_back/go_forward race condition
    ::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 



161
162
163
164
165
166
 
# File 'lib/capybara/selenium/driver.rb', line 161

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) 


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

def needs_server?; true; end

#no_such_window_error ⇒ Object 



242
243
244
 
# File 'lib/capybara/selenium/driver.rb', line 242

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

#open_new_window ⇒ Object 



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

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

#quit ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/capybara/selenium/driver.rb', line 213

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 => err
  unless silenced_unknown_error_message?(err.message) # Most likely already gone
    # probably already gone but not sure - so warn
    warn "Ignoring Selenium UnknownError during driver quit: #{err.message}"
  end
ensure
  @browser = nil
end

#refresh ⇒ Object 



52
53
54
 
# File 'lib/capybara/selenium/driver.rb', line 52

def refresh
  browser.navigate.refresh
end

#reset! ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/capybara/selenium/driver.rb', line 106

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 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
    accept_unhandled_reset_alert
    # try cleaning up the browser again
    retry
  end
end

#resize_window_to(handle, width, height) ⇒ Object 



155
156
157
158
159
 
# File 'lib/capybara/selenium/driver.rb', line 155

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 



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

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

#switch_to_frame(frame) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/capybara/selenium/driver.rb', line 129

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.native
    browser.switch_to.frame(frame.native)
  end
end

#switch_to_window(handle) ⇒ Object 



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

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

#title ⇒ Object 



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

def title
  browser.title
end

#visit(path) ⇒ Object 



48
49
50
 
# File 'lib/capybara/selenium/driver.rb', line 48

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

#wait? ⇒ Boolean

Returns:

  • (Boolean) 


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

def wait?; true; end

#window_handles ⇒ Object 



182
183
184
 
# File 'lib/capybara/selenium/driver.rb', line 182

def window_handles
  browser.window_handles
end

#window_size(handle) ⇒ Object 



148
149
150
151
152
153
 
# File 'lib/capybara/selenium/driver.rb', line 148

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