nl.praegus.fitnesse.slim.fixtures.AppiumDriverSetup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolchain-appium-fixtures Show documentation
Fixtures to assist in android, iOS and windows app testing via FitNesse
There is a newer version: 0.0.22
Show newest version
package nl.praegus.fitnesse.slim.fixtures;

import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.ios.IOSDriver;
import io.appium.java_client.windows.WindowsDriver;
import nl.hsac.fitnesse.fixture.Environment;
import nl.hsac.fitnesse.fixture.slim.web.SeleniumDriverSetup;
import nl.hsac.fitnesse.fixture.slim.web.annotation.TimeoutPolicy;
import nl.hsac.fitnesse.fixture.slim.web.annotation.WaitUntil;
import nl.hsac.fitnesse.fixture.util.selenium.driverfactory.DriverManager;
import nl.praegus.fitnesse.slim.util.AppiumDriverManager;
import org.openqa.selenium.By;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.invoke.MethodHandles;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.util.function.BiFunction;

/**
 * Fixture to connect FitNesse to appium.
 */
public class AppiumDriverSetup extends SeleniumDriverSetup {
    private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
    private static final String APP_CAPABILITY_NAME = "app";

    static {
        // ensure our helpers are used for Appium WebDrivers
        DriverManager manager = Environment.getInstance().getSeleniumDriverManager();
        AppiumDriverManager appiumDriverManager = new AppiumDriverManager(manager);
        Environment.getInstance().setSeleniumDriverManager(appiumDriverManager);
    }

    public AppiumDriverSetup() {
        getSecretCapabilities().add("testobject_api_key");
    }

    public boolean connectToAndroidDriverAtWithCapabilities(String url, Map capabilities)
            throws MalformedURLException {
        return createAndSetRemoteWebDriver(AndroidDriver::new, url, new DesiredCapabilities(capabilities));
    }

    public boolean connectToIosDriverAtWithCapabilities(String url, Map capabilities)
            throws MalformedURLException {
        return createAndSetRemoteWebDriver(IOSDriver::new, url, new DesiredCapabilities(capabilities));
    }

    public boolean connectToWindowsDriverAtWithCapabilities(String url, Map capabilities) throws MalformedURLException {
        return this.createAndSetRemoteWebDriver(WindowsDriver::new, url, new DesiredCapabilities(capabilities));
    }

    /**
     * Connect to a getDriver and poll maximum 5 times with 5 second delay for a window with name @window to appear
     * Useful in case starting the app takes more than 3 seconds before a window appears without having to start the app using
     * a script and connecting to the desktop
     *
     * @param url          The WinAppDriver URL
     * @param capabilities Capabiltities map to start the getDriver with
     * @param window       Name of the window to attach to
     * @return connection succesful or not
     */
    public boolean connectToWindowsDriverAtWithCapabilitiesAndAttachToWindow(String url, Map capabilities, String window) {
        boolean result = false;
        int numberOfRetries = 0;
        try {
            result = this.createAndSetRemoteWebDriver(WindowsDriver::new, url, new DesiredCapabilities(capabilities));
        } catch (Exception e) {
            while (!result && numberOfRetries < 5) {
                try {
                    result = connectToWindowsDriverAtAndSelectWindow(url, window);
                } catch (Exception e2) {
                    waitSeconds(5);
                    numberOfRetries++;
                    LOGGER.warn("Connection failed, retrying to connect, attempt: {}", numberOfRetries);
                }
            }
        }
        return result;
    }

    public boolean connectToWindowsDriverAtAndSelectWindow(String url, String window) throws MalformedURLException {
        Map capabilities = new HashMap<>();
        capabilities.put("app", "Root");
        if (connectToWindowsDriverAtWithCapabilities(url, capabilities)) {
            String windowHandle = getWindowHandleForName(window);
            stopDriver();
            capabilities.clear();

            capabilities.put("appTopLevelWindow", windowHandle);
            return connectToWindowsDriverAtWithCapabilities(url, capabilities);
        }
        return false;
    }

    @WaitUntil(TimeoutPolicy.RETURN_NULL)
    private String getWindowHandleForName(String applicationTitle) {
        String handle = getHelper().driver().findElement(By.name(applicationTitle)).getAttribute("NativeWindowHandle");
        return String.format("0x%s", Integer.toHexString(Integer.parseInt(handle)));
    }

    @Override
    protected boolean createAndSetRemoteWebDriver(BiFunction constr,
                                                  String url,
                                                  DesiredCapabilities desiredCapabilities)
            throws MalformedURLException {
        Object appValue = desiredCapabilities.getCapability(APP_CAPABILITY_NAME);
        if (appValue instanceof String) {
            String appLocation = (String) appValue;
            String fullPath = getFilePathFromWikiUrl(appLocation);
            desiredCapabilities.setCapability(APP_CAPABILITY_NAME, fullPath);
        }
        return super.createAndSetRemoteWebDriver(constr, url, desiredCapabilities);
    }
}