com.vaadin.testbench.unit.BaseUIUnitTest API 24.7.0.alpha6 | Vaadin

com.vaadin.testbench.unit.

java.lang.Object

com.vaadin.testbench.unit.BaseUIUnitTest

Direct Known Subclasses:

UIUnit4Test, UIUnitTest

public abstract class BaseUIUnitTest extends Object

Base class for UI unit tests. Provides methods to set up and clean a mocked Vaadin environment. The class allows scan classpath for routes and error views. Subclasses should typically restrict classpath scanning to a specific packages for faster bootstrap, by using ViewPackages annotation. If the annotation is not present a full classpath scan is performed For internal use only. May be renamed or removed in a future release.

See Also:

ViewPackages

Field Summary

Fields

Modifier and Type

Field

Description

protected static final Set<String>

scanned

protected static final Map<Class<?>,Class<? extends ComponentTester>>

testers
Constructor Summary

Constructors

Constructor

Description

BaseUIUnitTest()
Method Summary

Modifier and Type

Method

Description

<T extends Component> ComponentQuery<T>

$(Class<T> componentType)

Gets a query object for finding a component inside the UI

<T extends Component> ComponentQuery<T>

$(Class<T> componentType, Component fromThis)

Gets a query object for finding a component nested inside the given component.

<T extends Component> ComponentQuery<T>

$view(Class<T> componentType)

Gets a query object for finding a component inside the current view

protected void

cleanVaadinEnvironment()

Tears down mocked Vaadin.

protected com.vaadin.testbench.unit.internal.Routes

discoverRoutes()

protected static com.vaadin.testbench.unit.internal.Routes

discoverRoutes(Set<String> packageNames)

Discover and return Routes for mocked Vaadin core system.

void

fireShortcut(Key key, KeyModifier... modifiers)

Simulates a keyboard shortcut performed on the browser.

HasElement

getCurrentView()

Get the current view instance that is shown on the ui.

protected void

initVaadinEnvironment()

Create mocked Vaadin core obects, such as session, servlet populated with Routes, UI etc.

protected Set<Class<?>>

lookupServices()

Gets the services implementations to be used to initialized Vaadin Lookup.

<T extends Component> T

navigate(Class<T> navigationTarget)

Navigate to the given view class if it is registered.

<C, T extends Component & HasUrlParameter<C>> T

navigate(Class<T> navigationTarget, C parameter)

Navigate to view with url parameter.

<T extends Component> T

navigate(Class<T> navigationTarget, Map<String,String> parameters)

Navigate to view corresponding to the given navigation target with the specified parameters.

<T extends Component> T

navigate(String location, Class<T> expectedTarget)

Navigate to given location string.

protected static void

roundTrip()

Simulates a server round-trip, flushing pending component changes.

protected void

scanTesters()

Scan testers and populate testers map with them.

<T extends ComponentTester<Y>, Y extends Component> T

test(Class<T> tester, Y component)

Wrap component in given ComponentTester.

<T extends ComponentTester<Y>, Y extends Component> T

test(Y component)

Wrap component with ComponentTester best matching component type.

protected abstract String

testingEngine()

Gets the name of the Test Engine that is able to run the base class implementation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- testers
  
  protected static final Map<Class<?>,Class<? extends ComponentTester>> testers
- scanned
  
  protected static final Set<String> scanned
Constructor Details
- BaseUIUnitTest
  
  public BaseUIUnitTest()
Method Details
- discoverRoutes
  
  protected com.vaadin.testbench.unit.internal.Routes discoverRoutes()
- discoverRoutes
  
  protected static com.vaadin.testbench.unit.internal.Routes discoverRoutes(Set<String> packageNames)
  
  Discover and return Routes for mocked Vaadin core system.
  Returns:
  
  Routes
  
  See Also:
  
  initVadinEnvironment()
- initVaadinEnvironment
  
  protected void initVaadinEnvironment()
  
  Create mocked Vaadin core obects, such as session, servlet populated with Routes, UI etc. for testing and find testers for the components.
- scanTesters
  
  protected void scanTesters()
  
  Scan testers and populate testers map with them. The test method can find appropriate test based on testers map.
  See Also:
  
  <T,Y>test(Y)
- cleanVaadinEnvironment
  
  protected void cleanVaadinEnvironment()
  
  Tears down mocked Vaadin.
- lookupServices
  
  protected Set<Class<?>> lookupServices()
  
  Gets the services implementations to be used to initialized Vaadin Lookup. Default implementation returns an empty Set. Override this method to provide custom Vaadin services, such as InstantiatorFactory, ResourceProvider, etc.
  
  Returns:
  
  set of services implementation classes, never null.
- navigate
  
  public <T extends Component> T navigate(Class<T> navigationTarget)
  
  Navigate to the given view class if it is registered.
  
  Type Parameters:
  
  T - view type
  
  Parameters:
  
  navigationTarget - view class to navigate to
  
  Returns:
  
  instantiated view
- navigate
  
  public <C, T extends Component & HasUrlParameter<C>> T navigate(Class<T> navigationTarget, C parameter)
  
  Navigate to view with url parameter.
  
  Type Parameters:
  
  T - view type
  
  C - parameter type
  
  Parameters:
  
  navigationTarget - view class to navigate to
  
  parameter - parameter to send to view
  
  Returns:
  
  instantiated view
- navigate
  
  public <T extends Component> T navigate(Class<T> navigationTarget, Map<String,String> parameters)
  
  Navigate to view corresponding to the given navigation target with the specified parameters.
  
  Type Parameters:
  
  T - view type
  
  Parameters:
  
  navigationTarget - view class to navigate to
  
  parameters - parameters to pass to view.
  
  Returns:
  
  instantiated view
- navigate
  
  public <T extends Component> T navigate(String location, Class<T> expectedTarget)
  
  Navigate to given location string. Check that location navigated to is the expected view or throw exception.
  
  Type Parameters:
  
  T - view type
  
  Parameters:
  
  location - location string for navigating
  
  expectedTarget - class that is expected for navigation
  
  Returns:
  
  instantiated view
- fireShortcut
  
  public void fireShortcut(Key key, KeyModifier... modifiers)
  
  Simulates a keyboard shortcut performed on the browser.
  
  Parameters:
  
  key - Primary key of the shortcut. This must not be a KeyModifier.
  
  modifiers - Key modifiers. Can be empty.
- getCurrentView
  
  public HasElement getCurrentView()
  
  Get the current view instance that is shown on the ui.
  
  Returns:
  
  current view
- test
  
  public <T extends ComponentTester<Y>, Y extends Component> T test(Y component)
  
  Wrap component with ComponentTester best matching component type.
  
  Type Parameters:
  
  T - tester type
  
  Y - component type
  
  Parameters:
  
  component - component to get test wrapper for
  
  Returns:
  
  component in wrapper with test helpers
- test
  
  public <T extends ComponentTester<Y>, Y extends Component> T test(Class<T> tester, Y component)
  
  Wrap component in given ComponentTester.
  
  Type Parameters:
  
  T - tester type
  
  Y - component type
  
  Parameters:
  
  tester - test wrapper to use
  
  component - component to wrap
  
  Returns:
  
  initialized test wrapper for component
- $
  
  public <T extends Component> ComponentQuery<T> $(Class<T> componentType)
  
  Gets a query object for finding a component inside the UI
  
  Type Parameters:
  
  T - the type of the component(s) to search for
  
  Parameters:
  
  componentType - the type of the component(s) to search for
  
  Returns:
  
  a query object for finding components
- $
  
  public <T extends Component> ComponentQuery<T> $(Class<T> componentType, Component fromThis)
  
  Gets a query object for finding a component nested inside the given component.
  
  Type Parameters:
  
  T - the type of the component(s) to search for
  
  Parameters:
  
  componentType - the type of the component(s) to search for
  
  fromThis - component used as starting element for search.
  
  Returns:
  
  a query object for finding components
- $view
  
  public <T extends Component> ComponentQuery<T> $view(Class<T> componentType)
  
  Gets a query object for finding a component inside the current view
  
  Type Parameters:
  
  T - the type of the component(s) to search for
  
  Parameters:
  
  componentType - the type of the component(s) to search for
  
  Returns:
  
  a query object for finding components
- roundTrip
  
  protected static void roundTrip()
  
  Simulates a server round-trip, flushing pending component changes.
- testingEngine
  
  protected abstract String testingEngine()
  
  Gets the name of the Test Engine that is able to run the base class implementation. The Test Engine name is reported in the exception thrown when the Vaadin environment is not set up correctly.
  
  Returns:
  
  name of the Test Engine.