[bazel] Add a flag to allow us to run tests headlessly

Author: shs96c

.bazelrc

@@ -1,6 +1,7 @@
 try-import .bazelrc.local
 
 build --flag_alias=pin_browsers=//common:pin_browsers
+build --flag_alias=headless=//common:headless
 
 # Set the default java toolchain
 build --java_toolchain=@bazel_tools//tools/jdk:toolchain_java11

common/BUILD.bazel

@@ -14,6 +14,19 @@ config_setting(
     },
 )
 
+bool_flag(
+    name = "headless",
+    build_setting_default = False,
+)
+
+config_setting(
+    name = "use_headless_browser",
+    flag_values = {
+        ":headless": "true",
+    },
+)
+
+
 config_setting(
     name = "linux",
     constraint_values = ["@platforms//os:linux"],

java/browsers.bzl

@@ -26,6 +26,11 @@ chrome_jvm_flags = select({
     "//conditions:default": [
         "-Dselenium.skiptest=true",
     ],
+}) + select({
+    "//common:use_headless_browser": [
+        "-Dwebdriver.headless=true",
+    ],
+    "//conditions:default": [],
 })
 
 edge_data = select({
@@ -48,6 +53,11 @@ edge_jvm_flags = select({
     "//conditions:default": [
         "-Dselenium.skiptest=true",
     ],
+}) + select({
+    "//common:use_headless_browser": [
+        "-Dwebdriver.headless=true",
+    ],
+    "//conditions:default": [],
 })
 
 firefox_data = select({
@@ -78,4 +88,9 @@ firefox_jvm_flags = select({
     "//conditions:default": [
         "-Dselenium.skiptest=true",
     ],
+}) + select({
+    "//common:use_headless_browser": [
+        "-Dwebdriver.headless=true",
+    ],
+    "//conditions:default": [],
 })

java/client/test/org/openqa/selenium/testing/drivers/Browser.java

@@ -43,17 +43,35 @@ public enum Browser {
   CHROME(new ChromeOptions(), new ChromeDriverInfo().getDisplayName(), true) {
     @Override
     public Capabilities getCapabilities() {
+      ChromeOptions options = new ChromeOptions();
+
       String binary = System.getProperty("webdriver.chrome.binary");
+      if (binary != null) {
+        options.setBinary(binary);
+      }
+
+      if (Boolean.getBoolean("webdriver.headless")) {
+        options.setHeadless(true);
+      }
 
-      return binary == null ? new ChromeOptions() : new ChromeOptions().setBinary(binary);
+      return options;
     }
   },
   EDGE(new EdgeOptions(), new EdgeDriverInfo().getDisplayName(), true) {
     @Override
     public Capabilities getCapabilities() {
+      EdgeOptions options = new EdgeOptions();
+
       String binary = System.getProperty("webdriver.edge.binary");
+      if (binary != null) {
+        options.setBinary(binary);
+      }
 
-      return binary == null ? new EdgeOptions() : new EdgeOptions().setBinary(binary);
+      if (Boolean.getBoolean("webdriver.headless")) {
+        options.setHeadless(true);
+      }
+
+      return options;
     }
   },
   HTMLUNIT(new ImmutableCapabilities(BROWSER_NAME, BrowserType.HTMLUNIT), "HtmlUnit", false),
@@ -62,9 +80,18 @@ public Capabilities getCapabilities() {
   FIREFOX(new FirefoxOptions(), new GeckoDriverInfo().getDisplayName(), false) {
     @Override
     public Capabilities getCapabilities() {
+      FirefoxOptions options = new FirefoxOptions();
+
       String binary = System.getProperty("webdriver.firefox.bin");
+      if (binary != null) {
+        options.setBinary(binary);
+      }
+
+      if (Boolean.getBoolean("webdriver.headless")) {
+        options.setHeadless(true);
+      }
 
-      return binary == null ? new FirefoxOptions() : new FirefoxOptions().setBinary(binary);
+      return options;
     }
   },
   LEGACY_OPERA(new OperaOptions(), new OperaDriverInfo().getDisplayName(), false),