feat: Make settings api to accept string names (appium#1240)

Takeshi Kishi · mykola-mokhnach · commit f11fe00a536d · 2019-09-23T18:59:16.000+02:00
diff --git a/src/main/java/io/appium/java_client/HasSettings.java b/src/main/java/io/appium/java_client/HasSettings.java
@@ -37,6 +37,18 @@ public interface HasSettings extends ExecutesMethod {
      * @param value   value of the setting.
      */
     default void setSetting(Setting setting, Object value) {
+        CommandExecutionHelper.execute(this, setSettingsCommand(setting.toString(), value));
+    }
+
+    /**
+     * Set a setting for this test session It's probably better to use a
+     * convenience function, rather than use this function directly. Try finding
+     * the method for the specific setting you want to change.
+     *
+     * @param setting Setting you wish to set.
+     * @param value   value of the setting.
+     */
+    default void setSetting(String setting, Object value) {
         CommandExecutionHelper.execute(this, setSettingsCommand(setting, value));
     }
 
diff --git a/src/main/java/io/appium/java_client/MobileCommand.java b/src/main/java/io/appium/java_client/MobileCommand.java
@@ -469,9 +469,9 @@ public static ImmutableMap<String, Object> prepareArguments(String[] params,
         return new AbstractMap.SimpleEntry<>(GET_SETTINGS, ImmutableMap.of());
     }
 
-    public static Map.Entry<String, Map<String, ?>> setSettingsCommand(Setting setting, Object value) {
+    public static Map.Entry<String, Map<String, ?>> setSettingsCommand(String setting, Object value) {
         return new AbstractMap.SimpleEntry<>(SET_SETTINGS, prepareArguments("settings",
-                prepareArguments(setting.toString(), value)));
+                prepareArguments(setting, value)));
     }
 
     /**
diff --git a/src/test/java/io/appium/java_client/android/SettingTest.java b/src/test/java/io/appium/java_client/android/SettingTest.java
@@ -92,6 +92,17 @@ public class SettingTest extends BaseAndroidTest {
             .get(Setting.TRACK_SCROLL_EVENTS.toString()));
     }
 
+    @Test public void testSettingByString() {
+        assertEquals(true, driver.getSettings()
+                .get("shouldUseCompactResponses"));
+        driver.setSetting("shouldUseCompactResponses", false);
+        assertEquals(false, driver.getSettings()
+                .get("shouldUseCompactResponses"));
+        driver.setSetting("shouldUseCompactResponses", true);
+        assertEquals(true, driver.getSettings()
+                .get("shouldUseCompactResponses"));
+    }
+
     private void assertJSONElementContains(Setting setting, long value) {
         assertEquals(driver.getSettings().get(setting.toString()), value);
     }
diff --git a/src/test/java/io/appium/java_client/ios/SettingTest.java b/src/test/java/io/appium/java_client/ios/SettingTest.java
@@ -83,5 +83,16 @@ public class SettingTest extends AppIOSTest {
             .get(Setting.KEYBOARD_PREDICTION.toString()));
     }
 
+    @Test public void testSettingByString() {
+        assertEquals(true, driver.getSettings()
+                .get("shouldUseCompactResponses"));
+        driver.setSetting("shouldUseCompactResponses", false);
+        assertEquals(false, driver.getSettings()
+                .get("shouldUseCompactResponses"));
+        driver.setSetting("shouldUseCompactResponses", true);
+        assertEquals(true, driver.getSettings()
+                .get("shouldUseCompactResponses"));
+    }
+
 
 }

Original file line number	Diff line number	Diff line change
`@@ -469,9 +469,9 @@ public static ImmutableMap<String, Object> prepareArguments(String[] params,`
`469`	`469`	`return new AbstractMap.SimpleEntry<>(GET_SETTINGS, ImmutableMap.of());`
`470`	`470`	`}`
`471`	`471`
`472`		`- public static Map.Entry<String, Map<String, ?>> setSettingsCommand(Setting setting, Object value) {`
	`472`	`+ public static Map.Entry<String, Map<String, ?>> setSettingsCommand(String setting, Object value) {`
`473`	`473`	`return new AbstractMap.SimpleEntry<>(SET_SETTINGS, prepareArguments("settings",`
`474`		`- prepareArguments(setting.toString(), value)));`
	`474`	`+ prepareArguments(setting, value)));`
`475`	`475`	`}`
`476`	`476`
`477`	`477`	`/**`