com.github.noraui.application.steps

Class RESTSteps

java.lang.Object

com.github.noraui.application.steps.Step

com.github.noraui.application.steps.RESTSteps

All Implemented Interfaces:

IStep

public class RESTSteps
extends Step

This class contains API REST callable steps.

Field Summary

Fields inherited from class com.github.noraui.application.steps.Step

cryptoService, cucumberExpressionService, SECURE_MASK, userNameService

Constructor Summary

Constructors

Constructor and Description
RESTSteps()

Method Summary

Modifier and Type	Method and Description
void	saveValue(String method, String pageKey, String uri, String targetKey, List<GherkinStepCondition> conditions) Save result of REST API in memory if all 'expected' parameters equals 'actual' parameters in conditions.
void	saveValueInDataOutputProvider(String method, String pageKey, String uri, String targetColumn, List<GherkinStepCondition> conditions) Save result of REST API in dataOutputProvider if all 'expected' parameters equals 'actual' parameters in conditions.

Methods inherited from class com.github.noraui.application.steps.Step

checkAlert, checkElementPresence, checkElementVisible, checkInputText, checkInputText, checkMandatoryTextField, checkRadioList, checkRadioList, checkStep, checkText, checkTextContains, checkTextSelectedInList, clearText, clearText, clearText, clearText, clickOn, clickOn, clickOnByJs, clickOnByJs, clickOnByJs, clickOnByJs, displayConcernedElementsAtTheBeginningOfMethod, displayMessageAtTheBeginningOfMethod, displayMessageAtTheBeginningOfMethod, expectText, expectText, expectTextContains, expectTextContains, getAlertMessage, getDriver, getTextOrKey, passOver, readValueTextField, runAllStepsInLoop, saveElementValue, saveElementValue, selectCheckbox, selectCheckbox, setText, setText, setText, switchFrame, updateDateValidated, updateList, updateRadioList, updateRadioList, updateText, updateText, updateText, updateText, uploadFile

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTSteps

public RESTSteps()

Method Detail

saveValue

@Et(value="Je sauvegarde la valeur de cette API REST {string} {string} {string} dans {string} du contexte(\\?)")
 @And(value="I save the value of REST API {string} {string} {string} in {string} context key(\\?)")
public void saveValue(String method,
                                                                                                                                                                                                                                           String pageKey,
                                                                                                                                                                                                                                           String uri,
                                                                                                                                                                                                                                           String targetKey,
                                                                                                                                                                                                                                           List<GherkinStepCondition> conditions)
                                                                                                                                                                                                                                    throws TechnicalException,
                                                                                                                                                                                                                                           FailureException

Save result of REST API in memory if all 'expected' parameters equals 'actual' parameters in conditions.

Parameters:

method - GET or POST

pageKey - is the key of page (example: GOOGLE_HOME)

uri - end of the url

targetKey - Target key to save retrieved value.

conditions - List of 'expected' values condition and 'actual' values (GherkinStepCondition).

Throws:

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

FailureException - if the scenario encounters a functional error

saveValueInDataOutputProvider

@Et(value="Je sauvegarde la valeur de cette API REST {string} {string} {string} dans {string} du fournisseur de donn\u00e9es en sortie(\\?)")
 @And(value="I save the value of REST API {string} {string} {string} in {string} column of data output provider(\\?)")
public void saveValueInDataOutputProvider(String method,
                                                                                                                                                                                                                                                                                                               String pageKey,
                                                                                                                                                                                                                                                                                                               String uri,
                                                                                                                                                                                                                                                                                                               String targetColumn,
                                                                                                                                                                                                                                                                                                               List<GherkinStepCondition> conditions)
                                                                                                                                                                                                                                                                                                        throws TechnicalException,
                                                                                                                                                                                                                                                                                                               FailureException,
                                                                                                                                                                                                                                                                                                               WarningException

Save result of REST API in dataOutputProvider if all 'expected' parameters equals 'actual' parameters in conditions.

Parameters:

method - GET or POST

pageKey - is the key of page (example: GOOGLE_HOME)

uri - end of the url

targetColumn - Target column (in data output provider) to save retrieved value.

conditions - List of 'expected' values condition and 'actual' values (GherkinStepCondition).

Throws:

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

FailureException - if the scenario encounters a functional error

WarningException - if the scenario encounters a functional warning (with message and screenshot)