Module: TestCentricity::WebDriverConnect

Includes:
Capybara::DSL
Defined in:
lib/testcentricity_web/webdriver_helper.rb

Class Method Summary collapse

Class Method Details

.initialize_appium ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 48

def self.initialize_appium
  Environ.set_device(true)
  Environ.set_platform(:mobile)
  Environ.set_device_type(ENV['APP_DEVICE'])
  Capybara.default_driver = :appium
  endpoint = 'http://localhost:4723/wd/hub'
  desired_capabilities = {
      platformName:    ENV['APP_PLATFORM_NAME'],
      platformVersion: ENV['APP_VERSION'],
      browserName:     ENV['APP_BROWSER'],
      deviceName:      ENV['APP_DEVICE']
  }
  desired_capabilities['deviceOrientation'] = ENV['ORIENTATION'] if ENV['ORIENTATION']
  desired_capabilities['udid'] = ENV['APP_UDID'] if ENV['APP_UDID']
  desired_capabilities['safariInitialUrl'] = ENV['APP_INITIAL_URL'] if ENV['APP_INITIAL_URL']
  desired_capabilities['safariAllowPopups'] = ENV['APP_ALLOW_POPUPS'] if ENV['APP_ALLOW_POPUPS']
  desired_capabilities['safariIgnoreFraudWarning'] = ENV['APP_IGNORE_FRAUD_WARNING'] if ENV['APP_IGNORE_FRAUD_WARNING']
  desired_capabilities['noReset'] = ENV['APP_NO_RESET'] if ENV['APP_NO_RESET']
  desired_capabilities['locale'] = ENV['LOCALE'] if ENV['LOCALE']

  Capybara.register_driver :appium do |app|
    appium_lib_options = { server_url: endpoint }
    all_options = {
        browser:     :safari,
        appium_lib:  appium_lib_options,
        caps:        desired_capabilities
    }
    Appium::Capybara::Driver.new app, all_options
  end
end

.initialize_browser_size ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 261

def self.initialize_browser_size
  browser = Environ.browser.to_s
  if Environ.is_desktop?
    if ENV['BROWSER_SIZE'] == 'max'
      Browsers.maximize_browser
    elsif ENV['BROWSER_SIZE']
      Browsers.set_browser_window_size(ENV['BROWSER_SIZE'])
    else
      Browsers.set_browser_window_size(Browsers.browser_size(browser, ENV['ORIENTATION']))
    end
  elsif Environ.is_mobile? && !Environ.is_device?
    Browsers.set_browser_window_size(Browsers.browser_size(browser, ENV['ORIENTATION']))
  end
end

.initialize_browserstack ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
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
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 104

def self.initialize_browserstack
  browser = ENV['BS_BROWSER']

  endpoint = "http://#{ENV['BS_USERNAME']}:#{ENV['BS_AUTHKEY']}@hub.browserstack.com/wd/hub"
  Capybara.register_driver :browserstack do |app|
    capabilities = Selenium::WebDriver::Remote::Capabilities.new

    if ENV['BS_OS']
      capabilities['os'] = ENV['BS_OS']
      capabilities['os_version'] = ENV['BS_OS_VERSION']
      Environ.set_os("#{ENV['BS_OS']} #{ENV['BS_OS_VERSION']}")
      capabilities['browser'] = browser || 'chrome'
      capabilities['browser_version'] = ENV['BS_VERSION'] if ENV['BS_VERSION']
      capabilities['resolution'] = ENV['RESOLUTION'] if ENV['RESOLUTION']
    elsif ENV['BS_PLATFORM']
      capabilities[:platform] = ENV['BS_PLATFORM']
      capabilities[:browserName] = browser
      capabilities['device'] = ENV['BS_DEVICE'] if ENV['BS_DEVICE']
      Environ.set_platform(:mobile)
      Environ.set_device(true)
      Environ.set_device_type(ENV['BS_DEVICE'])
      capabilities['deviceOrientation'] = ENV['ORIENTATION'] if ENV['ORIENTATION']
    end

    capabilities['browserstack.debug'] = 'true'
    capabilities['project'] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
    capabilities['build'] = ENV['AUTOMATE_BUILD'] if ENV['AUTOMATE_BUILD']
    ENV['TEST_CONTEXT'] ?
        capabilities['name'] = "#{ENV['TEST_ENVIRONMENT']} - #{ENV['TEST_CONTEXT']}" :
        capabilities['name'] = ENV['TEST_ENVIRONMENT']

    capabilities['acceptSslCerts'] = 'true'
    capabilities['browserstack.local'] = 'true' if ENV['TUNNELING']
    capabilities['browserstack.localIdentifier'] =  ENV['BS_LOCAL_ID'] if ENV['BS_LOCAL_ID']

    case browser.downcase.to_sym
    when :ie
      capabilities['ie.ensureCleanSession'] = 'true'
      capabilities['ie.browserCommandLineSwitches'] = 'true'
      capabilities['nativeEvents'] ='true'
    when :safari
      capabilities['cleanSession'] = 'true'
    when :iphone, :ipad
      capabilities['javascriptEnabled'] = 'true'
      capabilities['cleanSession'] = 'true'
    end
    Capybara::Selenium::Driver.new(app, :browser => :remote, :url => endpoint, :desired_capabilities => capabilities)
  end

  Environ.set_browser(browser)

  Capybara.default_driver = :browserstack
  Capybara.run_server = false
end

.initialize_crossbrowser ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 159

def self.initialize_crossbrowser
  browser = ENV['CB_BROWSER']

  endpoint = "http://#{ENV['CB_USERNAME']}:#{ENV['CB_AUTHKEY']}@hub.crossbrowsertesting.com:80/wd/hub"
  Capybara.register_driver :crossbrowser do |app|
    capabilities = Selenium::WebDriver::Remote::Capabilities.new
    capabilities['name'] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
    capabilities['build'] = ENV['AUTOMATE_BUILD'] if ENV['AUTOMATE_BUILD']
    capabilities['browser_api_name'] = browser
    capabilities['screen_resolution'] = ENV['RESOLUTION'] if ENV['RESOLUTION']
    if ENV['CB_OS']
      capabilities['os_api_name'] = ENV['CB_OS']
      Environ.set_platform(:desktop)
    elsif ENV['CB_PLATFORM']
      capabilities['os_api_name'] = ENV['CB_PLATFORM']
      Environ.set_device_type(ENV['CB_PLATFORM'])
      Environ.set_platform(:mobile)
    end
    Capybara::Selenium::Driver.new(app, :browser => :remote, :url => endpoint, :desired_capabilities => capabilities)
  end

  Environ.set_browser(browser)

  Capybara.default_driver = :crossbrowser
  Capybara.run_server = false
end

.initialize_local_browser(browser) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 79

def self.initialize_local_browser(browser)
  Capybara.default_driver = :selenium
  Capybara.register_driver :selenium do |app|
    case browser.downcase.to_sym
    when :firefox, :chrome, :ie, :safari, :edge
      Capybara::Selenium::Driver.new(app, :browser => browser.to_sym)
    else
      user_agent = Browsers.mobile_device_agent(browser)
      Environ.set_platform(:mobile)
      Environ.set_device_type(Browsers.mobile_device_name(browser))
      ENV['HOST_BROWSER'] ? host_browser = ENV['HOST_BROWSER'].downcase.to_sym : host_browser = :firefox
      case host_browser
        when :firefox
          profile = Selenium::WebDriver::Firefox::Profile.new
          profile['general.useragent.override'] = user_agent
          Capybara::Selenium::Driver.new(app, :profile => profile)
        when :chrome
          args = []
          args << "--user-agent='#{user_agent}'"
          Capybara::Selenium::Driver.new(app, :browser => :chrome, :args => args)
      end
    end
  end
end

.initialize_poltergeist ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 186

def self.initialize_poltergeist
  Capybara.default_driver = :poltergeist
  Capybara.register_driver :poltergeist do |app|
    options = {
        :js_errors => true,
        :timeout => 120,
        :debug => false,
        :phantomjs_options => ['--load-images=no', '--disk-cache=false'],
        :inspector => true,
    }
    Capybara::Poltergeist::Driver.new(app, options)
  end
end

.initialize_saucelabs ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 200

def self.initialize_saucelabs
  browser = ENV['SL_BROWSER']

  endpoint = "http://#{ENV['SL_USERNAME']}:#{ENV['SL_AUTHKEY']}@ondemand.saucelabs.com:80/wd/hub"
  Capybara.register_driver :saucelabs do |app|
    capabilities = Selenium::WebDriver::Remote::Capabilities.new
    capabilities['name'] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
    capabilities['build'] = ENV['AUTOMATE_BUILD'] if ENV['AUTOMATE_BUILD']
    capabilities['browserName'] = browser
    capabilities['version'] = ENV['SL_VERSION'] if ENV['SL_VERSION']
    capabilities['screenResolution'] = ENV['RESOLUTION'] if ENV['RESOLUTION']
    if ENV['SL_OS']
      capabilities['platform'] = ENV['SL_OS']
      Environ.set_platform(:desktop)
    elsif ENV['SL_PLATFORM']
      capabilities['platform'] = ENV['SL_PLATFORM']
      capabilities['deviceName'] = ENV['SL_DEVICE']
      capabilities['deviceType'] = ENV['SL_DEVICE_TYPE'] if ENV['SL_DEVICE_TYPE']
      capabilities['deviceOrientation'] = ENV['ORIENTATION'] if ENV['ORIENTATION']
      Environ.set_device_type(ENV['SL_DEVICE'])
      Environ.set_platform(:mobile)
    end

    Capybara::Selenium::Driver.new(app, :browser => :remote, :url => endpoint, :desired_capabilities => capabilities)
  end

  Environ.set_browser(browser)

  Capybara.default_driver = :saucelabs
  Capybara.run_server = false
end

.initialize_testingbot ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 232

def self.initialize_testingbot
  browser = ENV['TB_BROWSER']

  if ENV['TUNNELING']
    endpoint = '@localhost:4445/wd/hub'
  else
    endpoint = '@hub.testingbot.com:4444/wd/hub'
  end
  endpoint = "http://#{ENV['TB_USERNAME']}:#{ENV['TB_AUTHKEY']}#{endpoint}"
  Capybara.register_driver :testingbot do |app|
    capabilities = Selenium::WebDriver::Remote::Capabilities.new
    capabilities['name'] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
    capabilities['build'] = ENV['AUTOMATE_BUILD'] if ENV['AUTOMATE_BUILD']
    capabilities['browserName'] = browser
    capabilities['version'] = ENV['TB_VERSION'] if ENV['TB_VERSION']
    capabilities['screen-resolution'] = ENV['RESOLUTION'] if ENV['RESOLUTION']
    capabilities['platform'] = ENV['TB_OS']
    Environ.set_platform(:desktop)

    Capybara::Selenium::Driver.new(app, :browser => :remote, :url => endpoint, :desired_capabilities => capabilities)
  end

  Environ.set_browser(browser)

  Capybara.default_driver = :testingbot
  Capybara.run_server = false

end

.initialize_web_driver(app_host = nil) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 8

def self.initialize_web_driver(app_host = nil)
  Capybara.app_host = app_host unless app_host.nil?
  browser = ENV['WEB_BROWSER']

  # assume that we're testing within a local desktop web browser
  Environ.set_platform(:desktop)
  Environ.set_browser(browser)
  Environ.set_device(false)
  Environ.set_device_type('browser')

  case browser.downcase.to_sym

  when :appium
    initialize_appium
  when :browserstack
    initialize_browserstack
  when :crossbrowser
    initialize_crossbrowser
  when :poltergeist
    initialize_poltergeist
  when :saucelabs
    initialize_saucelabs
  when :testingbot
    initialize_testingbot
  else
    initialize_local_browser(browser)
  end

  # set browser window size only if testing with a desktop web browser
  initialize_browser_size unless Capybara.current_driver == :poltergeist || Capybara.current_driver == :appium

  puts "Using #{Environ.browser.to_s} browser"
end

.set_domain(url) ⇒ Object 



42
43
44
 
# File 'lib/testcentricity_web/webdriver_helper.rb', line 42

def self.set_domain(url)
  Capybara.app_host = url
end