Package com.vaadin.flow.testutil

Class AbstractTestBenchTest

java.lang.Object

com.vaadin.testbench.TestBenchTestCase

com.vaadin.testbench.parallel.ParallelTest

com.vaadin.flow.testutil.TestBenchHelpers

com.vaadin.flow.testutil.AbstractTestBenchTest

All Implemented Interfaces:

com.vaadin.testbench.HasDriver, com.vaadin.testbench.HasElementQuery, com.vaadin.testbench.HasSearchContext, com.vaadin.testbench.HasTestBenchCommandExecutor

Direct Known Subclasses:

ViewOrUITest

public abstract class AbstractTestBenchTest
extends TestBenchHelpers

Abstract base class for flow TestBench tests.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractTestBenchTest.ClientChecker

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROWSERSTACK_IDENTIFIER
static final String	BROWSERSTACK_IDENTIFIER_PROPERTY
static final int	SERVER_PORT	Server port resolved by system property "serverPort" or the default "8888".
static final String	SERVER_PORT_PROPERTY_KEY	System property key for the test server port.
org.junit.rules.TestName	testName
static final boolean	USE_BROWSERSTACK
static final String	USE_BROWSERSTACK_PROPERTY
static final boolean	USE_HUB
static final String	USE_HUB_PROPERTY

Fields inherited from class com.vaadin.testbench.parallel.ParallelTest

screenshotOnFailure

Fields inherited from class com.vaadin.testbench.TestBenchTestCase

driver, maxAttempts

Constructor Summary

Constructors

Constructor	Description
AbstractTestBenchTest()

Method Summary

Modifier and Type	Method	Description
protected void	assertImageEquals(Path pathToExpectedImage, String imageUrl)
protected void	assertRuleOnce(String style)
void	checkIfServerAvailable()	Checks that server is available before running the actual test.
protected List<org.openqa.selenium.remote.DesiredCapabilities>	getBrowserCapabilities(com.vaadin.testbench.parallel.Browser... browsers)	Gets browser capabilities for the provided browsers.
List<org.openqa.selenium.remote.DesiredCapabilities>	getBrowsersToTest()	Produces a collection of browsers to run the test on.
protected String	getCurrentHostAddress()	Returns host address that can be targeted from the outside, like from a test hub.
protected String	getDeploymentHostname()	Used to determine what URL to initially open for the test.
protected int	getDeploymentPort()	Used to determine what port the test is running on.
protected List<org.openqa.selenium.remote.DesiredCapabilities>	getHubBrowsersToTest()	Gets the browsers capabilities list to execute test on the tests Hub.
protected String	getHubHostname()
protected Optional<LocalExecution>	getLocalExecution()	Gets local execution (LocalExecution) configuration for the test.
protected String	getRootURL()	Returns the URL to the root of the server, e.g.
protected com.vaadin.testbench.parallel.Browser	getRunLocallyBrowser()
protected String	getRunLocallyBrowserVersion()
protected abstract String	getTestPath()	Gets the absolute path to the test, starting with a "/".
protected String	getTestURL(String... parameters)	Returns the URL to be used for the test.
static String	getTestURL(String rootUrl, String testPath, String... parameters)	Returns the URL to be used for the test.
protected final boolean	isClientRouter()	Returns true when using clientSide routing
protected void	open()
protected void	open(String... parameters)
protected void	openForEs6Url(String... parameters)
protected void	openUrl(String targetUrl, String... parameters)
protected void	verifyScreenshot(String identifier)	Compares the given reference screenshot to the current and fails the test if it doesn't match.
protected void	waitForClientRouter()	Waits until clientSide route renders the view.
protected void	waitForFont(String fontSizeAndName)
protected void	waitForWebComponent(String tagName)
protected void	waitForWebComponentsBootstrap()

Methods inherited from class com.vaadin.flow.testutil.TestBenchHelpers

assertEquals, blur, checkLogsForErrors, checkLogsForErrors, clickElementWithJs, clickElementWithJs, drag, dragAndDrop, dragElementOver, executeScript, getLogEntries, getScrollX, getScrollY, hasCssClass, isElementPresent, scrollBy, scrollIntoViewAndClick, scrollToElement, waitForDevServer, waitForElementNotPresent, waitForElementPresent, waitForElementVisible, waitUntilNot, waitUntilNot

Methods inherited from class com.vaadin.testbench.parallel.ParallelTest

getDefaultCapabilities, getDesiredCapabilities, getHubURL, getRunOnHub, setDesiredCapabilities, setup

Methods inherited from class com.vaadin.testbench.TestBenchTestCase

concatUrl, findElement, findElements, getCommandExecutor, getContext, getDriver, setDriver, testBench, waitUntil, waitUntil, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.testbench.HasElementQuery

$, $

Field Details

SERVER_PORT_PROPERTY_KEY

public static final String SERVER_PORT_PROPERTY_KEY

System property key for the test server port.

See Also:

• Constant Field Values

SERVER_PORT

public static final int SERVER_PORT

Server port resolved by system property "serverPort" or the default "8888".

USE_HUB_PROPERTY

public static final String USE_HUB_PROPERTY

See Also:

• Constant Field Values

USE_HUB

public static final boolean USE_HUB

USE_BROWSERSTACK_PROPERTY

public static final String USE_BROWSERSTACK_PROPERTY

See Also:

• Constant Field Values

USE_BROWSERSTACK

public static final boolean USE_BROWSERSTACK

BROWSERSTACK_IDENTIFIER_PROPERTY

public static final String BROWSERSTACK_IDENTIFIER_PROPERTY

See Also:

• Constant Field Values

BROWSERSTACK_IDENTIFIER

public static final String BROWSERSTACK_IDENTIFIER

testName

public org.junit.rules.TestName testName

Constructor Details

AbstractTestBenchTest

public AbstractTestBenchTest()

Method Details

checkIfServerAvailable

public void checkIfServerAvailable()

Checks that server is available before running the actual test.

open

protected void open()

open

protected void open(String... parameters)

openForEs6Url

protected void openForEs6Url(String... parameters)

openUrl

protected void openUrl(String targetUrl,
 String... parameters)

isClientRouter

protected final boolean isClientRouter()

Returns true when using clientSide routing

Returns:

true when client-side route

waitForClientRouter

protected void waitForClientRouter()

Waits until clientSide route renders the view.

waitForWebComponentsBootstrap

protected void waitForWebComponentsBootstrap()

waitForWebComponent

protected void waitForWebComponent(String tagName)

getTestURL

protected String getTestURL(String... parameters)

Returns the URL to be used for the test.

Parameters:

parameters - query string parameters to add to the url

Returns:

the URL for the test

getTestPath

protected abstract String getTestPath()

Gets the absolute path to the test, starting with a "/".

Returns:

the path to the test, appended to getRootURL() for the full test URL.

getRootURL

protected String getRootURL()

Returns the URL to the root of the server, e.g. "http://localhost:8888"

Returns:

the URL to the root

verifyScreenshot

protected void verifyScreenshot(String identifier)
                         throws IOException

Compares the given reference screenshot to the current and fails the test if it doesn't match.

Parameters:

identifier - the identifier to use for the screenshot, becomes part of the screenshot name in the module-folder/reference-screenshots/ folder

Throws:

IOException - if there was a problem accessing the reference image

getBrowsersToTest

public List<org.openqa.selenium.remote.DesiredCapabilities> getBrowsersToTest()

Produces a collection of browsers to run the test on. This method is executed by the test runner when determining how many test methods to invoke and with what parameters. For each returned value a test method is ran and before running that, ParallelTest.setDesiredCapabilities(DesiredCapabilities) is invoked with the value returned by this method.

Returns:

The browsers to run the test on

getHubBrowsersToTest

protected List<org.openqa.selenium.remote.DesiredCapabilities> getHubBrowsersToTest()

Gets the browsers capabilities list to execute test on the tests Hub.

This list will be used only for the tests Hub. Local test execution is managed by LocalExecution annotation.

The method getBrowsersToTest() delegates the logic to this method in case getLocalExecution() return value is an empty optional (i.e. the tests Hub is used).

Returns:

the browsers capabilities list to execute test on the tests Hub

getBrowserCapabilities

protected List<org.openqa.selenium.remote.DesiredCapabilities> getBrowserCapabilities(com.vaadin.testbench.parallel.Browser... browsers)

Gets browser capabilities for the provided browsers.

Parameters:

browsers - a browsers list

Returns:

the capabilities for the given browsers

getDeploymentHostname

protected String getDeploymentHostname()

Used to determine what URL to initially open for the test.

Returns:

the host name of development server

getCurrentHostAddress

protected String getCurrentHostAddress()

Returns host address that can be targeted from the outside, like from a test hub.

Returns:

host address

Throws:

RuntimeException - if host name could not be determined or SocketException was caught during the determination.

getDeploymentPort

protected int getDeploymentPort()

Used to determine what port the test is running on.

Returns:

The port the test is running on, by default AbstractTestBenchTest.DEFAULT_SERVER_PORT

getHubHostname

protected String getHubHostname()

Overrides:

getHubHostname in class com.vaadin.testbench.parallel.ParallelTest

getRunLocallyBrowser

protected com.vaadin.testbench.parallel.Browser getRunLocallyBrowser()

Overrides:

getRunLocallyBrowser in class com.vaadin.testbench.parallel.ParallelTest

getRunLocallyBrowserVersion

protected String getRunLocallyBrowserVersion()

Overrides:

getRunLocallyBrowserVersion in class com.vaadin.testbench.parallel.ParallelTest

getLocalExecution

protected Optional<LocalExecution> getLocalExecution()

Gets local execution (LocalExecution) configuration for the test.

If this method return an empty optional then test with be run on the test Hub

Returns:

an optional configuration, or an empty optional if configuration is disabled or not available

See Also:

• LocalExecution

getTestURL

public static String getTestURL(String rootUrl,
 String testPath,
 String... parameters)

Returns the URL to be used for the test.

Parameters:

rootUrl - the root URL of the server (hostname + port)

testPath - the path of the test

parameters - query string parameters to add to the url

Returns:

the URL for the test

assertImageEquals

protected void assertImageEquals(Path pathToExpectedImage,
 String imageUrl)
                          throws IOException

Throws:

IOException

waitForFont

protected void waitForFont(String fontSizeAndName)

assertRuleOnce

protected void assertRuleOnce(String style)