at.willhaben.willtest.rule.ScreenshotRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Core classes with as few dependencies as possible

There is a newer version: 3.1.10

package at.willhaben.willtest.rule;

import at.willhaben.willtest.config.ScreenshotGenerator;
import at.willhaben.willtest.config.SeleniumProvider;
import at.willhaben.willtest.util.TestReportFile;
import org.junit.runner.Description;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.File;
import java.util.Objects;

/**
 * Creates a PNG screenshot if there is a test failure. Please note, that creating the screenshot is not instant
 * when a failure happens. It happens a few milliseconds after the failure, and it can show a different state.
 */
@Deprecated
public class ScreenshotRule extends TestFailureAwareRule {
    private static final Logger LOGGER = LoggerFactory.getLogger(ScreenshotRule.class);
    private final SeleniumProvider seleniumProvider;
    private ScreenshotGenerator screenshotGenerator;

    public ScreenshotRule(SeleniumProvider seleniumProvider) {
        this.seleniumProvider = seleniumProvider;
    }

    @Override
    protected void onError(Description description, Throwable testFailure) throws Throwable {
        super.onError(description, testFailure);
        if(Objects.nonNull(screenshotGenerator)) {
            WebDriver webDriver = seleniumProvider.getWebDriver();
            if (webDriver instanceof TakesScreenshot) {
                BufferedImage screenshot = screenshotGenerator.takeScreenshot(webDriver);

                File destFile = TestReportFile.forTest(description).withPostix(".png").build().getFile();
                ImageIO.write(screenshot, "PNG", destFile);

                LOGGER.info("Saved screenshot as " + destFile.getAbsolutePath());
            } else {
                testFailure.addSuppressed(
                        new RuntimeException(
                                "Could not take screenshot, since webdriver is not a " +
                                        TakesScreenshot.class.getName() + " instance as expected. Actual class is " +
                                        webDriver.getClass().getName()));
            }
        } else {
            LOGGER.info("Due to SreenshotProvider is not specified, no screenshot is taken");
        }
    }

    public ScreenshotRule setScreenshotGenerator(ScreenshotGenerator screenshotGenerator) {
        this.screenshotGenerator = screenshotGenerator;
        return this;
    }
}