appium#105 & appium#108 IOSDriver. AppiumDriver. InteractsWithApps.

Author: TikhomirovSergey

src/main/java/io/appium/java_client/AppiumDriver.java

@@ -86,7 +86,7 @@
 public class AppiumDriver extends RemoteWebDriver implements MobileDriver,
 ContextAware, Rotatable, FindsByIosUIAutomation,
 FindsByAndroidUIAutomator, FindsByAccessibilityId, LocationContext,
-DeviceActionShortcuts, TouchShortcuts, InteractsWithFiles {
+DeviceActionShortcuts, TouchShortcuts, InteractsWithFiles, InteractsWithApps {
 
 private final static ErrorHandler errorHandler = new ErrorHandler(
 new ErrorCodesMobile(), true);
@@ -231,8 +231,9 @@ public ExecuteMethod getExecuteMethod() {
 }
 
 /**
- * Reset the currently running app for this session
+ * @see InteractsWithApps#resetApp()
  */
+@Override
 public void resetApp() {
 execute(MobileCommand.RESET);
 }
@@ -293,48 +294,9 @@ public void hideKeyboard() {
 }
 
 /**
- * Hides the keyboard if it is showing. Available strategies are PRESS_KEY
- * and TAP_OUTSIDE. One taps outside the keyboard, the other presses a key
- * of your choosing (probably the 'Done' key). Hiding the keyboard often
- * depends on the way an app is implemented, no single strategy always
- * works.
- * 
- * These parameters are only for iOS, and ignored by Android.
- * 
- * @param strategy
- * HideKeyboardStrategy
- * @param keyName
- * a String, representing the text displayed on the button of the
- * keyboard you want to press. For example: "Done"
- */
-//Should be moved to the subclass
-public void hideKeyboard(String strategy, String keyName) {
-String[] parameters = new String[] { "strategy", "key" };
-Object[] values = new Object[] { strategy, keyName };
-execute(HIDE_KEYBOARD, getCommandImmutableMap(parameters, values));
-}
-
-/**
- * Hides the keyboard by pressing the button specified by keyName if it is
- * showing. This is an iOS only command.
- * 
- * @param keyName
- * The button pressed by the mobile driver to attempt hiding the
- * keyboard
- */
-//Should be moved to the subclass
-public void hideKeyboard(String keyName) {
-execute(HIDE_KEYBOARD, ImmutableMap.of("keyName", keyName));
-}
-
-/**
- * Runs the current app as a background app for the number of seconds
- * requested. This is a synchronous method, it returns after the back has
- * been returned to the foreground.
- * 
- * @param seconds
- * Number of seconds to run App in background
+ * @see InteractsWithApps#runAppInBackground(int)
  */
+@Override
 public void runAppInBackground(int seconds) {
 execute(RUN_APP_IN_BACKGROUND, ImmutableMap.of("seconds", seconds));
 }
@@ -487,31 +449,9 @@ public void zoom(int x, int y) {
 }
 
 /**
- * In iOS apps, named TextFields have the same accessibility Id as their
- * containing TableElement. This is a convenience method for getting the
- * named TextField, rather than its containing element.
- * 
- * @param name
- * accessiblity id of TextField
- * @return The textfield with the given accessibility id
- */
-//Should be moved to the subclass
-public WebElement getNamedTextField(String name) {
-MobileElement element = (MobileElement) findElementByAccessibilityId(name);
-if (element.getTagName() != "TextField") {
-return element.findElementByAccessibilityId(name);
-}
-
-return element;
-}
-
-/**
- * Checks if an app is installed on the device
- * 
- * @param bundleId
- * bundleId of the app
- * @return True if app is installed, false otherwise
+ * @see InteractsWithApps#isAppInstalled(String)
  */
+@Override
 public boolean isAppInstalled(String bundleId) {
 Response response = execute(IS_APP_INSTALLED,
 ImmutableMap.of("bundleId", bundleId));
@@ -520,59 +460,37 @@ public boolean isAppInstalled(String bundleId) {
 }
 
 /**
- * Install an app on the mobile device
- * 
- * @param appPath
- * path to app to install
+ * @see InteractsWithApps#installApp(String)
  */
+@Override
 public void installApp(String appPath) {
 execute(INSTALL_APP, ImmutableMap.of("appPath", appPath));
 }
 
 /**
- * Remove the specified app from the device (uninstall)
- * 
- * @param bundleId
- * the bunble identifier (or app id) of the app to remove
+ * @see InteractsWithApps#removeApp(String)
  */
+@Override
 public void removeApp(String bundleId) {
 execute(REMOVE_APP, ImmutableMap.of("bundleId", bundleId));
 }
 
 /**
- * Launch the app which was provided in the capabilities at session creation
+ * @see InteractsWithApps#launchApp()
  */
+@Override
 public void launchApp() {
 execute(LAUNCH_APP);
 }
 
 /**
- * Close the app which was provided in the capabilities at session creation
+ * @see InteractsWithApps#closeApp()
  */
+@Override
 public void closeApp() {
 execute(CLOSE_APP);
 }
 
-/**
- * Lock the device (bring it to the lock screen) for a given number of
- * seconds
- * 
- * @param seconds
- * number of seconds to lock the screen for
- */
-//Should be moved to the subclass (supposed to be in iOS)
-public void lockScreen(int seconds) {
-execute(LOCK, ImmutableMap.of("seconds", seconds));
-}
-
-/**
- * Simulate shaking the device This is an iOS-only method
- */
-//Should be moved to the subclass
-public void shake() {
-execute(SHAKE);
-}
-
 /**
  * Get settings stored for this test session It's probably better to use a
  * convenience function, rather than use this function directly. Try finding

src/main/java/io/appium/java_client/InteractsWithApps.java

@@ -0,0 +1,54 @@
+package io.appium.java_client;
+
+public interface InteractsWithApps {
+/**
+ * Launch the app which was provided in the capabilities at session creation
+ */
+public void launchApp();
+
+/**
+ * Install an app on the mobile device
+ * 
+ * @param appPath
+ * path to app to install
+ */
+public void installApp(String appPath);
+
+/**
+ * Checks if an app is installed on the device
+ * 
+ * @param bundleId
+ * bundleId of the app
+ * @return True if app is installed, false otherwise
+ */
+public boolean isAppInstalled(String bundleId);
+
+/**
+ * Reset the currently running app for this session
+ */
+public void resetApp();
+
+/**
+ * Runs the current app as a background app for the number of seconds
+ * requested. This is a synchronous method, it returns after the back has
+ * been returned to the foreground.
+ * 
+ * @param seconds
+ * Number of seconds to run App in background
+ */
+public void runAppInBackground(int seconds);
+
+/**
+ * Remove the specified app from the device (uninstall)
+ * 
+ * @param bundleId
+ * the bunble identifier (or app id) of the app to remove
+ */
+public void removeApp(String bundleId);
+
+/**
+ * Close the app which was provided in the capabilities at session creation
+ */
+public void closeApp();
+
+}

src/main/java/io/appium/java_client/ios/IOSDriver.java

@@ -0,0 +1,74 @@
+package io.appium.java_client.ios;
+
+import static io.appium.java_client.MobileCommand.HIDE_KEYBOARD;
+import static io.appium.java_client.MobileCommand.LOCK;
+import static io.appium.java_client.MobileCommand.SHAKE;
+
+import java.net.URL;
+
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.WebElement;
+
+import com.google.common.collect.ImmutableMap;
+
+import io.appium.java_client.AppiumDriver;
+import io.appium.java_client.MobileElement;
+import io.appium.java_client.remote.MobilePlatform;
+
+public class IOSDriver extends AppiumDriver implements IOSDeviceActionShortcuts, GetsNamedTextField{
+private static final String IOS_PLATFORM = MobilePlatform.IOS;
+
+public IOSDriver(URL remoteAddress, Capabilities desiredCapabilities) {
+super(remoteAddress, substituteMobilePlatform(desiredCapabilities,
+IOS_PLATFORM));
+}
+
+/**
+ * @see IOSDeviceActionShortcuts#hideKeyboard(String, String)
+ */
+@Override
+public void hideKeyboard(String strategy, String keyName) {
+String[] parameters = new String[] { "strategy", "key" };
+Object[] values = new Object[] { strategy, keyName };
+execute(HIDE_KEYBOARD, getCommandImmutableMap(parameters, values));
+}
+
+/**
+ * @see IOSDeviceActionShortcuts#hideKeyboard(String)
+ */
+@Override
+public void hideKeyboard(String keyName) {
+execute(HIDE_KEYBOARD, ImmutableMap.of("keyName", keyName));
+}
+
+/**
+ * @see IOSDeviceActionShortcuts#shake()
+ */
+@Override
+public void shake() {
+execute(SHAKE);
+}
+
+/**
+ * @see GetsNamedTextField#getNamedTextField(String)
+ */
+@Override
+public WebElement getNamedTextField(String name) {
+MobileElement element = (MobileElement) findElementByAccessibilityId(name);
+if (element.getTagName() != "TextField") {
+return element.findElementByAccessibilityId(name);
+}
+return element;
+}
+
+/**
+ * Lock the device (bring it to the lock screen) for a given number of
+ * seconds
+ * 
+ * @param seconds
+ * number of seconds to lock the screen for
+ */
+public void lockScreen(int seconds) {
+execute(LOCK, ImmutableMap.of("seconds", seconds));
+}
+}

src/test/java/io/appium/java_client/MobileDriverIOSTest.java

@@ -17,9 +17,9 @@
 
 package io.appium.java_client;
 
+import io.appium.java_client.ios.IOSDriver;
 import io.appium.java_client.remote.HideKeyboardStrategy;
 import io.appium.java_client.remote.MobileCapabilityType;
-import io.appium.java_client.remote.MobilePlatform;
 
 import org.junit.After;
 import org.junit.Before;
@@ -38,7 +38,7 @@
  */
 public class MobileDriverIOSTest {
 
- private AppiumDriver driver;
+ private IOSDriver driver;
 
  @Before
  public void setup() throws Exception {
@@ -47,10 +47,10 @@ public void setup() throws Exception {
  DesiredCapabilities capabilities = new DesiredCapabilities();
  capabilities.setCapability(MobileCapabilityType.BROWSER_NAME, "");
  capabilities.setCapability(MobileCapabilityType.PLATFORM_VERSION, "7.1");
- capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, MobilePlatform.IOS);
+ //capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, MobilePlatform.IOS);
  capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "iPhone Simulator");
  capabilities.setCapability(MobileCapabilityType.APP, app.getAbsolutePath());
- driver = new AppiumDriver(new URL("http://127.0.0.1:4723/wd/hub"), capabilities);
+ driver = new IOSDriver(new URL("http://127.0.0.1:4723/wd/hub"), capabilities);
  }
 
  @After