fix: bring back ability to automatically quote desired capabilities on windows systems

root-intruder · root-intruder · commit 4dbaca1fcae8 · 2021-03-23T11:46:49.000+01:00
diff --git a/src/main/java/io/appium/java_client/service/local/AppiumServiceBuilder.java b/src/main/java/io/appium/java_client/service/local/AppiumServiceBuilder.java
@@ -25,13 +25,16 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import io.appium.java_client.remote.AndroidMobileCapabilityType;
+import io.appium.java_client.remote.MobileCapabilityType;
 import io.appium.java_client.service.local.flags.ServerArgument;
 
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.SystemUtils;
 import org.apache.commons.validator.routines.InetAddressValidator;
 import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.Platform;
 import org.openqa.selenium.os.ExecutableFinder;
 import org.openqa.selenium.remote.BrowserType;
 import org.openqa.selenium.remote.DesiredCapabilities;
@@ -78,6 +81,7 @@ public final class AppiumServiceBuilder
     private File node;
     private String ipAddress = BROADCAST_IP_ADDRESS;
     private DesiredCapabilities capabilities;
+    private boolean autoQuoteCapabilitiesOnWindows = false;
     private static final Function<File, String> APPIUM_JS_NOT_EXIST_ERROR = (fullPath) -> String.format(
             "The main Appium script does not exist at '%s'", fullPath.getAbsolutePath());
     private static final Function<File, String> NODE_JS_NOT_EXIST_ERROR = (fullPath) ->
@@ -239,6 +243,21 @@ public AppiumServiceBuilder withCapabilities(DesiredCapabilities capabilities) {
         return this;
     }
 
+    /**
+     * Adds a desired capabilities.
+     *
+     * @param capabilities is an instance of {@link DesiredCapabilities}.
+     * @param autoQuoteCapabilitiesOnWindows automatically escape quote all
+     *                                       capabilities when calling appium.
+     *                                       This is required on windows systems only.
+     * @return the self-reference.
+     */
+    public AppiumServiceBuilder withCapabilities(DesiredCapabilities capabilities,
+                                                 boolean autoQuoteCapabilitiesOnWindows) {
+        this.autoQuoteCapabilitiesOnWindows = autoQuoteCapabilitiesOnWindows;
+        return withCapabilities(capabilities);
+    }
+
     /**
      * Sets an executable appium.js.
      *
@@ -296,7 +315,48 @@ private void loadPathToMainScript() {
         this.appiumJS = findMainScript();
     }
 
+    private String parseCapabilitiesIfWindows() {
+        StringBuilder result = new StringBuilder();
+        final List<String> pathCapabilities = ImmutableList.of(AndroidMobileCapabilityType.KEYSTORE_PATH,
+                AndroidMobileCapabilityType.CHROMEDRIVER_EXECUTABLE, MobileCapabilityType.APP);
+
+        if (capabilities != null) {
+            Map<String, ?> capabilitiesMap = capabilities.asMap();
+            Set<? extends Map.Entry<String, ?>> entries = capabilitiesMap.entrySet();
+
+            for (Map.Entry<String, ?> entry : entries) {
+                Object value = entry.getValue();
+
+                if (value == null) {
+                    continue;
+                }
+
+                if (value instanceof String) {
+                    String valueString = (String) value;
+                    if (pathCapabilities.contains(entry.getKey())) {
+                        value = "\\\"" + valueString.replace("\\", "/") + "\\\"";
+                    } else {
+                        value = "\\\"" + valueString + "\\\"";
+                    }
+                } else {
+                    value = String.valueOf(value);
+                }
+
+                String key = "\\\"" + entry.getKey() + "\\\"";
+                if (result.length() > 0) {
+                    result.append(", ");
+                }
+                result.append(key).append(": ").append(value);
+            }
+        }
+
+        return "{" + result.toString() + "}";
+    }
+
     private String capabilitiesToCmdlineArg() {
+        if (autoQuoteCapabilitiesOnWindows && Platform.getCurrent().is(Platform.WINDOWS)) {
+            return parseCapabilitiesIfWindows();
+        }
         Gson gson = new GsonBuilder()
                 .disableHtmlEscaping()
                 .serializeNulls()
