se.claremont.taf.javasupport.interaction

Class GenericInteractionMethods

java.lang.Object

se.claremont.taf.javasupport.interaction.GenericInteractionMethods

public class GenericInteractionMethods
extends Object

Class enabling interaction with rich Java application GUIs

Created by jordam on 2017-02-08.

Field Summary

Fields

Modifier and Type	Field and Description
int	standardTimeout
TestCase	testCase

Constructor Summary

Constructors

Constructor and Description
GenericInteractionMethods(TestCase testCase) Constructor to enable interaction with Java GUIs

Method Summary

Modifier and Type	Method and Description
void	activateTab(JavaWindow window, String tabText)
ArrayList<Object>	allSubElementsOf(Object component) Retrieves all sub-elements (recursively) of the object provided.
void	bringWindowOfElementToFront(GuiComponent component)
boolean	checkboxIsChecked(GuiComponent component, int timeoutInSeconds) Returns the current status of a checkbox.
void	chooseRadioButton(GuiComponent guiElement, String textOfElementToChoose) When implemented, this method will set radio button status.
void	click(GuiComponent guiElement)
void	clickByRawMouseAction(GuiComponent guiElement) Performs a left mouse button click upon the given element.
void	clickElementWithText(GuiComponent parentElement, String textOfElementToClick) Finds the element with the specified text and click on it.
void	clickElementWithText(JavaWindow window, String textOfElementToClick) Finds the element with the specified text and click on it.
void	closeAllWindows()
void	closeWindow(JavaWindow window)
void	debug_LogCurrentActiveWindows() Writes currently active window to the test case log
boolean	doesNotExist(GuiComponent guiElement) Checks if an element does not exist at runtime.
boolean	doesNotExistWithTimeout(GuiComponent guiElement, int timeoutInSeconds) Checks if an element exist, but gives the element time to disappear for a timeout.
boolean	exists(GuiComponent guiElement) Checks if an element exists in the GUI.
boolean	existsWithTimeout(GuiComponent guiElement, int timeoutInSeconds) Checks if a component exist, but actually gives it time to appear in the GUI.
Object	getContainerComponent(Object component) Returns the first parent that has the ability to hold child objects.
String	getDropDownSelectedOption(GuiComponent guiComponent) Returns the currently selected value of a dropdown
List<String>	getDropDownSelectedOptions(GuiComponent guiElement) Returns a list of the selected options of a dropdown
String	getName(Object component) Returns the name of a component, as specified by the programmer when creating the GUI.
Object	getParentComponent(Object component) Returns the parent element if that can be identified.
List<String>	getSelected(GuiComponent guiComponent)
String	getText(GuiComponent guiElement)
String	getText(GuiComponent guiElement, int timeoutInMilliseconds) Returns the runtime text of the element.
String	getText(Object component) Returns the current text of a GUI component.
void	haltFurtherExecution()
void	hover(GuiComponent guiElement) Moves the mouse to the given element.
boolean	isDisplayed(GuiComponent guiElement) Checks if the element is currently displayed (no timeout, no waiting), meaning that it exists, and is set as visible in the GUI.
boolean	isDisplayedWithinTimeout(GuiComponent guiElement, int timeoutInSeconds) Checks if the element gets displayed within the timeout.
boolean	isNotDisplayed(GuiComponent guiElement) Checks if the element is currently not displayed (no timeout, no waiting), meaning that it does not exists, or it is set as non-visible in the GUI.
boolean	isNotDisplayedWithTimeout(GuiComponent guiComponent, int timeoutInSeconds) Checks if the element get displayed within the timeout.
void	selectInDropdown(GuiComponent guiElement, String selection) Selects a value in a dropdown.
void	setApplicationUnderTest(ApplicationUnderTest app)
void	setCheckboxToChecked(GuiComponent component) Sets a checkbox to be checked (=true).
void	setCheckboxToState(GuiComponent component, boolean expectedEndState) Sets a checkbox element to selected state.
void	setCheckboxToState(GuiComponent component, boolean expectedEndState, int timeoutInSeconds) Tries to set a checkbox element to selected state for a certain number of seconds to enable elements to appear or to get enabled.
void	setCheckboxToUnChecked(GuiComponent component) Sets a checkbox to be un-checked (=false).
void	setSelected(GuiComponent guiComponent, String... strings)
void	tabToNext()
void	takeScreenshot() Saves a screenshot of all screens and writes its save path to the test case log.
static void	takeScreenshot(TestCase testCase)
void	trackMousePosition(int timeoutInSeconds)
void	type(GuiComponent guiComponent, int javaAwtEventKeyEvent)
void	type(GuiComponent guiComponent, String text)
void	type(int javaAwtEventKeyEvent)
void	type(String text)
void	wait(int milliseconds) Pauses execution the stated time.
void	verifyCheckboxIsChecked(GuiComponent component) Verifies that a checkbox element is checked.
void	verifyCheckboxIsUnChecked(GuiComponent component) Verifies that a checkbox element is un-checked.
void	verifyCheckboxSelectionStatus(JavaGuiElement guiElement, boolean expectedToBeSelected)
void	verifyCheckboxStatus(GuiComponent component, boolean expectedStatus) Verifies the status of a checkbox element.
void	verifyCheckboxStatus(GuiComponent component, boolean expectedStatus, int timeoutInSeconds) Verifies the status of a checkbox element.
void	verifyElementDoesNotExist(GuiComponent guiComponent)
void	verifyElementIsDisabled(GuiComponent guiComponent)
void	verifyElementIsEnabled(GuiComponent guiComponent)
void	verifyElementTextContains(GuiComponent guiElement, String expectedText) Retrieves the text of a runtime element and verifies the text against the given oracle.
void	verifyElementTextIsExactly(GuiComponent guiElement, String expectedText) Retrieves the text of a runtime element and verifies the text against the given oracle.
void	verifyElementTextIsRegexMatch(GuiComponent guiElement, String pattern) Retrieves the text of a runtime element and verifies the text against the given oracle.
void	verifyImage(GuiComponent guiElement, String s)
void	verifyObjectExistence(GuiComponent guiElement) Verifies that a GUI element exists.
void	verifyObjectExistenceWithTimeout(GuiComponent guiElement, int timeoutInSeconds) Verifies object existance, but gives the element time to appear.
void	verifyObjectIsDisplayed(GuiComponent guiElement) Verifies that a GUI element is displayed, and writes the outcome to the test case log.
void	verifyObjectIsNotDisplayed(GuiComponent guiElement) Verifies that a GUI element is not displayed, and writes the outcome to the test case log.
void	verifyText(String actualText, String expectedTest)
void	verifyWindowIsDisplayed(JavaWindow javaWindow)
void	verifyWindowIsDisplayed(JavaWindow javaWindow, int timeoutInSeconds)
void	verifyWindowIsNotDisplayed(JavaWindow window)
void	verifyWindowIsNotDisplayed(JavaWindow window, int timeoutInSecondsForWindowToDisappear)
void	write(GuiComponent guiComponent, String textToWrite) Writes the given text to the given component.
void	writeWithoutCheck(GuiComponent guiComponent, String textToWrite) Writes the given text to the given component.

Methods inherited from class java.lang.Object

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

Field Detail

testCase

public TestCase testCase

standardTimeout

public int standardTimeout

Constructor Detail

GenericInteractionMethods

public GenericInteractionMethods(TestCase testCase)

Constructor to enable interaction with Java GUIs

Parameters:

testCase - The test case to log interactions to

Method Detail

setApplicationUnderTest

public void setApplicationUnderTest(ApplicationUnderTest app)

getParentComponent

public Object getParentComponent(Object component)

Returns the parent element if that can be identified.

Parameters:

component - The component to find the parent of.

Returns:

Returns the parent

getContainerComponent

public Object getContainerComponent(Object component)

Returns the first parent that has the ability to hold child objects.

Parameters:

component - Component to find the container for

Returns:

Returns the inclosing parent container

allSubElementsOf

public ArrayList<Object> allSubElementsOf(Object component)

Retrieves all sub-elements (recursively) of the object provided.

Parameters:

component - The component to identify sub-elements of

Returns:

Returns a list of the sub-elements of the provided element

debug_LogCurrentActiveWindows

public void debug_LogCurrentActiveWindows()

Writes currently active window to the test case log

getName

public String getName(Object component)

Returns the name of a component, as specified by the programmer when creating the GUI. Some elements do not get names.

Parameters:

component - The component to find the name of.

Returns:

Returns the given name the application programmer gave it when creating the GUI.

takeScreenshot

public static void takeScreenshot(TestCase testCase)

takeScreenshot

public void takeScreenshot()

Saves a screenshot of all screens and writes its save path to the test case log.

getSelected

public List<String> getSelected(GuiComponent guiComponent)

getText

public String getText(Object component)

Returns the current text of a GUI component.

Parameters:

component - The component to find text in.

Returns:

The current text at runtime for the GUI component.

bringWindowOfElementToFront

public void bringWindowOfElementToFront(GuiComponent component)

click

public void click(GuiComponent guiElement)

clickByRawMouseAction

public void clickByRawMouseAction(GuiComponent guiElement)

Performs a left mouse button click upon the given element.

Parameters:

guiElement - The element to click.

clickElementWithText

public void clickElementWithText(JavaWindow window,
                                 String textOfElementToClick)

Finds the element with the specified text and click on it. First attempt is exact match, then partial match, last regular expression pattern match is tried.

Parameters:

window - The JavaWindow to search for the element in.

textOfElementToClick - The text to find (exact match, partial match, or regular expression pattern)

clickElementWithText

public void clickElementWithText(GuiComponent parentElement,
                                 String textOfElementToClick)

Finds the element with the specified text and click on it. First attempt is exact match, then partial match, last regular expression pattern match is tried.

Parameters:

parentElement - The object where to look for sub-elements with the specified text.

textOfElementToClick - The text to find (exact match, partial match, or regular expression pattern)

wait

public void wait(int milliseconds)

Pauses execution the stated time.

Parameters:

milliseconds - Number of milliseconds to pause

write

public void write(GuiComponent guiComponent,
                  String textToWrite)

Writes the given text to the given component. Checks afterwards that the entered characters are in the object, and that they appear in the same order as written. This procedure is because some elements reformat input texts.

Parameters:

guiComponent - Element to write to.

textToWrite - Text to write.

writeWithoutCheck

public void writeWithoutCheck(GuiComponent guiComponent,
                              String textToWrite)

Writes the given text to the given component.

Parameters:

guiComponent - Element to write to.

textToWrite - Text to write.

chooseRadioButton

public void chooseRadioButton(GuiComponent guiElement,
                              String textOfElementToChoose)

When implemented, this method will set radio button status.

Parameters:

guiElement - The radio button element to interact with

textOfElementToChoose - The text of the option to choose. First attempt is exact match, then partial match, then regular expression pattern

selectInDropdown

public void selectInDropdown(GuiComponent guiElement,
                             String selection)

Selects a value in a dropdown. First an exact match is attempted. If the exact match fails a search for an option containing the given selection is attempted to be found. If that attempt fails too a regular expression pattern search is attempted.

Parameters:

guiElement - The dropdown element (ComboBox) to select a value in

selection - The selection expected to be able to make.

getDropDownSelectedOption

public String getDropDownSelectedOption(GuiComponent guiComponent)

Returns the currently selected value of a dropdown

Parameters:

guiComponent - The dropdown

Returns:

The selection

getDropDownSelectedOptions

public List<String> getDropDownSelectedOptions(GuiComponent guiElement)

Returns a list of the selected options of a dropdown

Parameters:

guiElement - The dropdown

Returns:

List of selected strings

verifyElementTextIsExactly

public void verifyElementTextIsExactly(GuiComponent guiElement,
                                       String expectedText)

Retrieves the text of a runtime element and verifies the text against the given oracle. This verification requires an exact string match to pass.

Parameters:

guiElement - The GUI element to grep the text of

expectedText - The oracle text to verify against

verifyElementTextContains

public void verifyElementTextContains(GuiComponent guiElement,
                                      String expectedText)

Retrieves the text of a runtime element and verifies the text against the given oracle. This verification will pass of the expected oracle text is found within the text of the runtime GUI element.

Parameters:

guiElement - The GUI element to grep the text of

expectedText - The oracle text to verify against

verifyElementTextIsRegexMatch

public void verifyElementTextIsRegexMatch(GuiComponent guiElement,
                                          String pattern)

Retrieves the text of a runtime element and verifies the text against the given oracle. This verification passes if the actual text in the runtime component passes a regular expresseion matching with the given pattern string.

Parameters:

guiElement - The GUI element to grep the text of

pattern - The regular expression pattern to verify against

getText

public String getText(GuiComponent guiElement)

getText

public String getText(GuiComponent guiElement,
                      int timeoutInMilliseconds)

Returns the runtime text of the element.

Parameters:

guiElement - The element to get the text of.

timeoutInMilliseconds - The timeout to wait for the element to appear

Returns:

Returns the current text of the runtime element.

exists

public boolean exists(GuiComponent guiElement)

Checks if an element exists in the GUI. Make note that an element might exist, but not be displayed.

Parameters:

guiElement - The GUI element to verify existance of.

Returns:

Returns true if the element exist, regardless if it is displayed or not.

existsWithTimeout

public boolean existsWithTimeout(GuiComponent guiElement,
                                 int timeoutInSeconds)

Checks if a component exist, but actually gives it time to appear in the GUI.

Parameters:

guiElement - Element to check existance of.

timeoutInSeconds - Timeout to wait.

Returns:

Returns true if found.

doesNotExist

public boolean doesNotExist(GuiComponent guiElement)

Checks if an element does not exist at runtime.

Parameters:

guiElement - Element to check for

Returns:

Returns false if element is identified.

doesNotExistWithTimeout

public boolean doesNotExistWithTimeout(GuiComponent guiElement,
                                       int timeoutInSeconds)

Checks if an element exist, but gives the element time to disappear for a timeout.

Parameters:

guiElement - The element to verify does not exist

timeoutInSeconds - The time to wait for the element to disappear, if needed

Returns:

Returns true if the element does not exist, or disappear within the stated timeout. If the element still exist after the timeout it returns false.

isDisplayedWithinTimeout

public boolean isDisplayedWithinTimeout(GuiComponent guiElement,
                                        int timeoutInSeconds)

Checks if the element gets displayed within the timeout.

Parameters:

guiElement - The element to check.

timeoutInSeconds - The number of seconds to wait for the element to get displayed.

Returns:

Returns true if the element gets displayed within the given timeout period, othervise fale.

isDisplayed

public boolean isDisplayed(GuiComponent guiElement)

Checks if the element is currently displayed (no timeout, no waiting), meaning that it exists, and is set as visible in the GUI.

Parameters:

guiElement - The element to check.

Returns:

Returns true if element is identified, it exists, and it is visible.

isNotDisplayed

public boolean isNotDisplayed(GuiComponent guiElement)

Checks if the element is currently not displayed (no timeout, no waiting), meaning that it does not exists, or it is set as non-visible in the GUI.

Parameters:

guiElement - The element to check.

Returns:

Returns false if element is identified, it exists, and it is visible.

isNotDisplayedWithTimeout

public boolean isNotDisplayedWithTimeout(GuiComponent guiComponent,
                                         int timeoutInSeconds)

Checks if the element get displayed within the timeout.

Parameters:

guiComponent - The element to check

timeoutInSeconds - The timout to wait for the element to get displayed

Returns:

Returns true if the element is identified, and is visible during the timeout

verifyObjectIsDisplayed

public void verifyObjectIsDisplayed(GuiComponent guiElement)

Verifies that a GUI element is displayed, and writes the outcome to the test case log.

Parameters:

guiElement - The GUI element to check if it is displayed

verifyObjectIsNotDisplayed

public void verifyObjectIsNotDisplayed(GuiComponent guiElement)

Verifies that a GUI element is not displayed, and writes the outcome to the test case log.

Parameters:

guiElement - The GUI element to check if it is displayed.

verifyObjectExistence

public void verifyObjectExistence(GuiComponent guiElement)

Verifies that a GUI element exists. An element can exist but not be displayed. Use verifyObjectIsDisplayed() if you want to make sure the element is visible.

Parameters:

guiElement - The GUI element to check existance of.

verifyObjectExistenceWithTimeout

public void verifyObjectExistenceWithTimeout(GuiComponent guiElement,
                                             int timeoutInSeconds)

Verifies object existance, but gives the element time to appear. Writes results to log. An element can exist but set to not be visible. Other methods check if elements are displayed.

Parameters:

guiElement - The GUI element to check for.

timeoutInSeconds - The timeout to wait for the element to become present.

setCheckboxToChecked

public void setCheckboxToChecked(GuiComponent component)

Sets a checkbox to be checked (=true).

Parameters:

component - The checkbox element

setCheckboxToUnChecked

public void setCheckboxToUnChecked(GuiComponent component)

Sets a checkbox to be un-checked (=false).

Parameters:

component - The checkbox element

setCheckboxToState

public void setCheckboxToState(GuiComponent component,
                               boolean expectedEndState)

Sets a checkbox element to selected state.

Parameters:

component - The checkbox element

expectedEndState - The expected state to set the element to (checked = true, un-checked=false).

setCheckboxToState

public void setCheckboxToState(GuiComponent component,
                               boolean expectedEndState,
                               int timeoutInSeconds)

Tries to set a checkbox element to selected state for a certain number of seconds to enable elements to appear or to get enabled.

Parameters:

component - The checkbox element

expectedEndState - The expected state to set the element to (checked = true, un-checked=false).

timeoutInSeconds - The time, in seconds to wait for successful checkbox interaction

checkboxIsChecked

public boolean checkboxIsChecked(GuiComponent component,
                                 int timeoutInSeconds)

Returns the current status of a checkbox.

Parameters:

component - The checkbox element

timeoutInSeconds - The number of seconds to wait for the checkbox appearance

Returns:

Returns true if the checkbox is checked, and false if the checbox is checked or if the checkbox is not found.

verifyCheckboxStatus

public void verifyCheckboxStatus(GuiComponent component,
                                 boolean expectedStatus,
                                 int timeoutInSeconds)

Verifies the status of a checkbox element.

Parameters:

component - The checkbox element

expectedStatus - True if the expectation is that the checkbox should be checked, othervise false.

timeoutInSeconds - The timeout to wait for the checkbox element to appear and get the expected status.

verifyCheckboxStatus

public void verifyCheckboxStatus(GuiComponent component,
                                 boolean expectedStatus)

Verifies the status of a checkbox element.

Parameters:

component - The checkbox element

expectedStatus - True if the expectation is that the checkbox should be checked, othervise false.

verifyCheckboxIsChecked

public void verifyCheckboxIsChecked(GuiComponent component)

Verifies that a checkbox element is checked.

Parameters:

component - The checkbox element

verifyCheckboxIsUnChecked

public void verifyCheckboxIsUnChecked(GuiComponent component)

Verifies that a checkbox element is un-checked.

Parameters:

component - The checkbox element

verifyImage

public void verifyImage(GuiComponent guiElement,
                        String s)

type

public void type(String text)

tabToNext

public void tabToNext()

type

public void type(int javaAwtEventKeyEvent)

type

public void type(GuiComponent guiComponent,
                 int javaAwtEventKeyEvent)

type

public void type(GuiComponent guiComponent,
                 String text)

verifyWindowIsDisplayed

public void verifyWindowIsDisplayed(JavaWindow javaWindow)

verifyWindowIsDisplayed

public void verifyWindowIsDisplayed(JavaWindow javaWindow,
                                    int timeoutInSeconds)

verifyElementDoesNotExist

public void verifyElementDoesNotExist(GuiComponent guiComponent)

verifyText

public void verifyText(String actualText,
                       String expectedTest)

verifyWindowIsNotDisplayed

public void verifyWindowIsNotDisplayed(JavaWindow window)

verifyWindowIsNotDisplayed

public void verifyWindowIsNotDisplayed(JavaWindow window,
                                       int timeoutInSecondsForWindowToDisappear)

closeAllWindows

public void closeAllWindows()

setSelected

public void setSelected(GuiComponent guiComponent,
                        String... strings)

haltFurtherExecution

public void haltFurtherExecution()

verifyCheckboxSelectionStatus

public void verifyCheckboxSelectionStatus(JavaGuiElement guiElement,
                                          boolean expectedToBeSelected)

closeWindow

public void closeWindow(JavaWindow window)

activateTab

public void activateTab(JavaWindow window,
                        String tabText)

trackMousePosition

public void trackMousePosition(int timeoutInSeconds)

hover

public void hover(GuiComponent guiElement)

Moves the mouse to the given element. Does not work with DPI scaling.

Parameters:

guiElement - The element to hover.

verifyElementIsEnabled

public void verifyElementIsEnabled(GuiComponent guiComponent)

verifyElementIsDisabled

public void verifyElementIsDisabled(GuiComponent guiComponent)