BaseGUISpecification (eframe 0.5 API)

org.simplemes.eframe.test.BaseGUISpecification

```
@groovy.util.logging.Slf4j
class BaseGUISpecification
extends BaseSpecification
```
This is the common Spock specification base class for GUI/GEB tests. This includes login/out and debug functions for GEB elements.

Properties Summary

Properties
Type	Name and description
`private java.util.Locale`	`currentLocale` The current local being tested.
`private static java.util.List<java.lang.String>`	`dumpAttributes`
`private static java.lang.String`	`loggedInUser` Tracks the current user logged in.
`private static java.lang.Boolean`	`searchServerUp` See if the search server is up.
`private static java.lang.Object`	`specNeeds` Makes sure the GUI test has GEB GUI, embedded server and database.

Constructor Summary

Constructors
Constructor and description
`BaseGUISpecification ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`groovy.lang.Tuple2`	`calculateOffset(java.lang.Object element1, java.lang.Object element2)` Calculates the display offsets between a given pair of GEB (HTML) elements.
	`boolean`	`checkMenuLabels(java.lang.String menuName, java.lang.String menuLabel, java.util.List<java.util.List<java.lang.String>> subMenus)` Check a menu from a toolbar-style menu with some sub menus.
	`void`	`cleanup()` Restores any globals that were mocked.
	`void`	`clickButton(java.lang.String id)` Clicks a toolkit button with the given view ID.
	`void`	`clickMenu(java.lang.String menuID, java.lang.String subMenuID)` Clicks a menu (and maybe sub menu).
	`java.lang.String`	`dumpElement(java.lang.Object elementList, int level)` Creates a human readable debug representation of the given element and its children (recursive).
	`protected java.lang.Object`	`findLogoutButton()` Finds the logout button on the current page.
	`int`	`getColumnIndex(java.lang.Class domainClass, java.lang.String columnName)` Determines the column index for the given column (field) name for the given domain.
	`geb.navigator.Navigator`	`getComboListItem(java.lang.String id)` Finds the combobox popup list item with the given ID.
	`java.lang.String`	`getFieldLabel(java.lang.String fieldName)` Finds the field label (text) for the given field name.
	`geb.navigator.Navigator`	`getInputField(java.lang.String fieldName)` Finds the given input text field element on the GUI.
	`java.lang.String`	`getReadonlyFieldValue(java.lang.String fieldName)` Finds the field value (text) for the given field name.
	`java.lang.String`	`getTooltip(java.lang.String id)` Returns the given dynamic tooltip (needed for toolkit 8.0 tooltips on buttons).
	`boolean`	`isFireFox()` Returns true if the GUI test is running in firefox.
	`static boolean`	`isSearchServerUp()`
	`void`	`login(java.lang.String _userName, java.lang.String passwordInput)` Logs the user in as the given user, if not already logged in.
	`void`	`logout()` Logs the user out.
	`java.lang.String`	`lookup(java.lang.String key, java.util.Locale locale, java.lang.Object[] args)` Convenience method for general message.properties lookup.
	`java.lang.String`	`lookupRequired(java.lang.String key, java.util.Locale locale, java.lang.Object[] args)` Convenience method for general message.properties lookup for fields marked as required.
	`boolean`	`nonZeroRecordCount(java.lang.Class domainClass)` Returns true if the given domain has non-zero record count.
	`void`	`sendKey(java.lang.Object keys)` Send the key(s) without wait to the browser.
	`void`	`setCombobox(java.lang.Object combobox, java.lang.String id)` Sets a combobox to the given ID setting.
	`void`	`setCombobox(java.lang.String view, java.lang.String id)` Sets a combobox to the given ID setting.
	`void`	`setFieldValue(java.lang.String fieldName, java.lang.Object expectedValue, java.lang.Object newValue)` Checks and sets the given field value.
	`void`	`setMultiCombobox(java.lang.Object combobox, java.util.List values)` Sets a multi-select combobox to the given list of IDs.
	`void`	`setMultiCombobox(java.lang.String view, java.util.List values)` Sets a multi-select combobox to the given list of IDs.
	`java.lang.Object`	`setup()` Initializes the GUI, if needed.
	`void`	`standardGUISleep(int multiplier)` Convenience method to wait a standard delay time (approx 100ms) for the GUI to react.
	`void`	`waitForAjaxCompletion()` Waits for the combobox in a grid to display the input value.
	`void`	`waitForGridComboboxInputValue(java.lang.String value)` Waits for the combobox in a grid to display the input value.
	`void`	`waitForNonZeroRecordCount(java.lang.Class domainClass)` Wait for a record to to be created in the database.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class BaseSpecification`	assertValidationFails, checkForDBConnectionLeaks, checkForLeftoverRecords, checkJavascript, checkJavascriptFragment, checkPage, cleanup, cleanupDomainRecords, cleanupMockedUtilityClasses, createReportLabel, deleteAllRecords, disableSQLTrace, disableStackTraceLogging, doAutoCleanups, doOtherCleanups, enableSQLTrace, getObjectMapper, getPreparedStatement, lookup, lookupRequired, mockFieldExtension, mockRequest, needs, needsServer, propertyMissing, registerAutoCleanup, report, reportFailure, setCurrentUser, setTraceLogLevel, setup, setupSpec, startServerIfNeeded, waitForInitialDataLoad, waitForRecordChange

- Property Detail
  - private java.util.Locale currentLocale
    
    The current local being tested. Comes from the -Dgeb.lang option (e.g. -Dgeb.lang=de-DE). (Default: en-US).
  - private static final java.util.List<java.lang.String> dumpAttributes
  - private static java.lang.String loggedInUser
    
    Tracks the current user logged in.
  - private static java.lang.Boolean searchServerUp
    
    See if the search server is up.
  - private static java.lang.Object specNeeds
    
    Makes sure the GUI test has GEB GUI, embedded server and database.
- Constructor Detail
  - BaseGUISpecification()
- Method Detail
  - groovy.lang.Tuple2 calculateOffset(java.lang.Object element1, java.lang.Object element2)
    
    Calculates the display offsets between a given pair of GEB (HTML) elements. This is the distance to move from element1 to element2.
    Parameters:
    element1 - The first GEB element.
    element2 - The second GEB element.
    Returns:
    A Tuple with the x and y offset.
  - boolean checkMenuLabels(java.lang.String menuName, java.lang.String menuLabel, java.util.List<java.util.List<java.lang.String>> subMenus)
    
    Check a menu from a toolbar-style menu with some sub menus.
    Parameters:
    menuName - The top-level menu.
    menuLabel - The top-level menu lookup key.
    subMenus - The list of menus to check (element 0 = menu ID, element 1 = lookup key for label.
    Returns:
    Always returns true.
  - void cleanup()
    
    Restores any globals that were mocked.
  - void clickButton(java.lang.String id)
    
    Clicks a toolkit button with the given view ID.
    Parameters:
    id - The ID of the button.
  - void clickMenu(java.lang.String menuID, java.lang.String subMenuID)
    
    Clicks a menu (and maybe sub menu).
    Parameters:
    menuID - The menu to click.
    subMenuID
  - java.lang.String dumpElement(java.lang.Object elementList, int level)
    
    Creates a human readable debug representation of the given element and its children (recursive).
    Parameters:
    elementList - The element (can be a list).
    level - The nesting level (optional).
    Returns:
    The element and its children in a debug format.
  - protected java.lang.Object findLogoutButton()
    
    Finds the logout button on the current page. This is needed since in most pages, the page context is not always know for a given test. A simple 'logoutButton.click()' frequently fails when a new test starts, so we use the explicit $() below instead of the simple page-based approach.
    Returns:
    The logout button.
  - int getColumnIndex(java.lang.Class domainClass, java.lang.String columnName)
    
    Determines the column index for the given column (field) name for the given domain. Uses the default fieldOrder.
    Parameters:
    domainClass - The domain class.
    columnName - The column name.
    Returns:
    The column Index. -1 if not found.
  - geb.navigator.Navigator getComboListItem(java.lang.String id)
    
    Finds the combobox popup list item with the given ID.
    Parameters:
    id - The ID.
    Returns:
    The item (supports the GEB click() and text() methods).
  - java.lang.String getFieldLabel(java.lang.String fieldName)
    
    Finds the field label (text) for the given field name.
    Note: This is rarely needed. Most Page elements use the TextFieldModule or ReadOnlyFieldModule to find the label.
    Parameters:
    fieldName - The field name.
    Returns:
    The field label text.
  - geb.navigator.Navigator getInputField(java.lang.String fieldName)
    
    Finds the given input text field element on the GUI.
    Note: This is rarely needed outside of closures. Most Page elements use the TextFieldModule to find the input field.
    Parameters:
    fieldName - The field name.
    Returns:
    The input field element.
  - java.lang.String getReadonlyFieldValue(java.lang.String fieldName)
    
    Finds the field value (text) for the given field name.
    Note: This is rarely needed. Most Page elements use the TextFieldModule or ReadOnlyFieldModule to find the field text.
    Parameters:
    fieldName - The field name.
    Returns:
    The field text.
  - java.lang.String getTooltip(java.lang.String id)
    
    Returns the given dynamic tooltip (needed for toolkit 8.0 tooltips on buttons).
    Parameters:
    id - The button ID (toolkit ID).
    Returns:
    The tooltip value.
  - boolean isFireFox()
    
    Returns true if the GUI test is running in firefox.
    Note: Use this sparingly.
    Returns:
    True if running in firefox.
  - static boolean isSearchServerUp()
  - void login(java.lang.String _userName, java.lang.String passwordInput)
    
    Logs the user in as the given user, if not already logged in. If the user is different from the previous login, then the user will be logged out before the new user is logged in.
    Parameters:
    _userName - The user to login as Required.
    passwordInput - The password to login with (Default: userName).
  - void logout()
    
    Logs the user out. Will navigate to the home page if no logout button is found.
  - @java.lang.Override java.lang.String lookup(java.lang.String key, java.util.Locale locale, java.lang.Object[] args)
    
    Convenience method for general message.properties lookup. This sub-class uses the current locale from the GUI test browser if none is given.
    Note: This lookup will flag missing .properties entries.
    Parameters:
    key - The key to lookup.
    locale - The locale to use for the message. (Default: Current Browser Locale)
    args - The replaceable arguments used by the message (if any).
    Returns:
    The looked up message.
  - @java.lang.Override java.lang.String lookupRequired(java.lang.String key, java.util.Locale locale, java.lang.Object[] args)
    
    Convenience method for general message.properties lookup for fields marked as required. This sub-class uses the current locale from the GUI test browser if none is given.
    Note: This lookup will flag missing .properties entries.
    Parameters:
    key - The key to lookup.
    locale - The locale to use for the message. (Default: Current browser Locale)
    args - The replaceable arguments used by the message (if any).
    Returns:
    The looked up message.
  - boolean nonZeroRecordCount(java.lang.Class domainClass)
    
    Returns true if the given domain has non-zero record count.
    Parameters:
    domainClass - The domain class.
    Returns:
    True if non-zero.
  - void sendKey(java.lang.Object keys)
    
    Send the key(s) without wait to the browser.
    keys:
    The key(s) to send.
  - void setCombobox(java.lang.Object combobox, java.lang.String id)
    
    Sets a combobox to the given ID setting. Does not use the drop-down.
    Parameters:
    combobox - The combobox module to set the value to.
    id - The ID of the combobox element to select.
  - void setCombobox(java.lang.String view, java.lang.String id)
    
    Sets a combobox to the given ID setting. Does not use the drop-down.
    Parameters:
    view - The combobox view.
    id - The ID of the combobox element to select.
  - void setFieldValue(java.lang.String fieldName, java.lang.Object expectedValue, java.lang.Object newValue)
    
    Checks and sets the given field value. Supports text field and checkbox fields.
    Parameters:
    fieldName - The field name.
    expectedValue - The expected value.
    newValue - The new value.
  - void setMultiCombobox(java.lang.Object combobox, java.util.List values)
    
    Sets a multi-select combobox to the given list of IDs. Does not use the drop-down.
    Parameters:
    combobox - The combobox module to set the value to.
    values - The list of values to set (uses the .id element).
  - void setMultiCombobox(java.lang.String view, java.util.List values)
    
    Sets a multi-select combobox to the given list of IDs. Does not use the drop-down.
    Parameters:
    view - The combobox view.
    values - The list of values to set (uses the .id element).
  - java.lang.Object setup()
    
    Initializes the GUI, if needed.
  - void standardGUISleep(int multiplier)
    
    Convenience method to wait a standard delay time (approx 100ms) for the GUI to react.
    Note: This should only be used when waitFor is not suitable (rare).
    Note: If TRACE logging is enabled, then this method will print an abbreviated stack trace to help you track down where it was called. This will help you decide when a waitFor might be better than a sleep.
    Parameters:
    multiplier - The number of standard sleeps to wait for. (Default: 1)
  - void waitForAjaxCompletion()
    
    Waits for the combobox in a grid to display the input value. Assumes the focus is in the cell with the combobox.
    Parameters:
    value - The value in the current combobox editor field.
  - void waitForGridComboboxInputValue(java.lang.String value)
    
    Waits for the combobox in a grid to display the input value. Assumes the focus is in the cell with the combobox.
    Parameters:
    value - The value in the current combobox editor field.
  - void waitForNonZeroRecordCount(java.lang.Class domainClass)
    
    Wait for a record to to be created in the database.
    Parameters:
    domainClass - The domain class.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class BaseGUISpecification

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private java.util.Locale currentLocale

private static final java.util.List<java.lang.String> dumpAttributes

private static java.lang.String loggedInUser

private static java.lang.Boolean searchServerUp

private static java.lang.Object specNeeds

Constructor Detail

BaseGUISpecification()

Method Detail

groovy.lang.Tuple2 calculateOffset(java.lang.Object element1, java.lang.Object element2)

boolean checkMenuLabels(java.lang.String menuName, java.lang.String menuLabel, java.util.List<java.util.List<java.lang.String>> subMenus)

void cleanup()

void clickButton(java.lang.String id)

void clickMenu(java.lang.String menuID, java.lang.String subMenuID)

java.lang.String dumpElement(java.lang.Object elementList, int level)

protected java.lang.Object findLogoutButton()

int getColumnIndex(java.lang.Class domainClass, java.lang.String columnName)

geb.navigator.Navigator getComboListItem(java.lang.String id)

java.lang.String getFieldLabel(java.lang.String fieldName)

geb.navigator.Navigator getInputField(java.lang.String fieldName)

java.lang.String getReadonlyFieldValue(java.lang.String fieldName)

java.lang.String getTooltip(java.lang.String id)

boolean isFireFox()

static boolean isSearchServerUp()

void login(java.lang.String _userName, java.lang.String passwordInput)

void logout()

@java.lang.Override java.lang.String lookup(java.lang.String key, java.util.Locale locale, java.lang.Object[] args)

@java.lang.Override java.lang.String lookupRequired(java.lang.String key, java.util.Locale locale, java.lang.Object[] args)

boolean nonZeroRecordCount(java.lang.Class domainClass)

void sendKey(java.lang.Object keys)

void setCombobox(java.lang.Object combobox, java.lang.String id)

void setCombobox(java.lang.String view, java.lang.String id)

void setFieldValue(java.lang.String fieldName, java.lang.Object expectedValue, java.lang.Object newValue)

void setMultiCombobox(java.lang.Object combobox, java.util.List values)

void setMultiCombobox(java.lang.String view, java.util.List values)

java.lang.Object setup()

void standardGUISleep(int multiplier)

void waitForAjaxCompletion()

void waitForGridComboboxInputValue(java.lang.String value)

void waitForNonZeroRecordCount(java.lang.Class domainClass)