Class: TestCentricity::WebDriverConnect

Inherits:
Object
  • Object
show all
Includes:
Capybara::DSL
Defined in:
lib/testcentricity_web/web_core/webdriver_helper.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#bs_local ⇒ Object

Returns the value of attribute bs_local.



12
13
14
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 12

def bs_local
  @bs_local
end

#capabilities ⇒ Object

Returns the value of attribute capabilities.



15
16
17
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 15

def capabilities
  @capabilities
end

#downloads_path ⇒ Object

Returns the value of attribute downloads_path.



13
14
15
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 13

def downloads_path
  @downloads_path
end

#endpoint ⇒ Object

Returns the value of attribute endpoint.



14
15
16
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 14

def endpoint
  @endpoint
end

Class Method Details

.close_tunnel ⇒ Object 



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 119

def self.close_tunnel
  unless @bs_local.nil?
    @bs_local.stop
    if @bs_local.isRunning
      raise 'BrowserStack Local instance could not be stopped'
    else
      puts 'BrowserStack Local instance has been stopped'
    end
  end
end

.config_file_uploads ⇒ Object 



673
674
675
676
677
678
679
680
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 673

def self.config_file_uploads
  # configure file_detector for remote uploads
  selenium = Capybara.page.driver.browser
  selenium.file_detector = lambda do |args|
    str = args.first.to_s
    str if File.exist?(str)
  end
end

.initialize_appium ⇒ Object 



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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 132

def self.initialize_appium
  Environ.platform    = :mobile
  Environ.device_name = ENV['APP_DEVICE']
  Environ.device_os   = ENV['APP_PLATFORM_NAME'].downcase.to_sym
  Environ.device_type = ENV['DEVICE_TYPE'] if ENV['DEVICE_TYPE']
  Environ.device_os_version = ENV['APP_VERSION']
  Environ.device_orientation = ENV['ORIENTATION'] if ENV['ORIENTATION']
  Capybara.default_driver = :appium
  @endpoint = 'http://localhost:4723/wd/hub' if @endpoint.nil?
  desired_capabilities = {
      platformName:    Environ.device_os,
      platformVersion: Environ.device_os_version,
      browserName:     ENV['APP_BROWSER'],
      deviceName:      Environ.device_name
  }
  desired_capabilities[:avd] = ENV['APP_DEVICE'] if Environ.device_os == :android
  desired_capabilities[:automationName] = ENV['AUTOMATION_ENGINE'] if ENV['AUTOMATION_ENGINE']
  if ENV['UDID']
    Environ.device = :device
    desired_capabilities[:udid] = ENV['UDID']
    desired_capabilities[:xcodeOrgId] = ENV['TEAM_ID'] if ENV['TEAM_ID']
    desired_capabilities[:xcodeSigningId] = ENV['TEAM_NAME'] if ENV['TEAM_NAME']
  else
    Environ.device = :simulator
    desired_capabilities[:orientation] = Environ.device_orientation.upcase if Environ.device_orientation
    if Environ.device_os == :ios
      desired_capabilities[:language] = Environ.language if Environ.language
      desired_capabilities[:locale] = Environ.locale.gsub('-', '_') if Environ.locale
    end
  end
  desired_capabilities[:safariIgnoreFraudWarning] = ENV['APP_IGNORE_FRAUD_WARNING'] if ENV['APP_IGNORE_FRAUD_WARNING']
  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[:shutdownOtherSimulators] = ENV['SHUTDOWN_OTHER_SIMS'] if ENV['SHUTDOWN_OTHER_SIMS']
  desired_capabilities[:forceSimulatorSoftwareKeyboardPresence] = ENV['SHOW_SIM_KEYBOARD'] if ENV['SHOW_SIM_KEYBOARD']

  desired_capabilities[:autoAcceptAlerts] = ENV['AUTO_ACCEPT_ALERTS'] if ENV['AUTO_ACCEPT_ALERTS']
  desired_capabilities[:autoDismissAlerts] = ENV['AUTO_DISMISS_ALERTS'] if ENV['AUTO_DISMISS_ALERTS']
  desired_capabilities[:isHeadless] = ENV['HEADLESS'] if ENV['HEADLESS']

  desired_capabilities[:newCommandTimeout] = ENV['NEW_COMMAND_TIMEOUT'] if ENV['NEW_COMMAND_TIMEOUT']
  desired_capabilities[:noReset] = ENV['APP_NO_RESET'] if ENV['APP_NO_RESET']
  desired_capabilities[:fullReset] = ENV['APP_FULL_RESET'] if ENV['APP_FULL_RESET']
  desired_capabilities[:webkitDebugProxyPort] = ENV['WEBKIT_DEBUG_PROXY_PORT'] if ENV['WEBKIT_DEBUG_PROXY_PORT']
  desired_capabilities[:webDriverAgentUrl] = ENV['WEBDRIVER_AGENT_URL'] if ENV['WEBDRIVER_AGENT_URL']
  desired_capabilities[:usePrebuiltWDA] = ENV['USE_PREBUILT_WDA'] if ENV['USE_PREBUILT_WDA']
  desired_capabilities[:useNewWDA] = ENV['USE_NEW_WDA'] if ENV['USE_NEW_WDA']
  desired_capabilities[:chromedriverExecutable] = ENV['CHROMEDRIVER_EXECUTABLE'] if ENV['CHROMEDRIVER_EXECUTABLE']
  # set wdaLocalPort (iOS) or systemPort (Android) if PARALLEL_PORT is true
  if ENV['PARALLEL'] && ENV['PARALLEL_PORT']
    if Environ.device_os == :ios
      desired_capabilities[:wdaLocalPort] = 8100 + ENV['TEST_ENV_NUMBER'].to_i
    else
      desired_capabilities[:systemPort] = 8200 + ENV['TEST_ENV_NUMBER'].to_i
    end
  else
    desired_capabilities[:wdaLocalPort] = ENV['WDA_LOCAL_PORT'] if ENV['WDA_LOCAL_PORT']
    desired_capabilities[:systemPort]   = ENV['SYSTEM_PORT'] if ENV['SYSTEM_PORT']
  end

  unless @capabilities.nil?
    desired_capabilities = @capabilities
  end

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

.initialize_browser_size ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 91

def self.initialize_browser_size
  # tile browser windows if running in multiple parallel threads and BROWSER_TILE environment variable is true
  if ENV['PARALLEL'] && ENV['BROWSER_TILE']
    thread = ENV['TEST_ENV_NUMBER'].to_i
    if thread > 1
      Browsers.set_browser_window_position(100 * thread - 1, 100 * thread - 1)
      sleep(1)
    end
  else
    Browsers.set_browser_window_position(10, 10)
    sleep(1)
  end

  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
  Environ.session_state = :running
end

.initialize_browserstack ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 304

def self.initialize_browserstack
  browser = ENV['BS_BROWSER']
  Environ.grid = :browserstack

  if ENV['BS_REAL_MOBILE'] || ENV['BS_DEVICE']
    Environ.platform    = :mobile
    Environ.device_name = ENV['BS_DEVICE']
    Environ.device_os   = ENV['BS_OS']
    Environ.device_orientation = ENV['ORIENTATION'] if ENV['ORIENTATION']
    Environ.device = if ENV['BS_REAL_MOBILE']
                       :device
                     else
                       :simulator
                     end
  elsif ENV['BS_OS']
    Environ.os = "#{ENV['BS_OS']} #{ENV['BS_OS_VERSION']}"
  end
  # specify endpoint url
  @endpoint = "http://#{ENV['BS_USERNAME']}:#{ENV['BS_AUTHKEY']}@hub-cloud.browserstack.com/wd/hub" if @endpoint.nil?
  # enable tunneling if specified
  if ENV['TUNNELING']
    @bs_local = BrowserStack::Local.new
    bs_local_args = {'key' => "#{ENV['BS_AUTHKEY']}"}
    @bs_local.start(bs_local_args)
    if @bs_local.isRunning
      puts 'BrowserStack Local instance has been started'
    else
      puts 'BrowserStack Local instance failed to start'
    end
  end
  # define BrowserStack options
  options = if @capabilities.nil?
              browser_options = {}
              # define the required set of BrowserStack options
              bs_options = {
                userName: ENV['BS_USERNAME'],
                accessKey: ENV['BS_AUTHKEY'],
                sessionName: test_context_message,
                os: ENV['BS_OS'],
                osVersion: ENV['BS_OS_VERSION']
              }
              # define browser specific BrowserStack options
              case browser.downcase.to_sym
              when :safari
                browser_options[:enablePopups] = ENV['ALLOW_POPUPS'] if ENV['ALLOW_POPUPS']
                browser_options[:allowAllCookies] = ENV['ALLOW_COOKIES'] if ENV['ALLOW_COOKIES']
                bs_options[:safari] = browser_options unless browser_options.empty?
              when :ie
                browser_options[:enablePopups] = ENV['ALLOW_POPUPS'] if ENV['ALLOW_POPUPS']
                bs_options[:ie] = browser_options unless browser_options.empty?
              when :edge
                browser_options[:enablePopups] = ENV['ALLOW_POPUPS'] if ENV['ALLOW_POPUPS']
                bs_options[:edge] = browser_options unless browser_options.empty?
              end
              # define the optional BrowserStack options
              bs_options[:projectName] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
              bs_options[:buildName] = ENV['AUTOMATE_BUILD'] if ENV['AUTOMATE_BUILD']
              bs_options[:headless] = ENV['HEADLESS'] if ENV['HEADLESS']
              bs_options[:timezone] = ENV['TIME_ZONE'] if ENV['TIME_ZONE']
              bs_options[:geoLocation] = ENV['IP_GEOLOCATION'] if ENV['IP_GEOLOCATION']
              bs_options[:video] = ENV['RECORD_VIDEO'] if ENV['RECORD_VIDEO']
              bs_options[:debug] = ENV['SCREENSHOTS'] if ENV['SCREENSHOTS']
              bs_options[:networkLogs] = ENV['NETWORK_LOGS'] if ENV['NETWORK_LOGS']
              bs_options[:local] = ENV['TUNNELING'] if ENV['TUNNELING']
              bs_options[:deviceOrientation] = ENV['ORIENTATION'] if ENV['ORIENTATION']
              bs_options[:appiumLogs] = ENV['APPIUM_LOGS'] if ENV['APPIUM_LOGS']
              bs_options[:realMobile] = ENV['BS_REAL_MOBILE'] if ENV['BS_REAL_MOBILE']
              # define mobile device options
              if ENV['BS_DEVICE']
                bs_options[:deviceName] = ENV['BS_DEVICE']
                bs_options[:appiumVersion] = '1.22.0'
                {
                  browserName: browser,
                  'bstack:options': bs_options
                }
              else
                # define desktop browser options
                bs_options[:resolution] = ENV['RESOLUTION'] if ENV['RESOLUTION']
                bs_options[:seleniumVersion] = '4.1.0'
                {
                  browserName: browser,
                  browserVersion: ENV['BS_VERSION'],
                  'bstack:options': bs_options
                }
              end
            else
              @capabilities
            end
  register_remote_driver(:browserstack, browser, options)
  # configure file_detector for remote uploads
  config_file_uploads
  Environ.tunneling = ENV['TUNNELING'] if ENV['TUNNELING']
  Environ.device_type = ENV['DEVICE_TYPE'] if ENV['DEVICE_TYPE']
end

.initialize_lambdatest ⇒ Object 



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 399

def self.initialize_lambdatest
  browser = ENV['LT_BROWSER']
  Environ.grid = :lambdatest
  Environ.os = ENV['LT_OS']
  Environ.platform = :desktop
  Environ.tunneling = ENV['TUNNELING'] if ENV['TUNNELING']
  # specify endpoint url
  @endpoint = "https://#{ENV['LT_USERNAME']}:#{ENV['LT_AUTHKEY']}@hub.lambdatest.com/wd/hub" if @endpoint.nil?
  # define LambdaTest options
  options = if @capabilities.nil?
              # define the required set of LambdaTest options
              lt_options = {
                user: ENV['LT_USERNAME'],
                accessKey: ENV['LT_AUTHKEY'],
                build: test_context_message,
                platformName: ENV['LT_OS'],
                resolution: ENV['RESOLUTION'],
                selenium_version: '4.0.0',
              }
              # define the optional LambdaTest options
              lt_options[:name] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
              lt_options[:headless] = ENV['HEADLESS'] if ENV['HEADLESS']
              lt_options[:timezone] = ENV['TIME_ZONE'] if ENV['TIME_ZONE']
              lt_options[:geoLocation] = ENV['GEO_LOCATION'] if ENV['GEO_LOCATION']
              lt_options[:video] = ENV['RECORD_VIDEO'] if ENV['RECORD_VIDEO']
              lt_options[:visual] = ENV['SCREENSHOTS'] if ENV['SCREENSHOTS']
              lt_options[:network] = ENV['NETWORK_LOGS'] if ENV['NETWORK_LOGS']
              lt_options[:tunnel] = ENV['TUNNELING'] if ENV['TUNNELING']
              # define browser specific LambdaTest options
              case browser.downcase.to_sym
              when :safari
                lt_options['safari.popups'] = ENV['ALLOW_POPUPS'] if ENV['ALLOW_POPUPS']
                lt_options['safari.cookies'] = ENV['ALLOW_COOKIES'] if ENV['ALLOW_COOKIES']
              when :ie
                lt_options['ie.popups'] = ENV['ALLOW_POPUPS'] if ENV['ALLOW_POPUPS']
              when :microsoftedge
                lt_options['edge.popups'] = ENV['ALLOW_POPUPS'] if ENV['ALLOW_POPUPS']
              end
              {
                browserName: browser,
                browserVersion: ENV['LT_VERSION'],
                'LT:Options': lt_options
              }
            else
              @capabilities
            end
  register_remote_driver(:lambdatest, browser, options)
  # configure file_detector for remote uploads
  config_file_uploads
end

.initialize_local_browser ⇒ Object 



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
231
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 206

def self.initialize_local_browser
  Environ.os = case
               when OS.osx?
                 'OS X'
               when OS.windows?
                 'Windows'
               when OS.linux?
                 'Linux'
               else
                 'unknown'
               end
  browser = ENV['WEB_BROWSER'].downcase.to_sym

  case browser
  when :firefox, :chrome, :ie, :safari, :edge
    Environ.platform = :desktop
  when :chrome_headless, :firefox_headless, :edge_headless
    Environ.platform = :desktop
    Environ.headless = true
  else
    Environ.platform = :mobile
    Environ.device_name = Browsers.mobile_device_name(ENV['WEB_BROWSER'])
  end

  Capybara.register_driver :selenium do |app|
    case browser
    when :safari, :ie
      Capybara::Selenium::Driver.new(app, browser: browser)
    when :firefox, :firefox_headless
      profile = Selenium::WebDriver::Firefox::Profile.new
      profile['browser.download.dir'] = @downloads_path
      profile['browser.download.folderList'] = 2
      profile['browser.download.manager.showWhenStarting'] = false
      profile['browser.download.manager.closeWhenDone'] = true
      profile['browser.download.manager.showAlertOnComplete'] = false
      profile['browser.download.manager.alertOnEXEOpen'] = false
      profile['browser.download.manager.useWindow'] = false
      profile['browser.helperApps.alwaysAsk.force'] = false
      profile['pdfjs.disabled'] = true

      mime_types = ENV['MIME_TYPES'] || 'images/jpeg, application/pdf, application/octet-stream'
      profile['browser.helperApps.neverAsk.saveToDisk'] = mime_types

      profile['intl.accept_languages'] = ENV['LOCALE'] if ENV['LOCALE']
      options = Selenium::WebDriver::Firefox::Options.new(profile: profile)
      options.args << '--headless' if browser == :firefox_headless
      Capybara::Selenium::Driver.new(app, browser: :firefox, capabilities: [options])
    when :chrome, :chrome_headless
      options = Selenium::WebDriver::Chrome::Options.new(options: {'excludeSwitches' => ['enable-automation']})
      prefs = {
        prompt_for_download: false,
        directory_upgrade:   true,
        default_directory:   @downloads_path
      }
      options.add_preference(:download, prefs)
      options.add_argument('--disable-dev-shm-usage')
      options.add_argument("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
      if browser == :chrome_headless
        options.add_argument('--headless')
        options.add_argument('--disable-gpu')
        options.add_argument('--no-sandbox')
      end

      Capybara::Selenium::Driver.new(app, browser: :chrome, capabilities: [options])
    when :edge, :edge_headless
      options = Selenium::WebDriver::Edge::Options.new(options: {'excludeSwitches' => ['enable-automation']})
      prefs = {
        prompt_for_download: false,
        directory_upgrade:   true,
        default_directory:   @downloads_path
      }
      options.add_preference(:download, prefs)
      options.add_argument('--disable-dev-shm-usage')
      options.add_argument("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
      if browser == :edge_headless
        options.add_argument('--headless')
        options.add_argument('--disable-gpu')
        options.add_argument('--no-sandbox')
      end

      Capybara::Selenium::Driver.new(app, browser: :edge, capabilities: [options])
    else
      if ENV['HOST_BROWSER'] && ENV['HOST_BROWSER'].downcase.to_sym == :chrome
        user_agent = Browsers.mobile_device_agent(ENV['WEB_BROWSER'])
        options = Selenium::WebDriver::Chrome::Options.new(options: {'excludeSwitches' => ['enable-automation']})
        options.add_argument('--disable-infobars')
        options.add_argument('--disable-dev-shm-usage')
        options.add_argument("--user-agent='#{user_agent}'")
        options.add_argument("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
        Capybara::Selenium::Driver.new(app, browser: :chrome, capabilities: [options])
      else
        raise "Requested browser '#{browser}' is not supported"
      end
    end
  end
  Capybara.default_driver = :selenium
end

.initialize_remote ⇒ Object 



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 450

def self.initialize_remote
  Environ.grid = :selenium_grid
  browser  = ENV['WEB_BROWSER'].downcase.to_sym
  @endpoint = ENV['REMOTE_ENDPOINT'] || 'http://127.0.0.1:4444/wd/hub' if @endpoint.nil?
  Capybara.register_driver :remote_browser do |app|
    case browser
    when :safari
      options = Selenium::WebDriver::Safari::Options.new
    when :ie
      options = Selenium::WebDriver::IE::Options.new
    when :firefox, :firefox_headless
      profile = Selenium::WebDriver::Firefox::Profile.new
      profile['browser.download.dir'] = @downloads_path
      profile['browser.download.folderList'] = 2
      profile['browser.download.manager.showWhenStarting'] = false
      profile['browser.download.manager.closeWhenDone'] = true
      profile['browser.download.manager.showAlertOnComplete'] = false
      profile['browser.download.manager.alertOnEXEOpen'] = false
      profile['browser.download.manager.useWindow'] = false
      profile['browser.helperApps.alwaysAsk.force'] = false
      profile['pdfjs.disabled'] = true

      mime_types = ENV['MIME_TYPES'] || 'images/jpeg, application/pdf, application/octet-stream'
      profile['browser.helperApps.neverAsk.saveToDisk'] = mime_types

      profile['intl.accept_languages'] = ENV['LOCALE'] if ENV['LOCALE']
      options = Selenium::WebDriver::Firefox::Options.new(profile: profile)
      options.args << '--headless' if browser == :firefox_headless
    when :chrome, :chrome_headless
      options = Selenium::WebDriver::Chrome::Options.new(options: {'excludeSwitches' => ['enable-automation']})
      prefs = {
        prompt_for_download: false,
        directory_upgrade:   true,
        default_directory:   @downloads_path
      }
      options.add_preference(:download, prefs)
      options.add_argument('--disable-dev-shm-usage')
      options.add_argument("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
      if browser == :chrome_headless
        options.add_argument('--headless')
        options.add_argument('--disable-gpu')
        options.add_argument('--no-sandbox')
      end
    when :edge, :edge_headless
      options = Selenium::WebDriver::Edge::Options.new(options: {'excludeSwitches' => ['enable-automation']})
      prefs = {
        prompt_for_download: false,
        directory_upgrade:   true,
        default_directory:   @downloads_path
      }
      options.add_preference(:download, prefs)
      options.add_argument('--disable-dev-shm-usage')
      options.add_argument("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
      if browser == :edge_headless
        options.add_argument('--headless')
        options.add_argument('--disable-gpu')
        options.add_argument('--no-sandbox')
      end
    else
      if ENV['HOST_BROWSER'] && ENV['HOST_BROWSER'].downcase.to_sym == :chrome
        Environ.platform = :mobile
        Environ.device_name = Browsers.mobile_device_name(ENV['WEB_BROWSER'])
        user_agent = Browsers.mobile_device_agent(ENV['WEB_BROWSER'])
        options = Selenium::WebDriver::Chrome::Options.new(options: {'excludeSwitches' => ['enable-automation']})
        options.add_argument('--disable-infobars')
        options.add_argument('--disable-dev-shm-usage')
        options.add_argument("--user-agent='#{user_agent}'")
        options.add_argument("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
      else
        raise "Requested browser '#{browser}' is not supported on Selenium Grid"
      end
    end
    Capybara::Selenium::Driver.new(app,
                                   browser: :remote,
                                   url: @endpoint,
                                   capabilities: [options]).tap do |driver|
      # configure file_detector for remote uploads
      driver.browser.file_detector = lambda do |args|
        str = args.first.to_s
        str if File.exist?(str)
      end
    end
  end
  Capybara.current_driver = :remote_browser
  Capybara.default_driver = :remote_browser
end

.initialize_saucelabs ⇒ Object 



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 537

def self.initialize_saucelabs
  browser = ENV['SL_BROWSER']
  Environ.grid = :saucelabs

  if ENV['SL_OS']
    Environ.platform = :desktop
    Environ.os = ENV['SL_OS']
  elsif ENV['SL_PLATFORM']
    Environ.device_name = ENV['SL_DEVICE']
    Environ.platform = :mobile
    Environ.device_orientation = ENV['ORIENTATION'] if ENV['ORIENTATION']
    Environ.device = :simulator
  end
  # specify endpoint url
  @endpoint = "https://#{ENV['SL_USERNAME']}:#{ENV['SL_AUTHKEY']}@ondemand.#{ENV['DATA_CENTER']}.saucelabs.com/wd/hub" if @endpoint.nil?
  # define SauceLab options
  options = if @capabilities.nil?
              # define the required set of SauceLab options
              sl_options = {
                userName: ENV['SL_USERNAME'],
                accessKey: ENV['SL_AUTHKEY'],
                build: test_context_message
              }
              # define the optional SauceLab options
              sl_options[:name] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
              sl_options[:recordVideo] = ENV['RECORD_VIDEO'] if ENV['RECORD_VIDEO']
              sl_options[:recordScreenshots] = ENV['SCREENSHOTS'] if ENV['SCREENSHOTS']
              # define mobile device options
              if ENV['SL_PLATFORM']
                sl_options[:deviceOrientation] = ENV['ORIENTATION'].upcase if ENV['ORIENTATION']
                sl_options[:appiumVersion] = '1.22.0'
                {
                  browserName: browser,
                  platformName: ENV['SL_PLATFORM'],
                  'appium:deviceName': ENV['SL_DEVICE'],
                  'appium:platformVersion': ENV['SL_VERSION'],
                  'sauce:options': sl_options
                }
              else
                # define desktop browser options
                sl_options[:screenResolution] = ENV['RESOLUTION'] if ENV['RESOLUTION']
                {
                  browserName: browser,
                  browserVersion: ENV['SL_VERSION'],
                  platformName: ENV['SL_OS'],
                  'sauce:options': sl_options
                }
              end
            else
              @capabilities
            end
  register_remote_driver(:saucelabs, browser, options)
  # configure file_detector for remote uploads
  config_file_uploads
end

.initialize_testingbot ⇒ Object 



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 593

def self.initialize_testingbot
  browser = ENV['TB_BROWSER']
  Environ.grid = :testingbot

  Environ.os = ENV['TB_OS']
  if ENV['TB_PLATFORM']
    Environ.device_orientation = ENV['ORIENTATION'] if ENV['ORIENTATION']
    Environ.device_os   = ENV['TB_PLATFORM']
    Environ.device_name = ENV['TB_DEVICE']
    Environ.device      = :device
    Environ.platform    = :mobile
    Environ.device_type = ENV['DEVICE_TYPE'] if ENV['DEVICE_TYPE']
  else
    Environ.platform = :desktop
  end
  # specify endpoint url
  if @endpoint.nil?
    url = ENV['TUNNELING'] ? '@localhost:4445/wd/hub' : '@hub.testingbot.com/wd/hub'
    @endpoint = "http://#{ENV['TB_USERNAME']}:#{ENV['TB_AUTHKEY']}#{url}"
  end
  # define TestingBot options
  options = if @capabilities.nil?
              # define the required set of TestingBot options
              tb_options = { build: test_context_message }
              # define the optional TestingBot options
              tb_options[:name] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
              tb_options[:timeZone] = ENV['TIME_ZONE'] if ENV['TIME_ZONE']
              tb_options['testingbot.geoCountryCode'] = ENV['GEO_LOCATION'] if ENV['GEO_LOCATION']
              tb_options[:screenrecorder] = ENV['RECORD_VIDEO'] if ENV['RECORD_VIDEO']
              tb_options[:screenshot] = ENV['SCREENSHOTS'] if ENV['SCREENSHOTS']
              # define mobile device options
              if ENV['TB_PLATFORM']
                tb_options[:platform] = ENV['TB_PLATFORM']
                tb_options[:orientation] = ENV['ORIENTATION'].upcase if ENV['ORIENTATION']
                tb_options[:deviceName] = ENV['TB_DEVICE'] if ENV['TB_DEVICE']
              else
                # define desktop browser options
                tb_options['screen-resolution'] = ENV['RESOLUTION'] if ENV['RESOLUTION']
                tb_options['selenium-version'] = '4.1.0'
              end
              {
                browserName: browser,
                browserVersion: ENV['TB_VERSION'],
                platformName: ENV['TB_OS'],
                'tb:options': tb_options
              }
            else
              @capabilities
            end
  register_remote_driver(:testingbot, browser, options)
  # configure file_detector for remote uploads if target is desktop web browser
  config_file_uploads unless ENV['TB_PLATFORM']
end

.initialize_web_driver(options = nil) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
78
79
80
81
82
83
84
85
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 17

def self.initialize_web_driver(options = nil)
  @endpoint = nil
  @capabilities = nil
  if options.is_a?(String)
    Capybara.app_host = options
  elsif options.is_a?(Hash)
    Capybara.app_host = options[:app_host] if options.key?(:app_host)
    @endpoint = options[:endpoint] if options.key?(:endpoint)
    @capabilities = options[:desired_capabilities] if options.key?(:desired_capabilities)
  end

  browser = ENV['WEB_BROWSER']
  # set downloads folder path
  @downloads_path = "#{Dir.pwd}/downloads"
  if ENV['PARALLEL']
    Environ.parallel = true
    Environ.process_num = ENV['TEST_ENV_NUMBER']
    @downloads_path = "#{@downloads_path}/#{ENV['TEST_ENV_NUMBER']}"
    Dir.mkdir(@downloads_path) unless Dir.exist?(@downloads_path)
  else
    Environ.parallel = false
  end
  @downloads_path = @downloads_path.tr('/', "\\") if OS.windows?

  # assume that we're testing within a local desktop web browser
  Environ.driver      = :webdriver
  Environ.platform    = :desktop
  Environ.browser     = browser
  Environ.headless    = false
  Environ.device      = :web
  Environ.device_name = 'browser'

  context = case browser.downcase.to_sym
            when :appium
              initialize_appium
              'mobile device emulator'
            when :browserstack
              initialize_browserstack
              'Browserstack cloud service'
            when :lambdatest
              initialize_lambdatest
              'LambdaTest cloud service'
            when :saucelabs
              initialize_saucelabs
              'Sauce Labs cloud service'
            when :testingbot
              initialize_testingbot
              'TestingBot cloud service'
            else
              if ENV['SELENIUM'] == 'remote'
                initialize_remote
                'Selenium Grid'
              else
                initialize_local_browser
                'local browser instance'
              end
            end

  # set browser window size only if testing with a desktop web browser
  unless Environ.is_device? || Environ.is_simulator? || Capybara.current_driver == :appium
    initialize_browser_size
  end

  # set Capybara's server port if PARALLEL_PORT is true
  Capybara.server_port = 9887 + ENV['TEST_ENV_NUMBER'].to_i if ENV['PARALLEL'] && ENV['PARALLEL_PORT']

  Environ.session_state = :running
  puts "Using #{Environ.browser} browser via #{context}"
end

.register_remote_driver(driver, browser, options) ⇒ Object 



661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 661

def self.register_remote_driver(driver, browser, options)
  Capybara.register_driver driver do |app|
    capabilities = Selenium::WebDriver::Remote::Capabilities.send(browser.gsub(/\s+/, '_').downcase.to_sym, options)
    Capybara::Selenium::Driver.new(app, browser: :remote, url: @endpoint, capabilities: capabilities)
  end

  Environ.browser = browser

  Capybara.default_driver = driver
  Capybara.run_server = false
end

.set_domain(url) ⇒ Object 



87
88
89
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 87

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

.test_context_message ⇒ Object 



647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/testcentricity_web/web_core/webdriver_helper.rb', line 647

def self.test_context_message
  context_message = if ENV['TEST_CONTEXT']
                      "#{Environ.test_environment.to_s.upcase} - #{ENV['TEST_CONTEXT']}"
                    else
                      Environ.test_environment.to_s.upcase
                    end
  if ENV['PARALLEL']
    thread_num = ENV['TEST_ENV_NUMBER']
    thread_num = 1 if thread_num.blank?
    context_message = "#{context_message} - Thread ##{thread_num}"
  end
  context_message
end