com.pojosontheweb.selenium.TestUtil Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-utils-core Show documentation
There is a newer version: 3.0.1
package com.pojosontheweb.selenium;

import org.openqa.selenium.WebDriver;

import java.io.File;

/**
 * Helper for test cases. Maps on the lifecycle of a typical test case (setUp/test/tearDown)
 * and handles driver init and video recording.
 * Easily driven via sys props (the ones of the DriverBuildr and some here for the video).
 */
public class TestUtil {

    public static final String SYS_PROP_VIDEO_ENABLED = "webtests.video.enabled";
    public static final String SYS_PROP_VIDEO_FAILED_ONLY = "webtests.video.failures.only";
    public static final String SYS_PROP_VIDEO_DIR = "webtests.video.dir";

    private WebDriver webDriver;
    private boolean videoEnabled = isVideoEnabledFromSysProps();
    private String videoDir = getVideoDirFromSysProps();
    private boolean failuresOnly = isVideoFailuresOnlyFromSysProps();

    protected static boolean isVideoEnabledFromSysProps() {
        String videoEnabledProp = System.getProperty(SYS_PROP_VIDEO_ENABLED, "false");
        return "true".equals(videoEnabledProp.toLowerCase());
    }

    protected static String getVideoDirFromSysProps() {
        String tmpDir = System.getProperty("java.io.tmpdir");
        return System.getProperty(SYS_PROP_VIDEO_DIR, tmpDir);
    }

    protected static boolean isVideoFailuresOnlyFromSysProps() {
        String prop = System.getProperty(SYS_PROP_VIDEO_FAILED_ONLY, "true");
        return "true".equals(prop.toLowerCase());
    }

    public boolean isVideoEnabled() {
        return videoEnabled;
    }

    public void setVideoEnabled(boolean videoEnabled) {
        this.videoEnabled = videoEnabled;
    }

    public String getVideoDir() {
        return videoDir;
    }

    public void setVideoDir(String videoDir) {
        this.videoDir = videoDir;
    }

    public boolean isFailuresOnly() {
        return failuresOnly;
    }

    public void setFailuresOnly(boolean failuresOnly) {
        this.failuresOnly = failuresOnly;
    }

    public void log(String... args) {
        if (Findr.isDebugEnabled()) {
            StringBuilder sb = new StringBuilder();
            sb.append("[TestUtil] ");
            for (String s : args) {
                sb.append(s);
            }
            System.out.println(sb.toString());
        }
    }

    private ScreenRecordr recordr = null;

    public void removeVideoFiles() {
        if (recordr!=null) {
            log("removing video files");
            recordr.removeVideoFiles();
            recordr = null;
        }

    }

    public void moveVideoFiles(String testName) {
        if (recordr!=null) {
            log("moving video files to ", videoDir, " with prefix ", testName);
            recordr.moveVideoFilesTo(new File(videoDir), testName);
            recordr = null;
        }
    }

    public void setUp() {

        // init web driver before each test
        webDriver = createWebDriver();

        // init recorder if needed
        recordr = videoEnabled ? new ScreenRecordr() : null;

        // start video recorder if video is enabled
        if (recordr!=null) {
            log("video is enabled, starting recorder");
            recordr.start();
        }
    }

    protected WebDriver createWebDriver() {
        return DriverBuildr.fromSysProps().build();
    }

    public void tearDown() {
        // quit webdriver
        // TODO find better exception handling mechanism, this one
        // is pretty ugly !!!
        Exception closeException = null;
        if (webDriver!=null) {
            try {
                webDriver.quit();
            } catch (Exception e) {
                closeException = e;
            }
        }
        Exception recordrException = null;
        if (recordr!=null) {
            // ref should have been nulled-out unless test is skipped
            // or whatever : destroy the files in any case !!!
            try {
                recordr.removeVideoFiles();
            } catch(Exception e) {
                recordrException = e;
            }
        }
        if (closeException!=null) {
            // re-throw
            throw new RuntimeException(closeException);
        }
        if (recordrException!=null) {
            // re-throw
            throw new RuntimeException(recordrException);
        }
    }

    public WebDriver getWebDriver() {
        if (webDriver==null) {
            throw new IllegalStateException("webDriver is null, forgot to call setUp() ?");
        }
        return webDriver;
    }
}