com.atlassian.jira.webtest.webdriver.tests.frontend.resources

Class AbstractTestCriticalResources

java.lang.Object

com.atlassian.jira.pageobjects.JiraWebDriverTest

com.atlassian.jira.pageobjects.BaseJiraWebTest

com.atlassian.jira.webtest.webdriver.tests.frontend.resources.AbstractTestCriticalResources

Direct Known Subclasses:

TestCriticalCSS, TestCriticalJS

public abstract class AbstractTestCriticalResources
extends BaseJiraWebTest

Abstract test class for detecting whether resources loaded during page load are in fact used. This class helps to prevent adding unnecessary stylesheets and javascript files to HEAD section of document. On test failure, a developer can either fix it by deferring resource loading or adding an entry to the appropriate exempt resource list file. Instructions for either option are listed in the test failure message.

Since:

7.0, 8.0 keeping common resources separately, following DRY when it comes to updating AUI, for example

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COMMON_CSS
protected static String	COMMON_JS

Fields inherited from class com.atlassian.jira.pageobjects.BaseJiraWebTest

jiraWebTestClassRules, webTestRule

Fields inherited from class com.atlassian.jira.pageobjects.JiraWebDriverTest

backdoor, jira, logger, mailHelper, pageBinder

Constructor Summary

Constructors

Constructor and Description
AbstractTestCriticalResources()

Method Summary

Modifier and Type	Method and Description
protected void	assertCriticalNetworkRequests(CriticalResources.ResourceType resourceType, List<String> expected) Verifies that scripts or stylesheets that were drained on the page load match the given list (such resources block further processing and take part in the critical path).
protected void	assertNoErrors()
protected String	getCommonPageURL()
protected static void	setProperty(String key)
protected static void	unsetProperty(String key)
protected void	verifyResources(String exemptResourceFile, CriticalResources.ResourceType resourceType)
protected void	verifyResources(String exemptResourceFile, CriticalResources.ResourceType resourceType, boolean includeCommonResources)
protected void	visitPage(Runnable visitor)

Methods inherited from class com.atlassian.jira.pageobjects.JiraWebDriverTest

getBackdoor, getBaseClassRule, getBaseRule

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_JS

protected static final String COMMON_JS

See Also:

Constant Field Values

COMMON_CSS

protected static final String COMMON_CSS

See Also:

Constant Field Values

Constructor Detail

AbstractTestCriticalResources

public AbstractTestCriticalResources()

Method Detail

setProperty

protected static void setProperty(String key)

unsetProperty

protected static void unsetProperty(String key)

visitPage

protected void visitPage(Runnable visitor)

verifyResources

protected void verifyResources(String exemptResourceFile,
                               CriticalResources.ResourceType resourceType)
                        throws IOException

Throws:

IOException

verifyResources

protected void verifyResources(String exemptResourceFile,
                               CriticalResources.ResourceType resourceType,
                               boolean includeCommonResources)
                        throws IOException

Throws:

IOException

assertNoErrors

protected void assertNoErrors()

getCommonPageURL

protected String getCommonPageURL()

assertCriticalNetworkRequests

protected void assertCriticalNetworkRequests(CriticalResources.ResourceType resourceType,
                                             List<String> expected)

Verifies that scripts or stylesheets that were drained on the page load match the given list (such resources block further processing and take part in the critical path).

Parameters:

resourceType - look either for Scripts or Stylesheets

expected - the list of critical resources (in the format of "[context|resource]:[name]")