Add getAppStrings method to allow searching app strings in the specified file

rgonalo · rgonalo · commit 23d1ec3c9979 · 2016-01-13T17:22:12.000+01:00
diff --git a/README.md b/README.md
@@ -110,6 +110,7 @@ If you are using the Eclipse IDE, make sure you are using version Luna or later.
 ##Changelog##
 *4.0.0 (still not released)*
 - `getAppStrings()` methods now return a map with the app strings keys and values, instead of an string
+- Add `getAppStrings(String language, String stringFile)` method to allow searching app strings in the specified file
 
 *3.3.0*
 - updated the dependency on Selenium to version 2.48.2
diff --git a/src/main/java/io/appium/java_client/AppiumDriver.java b/src/main/java/io/appium/java_client/AppiumDriver.java
@@ -66,6 +66,7 @@ public abstract class AppiumDriver<RequiredElementType extends WebElement> exten
     private final String SETTINGS = "settings";
 
     private final String LANGUAGE_PARAM = "language";
+    private final String STRING_FILE_PARAM = "stringFile";
 
     /**
      * @param originalCapabilities
@@ -627,6 +628,24 @@ public Map<String, String> getAppStrings(String language) {
         return (Map<String, String>) response.getValue();
     }
 
+    /**
+     * @param language
+     *            strings language code
+     * @param stringFile
+     *            strings filename
+     * @return a map with localized strings defined in the app
+     *
+     * @see HasAppStrings#getAppStrings(String, String)
+     */
+    @Override
+    public Map<String, String> getAppStrings(String language, String stringFile) {
+        String[] parameters = new String[] { LANGUAGE_PARAM, STRING_FILE_PARAM };
+        Object[] values = new Object[] { language, stringFile };
+        Response response = execute(GET_STRINGS,
+                getCommandImmutableMap(parameters, values));
+        return (Map<String, String>) response.getValue();
+    }
+
     private TouchAction createTap(WebElement element, int duration) {
         TouchAction tap = new TouchAction(this);
         return tap.press(element).waitAction(duration).release();
diff --git a/src/main/java/io/appium/java_client/HasAppStrings.java b/src/main/java/io/appium/java_client/HasAppStrings.java
@@ -21,18 +21,31 @@
 public interface HasAppStrings {
 
     /**
-    * Get all defined Strings from an app for the default language
-    *
-    * @return a map with localized strings defined in the app
-    */
+     * Get all defined Strings from an app for the default language
+     *
+     * @return a map with localized strings defined in the app
+     */
     Map<String, String> getAppStrings();
 
     /**
-    * Get all defined Strings from an app for the specified language
-    *
-    * @param language strings language code
-    * @return a map with localized strings defined in the app
-    */
+     * Get all defined Strings from an app for the specified language
+     *
+     * @param language
+     *            strings language code
+     * @return a map with localized strings defined in the app
+     */
     Map<String, String> getAppStrings(String language);
 
+    /**
+     * Get all defined Strings from an app for the specified language and
+     * strings filename
+     *
+     * @param language
+     *            strings language code
+     * @param stringFile
+     *            strings filename
+     * @return a map with localized strings defined in the app
+     */
+    Map<String, String> getAppStrings(String language, String stringFile);
+
 }
diff --git a/src/test/java/io/appium/java_client/ios/IOSDriverTest.java b/src/test/java/io/appium/java_client/ios/IOSDriverTest.java
@@ -81,6 +81,18 @@ public void getStringsWithLanguageTest() {
     assertTrue(strings.size() > 10);
   }
 
+  @Test
+  public void getStringsWithLanguageAndStringFileTest() {
+    Map<String, String> strings = driver.getAppStrings("en", "Localizable.strings");
+    assertTrue(strings.size() > 10);
+  }
+
+  @Test
+  public void getStringsWithUnknownStringFileTest() {
+    Map<String, String> strings = driver.getAppStrings("en", "Unknown.strings");
+    assertTrue(strings.size() > 10);
+  }
+
   @Test
   public void resetTest() {
     driver.resetApp();
