Merge pull request code-dot-org#26944 from code-dot-org/headless-local-chrome

Make runner.rb use headless chrome by default in local mode

Author: Winter

dashboard/test/ui/features/support/connect.rb

@@ -87,8 +87,9 @@ def saucelabs_browser(test_run_name)
 
 def get_browser(test_run_name)
   if ENV['TEST_LOCAL'] == 'true'
+    headless = ENV['TEST_LOCAL_HEADLESS'] == 'true'
     # This drives a local installation of ChromeDriver running on port 9515, instead of Saucelabs.
-    SeleniumBrowser.local_browser
+    SeleniumBrowser.local_browser(headless)
   else
     saucelabs_browser test_run_name
   end

dashboard/test/ui/runner.rb

@@ -101,6 +101,7 @@ def parse_options
     options.csedweek_domain = 'test.csedweek.org'
     options.advocacy_domain = 'test-advocacy.code.org'
     options.local = nil
+    options.local_headless = true
     options.html = nil
     options.maximize = nil
     options.auto_retry = false
@@ -140,6 +141,9 @@ def parse_options
         options.csedweek_domain = 'localhost.csedweek.org:3000'
         options.advocacy_domain = 'localhost-advocacy.code.org:3000'
       end
+      opts.on("--headed", "Open visible chrome browser windows. Runs in headless mode without this flag. Only relevant when -l is specified.") do
+        options.local_headless = false
+      end
       opts.on("-p", "--pegasus Domain", String, "Specify an override domain for code.org, e.g. localhost.code.org:3000") do |p|
         if p == 'localhost:3000'
           print "WARNING: Some tests may fail using '-p localhost:3000' because cookies will not be available.\n"\
@@ -673,6 +677,7 @@ def run_feature(browser, feature, options)
   run_environment['CSEDWEEK_TEST_DOMAIN'] = options.csedweek_domain if options.csedweek_domain
   run_environment['ADVOCACY_TEST_DOMAIN'] = options.advocacy_domain if options.advocacy_domain
   run_environment['TEST_LOCAL'] = options.local ? "true" : "false"
+  run_environment['TEST_LOCAL_HEADLESS'] = options.local_headless ? "true" : "false"
   run_environment['MAXIMIZE_LOCAL'] = options.maximize ? "true" : "false"
   run_environment['MOBILE'] = browser['mobile'] ? "true" : "false"
   run_environment['FAIL_FAST'] = options.fail_fast ? "true" : nil

dashboard/test/ui/utils/selenium_browser.rb

@@ -1,10 +1,14 @@
 require 'selenium/webdriver'
 
 module SeleniumBrowser
-  def self.local_browser
+  def self.local_browser(headless=true)
     ensure_chromedriver_running
     sleep 2
-    browser = Selenium::WebDriver.for :chrome, url: 'http://127.0.0.1:9515'
+    options = Selenium::WebDriver::Chrome::Options.new
+    if headless
+      options.add_argument('--headless')
+    end
+    browser = Selenium::WebDriver.for :chrome, url: 'http://127.0.0.1:9515', options: options
     if ENV['MAXIMIZE_LOCAL']
       max_width, max_height = browser.execute_script('return [window.screen.availWidth, window.screen.availHeight];')
       browser.manage.window.resize_to(max_width, max_height)