core.helpers.MobileHelper Maven / Gradle / Ivy
package core.helpers;
import java.io.File;
import java.io.IOException;
import java.time.Duration;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.openqa.selenium.Dimension;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.Point;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.html5.Location;
import org.openqa.selenium.remote.RemoteWebElement;
import core.support.configReader.Config;
import core.support.logger.TestLog;
import core.uiCore.driverProperties.browserType.BrowserType;
import core.uiCore.drivers.AbstractDriver;
import core.uiCore.webElement.EnhancedBy;
import core.uiCore.webElement.EnhancedWebElement;
import io.appium.java_client.AppiumDriver;
import io.appium.java_client.MultiTouchAction;
import io.appium.java_client.TouchAction;
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.android.nativekey.AndroidKey;
import io.appium.java_client.android.nativekey.KeyEvent;
import io.appium.java_client.imagecomparison.OccurrenceMatchingResult;
import io.appium.java_client.ios.IOSDriver;
import io.appium.java_client.touch.LongPressOptions;
import io.appium.java_client.touch.WaitOptions;
import io.appium.java_client.touch.offset.PointOption;
import io.appium.java_client.windows.WindowsDriver;
@SuppressWarnings({ "rawtypes", "unchecked" })
public class MobileHelper {
public enum DIRECTION {
DOWN, UP, LEFT, RIGHT;
}
private static final String DISMISS_IF_BLOCKING = "ios.keyboard.dismissIfBlocking";
private static final String DISMISS_BY_KEY_PRESS = "ios.keyboard.dismissByKeyPress";
private static final String DISMISS_STRATEGY = "ios.keyboard.dismiss.Strategy";
public AppiumDriver getAppiumDriver() {
return ((AppiumDriver) AbstractDriver.getWebDriver());
}
public AndroidDriver getAndroidDriver() {
return ((AndroidDriver) AbstractDriver.getWebDriver());
}
public IOSDriver getiOSDriver() {
return ((IOSDriver) AbstractDriver.getWebDriver());
}
/**
* hides ios or android keyboard
*
*/
public void hideKeyboard() {
if (isIOS()) {
dimissIosKeyboard();
}
}
/**
* if element is not visible, attempt to hide keyboard
*
* @param element
*/
public void smartHideKeyboard(EnhancedBy element) {
// if dismiss keyboard when blocking is enable, proceed
boolean enableSmartDismissKeyboard = Config.getBooleanValue(DISMISS_IF_BLOCKING);
if (!enableSmartDismissKeyboard)
return;
// if element is not visible, attempt to dismiss keyboard
if (!Helper.isPresent(element))
dimissIosKeyboard();
}
/**
* select enter on android
*/
public void pressEnterOnAndroid() {
if (isAndroid()) {
getAndroidDriver().pressKey(new KeyEvent(AndroidKey.ENTER));
}
}
/**
* resets the app
*/
public void resetApp() {
getAppiumDriver().resetApp();
TestLog.logPass("I reset the app");
}
/**
* places the app in background And Then relaunches it
*/
public void refreshMobileApp() {
if (isMobile()) {
getAppiumDriver().runAppInBackground(Duration.ofSeconds(1));
}
}
/**
* returns if mobile driver is used
*
* @return
*/
public boolean isMobile() {
if (AbstractDriver.getWebDriver() instanceof AppiumDriver) {
return true;
}
return false;
}
/**
* is ios driver
*
* @return
*/
public boolean isIOS() {
if (AbstractDriver.getWebDriver() instanceof IOSDriver) {
return true;
}
return false;
}
/**
* is ios driver
*
* @return
*/
public boolean isAndroid() {
if (AbstractDriver.getWebDriver() instanceof AndroidDriver) {
return true;
}
return false;
}
/**
* is win app driver
*
* @return
*/
public boolean isWinApp() {
if (AbstractDriver.getWebDriver() instanceof WindowsDriver) {
return true;
}
return false;
}
/**
* is web driver
*
* @return
*/
public boolean isWebDriver() {
if (isIOS() || isAndroid())
return false;
if (AbstractDriver.getWebDriver() instanceof WebDriver) {
return true;
}
return false;
}
/**
* returns true if browser is ie
*
* @return
*/
public boolean isIeExplorer() {
if (isIOS() || isAndroid())
return false;
if (!isWebDriver())
return false;
String browser = Config.getValue("web.browserType");
return browser.equals(BrowserType.INTERNET_EXPLORER.name());
}
/**
* sets gps location on ios simulator
*
* @param location
*/
public void setLocation(Location location) {
getAppiumDriver().setLocation(location);
}
/**
* ios gesture
* https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-scroll
*
* @param element
*/
@SuppressWarnings("unused")
@Deprecated
private void scrollToiOS(EnhancedBy element) {
if (isIOS()) {
try {
EnhancedWebElement targetElement = Element.findElements(element);
JavascriptExecutor js = (JavascriptExecutor) AbstractDriver.getWebDriver();
Map params = new HashMap<>();
params.put("element", ((RemoteWebElement) targetElement.get(0)).getId());
params.put("toVisible", "true");
js.executeScript("mobile: scroll", params);
} catch (Exception e) {
e.getStackTrace();
}
}
}
// iOS scroll by object
@Deprecated
@SuppressWarnings("unused")
private boolean swipeToDirection_iOS_XCTest(EnhancedBy element, String direction) {
try {
EnhancedWebElement targetElement = Element.findElements(element);
JavascriptExecutor js = (JavascriptExecutor) AbstractDriver.getWebDriver();
HashMap swipeObject = new HashMap();
if (direction.equals("d")) {
swipeObject.put("direction", "down");
} else if (direction.equals("u")) {
swipeObject.put("direction", "up");
} else if (direction.equals("l")) {
swipeObject.put("direction", "left");
} else if (direction.equals("r")) {
swipeObject.put("direction", "right");
}
swipeObject.put("element", ((RemoteWebElement) targetElement.get(0)).getId());
js.executeScript("mobile:swipe", swipeObject);
return true;
} catch (Exception e) {
return false;
}
}
/**
* does not function properly
*
* @param element
* @param direction
* @return
*/
@Deprecated
@SuppressWarnings("unused")
private boolean scrollToDirection_iOS_XCTest(EnhancedBy element, String direction) {
// The main difference from swipe call with the same argument is that scroll
// will try to move
// the current viewport exactly to the next/previous page (the term "page" means
// the content,
// which fits into a single device screen)
try {
EnhancedWebElement targetElement = Element.findElements(element);
JavascriptExecutor js = (JavascriptExecutor) AbstractDriver.getWebDriver();
HashMap scrollObject = new HashMap();
if (direction.equals("d")) {
scrollObject.put("direction", "down");
} else if (direction.equals("u")) {
scrollObject.put("direction", "up");
} else if (direction.equals("l")) {
scrollObject.put("direction", "left");
} else if (direction.equals("r")) {
scrollObject.put("direction", "right");
}
scrollObject.put("element", ((RemoteWebElement) targetElement.get(0)).getId());
scrollObject.put("toVisible", "true"); // optional But needed sometimes
js.executeScript("mobile:scroll", scrollObject);
return true;
} catch (Exception e) {
return false;
}
}
/**
* swipe right on the screen
*/
public void mobile_swipeRight(double durationInSeconds) {
swipe(null, 0, DIRECTION.RIGHT, durationInSeconds);
}
/**
* swipe right on the screen
*/
public void mobile_swipeRight(EnhancedBy element, int index, double durationInSeconds) {
swipe(element, 0, DIRECTION.RIGHT, durationInSeconds);
}
/**
* swipe right using actions
*
* @param durationInSeconds
*/
public void mobile_swipeLeft(double durationInSeconds) {
swipe(null, 0, DIRECTION.LEFT, durationInSeconds);
}
/**
* swipe left on the screen
*/
public void mobile_swipeLeft(EnhancedBy element, int index, double durationInSeconds) {
swipe(element, 0, DIRECTION.LEFT, durationInSeconds);
}
/**
* swipe up using actions
*
* @param durationInSeconds
*/
public void mobile_swipeUp(double durationInSeconds) {
swipe(null, 0, DIRECTION.UP, durationInSeconds);
}
/**
* swipe up on the screen
*/
public void mobile_swipeUp(EnhancedBy element, int index, double durationInSeconds) {
swipe(element, 0, DIRECTION.UP, durationInSeconds);
}
/**
* swipe down using actions
*
* @param durationInSeconds
*/
public void mobile_swipeDown(double durationInSeconds) {
swipe(null, 0, DIRECTION.DOWN, durationInSeconds);
}
/**
* swipe down on the screen
*/
public void mobile_swipeDown(EnhancedBy element, int index, double durationInSeconds) {
swipe(element, 0, DIRECTION.DOWN, durationInSeconds);
}
/**
* returns the occurrences of image based on partial image
*
* @param fullImage
* @param partialImage
* @return
*/
public OccurrenceMatchingResult findImageOccurrence(File fullImage, File partialImage) {
try {
return getAppiumDriver().findImageOccurrence(fullImage, partialImage);
} catch (IOException e) {
e.printStackTrace();
}
return null;
}
/**
* set context for android And ios apps
*
* @param context
*/
public void setAppiumContexts(String context) {
TestLog.logPass("I set context to '" + context + "'");
Set contextNames = getAppiumDriver().getContextHandles();
for (String contextName : contextNames) {
if (contextName.contains(context)) {
getAppiumDriver().context(contextName);
break;
}
}
}
/**
* returns the list of mobile context. eg. webview, native view
*
* @return
*/
public Set mobile_getContextList() {
Set contextNames = getAppiumDriver().getContextHandles();
return contextNames;
}
public void mobile_switchToNativeView() {
setAppiumContexts("NATIVE");
}
public void mobile_switchToWebView() {
setAppiumContexts("WEBVIEW");
}
public void mobile_switchToView(String view) {
setAppiumContexts(view);
}
public void switchWindowsHandle(int index) {
Set windowHandles = getAppiumDriver().getWindowHandles();
List windowStrings = new ArrayList<>(windowHandles);
getAppiumDriver().switchTo().window(windowStrings.get(index));
}
public void mobile_longPress(EnhancedBy target, long miliSeconds) {
int retry = 0;
// EnhancedWebElement targetElement = Element.findElements(target);
retry++;
Helper.wait.waitForElementToLoad(target, 5);
longPress(target, miliSeconds + (retry * 2));
Helper.wait.waitForElementToBeRemoved(target, 5);
}
/**
* long press And expect element
*
* @param target
* @param miliSeconds
* @param expected
*/
public void mobile_longPressAndExpect(EnhancedBy target, long miliSeconds, EnhancedBy expected) {
TestLog.logPass("I click " + target.name);
Helper.wait.waitForElementToBeClickable(target, 10);
boolean isExpectedFound = false;
int targetWaitTimeInSeconds = 5;
int retry = 0;
do {
retry++;
if (Helper.isPresent(target))
longPress(target, miliSeconds + (retry * 2));
Helper.wait.waitForSeconds(0.5);
isExpectedFound = Helper.wait.waitForElementToBeClickable(expected, targetWaitTimeInSeconds);
} while (!isExpectedFound && retry < 3);
AssertHelper.assertTrue("expected element not found: " + expected.name, isExpectedFound);
}
/**
* TODO: enhance to become longpress And expect presses the target element
*
* @param target
* @param index
* @param miliSeconds
* @param expected
*/
public void longPress(EnhancedBy target, long miliSeconds) {
try {
EnhancedWebElement targetElement = Element.findElements(target);
TouchAction action = new TouchAction(getAppiumDriver());
action.longPress(LongPressOptions.longPressOptions()
.withElement(io.appium.java_client.touch.offset.ElementOption.element(targetElement.get(0)))
.withDuration(Duration.ofMillis(miliSeconds))).release().perform();
Thread.sleep(5000);
} catch (Exception e) {
e.getMessage();
}
}
public void longPress(int x, int y, long miliSeconds) {
try {
PointOption point = new PointOption().withCoordinates(x, y);
TouchAction action = new TouchAction(getAppiumDriver());
action.longPress(LongPressOptions.longPressOptions().withPosition(point).withDuration(Duration.ofMillis(miliSeconds))).release().perform();
Thread.sleep(5000);
} catch (Exception e) {
e.getMessage();
}
}
public void mobile_zoomOut(int zoomLevel) {
for (int i = 0; i < zoomLevel; i++) {
mobile_zoom("out");
}
}
/**
* zooms out And checks if target level indicator has been reached
*
* @param zoomLevel
* @param indicator
*/
public void mobile_zoomOut(EnhancedBy indicator) {
int retry = 15;
while (!Helper.isPresent(indicator) && retry > 0) {
retry--;
mobile_zoomOut(1);
Helper.wait.waitForSeconds(1);
}
Helper.wait.waitForSeconds(1);
TestLog.logPass("I zoom out to " + indicator.name);
}
/**
* zooms in And checks if target level indicator has been reached
*
* @param zoomLevel
* @param indicator
*/
public void mobile_zoomIn(EnhancedBy indicator) {
int retry = 10;
while (!Helper.isPresent(indicator) && retry > 0) {
retry--;
mobile_zoomIn(1);
Helper.wait.waitForSeconds(0.3);
}
TestLog.logPass("I zoom in to " + indicator.name);
}
public void mobile_zoomIn(int zoomLevel) {
for (int i = 0; i < zoomLevel; i++) {
mobile_zoom("in");
}
}
/**
* pass in "in" or "out" to zoom in or out
*
* @param inOut
*/
public void mobile_zoom(String inOut) {
int screenHeight = getAppiumDriver().manage().window().getSize().getHeight();
int screenWidth = getAppiumDriver().manage().window().getSize().getWidth();
MultiTouchAction multiTouchAction = new MultiTouchAction(getAppiumDriver());
TouchAction touchAction0 = new TouchAction(getAppiumDriver());
TouchAction touchAction1 = new TouchAction(getAppiumDriver());
switch (inOut) {
case "out":
touchAction0.press(PointOption.point(screenWidth / 2 + 100, screenHeight / 2 + 100))
.moveTo(PointOption.point(screenWidth / 2 + 95, screenWidth / 2 + 95)).release();
touchAction1.press(PointOption.point(screenWidth / 2 - 100, (screenHeight / 2) - 100))
.moveTo(PointOption.point(screenWidth / 2 - 95, screenWidth / 2 - 95)).release();
break;
case "in":
touchAction0.press(PointOption.point(screenWidth / 2 - 5, screenHeight / 2 - 5))
.moveTo(PointOption.point(screenWidth / 2 - 10, screenWidth / 2 - 10)).release();
touchAction1.press(PointOption.point(screenWidth / 2 + 5, (screenHeight / 2) + 5))
.moveTo(PointOption.point(screenWidth / 2 + 10, screenWidth / 2 + 10)).release();
break;
default:
break;
}
multiTouchAction.add(touchAction0).add(touchAction1).perform();
Helper.wait.waitForSeconds(0.5);
}
/**
* scrolls down android left side of display
*/
public void scrollDown() {
int pressX = AbstractDriver.getWebDriver().manage().window().getSize().width / 8;
int bottomY = AbstractDriver.getWebDriver().manage().window().getSize().height * 3 / 6;
int topY = AbstractDriver.getWebDriver().manage().window().getSize().height / 6;
scroll(pressX, bottomY, pressX, topY);
Helper.wait.waitForSeconds(1);
}
public void scrollDownFromCenter() {
int pressX = AbstractDriver.getWebDriver().manage().window().getSize().width / 2;
int bottomY = AbstractDriver.getWebDriver().manage().window().getSize().height * 4 / 6;
int topY = AbstractDriver.getWebDriver().manage().window().getSize().height / 6;
scroll(pressX, bottomY, pressX, topY);
Helper.wait.waitForSeconds(1);
}
/*
* don't forget that it's "natural scroll" where fromY is the point where you
* press the And toY where you release it
*/
public void scroll(int fromX, int fromY, int toX, int toY) {
TouchAction touchAction = new TouchAction((AppiumDriver) AbstractDriver.getWebDriver());
touchAction.longPress(LongPressOptions.longPressOptions().withPosition(PointOption.point(fromX, fromY)))
.moveTo(PointOption.point(toX, toY)).release().perform();
}
/**
* scrolls to mobile element until element becomes visible
*
* @param target
*/
public void mobile_scrollToElement(EnhancedBy target) {
if (isMobile()) {
int scrollCount = 5;
while (!Helper.isPresent(target) && scrollCount > 0) {
scrollDown();
Helper.wait.waitForElementToLoad(target, 3);
scrollCount--;
}
}
}
public void mobile_scrollToElementWithRefresh(EnhancedBy target) {
if (isMobile()) {
int scrollCount = 5;
while (!Helper.isPresent(target) && scrollCount > 0) {
scrollDown();
tapAtCenterLeft();
refreshMobileApp();
Helper.wait.waitForElementToLoad(target, 3);
scrollCount--;
}
}
}
public void mobile_takePicture() {
getAndroidDriver().pressKey(new KeyEvent(AndroidKey.CAMERA));
}
public void mobile_keyCode(int code) {
getAndroidDriver().pressKey(new KeyEvent(AndroidKey.BACK));
}
public void mobile_backButton() {
getAndroidDriver().pressKey(new KeyEvent(AndroidKey.BACK));
}
public void tapAtCenterLeft() {
int leftX = AbstractDriver.getWebDriver().manage().window().getSize().width / 8;
int centerY = AbstractDriver.getWebDriver().manage().window().getSize().height * 1 / 2;
TouchAction touchAction = new TouchAction((AppiumDriver) AbstractDriver.getWebDriver());
touchAction.tap(PointOption.point(leftX, centerY)).perform();
}
public void tapAtCenterRight() {
int leftX = (int) (AbstractDriver.getWebDriver().manage().window().getSize().width * 0.95);
int centerY = AbstractDriver.getWebDriver().manage().window().getSize().height * 1 / 2;
TouchAction touchAction = new TouchAction((AppiumDriver) AbstractDriver.getWebDriver());
touchAction.tap(PointOption.point(leftX, centerY)).perform();
}
/**
* returns the starting position for element based on element being set or not
* if element is null, returns default start position
*
* @param element
* @param index
* @param startX
* @param startY
* @return
*/
private Map setStarterPositionForSwipe(EnhancedBy element, int index, int startX, int startY) {
Map coordinates = new HashMap();
if (element == null) {
coordinates.put("x", startX);
coordinates.put("y", startY);
return coordinates;
}
EnhancedWebElement targetElement = Element.findElements(element);
Point p = targetElement.get(index).getLocation();
coordinates.put("x", p.getX());
coordinates.put("y", p.getY());
return coordinates;
}
/**
* swipes to direction specified either from element or from a starting position
* in the app
*
* @param element
* @param index
* @param direction
* @param durationSec
*/
private void swipe(EnhancedBy element, int index, DIRECTION direction, double durationSec) {
Dimension size = getAppiumDriver().manage().window().getSize();
int startX = 0;
int endX = 0;
int startY = 0;
int endY = 0;
switch (direction) {
case RIGHT:
startY = (int) (size.height / 2);
startX = (int) (size.width * 0.90);
endX = (int) (size.width * 0.05);
Map startPoint = setStarterPositionForSwipe(element, index, startX, startY);
new TouchAction(getAppiumDriver()).press(PointOption.point(startPoint.get("x"), startPoint.get("y")))
.waitAction(WaitOptions.waitOptions(Duration.ofSeconds((long) durationSec)))
.moveTo(PointOption.point(endX, startPoint.get("y"))).release().perform();
break;
case LEFT:
startY = (int) (size.height / 2);
startX = (int) (size.width * 0.05);
endX = (int) (size.width * 0.90);
startPoint = setStarterPositionForSwipe(element, index, startX, startY);
new TouchAction(getAppiumDriver()).press(PointOption.point(startPoint.get("x"), startPoint.get("y")))
.waitAction(WaitOptions.waitOptions(Duration.ofSeconds((long) durationSec)))
.moveTo(PointOption.point(endX, startPoint.get("y"))).release().perform();
break;
case UP:
endY = (int) (size.height * 0.70);
startY = (int) (size.height * 0.30);
startX = (size.width / 2);
startPoint = setStarterPositionForSwipe(element, index, startX, startY);
new TouchAction(getAppiumDriver()).press(PointOption.point(startPoint.get("x"), startPoint.get("y")))
.waitAction(WaitOptions.waitOptions(Duration.ofSeconds((long) durationSec)))
.moveTo(PointOption.point(endX, startPoint.get("y"))).release().perform();
break;
case DOWN:
startY = (int) (size.height * 0.70);
endY = (int) (size.height * 0.30);
startX = (size.width / 2);
startPoint = setStarterPositionForSwipe(element, index, startX, startY);
new TouchAction(getAppiumDriver()).press(PointOption.point(startPoint.get("x"), startPoint.get("y")))
.waitAction(WaitOptions.waitOptions(Duration.ofSeconds((long) durationSec)))
.moveTo(PointOption.point(startX, endY)).release().perform();
break;
}
}
/**
* strategies: if no keyboard displayed, return Strategy1: tap outside the
* keyboard. just above the keyboard, left side Strategy2: if keys: "Hide
* keyboard", "DONE", "Done", "Return", "Next" displayed, click them Strategy3:
* if keyboard still exists, use appium.hideKeyboard()
*/
private void dimissIosKeyboard() {
if (isIOS()) {
// if no keyboard displayed, return
EnhancedBy KEYBOARD_IOS = Element.byClass("XCUIElementTypeKeyboard", "Keyboard");
if (!Element.findElements(KEYBOARD_IOS).isExist())
return;
String dismissStrategy = Config.getValue(DISMISS_STRATEGY);
switch (dismissStrategy) {
case "tapOutside":
// Strategy1: tap outside the keyboard. just above the keyboard, left side
EnhancedWebElement targetElement = Element.findElements(KEYBOARD_IOS);
Point p = targetElement.get(0).getLocation();
int xPosition = 1;
int topY = p.getY() - 10;
// Strategy1: implementation
TouchAction touchAction = new TouchAction((AppiumDriver) AbstractDriver.getWebDriver());
touchAction.tap(PointOption.point(xPosition, topY)).perform();
break;
case "keyPress":
// TODO: Strategy2 is too slow. isExist takes too long
// Strategy2: if keys: "Hide keyboard", "DONE", "Done", "Return", "Next"
// displayed, click them
List keys = Config.getValueList(DISMISS_BY_KEY_PRESS);
for (String key : keys) {
EnhancedBy ios_keys = Element.byAccessibility(key, "keyboard key: " + key);
if (Element.findElements(ios_keys).isExist()) {
Helper.clickAndWait(ios_keys, 0);
break;
}
}
break;
default:
getAppiumDriver().hideKeyboard();
}
if (!Element.findElements(KEYBOARD_IOS).isExist())
return;
// Strategy3: if keyboard still exists, use appium.hideKeyboard()
getAppiumDriver().hideKeyboard();
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy