com.vaadin.testbench.unit.SpringUIUnit4Test API 24.0.5

com.vaadin.testbench.unit.SpringUIUnit4Test

All Implemented Interfaces:

TesterWrappers

@TestExecutionListeners(listeners=UITestSpringLookupInitializer.class, mergeMode=MERGE_WITH_DEFAULTS) public abstract class SpringUIUnit4Test extends UIUnit4Test

Base JUnit 4 class for UI unit testing applications based on Spring Framework. This class provides functionality of the Spring TestContext Framework, in addition to set up a mock Vaadin Spring environment, so that views and components built upon dependency injection and AOP can be correctly be handled during unit testing. Usually when unit testing a UI view it is not needed to bootstrap the whole application. Subclasses can therefore be annotated with @ContextConfiguration or other Spring Testing annotations to load only required component or to provide mock services implementations.

 
 &#64;ContextConfiguration(classes = ViewTestConfig.class)
 public class ViewTest extends SpringUIUnit4Test {

 }
 &#64;Configuration
 class ViewTestConfig {
     &#64;Bean
     MyService myService() {
         return new my MockMyService();
     }
 }

Field Summary

Fields

Modifier and Type

Field

Description

protected static final Set<String>

scanned

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

testers

Fields inherited from class com.vaadin.testbench.unit.UIUnit4Test
treeOnFailure
Constructor Summary

Constructors

Constructor

Description

SpringUIUnit4Test()
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()

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.

void

initVaadinEnvironment()

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.

<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.

Methods inherited from class com.vaadin.testbench.unit.UIUnit4Test
printTree, testingEngine

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.unit.TesterWrappers
test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test, test

Field Details
- testers
  
  protected static final Map<Class<?>,Class<? extends ComponentTester>> testers
- scanned
  
  protected static final Set<String> scanned
Constructor Details
- SpringUIUnit4Test
  
  public SpringUIUnit4Test()
Method Details
- 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.
- initVaadinEnvironment
  
  public void initVaadinEnvironment()
  
  Overrides:
  
  initVaadinEnvironment in class UIUnit4Test
- cleanVaadinEnvironment
  
  protected void cleanVaadinEnvironment()
- 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.

com.vaadin.testbench.unit.

Class SpringUIUnit4Test

Field Summary

Fields inherited from class com.vaadin.testbench.unit.UIUnit4Test

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.testbench.unit.UIUnit4Test

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.testbench.unit.TesterWrappers

Field Details

testers

scanned

Constructor Details

SpringUIUnit4Test

Method Details

lookupServices

initVaadinEnvironment

cleanVaadinEnvironment

navigate

navigate

navigate

navigate

fireShortcut

getCurrentView

test

test

$

$

$view

roundTrip