[java] deprecate setHeadless method on FirefoxOptions

titusfortner · titusfortner · commit a711f7383b10 · 2023-01-14T17:38:28.000-06:00
diff --git a/java/src/org/openqa/selenium/firefox/FirefoxOptions.java b/java/src/org/openqa/selenium/firefox/FirefoxOptions.java
@@ -252,6 +252,11 @@ public FirefoxOptions setLogLevel(FirefoxDriverLogLevel logLevel) {
     return setFirefoxOption(Keys.LOG, logLevel.toJson());
   }
 
+  /**
+   * @deprecated Use {@link #addArguments(String...)}.
+   * Example: `addArguments("-headless")`.
+   */
+  @Deprecated
   public FirefoxOptions setHeadless(boolean headless) {
     Object rawArgs = firefoxOptions.getOrDefault(Keys.ARGS.key(), new ArrayList<>());
     Require.stateCondition(rawArgs instanceof List, "Arg list of unexpected type: %s", rawArgs);
diff --git a/java/test/org/openqa/selenium/firefox/FirefoxDriverTest.java b/java/test/org/openqa/selenium/firefox/FirefoxDriverTest.java
@@ -362,7 +362,7 @@ public void canSetPageLoadStrategyViaOptions() {
   @Test
   @NoDriverBeforeTest
   public void canStartHeadless() {
-    localDriver = new FirefoxDriver(new FirefoxOptions().setHeadless(true));
+    localDriver = new FirefoxDriver(new FirefoxOptions().addArguments("-headless"));
 
     assertThat(((FirefoxDriver) localDriver).getCapabilities().getCapability("moz:headless")).isEqualTo(true);
   }
diff --git a/java/test/org/openqa/selenium/firefox/FirefoxOptionsTest.java b/java/test/org/openqa/selenium/firefox/FirefoxOptionsTest.java
@@ -506,7 +506,7 @@ void mergingOptionsWithOptionsAsMutableCapabilities() throws IOException {
   void firefoxOptionsShouldEqualEquivalentImmutableCapabilities() {
     FirefoxOptions
       options =
-      new FirefoxOptions().addArguments("hello").setPageLoadStrategy(EAGER).setHeadless(true);
+      new FirefoxOptions().addArguments("hello", "-headless").setPageLoadStrategy(EAGER);
     Capabilities caps = new ImmutableCapabilities(options);
 
     assertThat(caps).isEqualTo(options);
diff --git a/java/test/org/openqa/selenium/testing/drivers/Browser.java b/java/test/org/openqa/selenium/testing/drivers/Browser.java
@@ -125,7 +125,7 @@ public Capabilities getCapabilities() {
       }
 
       if (Boolean.getBoolean("webdriver.headless")) {
-        options.setHeadless(true);
+        options.addArguments("-headless");
       }
 
       return options;

Original file line number	Diff line number	Diff line change
`@@ -362,7 +362,7 @@ public void canSetPageLoadStrategyViaOptions() {`
`362`	`362`	`@Test`
`363`	`363`	`@NoDriverBeforeTest`
`364`	`364`	`public void canStartHeadless() {`
`365`		`- localDriver = new FirefoxDriver(new FirefoxOptions().setHeadless(true));`
	`365`	`+ localDriver = new FirefoxDriver(new FirefoxOptions().addArguments("-headless"));`
`366`	`366`
`367`	`367`	`assertThat(((FirefoxDriver) localDriver).getCapabilities().getCapability("moz:headless")).isEqualTo(true);`
`368`	`368`	`}`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ public Capabilities getCapabilities() {`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`if (Boolean.getBoolean("webdriver.headless")) {`
`128`		`- options.setHeadless(true);`
	`128`	`+ options.addArguments("-headless");`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`return options;`