com.whitestein.lsps.test.web

Class UITester

java.lang.Object

com.whitestein.lsps.test.web.components.UIFinder

com.whitestein.lsps.test.web.UITester

Direct Known Subclasses:

UIDefaultAppTester

public class UITester
extends UIFinder

Helper for testing of the LSPS application. A generic tester, which should work on any app containing LSPS forms. For testing the Default Application, the class has additional utility methods.

When writing tests:

• Consider calling LspsRemote.unloadAllModules() in @Before and @After method
• Upload the testing model in the @Before method
• log in (for example by calling UIDefaultAppTester.login(String, String)) in the @Before method
• In the test method, just use this object to lookup UI components by ID

Example of your test case:

     public static class MyTest {
             // initializes the helper class
             protected UITester app = new UITester(new FirefoxDriver());
             // this will make a screenshot of the page on test failure
             @Rule
             public ScreenshotOnFailureRule screenshotOnFailureRule = new ScreenshotOnFailureRule(app, true);
             @Before
             public void prepare() {
                 LspsRemote.unloadAllModules();
                 app.login();
             }
             @After
             public void cleanup() {
                 LspsRemote.unloadAllModules();
             }
             @Test
             public void myTest() {
                 LspsRemote.uploadModule("mymodule", "1.0");
                 app.runModel("mymodule");
                 app.openTodo("mytodo");
                 final LspsTextBox name = app.find("NAME").as().textBox();
                 ...
             }
     }
 

Note that the tester framework uses Vaadin TestBench. To use this framework, you need to obtain the TestBench license first.

Author:

mvy

Field Summary

Fields

Modifier and Type	Field and Description
String	contextRoot Context root where the Vaadin Default app is deployed.

Fields inherited from class com.whitestein.lsps.test.web.components.UIFinder

context

Constructor Summary

Constructors

Constructor and Description
UITester(WebDriver driver) Deprecated. use UIDefaultAppTester.UIDefaultAppTester(WebDriver).
UITester(WebDriver driver, String contextRoot)
UITester(WebDriver driver, String contextRoot, int implicitWaitSeconds, int pageLoadTimeoutSeconds, int scriptTimeoutSeconds)

Method Summary

Modifier and Type	Method and Description
void	assertDocumentTitles(String... titles) Asserts that there are the following documents available to the current user.
void	assertUserSeesDocument(String documentName) Checks that the currently logged-in user is able to open given document.
protected static void	closeMenu(MenuBarElement menu)
List<DocumentInfo>	getDocuments() Returns a list of documents displayed for the currently logged-in user.
List<String>	getDocumentTitles() Returns the titles of a list of document displayed for the currently logged-in user.
Person	getLoggedInPerson()
protected LspsRemote	getRemote()
List<Todo>	getTodoList() Obtains a complete list of TO-DOs for the currently logged-in user.
static By	menuItemById(String titleKey) Returns a locator for given menu item.
protected void	mockLogIn(String username, String password) When your app differs greatly from the default app and UIDefaultAppTester.login(String, String) wouldn't work, you can log in via your custom TestBench/Selenium code.
protected void	mockLogout()
void	openTodo(String todoTitle) Deprecated. call UIDefaultAppTester.openTodo(String) instead.
ModelInstance	runModel(String modelName) Deprecated. call UIDefaultAppTester.runModel(String) instead.
void	waitForAttributeToBe(By locator, String attribute, String value) Waits till the attribute gets given value.
void	waitForElementPresent(By by) Waits till the elements described by by shows up.
void	waitForElementPresent(By by, long timeOutInSeconds) Waits till the elements described by by shows up.

Methods inherited from class com.whitestein.lsps.test.web.components.UIFinder

$, actions, clickButton, contains, createIdLocator, findAllByAttributeValue, findAllByClassname, findAllByFormId, findAllById, findAllByIdPrefix, findAllByLspsId, findAllByTextContent, findAllByXpath, findByAttributeValue, findByClassname, findByFormId, findById, findByIdPrefix, findByLspsId, findByTextContent, findByXpath, findCaptionByTextContent, findElement, findElements, findNthByTag, getDriver, getLspsCommandExecutor, toString, waitForVaadin, webElementsByExactTextContent, webElementsByFormId, webElementsById, webElementsByIdPrefix, webElementsByLspsFormId, webElementsByLspsId, webElementsByTextContent, webElementsByXpath

Methods inherited from class java.lang.Object

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

Field Detail

contextRoot

public final String contextRoot

Context root where the Vaadin Default app is deployed. For example "lsps-application"

Constructor Detail

UITester

@Deprecated
public UITester(WebDriver driver)

Deprecated. use UIDefaultAppTester.UIDefaultAppTester(WebDriver).

Parameters:

driver - the web driver to

UITester

public UITester(WebDriver driver,
                String contextRoot)

UITester

public UITester(WebDriver driver,
                String contextRoot,
                int implicitWaitSeconds,
                int pageLoadTimeoutSeconds,
                int scriptTimeoutSeconds)

Method Detail

waitForElementPresent

public void waitForElementPresent(By by)

Waits till the elements described by by shows up. Never waits more then 5 seconds, throws the exception if the element did not shown up.

Parameters:

by -

waitForAttributeToBe

public void waitForAttributeToBe(By locator,
                                 String attribute,
                                 String value)

Waits till the attribute gets given value.

Parameters:

locator -

attribute -

value -

waitForElementPresent

public void waitForElementPresent(By by,
                                  long timeOutInSeconds)

Waits till the elements described by by shows up. Never waits more then timeOutInSeconds seconds, throws the exception if the element did not shown up.

Parameters:

by -

timeOutInSeconds -

menuItemById

public static By menuItemById(String titleKey)

Returns a locator for given menu item.

Note that if you wish to activate a sub-menu-item, you will need to click on its parent first, to unravel the menu item itself.

Parameters:

titleKey - the title key as given to the NavigationMenu class

Returns:

the Selenium locator which locates the menu item, not null.

closeMenu

protected static void closeMenu(MenuBarElement menu)

mockLogIn

protected void mockLogIn(String username,
                         String password)

When your app differs greatly from the default app and UIDefaultAppTester.login(String, String) wouldn't work, you can log in via your custom TestBench/Selenium code. Then, just call this function in order for other functions to work properly.

Parameters:

username -

password -

mockLogout

protected void mockLogout()

getLoggedInPerson

public Person getLoggedInPerson()

Returns:

the person that is logged in

getRemote

protected LspsRemote getRemote()

getTodoList

public List<Todo> getTodoList()

Obtains a complete list of TO-DOs for the currently logged-in user. The list is obtained via underlying remote.

Returns:

a list of TO-DOs, not null, may be empty.

Throws:

IllegalStateException - if no user is currently logged in via mockLogIn(String, String).

getDocuments

public List<DocumentInfo> getDocuments()

Returns a list of documents displayed for the currently logged-in user. The list is obtained via webservices.

Returns:

document list, not null, may be empty.

getDocumentTitles

public List<String> getDocumentTitles()

Returns the titles of a list of document displayed for the currently logged-in user. The list is obtained via webservices.

Returns:

document list, not null, may be empty.

assertUserSeesDocument

public void assertUserSeesDocument(String documentName)

Checks that the currently logged-in user is able to open given document.

Parameters:

documentName - the document name, not null.

Throws:

AssertionError - if getDocuments() does not contain given document.

openTodo

@Deprecated
public void openTodo(String todoTitle)

Deprecated. call UIDefaultAppTester.openTodo(String) instead.

This method only works on the Default Application. Please use UIDefaultAppTester.openTodo(String) instead.

Parameters:

todoTitle -

runModel

@Deprecated
public ModelInstance runModel(String modelName)

Deprecated. call UIDefaultAppTester.runModel(String) instead.

This method only works on the Default Application. Please use UIDefaultAppTester.runModel(String) instead.

Parameters:

modelName -

Returns:

model instance id

assertDocumentTitles

public void assertDocumentTitles(String... titles)

Asserts that there are the following documents available to the current user.

Parameters:

titles - the expected document titles, not null.