123456789_123456789_123456789_123456789_123456789_

Class: Selenium::WebDriver::Driver

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
Chrome::Driver, Chromium::Driver, Edge::Driver, Firefox::Driver, IE::Driver, Remote::Driver, Safari::Driver
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, TakesScreenshot, SearchContext
Inherits: Object
Defined in: rb/lib/selenium/webdriver/common/driver.rb

Overview

The main class through which you control the browser.

See Also:

Constant Summary

SearchContext - Included

FINDERS

Class Method Summary

Instance Attribute Summary

Instance Method Summary

TakesScreenshot - Included

#save_screenshot

Save a PNG screenshot of the viewport to the given path.
#screenshot_as

Return a PNG screenshot in the given format as a string.

SearchContext - Included

#find_element

Find the first element matching the given arguments.
#find_elements

Find all elements matching the given arguments.
#extract_args

Constructor Details

.new(bridge: nil, listener: nil, **opts) ⇒ Driver

This method is for internal use only.

A new Driver instance with the given bridge. End users should use Selenium::WebDriver.for instead of using this directly.

[ GitHub ] 

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 71



def initialize(bridge: nil, listener: nil, **opts)
  @devtools = nil
  bridge ||= create_bridge(**opts)
  @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
  add_extensions(@bridge.browser)
end


  







Class Method Details



  

    .for(browser, opts = {})  ⇒ Driver 
  

  

    This method is for internal use only.
  



  

    
  





    
See Also:

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 44



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


  







Instance Attribute Details



  

    #bridge   (readonly, private)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 318



attr_reader :bridge


  







Instance Method Details



  

    #[](sel)  ⇒ WebDriver::Element 
  



  

    

Get the first element matching the given selector. If given a String or Symbol, it will be used as the id of the element.



Examples:



driver['someElementId']    #=> #<WebDriver::Element:0x1011c3b88>
driver[:tag_name => 'div'] #=> #<WebDriver::Element:0x1011c3b88>


  





  
Parameters:


    
  
  • 
    sel
    (String, Hash)
—    
    

    id or selector
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 293



def [](sel)
  sel = {id: sel} if sel.is_a?(String) || sel.is_a?(Symbol)

  find_element sel
end


  








  

    #action(**opts)  ⇒ ActionBuilder 
  



  

    
  





    
See Also:

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 141



def action(**opts)
  bridge.action(**opts)
end


  








  

    #add_extensions(browser)   (private)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 336



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


  








  

    #add_virtual_authenticator(options)  ⇒ VirtualAuthenticator 
  



  

    
  





    
See Also:

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 263



def add_virtual_authenticator(options)
  bridge.add_virtual_authenticator(options)
end


  








  

    #all  
  



  

    

driver.all(class: ‘bar’) #=> [#<WebDriver::Element:0x1011c3b88, …]


  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 279



alias all find_elements


  








  

    #browser  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 299



def browser
  bridge.browser
end


  








  

    #capabilities  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 303



def capabilities
  bridge.capabilities
end


  








  

    #close  
  



  

    

Close the current window, or the browser if no windows are left.


  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 198



def close
  bridge&.close
end


  








  

    #create_bridge(caps:, url:, http_client: nil)   (private)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 320



def create_bridge(caps:, url:, http_client: nil)
  klass = caps['webSocketUrl'] ? Remote::BiDiBridge : Remote::Bridge
  klass.new(http_client: http_client, url: url).tap do |bridge|
    bridge.create_session(caps)
  end
end


  








  

    #current_url  ⇒ String 
  



  

    

Get the URL of the current page


  





  


  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 159



def current_url
  bridge.url
end


  








  

    #execute_async_script(script, *args)  ⇒ WebDriver::Element, ... 
  



  

    

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.


  





  
Parameters:


    
  
  • 
    script
    (String)
—    
    

    JavaScript source to execute
    

    
  
    • 
  
  • 
    args
    (WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array)
—    
    

    Arguments to the script. May be empty.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 254



def execute_async_script(script, *args)
  bridge.execute_async_script(script, *args)
end


  








  

    #execute_script(script, *args)  ⇒ WebDriver::Element, ... 
  



  

    

Execute the given JavaScript


  





  
Parameters:


    
  
  • 
    script
    (String)
—    
    

    JavaScript source to execute
    

    
  
    • 
  
  • 
    args
    (WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array)
—    
    

    Arguments will be available in the given script in the ‘arguments’ pseudo-array.
    

    
  
    • 



Returns:


    
  
  • 
    (WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array)
—    
    

    The value returned from the script.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 235



def execute_script(script, *args)
  bridge.execute_script(script, *args)
end


  








  

    #first  
  



  

    

driver.first(id: ‘foo’)


  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 273



alias first find_element


  








  

    #get(url)  
  



  

    

Opens the specified URL in the browser.


  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 149



def get(url)
  navigate.to(url)
end


  








  

    #inspect  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 78



def inspect
  format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2,
                                                        browser: bridge.browser.inspect
end


  








  

    #manage  ⇒ Manager 
  



  

    
  





    
See Also:

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 132



def manage
  bridge.manage
end


  










  

    #page_source  ⇒ String 
  



  

    

Get the source of the current page


  





  


  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 179



def page_source
  bridge.page_source
end


  








  

    #quit  
  



  

    

Quit the browser


  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 187



def quit
  bridge.quit
ensure
  @service_manager&.stop
  @devtools&.close
end


  








  

    #ref  
  

  

    This method is for internal use only.
  



  

    
  





    
See Also:

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 312



def ref
  [:driver, nil]
end


  








  

    #screenshot   (private)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 332



def screenshot
  bridge.screenshot
end


  








  

    #script(*args)  ⇒ Script 
  



  

    
  





    
See Also:

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 107



def script(*args)
  if args.any?
    WebDriver.logger.deprecate('`Driver#script` as an alias for `#execute_script`',
                               '`Driver#execute_script`',
                               id: :driver_script)
    execute_script(*args)
  else
    @script ||= WebDriver::Script.new(bridge)
  end
end


  








  

    #service_url(service)   (private)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 327



def service_url(service)
  @service_manager = service.launch
  @service_manager.uri
end


  








  

    #status  ⇒ Hash 
  



  

    

information about whether a remote end is in a state in which it can create new sessions, and may include additional meta information.


  





  


  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 89



def status
  @bridge.status
end


  








  

    #switch_to  ⇒ TargetLocator 
  



  

    
  





    
See Also:

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 123



def switch_to
  @switch_to ||= WebDriver::TargetLocator.new(bridge)
end


  








  

    #title  ⇒ String 
  



  

    

Get the title of the current page


  





  


  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 169



def title
  bridge.title
end


  








  

    #window_handle  ⇒ String 
  



  

    

Get the current window handle


  





  


  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 219



def window_handle
  bridge.window_handle
end


  








  

    #window_handles  ⇒ Array 
  



  

    

Get the window handles of open browser windows.


  





    
See Also:

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/common/driver.rb', line 209



def window_handles
  bridge.window_handles
end