com.frameworkium.core.ui.UITestLifecycle Java Examples

@BeforeMethod(alwaysRun = true)
public void setTestName(Method method, Object[] testData) {
    PickleEvent pickleEvent = ((PickleEventWrapper) testData[0]).getPickleEvent();
    String scenarioName = pickleEvent.pickle.getName();
    this.scenarioName.set(scenarioName);
    logger.info("START {}", scenarioName);
    UITestLifecycle.get().beforeTestMethod(scenarioName);
}
 

private void takeScreenshotAndSend(String action, WebDriver driver, Throwable thrw) {

        UITestLifecycle.get().getCapture().takeAndSendScreenshotWithError(
                new Command(action, "n/a", "n/a"),
                driver,
                thrw.getMessage() + "\n" + ExceptionUtils.getStackTrace(thrw));
    }
 

private void sendFinalScreenshot(ITestResult result, String action) {
    if (ScreenshotCapture.isRequired() && isUITest()) {
        Throwable thrw = result.getThrowable();
        WebDriver driver = UITestLifecycle.get().getWebDriver();
        if (null != thrw) {
            takeScreenshotAndSend(action, driver, thrw);
        } else {
            Command command = new Command(action, "n/a", "n/a");
            takeScreenshotAndSend(command, driver);
        }
    }
}
 

private String getTestSessionURL() throws MalformedURLException {
    URL gridURL = new URL(Property.GRID_URL.getValue());
    return String.format(
            "%s://%s:%d/grid/api/testsession?session=%s",
            gridURL.getProtocol(),
            gridURL.getHost(),
            gridURL.getPort(),
            UITestLifecycle.get().getRemoteSessionId());
}
 

/**
 * Create browser object.
 */
public Browser() {

    Optional<String> userAgent = UITestLifecycle.get().getUserAgent();
    if (userAgent.isPresent() && !userAgent.get().isEmpty()) {
        UserAgentStringParser uaParser = UADetectorServiceFactory.getResourceModuleParser();
        ReadableUserAgent agent = uaParser.parse(userAgent.get());

        this.name = agent.getName();
        this.version = agent.getVersionNumber().toVersionString();
        this.device = agent.getDeviceCategory().getName();
        this.platform = agent.getOperatingSystem().getName();
        this.platformVersion = agent.getOperatingSystem().getVersionNumber().toVersionString();

    } else {
        // Fall-back to the Property class
        if (BROWSER.isSpecified()) {
            this.name = BROWSER.getValue().toLowerCase();
        } else {
            this.name = DriverSetup.DEFAULT_BROWSER.toString();
        }
        if (BROWSER_VERSION.isSpecified()) {
            this.version = BROWSER_VERSION.getValue();
        }
        if (DEVICE.isSpecified()) {
            this.device = DEVICE.getValue();
        }
        if (PLATFORM.isSpecified()) {
            this.platform = PLATFORM.getValue();
        }
        if (PLATFORM_VERSION.isSpecified()) {
            this.platformVersion = PLATFORM_VERSION.getValue();
        }
    }
}
 

private void takePageLoadedScreenshotAndSendToCapture() {
    if (ScreenshotCapture.isRequired()) {
        Command pageLoadCommand = new Command(
                "load", "page", getSimplePageObjectName());
        UITestLifecycle.get().getCapture().takeAndSendScreenshot(
                pageLoadCommand, driver);
    }
}
 

@Override
public void onTestStart(ITestResult iTestResult) {
    if (VideoCapture.isRequired()) {
        VideoCapture.saveTestSessionID(
                iTestResult.getName(),
                UITestLifecycle.get().getRemoteSessionId());
    }
}
 

private String baseComment(ITestResult result) {

        StringBuilder commentBuilder = new StringBuilder();

        commentBuilder.append("Test: ")
                .append(result.getTestClass().getName())
                .append(".")
                .append(result.getMethod().getMethodName())
                .append("\nDuration: ")
                .append(((result.getEndMillis() - result.getStartMillis()) / MILLIS_PER_SECOND))
                .append("seconds");

        if (!isNull(System.getenv("BUILD_URL"))) {
            commentBuilder.append("Jenkins build: ")
                    .append(System.getenv("BUILD_URL"));
        }
        if (ScreenshotCapture.isRequired()) {
            commentBuilder.append("Capture API: ")
                    .append(CAPTURE_URL.getValue());
        }
        commentBuilder.append("\nOS: ")
                .append(getOSInfo())
                .append("\nUserAgent: ")
                .append(UITestLifecycle.get().getUserAgent());

        if (!isNull(result.getThrowable())) {
            commentBuilder.append("\nStacktrace: ")
                    .append(Throwables.getStackTraceAsString(result.getThrowable()));
        }

        return commentBuilder.toString();
    }
 

private boolean isUITest() {
    return UITestLifecycle.get().isInitialised();
}
 

private static Properties getUIProperties() {
    Properties props = new Properties();
    UITestLifecycle.get().getUserAgent()
            .ifPresent(ua -> props.setProperty("UserAgent", ua));
    return props;
}
 

@BeforeClass(alwaysRun = true)
public void setUpClass() {
    testNGCucumberRunner = new TestNGCucumberRunner(this.getClass());
    // This is the only UI Test Class so no need for separate @BeforeSuite
    UITestLifecycle.get().beforeSuite();
}
 

@BeforeMethod(dependsOnMethods = "configureBrowserBeforeTest")
public void configureBrowserBeforeUse_allows_browser_access_in_before_method() {
    assertThat(UITestLifecycle.get().getWebDriver().getPageSource()).isNotEmpty();
}
 

private void takeScreenshotAndSend(Command command, WebDriver driver) {
    UITestLifecycle.get().getCapture().takeAndSendScreenshot(command, driver);
}
 

private void takeScreenshotAndSaveLocally(String testName) {
    takeScreenshotAndSaveLocally(
            testName, (TakesScreenshot) UITestLifecycle.get().getWebDriver());
}
 

@Override
public String getSessionId() {
    return UITestLifecycle.get().getRemoteSessionId();
}
 

/** @deprecated use {@code UITestLifecycle.get().getRemoteSessionId()}. */
@Deprecated
public static String getThreadSessionId() {
    return UITestLifecycle.get().getRemoteSessionId();
}
 

/**
 * @return the user agent of the browser in the first UI test to run.
 * @deprecated use {@code UITestLifecycle.get().getUserAgent()}.
 */
@Deprecated
public static Optional<String> getUserAgent() {
    return UITestLifecycle.get().getUserAgent();
}
 

/**
 * @deprecated use {@code UITestLifecycle.get().getWait()}.
 */
@Deprecated
public static Wait<WebDriver> getWait() {
    return UITestLifecycle.get().getWait();
}
 

/**
 * @deprecated use {@code UITestLifecycle.get().getCapture()}.
 */
@Deprecated
public static ScreenshotCapture getCapture() {
    return UITestLifecycle.get().getCapture();
}
 

/**
 * @return the {@link WebDriver} used by the current thread.
 * @deprecated use {@code UITestLifecycle.get().getWebDriver()}.
 */
@Deprecated
public static WebDriver getWebDriver() {
    return UITestLifecycle.get().getWebDriver();
}
 

/** Tears down the browser after the test method. */
@AfterMethod(alwaysRun = true)
protected static void tearDownDriver() {
    UITestLifecycle.get().afterTestMethod();
}
 

/**
 * Runs before the test suite to initialise a pool of drivers, if requested.
 */
@BeforeSuite(alwaysRun = true)
protected static void initialiseDriverPool() {
    UITestLifecycle.get().beforeSuite();
}
 

private void updatePageTimeout(Duration timeout) {
    wait = UITestLifecycle.get().newWaitWithTimeout(timeout);
    JavascriptExecutor jsExecutor = (JavascriptExecutor) driver;
    visibility = new Visibility(wait, jsExecutor);
    javascriptWait = new JavascriptWait(jsExecutor, wait);
}
 

public BasePage() {
    this(UITestLifecycle.get().getWebDriver(), UITestLifecycle.get().getWait());
}
 

@Step("Open home page")
public static HomePage open() {
    UITestLifecycle.get().getWebDriver().manage().timeouts().pageLoadTimeout(30, TimeUnit.SECONDS);
    return PageFactory.newInstance(HomePage.class, "https://angularjs.org/");
}
 

@AfterClass(alwaysRun = true)
public void tearDownClass() {
    testNGCucumberRunner.finish();
    UITestLifecycle.get().afterTestSuite();
}
 

@AfterMethod
public void afterMethod(ITestResult result) {
    UITestLifecycle.get().afterTestMethod();
    logResult(result);
}
 

/**
 * Create a new {@link Wait} with timeout.
 *
 * @param timeout timeout {@link Duration} for the {@link Wait}
 * @return a new {@link Wait} for the thread local driver and given timeout
 *         which also ignores {@link NoSuchElementException} and
 *         {@link StaleElementReferenceException}
 * @deprecated use {@code UITestLifecycle.get().newWaitWithTimeout(Duration)}.
 */
@Deprecated
public static Wait<WebDriver> newWaitWithTimeout(Duration timeout) {
    return UITestLifecycle.get().newWaitWithTimeout(timeout);
}
 

/**
 * Create a new {@link Wait} with ThreadLocal driver and default timeout.
 *
 * @deprecated use {@code UITestLifecycle.get().getWait()}.
 */
@Deprecated
public static Wait<WebDriver> newDefaultWait() {
    return UITestLifecycle.get().newDefaultWait();
}
 

/**
 * <ul>
 * <li>Ensures each driver in the pool has {@code quit()}
 * <li>Processes remaining screenshot backlog
 * <li>Create Allure properties
 * </ul>
 */
@AfterSuite(alwaysRun = true)
protected static void afterTestSuiteCleanUp() {
    UITestLifecycle.get().afterTestSuite();
}