Method: Appium::Driver#start_driver

Defined in:

lib/appium_lib/driver.rb

#start_driver(http_client_ops = { http_client: nil, open_timeout: 999_999, read_timeout: 999_999 }) ⇒ Selenium::WebDriver

Creates a new global driver and quits the old one if it exists. You can customise http_client as the following

Read www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device to understand more what the driver can call instance methods.

Examples:

require 'rubygems'
require 'appium_lib'

# platformName takes a string or a symbol.
# Start iOS driver
opts = {
         caps: {
           platformName: :ios,
           app: '/path/to/MyiOS.app'
         },
         appium_lib: {
           wait_timeout: 30
         }
       }
appium_driver = Appium::Driver.new(opts) #=> return an Appium::Driver instance
appium_driver.start_driver #=> return an Appium::Core::Base::Driver

Parameters:

• http_client_ops (Hash) (defaults to: { http_client: nil, open_timeout: 999_999, read_timeout: 999_999 }) —

  a customizable set of options

Options Hash (http_client_ops):

• :http_client (Hash) —

  Custom HTTP Client

• :open_timeout (Hash) —

  Custom open timeout for http client.

• :read_timeout (Hash) —

  Custom read timeout for http client.

Returns:

• (Selenium::WebDriver) —

  the new global driver

# File 'lib/appium_lib/driver.rb', line 539

def start_driver(http_client_ops = { http_client: nil, open_timeout: 999_999, read_timeout: 999_999 })
  if http_client_ops[:http_client].nil?
    http_client = ::Appium::Http::Default.new(open_timeout: http_client_ops[:open_timeout],
                                              read_timeout: http_client_ops[:read_timeout])
  end

  # TODO: do not kill the previous session in the future version.
  if $driver.nil?
    driver_quit
  else
    $driver.driver_quit
  end

  # If automationName is set only in server side, then the following automation_name should be nil before
  # starting driver.
  automation_name = @core.automation_name

  @driver = @core.start_driver(server_url: server_url,
                               http_client_ops: {
                                 http_client: http_client,
                                 open_timeout: 999_999,
                                 read_timeout: 999_999
                               })
  @http_client = @core.http_client

  # if automation_name was nil before start_driver, then re-extend driver specific methods
  # to be able to extend correctly.
  extend_for(device: @core.device, automation_name: @core.automation_name) if automation_name.nil?

  @appium_server_status = appium_server_version

  @driver
end