feat: Add ability to set multiple settings

appium · Nov 9, 2020 · f5190d0 · f5190d0
1 parent 5999ceb
commit f5190d0
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 3 deletions.
diff --git a/src/main/java/io/appium/java_client/HasSettings.java b/src/main/java/io/appium/java_client/HasSettings.java
@@ -21,7 +21,10 @@
 
 import org.openqa.selenium.remote.Response;
 
+import java.util.EnumMap;
 import java.util.Map;
+import java.util.Map.Entry;
+import java.util.stream.Collectors;
 
 public interface HasSettings extends ExecutesMethod {
 
@@ -52,6 +55,32 @@ default HasSettings setSetting(String settingName, Object value) {
         return this;
     }
 
+    /**
+     * Sets settings for this test session.
+     *
+     * @param settings a map with settings, where key is the setting name you wish to set and value is the value of
+     *                 the setting.
+     * @return         Self instance for chaining.
+     */
+    default HasSettings setSettings(EnumMap<Setting, Object> settings) {
+        Map<String, Object> convertedSettings = settings.entrySet().stream()
+                .collect(Collectors.toMap(e -> e.getKey().toString(), Entry::getValue));
+        CommandExecutionHelper.execute(this, setSettingsCommand(convertedSettings));
+        return this;
+    }
+
+    /**
+     * Sets settings for this test session.
+     *
+     * @param settings a map with settings, where key is the setting name you wish to set and value is the value of
+     *                 the setting.
+     * @return         Self instance for chaining.
+     */
+    default HasSettings setSettings(Map<String, Object> settings) {
+        CommandExecutionHelper.execute(this, setSettingsCommand(settings));
+        return this;
+    }
+
     /**
      * Get settings stored for this test session It's probably better to use a
      * convenience function, rather than use this function directly. Try finding

diff --git a/src/main/java/io/appium/java_client/MobileCommand.java b/src/main/java/io/appium/java_client/MobileCommand.java
@@ -481,8 +481,11 @@ public static ImmutableMap<String, Object> prepareArguments(String[] params,
     }
 
     public static Map.Entry<String, Map<String, ?>> setSettingsCommand(String setting, Object value) {
-        return new AbstractMap.SimpleEntry<>(SET_SETTINGS, prepareArguments("settings",
-                prepareArguments(setting, value)));
+        return setSettingsCommand(prepareArguments(setting, value));
+    }
+
+    public static Map.Entry<String, Map<String, ?>> setSettingsCommand(Map<String, Object> settings) {
+        return new AbstractMap.SimpleEntry<>(SET_SETTINGS, prepareArguments("settings", settings));
     }
 
     /**

diff --git a/src/test/java/io/appium/java_client/android/SettingTest.java b/src/test/java/io/appium/java_client/android/SettingTest.java
@@ -4,6 +4,9 @@
 import org.junit.Test;
 
 import java.time.Duration;
+import java.util.EnumMap;
+import java.util.HashMap;
+import java.util.Map;
 
 import static org.junit.Assert.assertEquals;
 
@@ -103,6 +106,24 @@ public class SettingTest extends BaseAndroidTest {
                 .get("shouldUseCompactResponses"));
     }
 
+    @Test public void setMultipleSettings() {
+        EnumMap<Setting, Object> enumSettings = new EnumMap<>(Setting.class);
+        enumSettings.put(Setting.IGNORE_UNIMPORTANT_VIEWS, true);
+        enumSettings.put(Setting.ELEMENT_RESPONSE_ATTRIBUTES, "type,label");
+        driver.setSettings(enumSettings);
+        Map<String, Object> actual = driver.getSettings();
+        assertEquals(true, actual.get(Setting.IGNORE_UNIMPORTANT_VIEWS.toString()));
+        assertEquals("type,label", actual.get(Setting.ELEMENT_RESPONSE_ATTRIBUTES.toString()));
+
+        Map<String, Object> mapSettings = new HashMap<>();
+        mapSettings.put(Setting.IGNORE_UNIMPORTANT_VIEWS.toString(), false);
+        mapSettings.put(Setting.ELEMENT_RESPONSE_ATTRIBUTES.toString(), "");
+        driver.setSettings(mapSettings);
+        actual = driver.getSettings();
+        assertEquals(false, actual.get(Setting.IGNORE_UNIMPORTANT_VIEWS.toString()));
+        assertEquals("", actual.get(Setting.ELEMENT_RESPONSE_ATTRIBUTES.toString()));
+    }
+
     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
@@ -22,6 +22,9 @@
 
 import static org.junit.Assert.assertEquals;
 
+import java.util.EnumMap;
+import java.util.HashMap;
+import java.util.Map;
 
 public class SettingTest extends AppIOSTest {
 
@@ -94,5 +97,21 @@ public class SettingTest extends AppIOSTest {
                 .get("shouldUseCompactResponses"));
     }
 
-
+    @Test public void setMultipleSettings() {
+        EnumMap<Setting, Object> enumSettings = new EnumMap<>(Setting.class);
+        enumSettings.put(Setting.IGNORE_UNIMPORTANT_VIEWS, true);
+        enumSettings.put(Setting.ELEMENT_RESPONSE_ATTRIBUTES, "type,label");
+        driver.setSettings(enumSettings);
+        Map<String, Object> actual = driver.getSettings();
+        assertEquals(true, actual.get(Setting.IGNORE_UNIMPORTANT_VIEWS.toString()));
+        assertEquals("type,label", actual.get(Setting.ELEMENT_RESPONSE_ATTRIBUTES.toString()));
+
+        Map<String, Object> mapSettings = new HashMap<>();
+        mapSettings.put(Setting.IGNORE_UNIMPORTANT_VIEWS.toString(), false);
+        mapSettings.put(Setting.ELEMENT_RESPONSE_ATTRIBUTES.toString(), "");
+        driver.setSettings(mapSettings);
+        actual = driver.getSettings();
+        assertEquals(false, actual.get(Setting.IGNORE_UNIMPORTANT_VIEWS.toString()));
+        assertEquals("", actual.get(Setting.ELEMENT_RESPONSE_ATTRIBUTES.toString()));
+    }
 }