com.shaft.gui.element.TouchActions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of SHAFT_ENGINE Show documentation
SHAFT is a unified test automation engine. Powered by best-in-class frameworks, SHAFT provides a wizard-like syntax to drive your automation efficiently, maximize your ROI, and minimize your learning curve. Stop reinventing the wheel. Upgrade now!
There is a newer version: 8.2.20240402
Show newest version
package com.shaft.gui.element;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.shaft.driver.SHAFT;
import com.shaft.driver.internal.DriverFactoryHelper;
import com.shaft.driver.internal.WizardHelpers;
import com.shaft.gui.element.internal.ElementActionsHelper;
import com.shaft.gui.element.internal.FluentElementActions;
import com.shaft.gui.internal.image.ScreenshotManager;
import com.shaft.tools.io.ReportManager;
import com.shaft.tools.io.internal.ReportManagerHelper;
import com.shaft.validation.internal.WebDriverElementValidationsBuilder;
import io.appium.java_client.AppiumBy;
import io.appium.java_client.AppiumDriver;
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.ios.IOSDriver;
import org.openqa.selenium.*;
import org.openqa.selenium.interactions.*;
import org.openqa.selenium.remote.RemoteWebDriver;

import java.time.Duration;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;

import static com.shaft.gui.element.internal.ElementActionsHelper.formatLocatorToString;
import static java.util.Arrays.asList;

@SuppressWarnings({"unused"})
public class TouchActions {
    private static final int DEFAULT_NUMBER_OF_ATTEMPTS_TO_SCROLL_TO_ELEMENT = 5;
    private static final boolean CAPTURE_CLICKED_ELEMENT_TEXT = SHAFT.Properties.reporting.captureElementName();

    public TouchActions(WebDriver driver) {
        new TouchActions();
    }

    public TouchActions() {
    }

    public static TouchActions getInstance() {
        return new TouchActions();
    }

    /**
     * This is a convenience method to be able to call Element Actions from within the current Touch Actions instance.
     * 
     * Sample use would look like this:
     * new TouchActions(driver).tap(username_textbox).performElementAction().type(username_textbox, "username");
     *
     * @return a FluentElementActions object
     */
    public FluentElementActions performElementAction() {
        return FluentElementActions.getInstance();
    }

    public FluentElementActions element() {
        return FluentElementActions.getInstance();
    }

    public TouchActions and() {
        return this;
    }

    public WebDriverElementValidationsBuilder assertThat(By elementLocator) {
        return new WizardHelpers.WebDriverAssertions().element(elementLocator);
    }

    public WebDriverElementValidationsBuilder verifyThat(By elementLocator) {
        return new WizardHelpers.WebDriverVerifications().element(elementLocator);
    }

    /**
     * Sends a key-press via the device soft keyboard.
     *
     * @param key the key that should be pressed
     * @return a self-reference to be used to chain actions
     */
    public TouchActions nativeKeyboardKeyPress(KeyboardKeys key) {
        try {
            ((RemoteWebDriver) DriverFactoryHelper.getDriver().get()).executeScript("mobile: performEditorAction", key.getValue());
            ElementActionsHelper.passAction(DriverFactoryHelper.getDriver().get(), null, Thread.currentThread().getStackTrace()[1].getMethodName(), key.name(), null, null);
        } catch (Exception rootCauseException) {
            ElementActionsHelper.failAction(DriverFactoryHelper.getDriver().get(), null, rootCauseException);
        }
        return this;
    }

    /**
     * Hides the device native soft keyboard.
     *
     * @return a self-reference to be used to chain actions
     */
    public TouchActions hideNativeKeyboard() {
        try {
            if (DriverFactoryHelper.getDriver().get() instanceof AndroidDriver androidDriver) {
                androidDriver.hideKeyboard();
            } else if (DriverFactoryHelper.getDriver().get() instanceof IOSDriver iosDriver) {
                iosDriver.hideKeyboard();
            } else {
                ElementActionsHelper.failAction(DriverFactoryHelper.getDriver().get(), null);
            }
        } catch (Exception rootCauseException) {
            ElementActionsHelper.failAction(DriverFactoryHelper.getDriver().get(), null, rootCauseException);
        }
        ElementActionsHelper.passAction(DriverFactoryHelper.getDriver().get(), null, Thread.currentThread().getStackTrace()[1].getMethodName(), null, null, null);
        return this;
    }

    /**
     * Taps an element once on a touch-enabled screen
     *
     * @param elementReferenceScreenshot relative path to the reference image from the local object repository
     * @return a self-reference to be used to chain actions
     */
    @SuppressWarnings("unchecked")
    public TouchActions tap(String elementReferenceScreenshot) {
        // Wait for element presence and get the needed data
        var objects = ElementActionsHelper.waitForElementPresence(DriverFactoryHelper.getDriver().get(), elementReferenceScreenshot);
        byte[] currentScreenImage = (byte[]) objects.get(0);
        byte[] referenceImage = (byte[]) objects.get(1);
        List coordinates = (List) objects.get(2);

        // Prepare screenshots for reporting
        var screenshot = ScreenshotManager.prepareImageForReport(currentScreenImage, "tap - Current Screen Image");
        var referenceScreenshot = ScreenshotManager.prepareImageForReport(referenceImage, "tap - Reference Screenshot");
        List> attachments = new LinkedList<>();
        attachments.add(referenceScreenshot);
        attachments.add(screenshot);

        // If coordinates are empty then OpenCV couldn't find the element on screen
        if (Collections.emptyList().equals(coordinates)) {
            ElementActionsHelper.failAction(DriverFactoryHelper.getDriver().get(), "Couldn't find reference element on the current screen. If you can see it in the attached image then kindly consider cropping it and updating your reference image under this path \"" + elementReferenceScreenshot + "\".", null, attachments);
        } else {
            // Perform tap action by coordinates
//            if (DriverFactoryHelper.isMobileNativeExecution()) {
            PointerInput input = new PointerInput(PointerInput.Kind.TOUCH, "finger1");
            Sequence tap = new Sequence(input, 0);
            tap.addAction(input.createPointerMove(Duration.ZERO, PointerInput.Origin.viewport(), coordinates.get(0), coordinates.get(1)));
            tap.addAction(input.createPointerDown(PointerInput.MouseButton.LEFT.asArg()));
            tap.addAction(new Pause(input, Duration.ofMillis(200)));
            tap.addAction(input.createPointerUp(PointerInput.MouseButton.LEFT.asArg()));
            try {
                ((RemoteWebDriver) DriverFactoryHelper.getDriver().get()).perform(ImmutableList.of(tap));
            } catch (UnsupportedCommandException exception) {
                ElementActionsHelper.failAction(DriverFactoryHelper.getDriver().get(), null, exception);
            }
//            } else {
//                (new org.openqa.selenium.interactions.touch.TouchActions(DriverFactoryHelper.getDriver().get()))
//                        .down(coordinates.get(0), coordinates.get(1))
//                        .up(coordinates.get(0), coordinates.get(1))
//                        .perform();
//            }
            ElementActionsHelper.passAction(DriverFactoryHelper.getDriver().get(), null, Thread.currentThread().getStackTrace()[1].getMethodName(), null, attachments, null);
        }
        return this;
    }

    /**
     * Taps an element once on a touch-enabled screen
     *
     * @param elementLocator the locator of the webElement under test (By xpath, id,
     *                       selector, name ...etc)
     * @return a self-reference to be used to chain actions
     */
    public TouchActions tap(By elementLocator) {
        try{
            String elementText = "";
            if (CAPTURE_CLICKED_ELEMENT_TEXT) {
                try {
                    if (DriverFactoryHelper.isMobileNativeExecution()) {
                        elementText = ((WebElement) ElementActionsHelper.identifyUniqueElement(DriverFactoryHelper.getDriver().get(), elementLocator).get(1)).getAttribute("text");
                    } else {
                        elementText = ((WebElement) ElementActionsHelper.identifyUniqueElement(DriverFactoryHelper.getDriver().get(), elementLocator).get(1)).getText();
                    }
                } catch (Exception e) {
                    // do nothing
                }
            }
            List