com.github.noraui.application.steps

Class Step

java.lang.Object

com.github.noraui.application.steps.Step

All Implemented Interfaces:

IStep

Direct Known Subclasses:

CommonSteps, ContextSteps, ExpectSteps, FileSteps, MailSteps, MathsSteps, RESTSteps, ScreenSteps, TimeSteps, WaitSteps

public abstract class Step
extends Object
implements IStep

Field Summary

Fields

Modifier and Type	Field and Description
protected CryptoService	cryptoService
protected CucumberExpressionService	cucumberExpressionService
protected static String	SECURE_MASK
protected UserNameService	userNameService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Step()

Method Summary

Modifier and Type	Method and Description
protected void	checkAlert(Page page) Checks that a given page displays a html alert.
protected void	checkElementPresence(Page.PageElement pageElement, boolean present, Object... args) Checks if an html element (PageElement) is displayed.
protected void	checkElementVisible(Page.PageElement pageElement, boolean displayed, Object... args) Checks if an html element (PageElement) is displayed.
protected boolean	checkInputText(int timeOutInSeconds, Page.PageElement pageElement, String textOrKey, Object... args) Checks if input text contains expected value.
protected boolean	checkInputText(Page.PageElement pageElement, String textOrKey, Object... args) Checks if input text contains expected value.
protected boolean	checkMandatoryTextField(Page.PageElement pageElement, Object... args) Checks mandatory text field.
protected boolean	checkRadioList(Page.PageElement pageElement, String valueKeyOrKey, Map<String,String> printedValues, Object... args) Checks that given value is matching the selected radio list button by value (value corresponding to key "index").
protected boolean	checkRadioList(Page.PageElement pageElement, String valueOrKey, Object... args) Checks that given value is matching the selected radio list button.
void	checkStep(IPage page) checkStep call checkPage
protected void	checkText(Page.PageElement pageElement, String textOrKey, Object... args) Checks if HTML text equals expected value.
protected void	checkTextContains(Page.PageElement pageElement, String textOrKey, Object... args) Checks if HTML text contains expected value.
protected boolean	checkTextSelectedInList(Page.PageElement pageElement, String text, Object... args) Check text selected in list (html select option).
protected void	clearText(int timeOutInSeconds, Page.PageElement pageElement, CharSequence keysToSend, Object... args) Update a html input text with "".
protected void	clearText(int timeOutInSeconds, Page.PageElement pageElement, Object... args) Update a html input text with "".
protected void	clearText(Page.PageElement pageElement, CharSequence keysToSend, Object... args) Update a html input text with "".
protected void	clearText(Page.PageElement pageElement, Object... args) Update a html input text with "".
protected void	clickOn(int timeOutInSeconds, Page.PageElement toClick, Object... args) Click on html element.
protected void	clickOn(Page.PageElement toClick, Object... args) Click on html element.
protected void	clickOnByJs(int timeOutInSeconds, Page.PageElement toClick, Object... args) Click on html element by Javascript.
protected void	clickOnByJs(int timeOutInSeconds, Page page, String xpath) Click on html element by Javascript.
protected void	clickOnByJs(Page.PageElement toClick, Object... args) Click on html element by Javascript.
protected void	clickOnByJs(Page page, String xpath) Click on html element by Javascript.
protected void	displayConcernedElementsAtTheBeginningOfMethod(String methodName, List<String> concernedElements) Display message (list of elements) at the beginning of method in logs.
protected void	displayMessageAtTheBeginningOfMethod(String methodName, String act, List<String> concernedActivities) Display message (list of authorized activities) at the beginning of method in logs.
protected void	displayMessageAtTheBeginningOfMethod(String methodName, String act, String concernedActivity, List<String> concernedActivities) Displays message (concerned activity and list of authorized activities) at the beginning of method in logs.
protected void	expectText(int timeOutInSeconds, Page.PageElement pageElement, String textOrKey, Object... args) Expects that an element equals expected value.
protected void	expectText(Page.PageElement pageElement, String textOrKey, Object... args) Expects that an element equals expected value.
protected void	expectTextContains(int timeOutInSeconds, Page.PageElement pageElement, String textOrKey, Object... args) Expects that an element contains expected value.
protected void	expectTextContains(Page.PageElement pageElement, String textOrKey, Object... args) Expects that an element contains expected value.
protected String	getAlertMessage()
org.openqa.selenium.WebDriver	getDriver() Quick getter to the global web driver
protected String	getTextOrKey(String textOrKey)
protected void	passOver(Page.PageElement element, Object... args) Passes over a specific page element triggering 'mouseover' js event.
protected String	readValueTextField(Page.PageElement pageElement, Object... args) Read Value Text Field.
protected void	runAllStepsInLoop(List<GherkinConditionedLoopedStep> loopedSteps) Runs a bunch of steps for a Gherkin loop.
protected void	saveElementValue(Page.PageElement pageElement, Object... args) Save value in memory using default target key (Page key + field).
protected void	saveElementValue(Page.PageElement pageElement, String targetKey, Object... args) Save value in memory.
protected void	selectCheckbox(Page.PageElement element, boolean checked, Object... args) Checks a checkbox type element.
protected void	selectCheckbox(Page.PageElement element, String valueKeyOrKey, Map<String,Boolean> values, Object... args) Checks a checkbox type element (value corresponding to key "valueKey").
protected void	setText(int timeOutInSeconds, Page.PageElement pageElement, String textOrKey, CharSequence keysToSend, Object... args) Set a html input text with a text.
protected void	setText(Page.PageElement pageElement, String textOrKey, CharSequence keysToSend, Object... args) Set a html input text with a text.
protected void	setText(Page.PageElement pageElement, String textOrKey, Object... args) Set a html input text with a text.
protected void	switchFrame(Page.PageElement element, Object... args) Switches to the given frame.
protected void	updateDateValidated(Page.PageElement pageElement, String dateType, String date, Object... args) Update a html input text value with a date.
protected void	updateList(Page.PageElement pageElement, String textOrKey, Object... args) Update a html select with a text value.
protected void	updateRadioList(Page.PageElement pageElement, String valueKeyOrKey, Map<String,String> printedValues, Object... args) Update html radio button by value (value corresponding to key "index").
protected void	updateRadioList(Page.PageElement pageElement, String valueOrKey, Object... args) Update html radio button by text "input".
protected void	updateText(int timeOutInSeconds, Page.PageElement pageElement, String textOrKey, CharSequence keysToSend, Object... args) Update a html input text with a text.
protected void	updateText(int timeOutInSeconds, Page.PageElement pageElement, String textOrKey, Object... args) Update a html input text with a text.
protected void	updateText(Page.PageElement pageElement, String textOrKey, CharSequence keysToSend, Object... args) Update a html input text with a text.
protected void	updateText(Page.PageElement pageElement, String textOrKey, Object... args) Update a html input text with a text.
protected void	uploadFile(Page.PageElement pageElement, String fileOrKey, Object... args) Updates a html file input with the path of the file to upload.

Methods inherited from class java.lang.Object

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

Field Detail

SECURE_MASK

protected static final String SECURE_MASK

See Also:

Constant Field Values

userNameService

@Inject
protected UserNameService userNameService

cryptoService

@Inject
protected CryptoService cryptoService

cucumberExpressionService

@Inject
protected CucumberExpressionService cucumberExpressionService

Constructor Detail

Step

protected Step()

Method Detail

checkStep

public void checkStep(IPage page)

checkStep call checkPage

Specified by:

checkStep in interface IStep

Parameters:

page - is the target page

getDriver

public org.openqa.selenium.WebDriver getDriver()

Quick getter to the global web driver

Specified by:

getDriver in interface IStep

Returns:

The global instance of web driver

clickOn

protected void clickOn(Page.PageElement toClick,
                       Object... args)
                throws TechnicalException,
                       FailureException

Click on html element.

Parameters:

toClick - html element.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_OPEN_ON_CLICK" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error

clickOn

protected void clickOn(int timeOutInSeconds,
                       Page.PageElement toClick,
                       Object... args)
                throws TechnicalException,
                       FailureException

Click on html element.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

toClick - html element.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_OPEN_ON_CLICK" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error

clickOnByJs

protected void clickOnByJs(Page.PageElement toClick,
                           Object... args)
                    throws TechnicalException,
                           FailureException

Click on html element by Javascript.

Parameters:

toClick - html element.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_OPEN_ON_CLICK" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error

clickOnByJs

protected void clickOnByJs(int timeOutInSeconds,
                           Page.PageElement toClick,
                           Object... args)
                    throws TechnicalException,
                           FailureException

Click on html element by Javascript.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

toClick - html element.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_OPEN_ON_CLICK" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error

clickOnByJs

protected void clickOnByJs(Page page,
                           String xpath)
                    throws TechnicalException,
                           FailureException

Click on html element by Javascript.

Parameters:

page - page target application.

xpath - XPath of an element to evaluate.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_OPEN_ON_CLICK" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error

clickOnByJs

protected void clickOnByJs(int timeOutInSeconds,
                           Page page,
                           String xpath)
                    throws TechnicalException,
                           FailureException

Click on html element by Javascript.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

page - page target application.

xpath - XPath of an element to evaluate.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_OPEN_ON_CLICK" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error

updateText

protected void updateText(Page.PageElement pageElement,
                          String textOrKey,
                          Object... args)
                   throws TechnicalException,
                          FailureException

Update a html input text with a text.

Parameters:

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

updateText

protected void updateText(int timeOutInSeconds,
                          Page.PageElement pageElement,
                          String textOrKey,
                          Object... args)
                   throws TechnicalException,
                          FailureException

Update a html input text with a text.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

setText

protected void setText(Page.PageElement pageElement,
                       String textOrKey,
                       Object... args)
                throws TechnicalException,
                       FailureException

Set a html input text with a text.

Parameters:

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

updateText

protected void updateText(Page.PageElement pageElement,
                          String textOrKey,
                          CharSequence keysToSend,
                          Object... args)
                   throws TechnicalException,
                          FailureException

Update a html input text with a text.

Parameters:

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

keysToSend - character to send to the element after sendKeys with textOrKey.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

updateText

protected void updateText(int timeOutInSeconds,
                          Page.PageElement pageElement,
                          String textOrKey,
                          CharSequence keysToSend,
                          Object... args)
                   throws TechnicalException,
                          FailureException

Update a html input text with a text.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

keysToSend - character to send to the element after sendKeys with textOrKey.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

setText

protected void setText(Page.PageElement pageElement,
                       String textOrKey,
                       CharSequence keysToSend,
                       Object... args)
                throws TechnicalException,
                       FailureException

Set a html input text with a text.

Parameters:

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

keysToSend - character to send to the element after sendKeys with textOrKey.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

setText

protected void setText(int timeOutInSeconds,
                       Page.PageElement pageElement,
                       String textOrKey,
                       CharSequence keysToSend,
                       Object... args)
                throws TechnicalException,
                       FailureException

Set a html input text with a text.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

keysToSend - character to send to the element after sendKeys with textOrKey.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

clearText

protected void clearText(Page.PageElement pageElement,
                         Object... args)
                  throws TechnicalException,
                         FailureException

Update a html input text with "".

Parameters:

pageElement - Is target element.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_CLEAR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

clearText

protected void clearText(int timeOutInSeconds,
                         Page.PageElement pageElement,
                         Object... args)
                  throws TechnicalException,
                         FailureException

Update a html input text with "".

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

pageElement - Is target element.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_CLEAR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

clearText

protected void clearText(Page.PageElement pageElement,
                         CharSequence keysToSend,
                         Object... args)
                  throws TechnicalException,
                         FailureException

Update a html input text with "".

Parameters:

pageElement - Is target element.

keysToSend - character to send to the element after sendKeys with textOrKey.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_CLEAR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

clearText

protected void clearText(int timeOutInSeconds,
                         Page.PageElement pageElement,
                         CharSequence keysToSend,
                         Object... args)
                  throws TechnicalException,
                         FailureException

Update a html input text with "".

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

pageElement - Is target element.

keysToSend - character to send to the element after sendKeys with textOrKey.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_CLEAR_ON_INPUT" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error

checkInputText

protected boolean checkInputText(Page.PageElement pageElement,
                                 String textOrKey,
                                 Object... args)
                          throws FailureException,
                                 TechnicalException

Checks if input text contains expected value.

Parameters:

pageElement - Is target element.

textOrKey - Is the data to check (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Returns:

true or false

Throws:

FailureException - if the scenario encounters a functional error

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, no exception)

checkInputText

protected boolean checkInputText(int timeOutInSeconds,
                                 Page.PageElement pageElement,
                                 String textOrKey,
                                 Object... args)
                          throws FailureException,
                                 TechnicalException

Checks if input text contains expected value.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

pageElement - Is target element.

textOrKey - Is the data to check (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Returns:

true or false

Throws:

FailureException - if the scenario encounters a functional error

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, no exception)

expectText

protected void expectText(Page.PageElement pageElement,
                          String textOrKey,
                          Object... args)
                   throws FailureException,
                          TechnicalException

Expects that an element equals expected value.

Parameters:

pageElement - Is target element.

textOrKey - Is the expected data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

FailureException - if the scenario encounters a functional error.

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, no exception) or with "FAIL_MESSAGE_WRONG_EXPECTED_VALUE" message (with screenshot, with exception)

expectTextContains

protected void expectTextContains(Page.PageElement pageElement,
                                  String textOrKey,
                                  Object... args)
                           throws FailureException,
                                  TechnicalException

Expects that an element contains expected value.

Parameters:

pageElement - Is target element.

textOrKey - Is the expected data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

FailureException - if the scenario encounters a functional error.

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, no exception) or with "FAIL_MESSAGE_WRONG_EXPECTED_VALUE" message (with screenshot, with exception)

expectText

protected void expectText(int timeOutInSeconds,
                          Page.PageElement pageElement,
                          String textOrKey,
                          Object... args)
                   throws FailureException,
                          TechnicalException

Expects that an element equals expected value.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

pageElement - Is target element.

textOrKey - Is the expected data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

FailureException - if the scenario encounters a functional error.

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, no exception) or with "FAIL_MESSAGE_WRONG_EXPECTED_VALUE" message (with screenshot, with exception)

expectTextContains

protected void expectTextContains(int timeOutInSeconds,
                                  Page.PageElement pageElement,
                                  String textOrKey,
                                  Object... args)
                           throws FailureException,
                                  TechnicalException

Expects that an element contains expected value.

Parameters:

timeOutInSeconds - The timeout in seconds when an expectation is called.

pageElement - Is target element.

textOrKey - Is the expected data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

FailureException - if the scenario encounters a functional error.

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, no exception) or with "FAIL_MESSAGE_WRONG_EXPECTED_VALUE" message (with screenshot, with exception)

checkMandatoryTextField

protected boolean checkMandatoryTextField(Page.PageElement pageElement,
                                          Object... args)
                                   throws FailureException

Checks mandatory text field.

Parameters:

pageElement - Is concerned element.

args - list of arguments to format the found selector with.

Returns:

true or false

Throws:

FailureException - if the scenario encounters a functional error.

readValueTextField

protected String readValueTextField(Page.PageElement pageElement,
                                    Object... args)
                             throws FailureException

Read Value Text Field.

Parameters:

pageElement - Is concerned element.

args - list of arguments to format the found selector with.

Returns:

text.

Throws:

FailureException - if the scenario encounters a functional error.

checkText

protected void checkText(Page.PageElement pageElement,
                         String textOrKey,
                         Object... args)
                  throws TechnicalException,
                         FailureException

Checks if HTML text equals expected value. If your value from Ajax, use "com.github.noraui.application.steps.Step#expectText".

Parameters:

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_WRONG_EXPECTED_VALUE" message (with screenshot, with exception) or with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error.

checkTextContains

protected void checkTextContains(Page.PageElement pageElement,
                                 String textOrKey,
                                 Object... args)
                          throws TechnicalException,
                                 FailureException

Checks if HTML text contains expected value.

Parameters:

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_WRONG_EXPECTED_VALUE" message (with screenshot, with exception) or with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error.

checkElementVisible

protected void checkElementVisible(Page.PageElement pageElement,
                                   boolean displayed,
                                   Object... args)
                            throws FailureException

Checks if an html element (PageElement) is displayed.

Parameters:

pageElement - Is target element.

displayed - Is target element supposed to be displayed.

args - list of arguments to format the found selector with.

Throws:

FailureException - if the scenario encounters a functional error. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, with exception)

checkElementPresence

protected void checkElementPresence(Page.PageElement pageElement,
                                    boolean present,
                                    Object... args)
                             throws FailureException

Checks if an html element (PageElement) is displayed.

Parameters:

pageElement - Is target element.

present - Is target element supposed to be present.

args - list of arguments to format the found selector with.

Throws:

FailureException - if the scenario encounters a functional error. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, with exception)

updateList

protected void updateList(Page.PageElement pageElement,
                          String textOrKey,
                          Object... args)
                   throws TechnicalException,
                          FailureException

Update a html select with a text value.

Parameters:

pageElement - Is target element.

textOrKey - Is the new data (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_ERROR_ON_INPUT" message (with screenshot, no exception) or Exception with "FAIL_MESSAGE_VALUE_NOT_AVAILABLE_IN_THE_LIST" message (no screenshot, no exception)

FailureException - if the scenario encounters a functional error

checkTextSelectedInList

protected boolean checkTextSelectedInList(Page.PageElement pageElement,
                                          String text,
                                          Object... args)
                                   throws FailureException

Check text selected in list (html select option).

Parameters:

pageElement - Is target element.

text - is text searched.

args - list of arguments to format the found selector with.

Returns:

true or false

Throws:

FailureException - if the scenario encounters a functional error.

updateDateValidated

protected void updateDateValidated(Page.PageElement pageElement,
                                   String dateType,
                                   String date,
                                   Object... args)
                            throws TechnicalException,
                                   FailureException

Update a html input text value with a date.

Parameters:

pageElement - Is target element.

dateType - "any", "future", "today", "future_strict".

date - Is the new data (date).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_WRONG_DATE_FORMAT" message (no screenshot, no exception) or with "FAIL_MESSAGE_UNEXPECTED_DATE" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error.

saveElementValue

protected void saveElementValue(Page.PageElement pageElement,
                                Object... args)
                         throws TechnicalException,
                                FailureException

Save value in memory using default target key (Page key + field).

Parameters:

pageElement - The concerned page of field AND name of the field to save in memory. (sample: $demo.DemoPage-button).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, with exception) or with "FAIL_MESSAGE_UNABLE_TO_RETRIEVE_VALUE" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error.

saveElementValue

protected void saveElementValue(Page.PageElement pageElement,
                                String targetKey,
                                Object... args)
                         throws TechnicalException,
                                FailureException

Save value in memory.

Parameters:

pageElement - The concerned page of field AND name of the field to save in memory to targetKey. (sample: demo.DemoPage-name_field in name).

targetKey - is the key to save value to.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_FIND_ELEMENT" message (with screenshot, with exception) or with "FAIL_MESSAGE_UNABLE_TO_RETRIEVE_VALUE" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error.

updateRadioList

protected void updateRadioList(Page.PageElement pageElement,
                               String valueKeyOrKey,
                               Map<String,String> printedValues,
                               Object... args)
                        throws TechnicalException,
                               FailureException

Update html radio button by value (value corresponding to key "index").

Parameters:

pageElement - Is concerned element.

valueKeyOrKey - key printedValues.

printedValues - contain all possible value (order by key).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_SELECT_RADIO_BUTTON" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error.

checkRadioList

protected boolean checkRadioList(Page.PageElement pageElement,
                                 String valueOrKey,
                                 Object... args)
                          throws FailureException

Checks that given value is matching the selected radio list button.

Parameters:

pageElement - The page element.

valueOrKey - (value or value in context (after a save)). The value to check the selection from.

args - list of arguments to format the found selector with.

Returns:

true if the given value is selected, false otherwise.

Throws:

FailureException - if the scenario encounters a functional error.

checkRadioList

protected boolean checkRadioList(Page.PageElement pageElement,
                                 String valueKeyOrKey,
                                 Map<String,String> printedValues,
                                 Object... args)
                          throws TechnicalException,
                                 FailureException

Checks that given value is matching the selected radio list button by value (value corresponding to key "index").

Parameters:

pageElement - Is concerned element.

valueKeyOrKey - key printedValues.

printedValues - contain all possible value (order by key).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_SELECT_RADIO_BUTTON" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error.

Since:

4.2.5

updateRadioList

protected void updateRadioList(Page.PageElement pageElement,
                               String valueOrKey,
                               Object... args)
                        throws TechnicalException,
                               FailureException

Update html radio button by text "input".

Parameters:

pageElement - Is concerned element.

valueOrKey - Is the value (value or value in context (after a save)) use for selection.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Failure with "FAIL_MESSAGE_UNABLE_TO_SELECT_RADIO_BUTTON" message (with screenshot)

FailureException - if the scenario encounters a functional error.

passOver

protected void passOver(Page.PageElement element,
                        Object... args)
                 throws TechnicalException,
                        FailureException

Passes over a specific page element triggering 'mouseover' js event.

Parameters:

element - Target page element.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Failure with "FAIL_MESSAGE_UNABLE_TO_PASS_OVER_ELEMENT" message (with screenshot)

FailureException - if the scenario encounters a functional error.

selectCheckbox

protected void selectCheckbox(Page.PageElement element,
                              boolean checked,
                              Object... args)
                       throws TechnicalException,
                              FailureException

Checks a checkbox type element.

Parameters:

element - Target page element.

checked - Final checkbox value.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Failure with "FAIL_MESSAGE_UNABLE_TO_CHECK_ELEMENT" message (with screenshot)

FailureException - if the scenario encounters a functional error.

selectCheckbox

protected void selectCheckbox(Page.PageElement element,
                              String valueKeyOrKey,
                              Map<String,Boolean> values,
                              Object... args)
                       throws TechnicalException,
                              FailureException

Checks a checkbox type element (value corresponding to key "valueKey").

Parameters:

element - Target page element.

valueKeyOrKey - is valueKey (valueKey or key in context (after a save)) to match in values map

values - Values map.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Failure with "FAIL_MESSAGE_UNABLE_TO_CHECK_ELEMENT" message (with screenshot)

FailureException - if the scenario encounters a functional error.

switchFrame

protected void switchFrame(Page.PageElement element,
                           Object... args)
                    throws FailureException,
                           TechnicalException

Switches to the given frame.

Parameters:

element - The PageElement representing a frame.

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UNABLE_TO_SWITCH_FRAME" message (with screenshot, with exception)

FailureException - if the scenario encounters a functional error.

uploadFile

protected void uploadFile(Page.PageElement pageElement,
                          String fileOrKey,
                          Object... args)
                   throws TechnicalException,
                          FailureException

Updates a html file input with the path of the file to upload.

Parameters:

pageElement - Is target element.

fileOrKey - Is the file path (text or text in context (after a save)).

args - list of arguments to format the found selector with.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi. Exception with "FAIL_MESSAGE_UPLOADING_FILE" message (with screenshot, no exception)

FailureException - if the scenario encounters a functional error.

displayMessageAtTheBeginningOfMethod

protected void displayMessageAtTheBeginningOfMethod(String methodName,
                                                    String act,
                                                    String concernedActivity,
                                                    List<String> concernedActivities)

Displays message (concerned activity and list of authorized activities) at the beginning of method in logs.

Parameters:

methodName - is name of java method.

act - is name of activity.

concernedActivity - is concerned activity.

concernedActivities - is a list of authorized activities.

displayMessageAtTheBeginningOfMethod

protected void displayMessageAtTheBeginningOfMethod(String methodName,
                                                    String act,
                                                    List<String> concernedActivities)

Display message (list of authorized activities) at the beginning of method in logs.

Parameters:

methodName - is name of java method.

act - is name of activity.

concernedActivities - is a list of authorized activities.

displayConcernedElementsAtTheBeginningOfMethod

protected void displayConcernedElementsAtTheBeginningOfMethod(String methodName,
                                                              List<String> concernedElements)

Display message (list of elements) at the beginning of method in logs.

Parameters:

methodName - is name of java method.

concernedElements - is a list of concerned elements (example: authorized activities).

checkAlert

protected void checkAlert(Page page)
                   throws FailureException

Checks that a given page displays a html alert. CAUTION: This check do not work with IE: https://github.com/SeleniumHQ/selenium/issues/468

Parameters:

page - A Page.

Throws:

FailureException - if the scenario encounters a functional error.

runAllStepsInLoop

protected void runAllStepsInLoop(List<GherkinConditionedLoopedStep> loopedSteps)
                          throws TechnicalException

Runs a bunch of steps for a Gherkin loop.

Parameters:

loopedSteps - GherkinConditionedLoopedStep steps to run.

Throws:

TechnicalException - is thrown if you have a technical error (format, configuration, datas, ...) in NoraUi.

getAlertMessage

protected String getAlertMessage()

Returns:

a String with the message of Alert, return null if no alert message.

getTextOrKey

protected String getTextOrKey(String textOrKey)
                       throws TechnicalException

Parameters:

textOrKey - Is the new data (text or text in context (after a save)).

Returns:

a string from context or not (and crypted or not).

Throws:

TechnicalException - is thrown if you have a technical error (decrypt value) in NoraUi.