Skip to content

fix: Properly translate desiredCapabilities into a command line argument #1337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2020
Merged

fix: Properly translate desiredCapabilities into a command line argument #1337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 12 additions & 80 deletions src/main/java/io/appium/java_client/service/local/AppiumServiceBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,15 @@
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;

import io.appium.java_client.remote.AndroidMobileCapabilityType;
import io.appium.java_client.remote.MobileCapabilityType;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
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;
Expand All @@ -54,7 +53,6 @@
import java.util.concurrent.TimeUnit;
import java.util.function.Function;


public final class AppiumServiceBuilder
extends DriverService.Builder<AppiumDriverLocalService, AppiumServiceBuilder> {

Expand All @@ -73,8 +71,6 @@ public final class AppiumServiceBuilder
private static final String NODE_PATH = "NODE_BINARY_PATH";

public static final String BROADCAST_IP_ADDRESS = "0.0.0.0";
private static final List<String> PATH_CAPABILITIES = ImmutableList.of(AndroidMobileCapabilityType.KEYSTORE_PATH,
AndroidMobileCapabilityType.CHROMEDRIVER_EXECUTABLE, MobileCapabilityType.APP);
private static final Path APPIUM_PATH_SUFFIX = Paths.get("appium", "build", "lib", "main.js");
public static final int DEFAULT_APPIUM_PORT = 4723;
private final Map<String, String> serverArguments = new HashMap<>();
Expand Down Expand Up @@ -300,79 +296,15 @@ private void loadPathToMainScript() {
this.appiumJS = findMainScript();
}

private String parseCapabilitiesIfWindows() {
String result = StringUtils.EMPTY;

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 (String.class.isAssignableFrom(value.getClass())) {
if (PATH_CAPABILITIES.contains(entry.getKey())) {
value = "\\\"" + String.valueOf(value).replace("\\", "/") + "\\\"";
} else {
value = "\\\"" + value + "\\\"";
}
} else {
value = String.valueOf(value);
}

String key = "\\\"" + entry.getKey() + "\\\"";
if (StringUtils.isBlank(result)) {
result = key + ": " + value;
} else {
result = result + ", " + key + ": " + value;
}
}
}

return "{" + result + "}";
}

private String parseCapabilitiesIfUNIX() {
String result = StringUtils.EMPTY;

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 (String.class.isAssignableFrom(value.getClass())) {
value = "\"" + value + "\"";
} else {
value = String.valueOf(value);
}

String key = "\"" + entry.getKey() + "\"";
if (StringUtils.isBlank(result)) {
result = key + ": " + value;
} else {
result = result + ", " + key + ": " + value;
}
}
}

return "{" + result + "}";
}

private String parseCapabilities() {
if (Platform.getCurrent().is(Platform.WINDOWS)) {
return parseCapabilitiesIfWindows();
}
return parseCapabilitiesIfUNIX();
private String capabilitiesToCmdlineArg() {
Gson gson = new GsonBuilder()
.disableHtmlEscaping()
.serializeNulls()
.create();
// Selenium internally uses org.apache.commons.exec.CommandLine
// which has the following known bug in its arguments parser:
// https://issues.apache.org/jira/browse/EXEC-54
return gson.toJson(capabilities.asMap());
}

@Override
Expand Down Expand Up @@ -418,7 +350,7 @@ protected ImmutableList<String> createArgs() {

if (capabilities != null) {
argList.add("--default-capabilities");
argList.add(parseCapabilities());
argList.add(capabilitiesToCmdlineArg());
}

return new ImmutableList.Builder<String>().addAll(argList).build();
Expand Down
6 changes: 6 additions & 0 deletions src/test/java/io/appium/java_client/service/local/ServerBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;

import com.google.common.collect.ImmutableMap;
import io.github.bonigarcia.wdm.WebDriverManager;
import org.junit.After;
import org.junit.BeforeClass;
Expand Down Expand Up @@ -178,6 +179,11 @@ public void checkAbilityToStartServiceUsingCapabilitiesAndFlags() {
caps.setCapability(APP_PACKAGE, "io.appium.android.apis");
caps.setCapability(APP_ACTIVITY, ".view.WebView1");
caps.setCapability(APP, app.getAbsolutePath());
caps.setCapability("winPath", "C:\\selenium\\app.apk");
caps.setCapability("unixPath", "/selenium/app.apk");
caps.setCapability("quotes", "\"'");
caps.setCapability("goog:chromeOptions",
ImmutableMap.of("env", ImmutableMap.of("test", "value"), "val2", 0));
caps.setCapability(CHROMEDRIVER_EXECUTABLE, chromeManager.getBinaryPath());

service = new AppiumServiceBuilder()
Expand Down