[java] Adding getPlatformName to follow W3C, getPlatform deprecated

Fixes SeleniumHQ#4561
strogo · Sep 9, 2020 · 3605a98 · 3605a98
1 parent 419bce8
commit 3605a98
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 15 deletions.
diff --git a/java/client/src/org/openqa/selenium/Capabilities.java b/java/client/src/org/openqa/selenium/Capabilities.java
@@ -34,7 +34,14 @@ default String getBrowserName() {
     return String.valueOf(Optional.ofNullable(getCapability("browserName")).orElse(""));
   }
 
+  /**
+   * @deprecated  Use {@link #getPlatformName()}
+   */
   default Platform getPlatform() {
+    return getPlatformName();
+  }
+
+  default Platform getPlatformName() {
     return Stream.of("platform", "platformName")
         .map(this::getCapability)
         .filter(Objects::nonNull)

diff --git a/java/client/test/org/openqa/selenium/remote/NewSessionPayloadTest.java b/java/client/test/org/openqa/selenium/remote/NewSessionPayloadTest.java
@@ -162,7 +162,7 @@ public void shouldCorrectlyExtractPlatformNameFromOssCapabilities() {
         "desiredCapabilities", singletonMap(
             "platform", "linux")));
 
-    assertEquals(Platform.LINUX, capabilities.get(0).getPlatform());
+    assertEquals(Platform.LINUX, capabilities.get(0).getPlatformName());
     assertEquals(Platform.LINUX, capabilities.get(0).getCapability("platform"));
     assertNull(capabilities.get(0).getCapability("platformName"));
   }
@@ -174,7 +174,7 @@ public void shouldCorrectlyExtractPlatformFromW3cCapabilities() {
             "alwaysMatch", singletonMap(
                 "platformName", "linux"))));
 
-    assertEquals(Platform.LINUX, capabilities.get(0).getPlatform());
+    assertEquals(Platform.LINUX, capabilities.get(0).getPlatformName());
     assertNull(capabilities.get(0).getCapability("platform"));
     assertEquals("linux", capabilities.get(0).getCapability("platformName"));
   }

diff --git a/java/client/test/org/openqa/selenium/remote/RemoteWebDriverUnitTest.java b/java/client/test/org/openqa/selenium/remote/RemoteWebDriverUnitTest.java
@@ -113,7 +113,7 @@ public void canHandlePlatformNameCapability() throws IOException {
 
     RemoteWebDriver driver = new RemoteWebDriver(executor, capabilities);
 
-    assertThat(driver.getCapabilities().getPlatform().is(Platform.MOJAVE)).isTrue();
+    assertThat(driver.getCapabilities().getPlatformName().is(Platform.MOJAVE)).isTrue();
   }
 
   @Test
@@ -124,7 +124,7 @@ public void canHandlePlatformOSSCapability() throws IOException {
 
     RemoteWebDriver driver = new RemoteWebDriver(executor, capabilities);
 
-    assertThat(driver.getCapabilities().getPlatform().is(Platform.MOJAVE)).isTrue();
+    assertThat(driver.getCapabilities().getPlatformName().is(Platform.MOJAVE)).isTrue();
   }
 
   @Test
@@ -135,7 +135,7 @@ public void canHandleUnknownPlatformNameAndFallsBackToUnix() throws IOException
 
     RemoteWebDriver driver = new RemoteWebDriver(executor, capabilities);
 
-    assertThat(driver.getCapabilities().getPlatform().is(Platform.UNIX)).isTrue(); // fallback
+    assertThat(driver.getCapabilities().getPlatformName().is(Platform.UNIX)).isTrue(); // fallback
   }
 
   @Test

diff --git a/java/client/test/org/openqa/selenium/testing/TestUtilities.java b/java/client/test/org/openqa/selenium/testing/TestUtilities.java
@@ -163,7 +163,7 @@ public static Platform getEffectivePlatform(WebDriver driver) {
     }
 
     Capabilities caps = ((HasCapabilities) driver).getCapabilities();
-    return caps.getPlatform();
+    return caps.getPlatformName();
   }
 
   public static boolean isLocal() {

diff --git a/java/server/src/org/openqa/selenium/remote/server/CapabilitiesComparator.java b/java/server/src/org/openqa/selenium/remote/server/CapabilitiesComparator.java
@@ -37,7 +37,7 @@
  *   <li>{@link Capabilities#getBrowserName() browser name},
  *   <li>{@link Capabilities#getBrowserVersion()} () browser version},
  *   <li>{@link Capabilities#is(String)} whether JavaScript is enabled},
- *   <li>and {@link Capabilities#getPlatform() platform}
+ *   <li>and {@link Capabilities#getPlatformName() platform name}
  * </ol>
  * For all comparisons, if the capability is missing, that particular criteria shall not factor
  * into the comparison.
@@ -69,25 +69,25 @@ public CapabilitiesComparator(final Capabilities desiredCapabilities,
     Comparator<Capabilities> byJavaScript =
         Comparator.comparingInt(c -> jsScorer.score(c.is(SUPPORTS_JAVASCRIPT)));
 
-    Platform desiredPlatform = desiredCapabilities.getPlatform();
+    Platform desiredPlatform = desiredCapabilities.getPlatformName();
     if (desiredPlatform == null) {
       desiredPlatform = Platform.ANY;
     }
 
     final CapabilityScorer<Platform> currentPlatformScorer =
         new CurrentPlatformScorer(currentPlatform, desiredPlatform);
     Comparator<Capabilities> byCurrentPlatform =
-        Comparator.comparingInt(c -> currentPlatformScorer.score(c.getPlatform()));
+        Comparator.comparingInt(c -> currentPlatformScorer.score(c.getPlatformName()));
 
     final CapabilityScorer<Platform> strictPlatformScorer =
         new CapabilityScorer<>(desiredPlatform);
     Comparator<Capabilities> byStrictPlatform =
-        Comparator.comparingInt(c -> strictPlatformScorer.score(c.getPlatform()));
+        Comparator.comparingInt(c -> strictPlatformScorer.score(c.getPlatformName()));
 
     final CapabilityScorer<Platform> fuzzyPlatformScorer =
         new FuzzyPlatformScorer(desiredPlatform);
     Comparator<Capabilities> byFuzzyPlatform =
-        Comparator.comparingInt(c -> fuzzyPlatformScorer.score(c.getPlatform()));
+        Comparator.comparingInt(c -> fuzzyPlatformScorer.score(c.getPlatformName()));
 
     compareWith = Ordering.compound(Arrays.asList(
         byBrowserName,

diff --git a/java/server/src/org/openqa/selenium/remote/server/DefaultDriverFactory.java b/java/server/src/org/openqa/selenium/remote/server/DefaultDriverFactory.java
@@ -137,8 +137,8 @@ private void registerDriverProvider(Platform current, DriverProvider provider) {
   }
 
   private boolean platformMatches(Platform current, Capabilities caps) {
-    return caps.getPlatform() == null
-           || caps.getPlatform() == ANY
-           || current.is(caps.getPlatform());
+    return caps.getPlatformName() == null
+           || caps.getPlatformName() == ANY
+           || current.is(caps.getPlatformName());
   }
 }
diff --git a/java/server/src/org/openqa/selenium/remote/server/DefaultSession.java b/java/server/src/org/openqa/selenium/remote/server/DefaultSession.java
@@ -176,7 +176,7 @@ public EventFiringWebDriver call() {
       Capabilities actualCapabilities = capabilities;
       if (rawDriver instanceof HasCapabilities) {
         actualCapabilities = ((HasCapabilities) rawDriver).getCapabilities();
-        isAndroid = actualCapabilities.getPlatform().is(Platform.ANDROID);
+        isAndroid = actualCapabilities.getPlatformName().is(Platform.ANDROID);
       }
       describedCapabilities = getDescription(rawDriver, actualCapabilities);
       if (rawDriver instanceof RemoteWebDriver) {