com.xamarin.testcloud.appium.EnhancedIOSDriver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of appium Show documentation
Extensions for producing nice looking test reports for appium tests in Xamarin Test Cloud
The newest version!
package com.xamarin.testcloud.appium;

import io.appium.java_client.service.local.AppiumDriverLocalService;
import io.appium.java_client.service.local.AppiumServiceBuilder;
import org.openqa.selenium.*;
import org.openqa.selenium.remote.DriverCommand;
import org.openqa.selenium.remote.http.HttpClient;

import java.net.URL;
import java.util.List;

public class EnhancedIOSDriver extends io.appium.java_client.ios.IOSDriver {

    protected final EventReporter eventReporter;

    EnhancedIOSDriver(URL remoteAddress, Capabilities desiredCapabilities, EventReporter eventReporter) {
        super(remoteAddress, desiredCapabilities);
        this.eventReporter = eventReporter;
    }

    EnhancedIOSDriver(URL remoteAddress, HttpClient.Factory httpClientFactory, Capabilities desiredCapabilities, EventReporter eventReporter) {
        super(remoteAddress, httpClientFactory, desiredCapabilities);
        this.eventReporter = eventReporter;
    }

    EnhancedIOSDriver(AppiumDriverLocalService service, Capabilities desiredCapabilities, EventReporter eventReporter) {
        super(service, desiredCapabilities);
        this.eventReporter = eventReporter;
    }

    EnhancedIOSDriver(AppiumDriverLocalService service, HttpClient.Factory httpClientFactory, Capabilities desiredCapabilities, EventReporter eventReporter) {
        super(service, httpClientFactory, desiredCapabilities);
        this.eventReporter = eventReporter;
    }

    EnhancedIOSDriver(AppiumServiceBuilder builder, Capabilities desiredCapabilities, EventReporter eventReporter) {
        super(builder, desiredCapabilities);
        this.eventReporter = eventReporter;
    }

    EnhancedIOSDriver(AppiumServiceBuilder builder, HttpClient.Factory httpClientFactory, Capabilities desiredCapabilities, EventReporter eventReporter) {
        super(builder, httpClientFactory, desiredCapabilities);
        this.eventReporter = eventReporter;
    }

    EnhancedIOSDriver(HttpClient.Factory httpClientFactory, Capabilities desiredCapabilities, EventReporter eventReporter) {
        super(httpClientFactory, desiredCapabilities);
        this.eventReporter = eventReporter;
    }

    EnhancedIOSDriver(Capabilities desiredCapabilities, EventReporter eventReporter) {
        super(desiredCapabilities);
        this.eventReporter = eventReporter;
    }

    /**
     * Get screenshot from device. Will store a copy of the screenshot in parent working directory and in test-cloud
     * it will be inserted into test report.
     * @param outputType output format of screenshot
     * @param  output format of screenshot
     * @return screenshot
     * @throws WebDriverException if an error occurs
     * @see #label(String) for the perfered way to insert screenshots in test reports.
     */
    @Override
    public  X getScreenshotAs(OutputType outputType) throws WebDriverException {
        Object value = execute(DriverCommand.SCREENSHOT).getValue();
        return DriverHelper.getScreenshotToWorkspace(value, outputType, path ->
                eventReporter.reportScreenshot(path.toAbsolutePath().toString(), 0, false));
    }

    /**
     * Label a point of time in a test. Will insert a screenshot and label {@code label} into test report when running
     * in test-cloud.
     * @param label text to insert into report.
     */
    public void label(String label) {
        DriverHelper.getScreenshotToWorkspace(execute(DriverCommand.SCREENSHOT).getValue(), OutputType.FILE, path ->
                eventReporter.reportLabel(DriverHelper.sanitize(label), path.toAbsolutePath().toString(), 0, false));
    }
}