com.atlassian.webdriver.testing.rule

Class WebDriverScreenshotRule

java.lang.Object

org.junit.rules.TestWatcher

com.atlassian.webdriver.testing.rule.WebDriverScreenshotRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class WebDriverScreenshotRule
extends org.junit.rules.TestWatcher

A rule for taking screen-shots when a WebDriver test fails. It will also dump the html source of the page to the target/webDriverTests directory.

Since:

2.1

Constructor Summary

Constructors

Modifier	Constructor and Description
	WebDriverScreenshotRule()
	WebDriverScreenshotRule(com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> driverSupplier)
	WebDriverScreenshotRule(com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> driverSupplier, File artifactDir) Deprecated. Will be removed in version 3.0; instead, use one of the other constructors to set the driver, then call artifactDir(File)
	WebDriverScreenshotRule(org.openqa.selenium.WebDriver webDriver)
	WebDriverScreenshotRule(WebDriverDebug webDriverDebug)
protected	WebDriverScreenshotRule(WebDriverDebug webDriverDebug, File artifactDir)
protected	WebDriverScreenshotRule(WebDriverSupport<? extends org.openqa.selenium.WebDriver> support, File artifactDir)

Method Summary

Modifier and Type	Method and Description
WebDriverScreenshotRule	artifactDir(File artifactDir) Returns a copy of this rule, specifying a different artifact directory than the default.
protected void	failed(Throwable e, org.junit.runner.Description description)
protected void	starting(org.junit.runner.Description description)

Methods inherited from class org.junit.rules.TestWatcher

apply, finished, skipped, succeeded

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebDriverScreenshotRule

protected WebDriverScreenshotRule(@Nonnull
                                  WebDriverDebug webDriverDebug,
                                  @Nonnull
                                  File artifactDir)

WebDriverScreenshotRule

protected WebDriverScreenshotRule(@Nonnull
                                  WebDriverSupport<? extends org.openqa.selenium.WebDriver> support,
                                  @Nonnull
                                  File artifactDir)

WebDriverScreenshotRule

@Deprecated
public WebDriverScreenshotRule(@Nonnull
                                           com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> driverSupplier,
                                           @Nonnull
                                           File artifactDir)

Deprecated. Will be removed in version 3.0; instead, use one of the other constructors to set the driver, then call artifactDir(File)

WebDriverScreenshotRule

public WebDriverScreenshotRule(@Nonnull
                               com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> driverSupplier)

WebDriverScreenshotRule

public WebDriverScreenshotRule(@Nonnull
                               org.openqa.selenium.WebDriver webDriver)

WebDriverScreenshotRule

@Inject
public WebDriverScreenshotRule(@Nonnull
                                       WebDriverDebug webDriverDebug)

WebDriverScreenshotRule

public WebDriverScreenshotRule()

Method Detail

artifactDir

public WebDriverScreenshotRule artifactDir(File artifactDir)

Returns a copy of this rule, specifying a different artifact directory than the default.

Parameters:

artifactDir - the directory in which screenshots should be stored

Returns:

a new WebDriverScreenshotRule based on the current instance

Since:

2.3

starting

protected void starting(@Nonnull
                        org.junit.runner.Description description)

Overrides:

starting in class org.junit.rules.TestWatcher

failed

protected void failed(@Nonnull
                      Throwable e,
                      @Nonnull
                      org.junit.runner.Description description)

Overrides:

failed in class org.junit.rules.TestWatcher