com.atlassian.webdriver.testing.rule

Class JavaScriptErrorsRule

java.lang.Object

org.junit.rules.TestWatcher

com.atlassian.webdriver.testing.rule.JavaScriptErrorsRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class JavaScriptErrorsRule
extends org.junit.rules.TestWatcher

Rule to log Javascript console error messages. At present, the logging only works in Firefox, since we use a Firefox extension to collect the console output.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
	JavaScriptErrorsRule()
protected	JavaScriptErrorsRule(JavaScriptErrorRetriever errorRetriever, com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> webDriver, org.slf4j.Logger logger, Set<String> errorsToIgnore, boolean failOnJavaScriptErrors)
	JavaScriptErrorsRule(com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> webDriver)
	JavaScriptErrorsRule(com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> webDriver, org.slf4j.Logger logger)
	JavaScriptErrorsRule(org.openqa.selenium.WebDriver webDriver)
	JavaScriptErrorsRule(org.openqa.selenium.WebDriver webDriver, org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method and Description
JavaScriptErrorsRule	errorRetriever(JavaScriptErrorRetriever errorRetriever) Returns a copy of this rule with a different underlying JavaScriptErrorRetriever.
JavaScriptErrorsRule	errorsToIgnore(Set<String> errorsToIgnore) Returns a copy of this rule with a specific set of error messages to ignore.
JavaScriptErrorsRule	failOnJavaScriptErrors(boolean failOnJavaScriptErrors) Returns a copy of this rule, specifying whether it should force a test failure when Javascript errors are found.
void	finished(org.junit.runner.Description description)
String	getConsoleOutput()
protected List<String>	getErrors() Get the console output from the browser.
JavaScriptErrorsRule	logger(org.slf4j.Logger logger) Returns a copy of this rule that writes to a different logger.

Methods inherited from class org.junit.rules.TestWatcher

apply, failed, skipped, starting, succeeded

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_SEPARATOR

public static final String ERROR_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

JavaScriptErrorsRule

public JavaScriptErrorsRule(com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> webDriver)

JavaScriptErrorsRule

public JavaScriptErrorsRule(com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> webDriver,
                            org.slf4j.Logger logger)

JavaScriptErrorsRule

@Inject
public JavaScriptErrorsRule(org.openqa.selenium.WebDriver webDriver)

JavaScriptErrorsRule

public JavaScriptErrorsRule(org.openqa.selenium.WebDriver webDriver,
                            org.slf4j.Logger logger)

JavaScriptErrorsRule

public JavaScriptErrorsRule()

JavaScriptErrorsRule

protected JavaScriptErrorsRule(JavaScriptErrorRetriever errorRetriever,
                               com.google.common.base.Supplier<? extends org.openqa.selenium.WebDriver> webDriver,
                               org.slf4j.Logger logger,
                               Set<String> errorsToIgnore,
                               boolean failOnJavaScriptErrors)

Method Detail

errorRetriever

public JavaScriptErrorsRule errorRetriever(JavaScriptErrorRetriever errorRetriever)

Returns a copy of this rule with a different underlying JavaScriptErrorRetriever. You may wish to override the ErrorRetriever in order to do custom post-processing of error messages.

Parameters:

errorRetriever - an implementation of JavaScriptErrorRetriever

Returns:

a new JavaScriptErrorsRule based on the current instance

errorsToIgnore

public JavaScriptErrorsRule errorsToIgnore(Set<String> errorsToIgnore)

Returns a copy of this rule with a specific set of error messages to ignore. Any error whose message exactly matches one of the strings in this set will not be logged.

Parameters:

errorsToIgnore - a set of error messages to ignore

Returns:

a new JavaScriptErrorsRule based on the current instance

logger

public JavaScriptErrorsRule logger(org.slf4j.Logger logger)

Returns a copy of this rule that writes to a different logger.

Parameters:

logger - a Logger

Returns:

a new JavaScriptErrorsRule based on the current instance

failOnJavaScriptErrors

public JavaScriptErrorsRule failOnJavaScriptErrors(boolean failOnJavaScriptErrors)

Returns a copy of this rule, specifying whether it should force a test failure when Javascript errors are found. This property is false by default.

Parameters:

failOnJavaScriptErrors - true if Javascript errors should always cause a test to fail

Returns:

a new JavaScriptErrorsRule based on the current instance

finished

public void finished(org.junit.runner.Description description)

Overrides:

finished in class org.junit.rules.TestWatcher

getConsoleOutput

public String getConsoleOutput()

getErrors

protected List<String> getErrors()

Get the console output from the browser.

THIS FUNCTION DRAINS OUTPUT; IT IS *NOT* IDEMPOTENT!