com.vaadin.testbench.commands

Interface TestBenchCommands

All Superinterfaces:

CanCompareScreenshots, CanWaitForVaadin

All Known Implementing Classes:

TestBenchCommandExecutor, TestBenchDriverProxy

public interface TestBenchCommands
extends CanWaitForVaadin, CanCompareScreenshots

Method Summary

Modifier and Type	Method and Description
void	disableWaitForVaadin() Disables implicit waiting for Vaadin to finish processing requests.
void	enableWaitForVaadin() Enables implicit waiting for Vaadin to finish processing requests.
ReferenceNameGenerator	getReferenceNameGenerator() Gets the name generator used for screenshot references.
String	getRemoteControlName() Finds the canonical host name of the remotely executing node where the test is being run.
boolean	isAutoScrollIntoView() Whether or not the elements should be scrolled into the visible area of the browser window before interacting with them.
void	resizeViewPortTo(int width, int height) Tries to resize the browsers window so that the space available for actual web content (aka viewport) is of given size.
void	setAutoScrollIntoView(boolean autoScrollIntoView) Sets if the elements should be scrolled into the visible area of the browser window before interacting with them.
default void	setReferenceNameGenerator(java.util.function.BiFunction<String,org.openqa.selenium.Capabilities,String> nameGenerator) Sets the name generator used for screenshot references.
void	setReferenceNameGenerator(ReferenceNameGenerator nameGenerator) Sets the name generator used for screenshot references.
long	timeSpentRenderingLastRequest() This method provides performance information of the client-side rendering for the last operation performed.
long	timeSpentServicingLastRequest() This method provides performance information of the server-side processing for the last request.
long	totalTimeSpentRendering() This method provides performance information of the client-side rendering for the entire session.
long	totalTimeSpentServicingRequests() This method provides performance information of the server-side processing for the entire session.

Methods inherited from interface com.vaadin.testbench.commands.CanWaitForVaadin

waitForVaadin

Methods inherited from interface com.vaadin.testbench.commands.CanCompareScreenshots

compareScreen, compareScreen, compareScreen

Method Detail

getRemoteControlName

String getRemoteControlName()

Finds the canonical host name of the remotely executing node where the test is being run. This is useful for failure reporting when running on large grids where one machine may start having problems and you need to find out which of the machines it is.

Returns:

the canonical host name along with it's IP as a string.

timeSpentRenderingLastRequest

long timeSpentRenderingLastRequest()

This method provides performance information of the client-side rendering for the last operation performed. You can use this information to make sure that some operation is executed in a timely fashion. If more than one application is running at the same URL, e.g. a portal environment with many portlets on the same page, the value returned will be the sum for all applications. Note! This method needs to be called before timeSpentRenderingLastRequest() or totalTimeSpentServicingRequests(), since they will perform an extra request, causing the value returned from this method to be that for an empty request/response.

Returns:

the time spent rendering the last request.

totalTimeSpentRendering

long totalTimeSpentRendering()

This method provides performance information of the client-side rendering for the entire session. The session starts when you navigate to an application and this method returns the amount of time spent rendering up to the point of the call. If more than one application is running at the same URL, e.g. a portal environment with many portlets on the same page, the value returned will be the sum for all applications.

Returns:

the total time spent rendering in this session.

timeSpentServicingLastRequest

long timeSpentServicingLastRequest()

This method provides performance information of the server-side processing for the last request. You can use this information to ensure that an operation is processed in a timely fashion. If more than one application is running at the same URL, e.g. a portal environment with many portlets on the same page, the value returned will be the sum for all applications. Note! If you are interested in the client-side performance for the last request, you must call timeSpentRenderingLastRequest() before calling this method. This is due to the fact that this method causes an extra server round-trip, which will cause an empty response to be rendered.

Returns:

the time spent servicing the last request on the server.

totalTimeSpentServicingRequests

long totalTimeSpentServicingRequests()

This method provides performance information of the server-side processing for the entire session. The session starts when you navigate to an application and this method returns the amount of time spent processing requests up to the point of the call. If more than one application is running at the same URL, e.g. a portal environment with many portlets on the same page, the value returned will be the sum for all applications. Note! If you are interested in the client-side performance for the last request, you must call timeSpentRenderingLastRequest() before calling this method. This is due to the fact that this method causes an extra server round-trip, which will cause an empty response to be rendered.

Returns:

the total time spent servicing requests in this session.

disableWaitForVaadin

void disableWaitForVaadin()

Disables implicit waiting for Vaadin to finish processing requests. This is useful if you need to test bombarding an application with events. Implicit waiting is enabled by default.

enableWaitForVaadin

void enableWaitForVaadin()

Enables implicit waiting for Vaadin to finish processing requests. Implicit waiting is enabled by default.

isAutoScrollIntoView

boolean isAutoScrollIntoView()

Whether or not the elements should be scrolled into the visible area of the browser window before interacting with them.

Returns:

true if elements should be scrolled, otherwise false

setAutoScrollIntoView

void setAutoScrollIntoView(boolean autoScrollIntoView)

Sets if the elements should be scrolled into the visible area of the browser window before interacting with them.

Parameters:

autoScrollIntoView - true to turn on, false to turn off

resizeViewPortTo

void resizeViewPortTo(int width,
                      int height)
               throws UnsupportedOperationException

Tries to resize the browsers window so that the space available for actual web content (aka viewport) is of given size.

Note, that the result cannot be guaranteed on all platforms. For example browsers in mobile devices are most often always fullscreen and their viewport can be "simultated". Also browsers might not allow resizing the window or limit size of window to minimum or maximum (often limited by screen size). Currently most common desktop browsers support this.

Parameters:

width - the desired width of the viewport

height - the desired height of the viewport

Throws:

UnsupportedOperationException

getReferenceNameGenerator

ReferenceNameGenerator getReferenceNameGenerator()

Gets the name generator used for screenshot references.

Returns:

the name generator for screenshot references

setReferenceNameGenerator

void setReferenceNameGenerator(ReferenceNameGenerator nameGenerator)

Sets the name generator used for screenshot references.

Parameters:

nameGenerator - the name generator for screenshot references

setReferenceNameGenerator

default void setReferenceNameGenerator(java.util.function.BiFunction<String,org.openqa.selenium.Capabilities,String> nameGenerator)

Sets the name generator used for screenshot references.

Parameters:

nameGenerator - the name generator for screenshot references