com.haulmont.cuba.web.testsupport

Class TestUiEnvironment

java.lang.Object

org.junit.rules.ExternalResource

com.haulmont.cuba.web.testsupport.TestUiEnvironment

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, org.junit.rules.TestRule

public class TestUiEnvironment
extends org.junit.rules.ExternalResource
implements org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback

Mocked UI environment for integration tests of Web tier.
Automatically starts and cleans the corresponding test container instance.
Provides App, AppUI and initialized ClientUserSession. Usually, you should use an additional mocking framework in order to mock middleware services, e.g. JMockit or Spock.

Usage:

     // setup environment, pass desired container instance to constructor
     @Rule
     public TestUiEnvironment environment =
             new TestUiEnvironment(TestContainer.Common.INSTANCE)
                     .withLocale(Locale.ENGLISH)
                     .withUserLogin("admin");

     // mock services

     @Mocked
     public UserManagementService userManagementService;

     @Before
     public void before() {
         new Expectations() {{
             userManagementService.getSubstitutedUsers((UUID) any); result = Collections.emptyList(); minTimes = 0;
         }};
         TestServiceProxy.mock(UserManagementService.class, userManagementService);
     }

     // test something

     @Test
     public void openMainScreen() {
         // open screens, manipulate UI
         Screen screen = environment.getScreens()
                 .create(MainScreen.class, OpenMode.ROOT)
                 .show();

         assertNotNull(screen);
         assertTrue(screen instanceof MainScreen);
     }
 

See Also:

TestContainer

Field Summary

Fields

Modifier and Type	Field and Description
protected App	app
protected TestContainer	container
protected java.util.Locale	locale
protected org.slf4j.Logger	log
protected RoleDefinition	roleDefinition
protected java.lang.String[]	screenPackages
protected boolean	sessionAuthenticated
protected TestUserSessionSource	sessionSource
protected AppUI	ui
static java.lang.String	USER_ID
protected java.lang.String	userLogin
protected java.lang.String	userName

Constructor Summary

Constructors

Constructor and Description
TestUiEnvironment(TestContainer container)

Method Summary

Modifier and Type	Method and Description
protected void	after()
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
protected void	before()
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
protected void	cleanupEnvironment()
protected UserSession	createSession()
protected User	createUser()
protected void	exportScreens(java.lang.String... packages)
TestContainer	getContainer()
Dialogs	getDialogs()
protected org.springframework.beans.factory.config.AutowireCapableBeanFactory	getInjector()
protected java.util.Locale	getLocale()
Notifications	getNotifications()
Screens	getScreens()
TestUserSessionSource	getSessionSource()
AppUI	getUI()
UserSession	getUserSession()
protected boolean	isSessionAuthenticated()
protected void	resetScreens()
TestUiEnvironment	sessionAuthenticated(boolean sessionAuthenticated) Sets authenticated flag to the mocked user session.
protected void	setupEnvironment()
protected void	setupSession()
protected void	setupVaadinUi()
protected void	setupWebBeans()
TestUiEnvironment	withLocale(java.util.Locale locale) Sets locale to the mocked user session.
TestUiEnvironment	withRoleDefinition(RoleDefinition roleDefinition) Sets the role definition to the mocked user session.
TestUiEnvironment	withScreenPackages(java.lang.String... screenPackages) Overrides screen packages that will be scanned by WindowConfig.
TestUiEnvironment	withUserLogin(java.lang.String userLogin) Sets user login to the mocked user session.
TestUiEnvironment	withUserName(java.lang.String userName) Sets user name to the mocked user session.

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Field Detail

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

container

protected TestContainer container

sessionSource

protected TestUserSessionSource sessionSource

app

protected App app

ui

protected AppUI ui

log

protected org.slf4j.Logger log

sessionAuthenticated

protected boolean sessionAuthenticated

locale

protected java.util.Locale locale

userLogin

protected java.lang.String userLogin

userName

protected java.lang.String userName

roleDefinition

protected RoleDefinition roleDefinition

screenPackages

protected java.lang.String[] screenPackages

Constructor Detail

TestUiEnvironment

public TestUiEnvironment(TestContainer container)

Method Detail

before

protected void before()
               throws java.lang.Throwable

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

java.lang.Throwable

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
               throws java.lang.Exception

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

java.lang.Exception

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                throws java.lang.Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

java.lang.Exception

setupEnvironment

protected void setupEnvironment()

setupWebBeans

protected void setupWebBeans()

setupSession

protected void setupSession()

setupVaadinUi

protected void setupVaadinUi()

getInjector

protected org.springframework.beans.factory.config.AutowireCapableBeanFactory getInjector()

isSessionAuthenticated

protected boolean isSessionAuthenticated()

createSession

protected UserSession createSession()

getLocale

protected java.util.Locale getLocale()

createUser

protected User createUser()

cleanupEnvironment

protected void cleanupEnvironment()

exportScreens

protected void exportScreens(java.lang.String... packages)

resetScreens

protected void resetScreens()

getSessionSource

public TestUserSessionSource getSessionSource()

Returns:

mocked user session source

getContainer

public TestContainer getContainer()

Returns:

test Spring container

getUserSession

public UserSession getUserSession()

Returns:

user session from UserSessionSource

getUI

public AppUI getUI()

Returns:

UI

getScreens

public Screens getScreens()

Returns:

screens API

getDialogs

public Dialogs getDialogs()

Returns:

dialogs API

getNotifications

public Notifications getNotifications()

Returns:

notifications API

sessionAuthenticated

public TestUiEnvironment sessionAuthenticated(boolean sessionAuthenticated)

Sets authenticated flag to the mocked user session.

Parameters:

sessionAuthenticated - true if user is authenticated

Returns:

this

withLocale

public TestUiEnvironment withLocale(java.util.Locale locale)

Sets locale to the mocked user session.

Parameters:

locale - locale

Returns:

this

withUserLogin

public TestUiEnvironment withUserLogin(java.lang.String userLogin)

Sets user login to the mocked user session.

Parameters:

userLogin - user login

Returns:

this

withUserName

public TestUiEnvironment withUserName(java.lang.String userName)

Sets user name to the mocked user session.

Parameters:

userName - user name

Returns:

this

withRoleDefinition

public TestUiEnvironment withRoleDefinition(RoleDefinition roleDefinition)

Sets the role definition to the mocked user session.

Parameters:

roleDefinition - role definition

Returns:

this

withScreenPackages

public TestUiEnvironment withScreenPackages(java.lang.String... screenPackages)

Overrides screen packages that will be scanned by WindowConfig.

Parameters:

screenPackages - screen packages

Returns:

this