API Testing Actions

---

postRestRequest

Description: This function is used to perform POST action on a Rest API.

Input Format : @Expected Payload

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	postRestRequest	@Payload (from Editor)			<< Hardcoded Input
Webservice	postRestRequest	Sheet:Column			<< Input from Datasheet
Webservice	postRestRequest	%dynamicVar%			<<Input from variable

Inputs in the Input column can be either hardcoded, passed inside the JSON editor which is capable of parameterising the Payload (Press ctrl+space to see the list of variables available ), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

Corresponding Code:

HttpURLConnection.setDoOutput(true);
HttpURLConnection.setRequestMethod("POST");

try (OutputStreamWriter out = new OutputStreamWriter(httpConnections.get(key).getOutputStream())) {
out.write(data);
out.flush();
out.close();
}

InputStreamReader reader = new InputStreamReader(HttpURLConnection.getInputStream());
StringBuilder buf = new StringBuilder();
char[] cbuf = new char[2048];
int num;
while (-1 != (num = reader.read(cbuf))) {
    buf.append(cbuf, 0, num);
}

---

putRestRequest

Description: This function is used to perform PUT action on a Rest API.

Input Format : @Expected Payload

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	putRestRequest	@Payload (from Editor)			<< Hardcoded Input
Webservice	putRestRequest	Sheet:Column			<< Input from Datasheet
Webservice	putRestRequest	%dynamicVar%			<<Input from variable

Inputs in the Input column can be either hardcoded, passed inside the JSON editor which is capable of parameterising the Payload (Press ctrl+space to see the list of variables available ), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

Corresponding Code:

HttpURLConnection.setDoOutput(true);
HttpURLConnection.setRequestMethod("PUT");

try (OutputStreamWriter out = new OutputStreamWriter(httpConnections.get(key).getOutputStream())) {
out.write(data);
out.flush();
out.close();
}

InputStreamReader reader = new InputStreamReader(HttpURLConnection.getInputStream());
StringBuilder buf = new StringBuilder();
char[] cbuf = new char[2048];
int num;
while (-1 != (num = reader.read(cbuf))) {
    buf.append(cbuf, 0, num);
}

---

postSoapRequest

Description: This function is used to perform POST action on a SOAP API.

Input Format : @Expected Payload

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	postRestRequest	@Payload (from Editor)			<< Hardcoded Input
Webservice	postRestRequest	Sheet:Column			<< Input from Datasheet
Webservice	postRestRequest	%dynamicVar%			<<Input from variable

Inputs in the Input column can be either hardcoded, passed inside the XML editor which is capable of parameterising the Payload (Press ctrl+space to see the list of variables available ), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

Corresponding Code:

HttpURLConnection.setDoOutput(true);
HttpURLConnection.setRequestMethod("POST");

try (OutputStreamWriter out = new OutputStreamWriter(httpConnections.get(key).getOutputStream())) {
out.write(data);
out.flush();
out.close();
}

InputStreamReader reader = new InputStreamReader(HttpURLConnection.getInputStream());
StringBuilder buf = new StringBuilder();
char[] cbuf = new char[2048];
int num;
while (-1 != (num = reader.read(cbuf))) {
    buf.append(cbuf, 0, num);
}

---

getRestRequest

Description: This function is used to perform GET action on a Rest API.

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	getRestRequest

Corresponding Code:

HttpURLConnection.setRequestMethod("GET");

InputStreamReader reader = new InputStreamReader(HttpURLConnection.getInputStream());
StringBuilder buf = new StringBuilder();
char[] cbuf = new char[2048];
int num;
while (-1 != (num = reader.read(cbuf))) {
    buf.append(cbuf, 0, num);
}

---

deleteRestRequest

Description: This function is used to perform DELETE action on a Rest API.

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	deleteRestRequest

Corresponding Code:

HttpURLConnection.setRequestMethod("DELETE");

InputStreamReader reader = new InputStreamReader(HttpURLConnection.getInputStream());
StringBuilder buf = new StringBuilder();
char[] cbuf = new char[2048];
int num;
while (-1 != (num = reader.read(cbuf))) {
    buf.append(cbuf, 0, num);
}

---

assertResponseCode

Description: This function is used to validate the response code of SOAP/REST response.

Input Format : @Expected code

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	assertResponseCode	@value			<< Hardcoded Input
Webservice	assertResponseCode	Sheet:Column			<< Input from Datasheet
Webservice	assertResponseCode	%dynamicVar%			<<Input from variable

Corresponding Code:

responsecodes.put(key, Integer.toString(httpConnections.get(key).getResponseCode()));

/***************************************************/

@Action(object = ObjectType.WEBSERVICE, desc = "Assert Response Code ", input = InputType.YES)
public void assertResponseCode() {
    try {
        if (responsecodes.get(key).equals(Data)) {
            Report.updateTestLog(Action, "Status code is : " + Data, Status.PASSNS);
        } else {
            Report.updateTestLog(Action, "Status code is : " + responsecodes.get(key) + " but should be " + Data,Status.FAILNS);
        }
    } catch (Exception ex) {
        Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
        Report.updateTestLog(Action, "Error in validating response code :" + "\n" + ex.getMessage(), Status.DEBUG);
    }
}

---

assertResponseMessage

Description: This function is used to validate the response message of SOAP/REST response.

Input Format : @Expected message

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	assertResponseMessage	@value			<< Hardcoded Input
Webservice	assertResponseMessage	Sheet:Column			<< Input from Datasheet
Webservice	assertResponseMessage	%dynamicVar%			<<Input from variable

Corresponding Code:

responsemessages.put(key, httpConnections.get(key).getResponseMessage());

/***************************************************/

@Action(object = ObjectType.WEBSERVICE, desc = "Assert Response Message ", input = InputType.YES)
    public void assertResponseMessage() {
        try {
            if (responsemessages.get(key).equals(Data)) {
                Report.updateTestLog(Action, "Response message is : " + Data, Status.PASSNS);
            } else {
                Report.updateTestLog(Action,"Response message is : " + responsemessages.get(key) + " but should be " + Data, Status.FAILNS);
            }
        } catch (Exception ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error in validating response message :" + "\n" + ex.getMessage(),Status.DEBUG);
        }
    }

---

assertResponsebodycontains

Description: This function is used to validate whether the response body of SOAP/REST request contains an expected text or not.

Input Format : @Expected Text

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	assertResponsebodycontains	@value			<< Hardcoded Input
Webservice	assertResponsebodycontains	Sheet:Column			<< Input from Datasheet
Webservice	assertResponsebodycontains	%dynamicVar%			<<Input from variable

Corresponding Code:

responsemessages.put(key, httpConnections.get(key).getResponseMessage());

/***************************************************/

@Action(object = ObjectType.WEBSERVICE, desc = "Assert Response Body contains ", input = InputType.YES)
    public void assertResponsebodycontains() {
        try {
            if (responsebodies.get(key).contains(Data)) {
                Report.updateTestLog(Action, "Response body contains : " + Data, Status.PASSNS);
            } else {
                Report.updateTestLog(Action, "Response body does not contain : " + Data, Status.FAILNS);
            }
        } catch (Exception ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error in validating response body :" + "\n" + ex.getMessage(), Status.DEBUG);
        }
    }

---

assertJSONelementEquals

Description: This function is used to validate whether a certain JSON tag of the response body of REST request contains an expected text or not.

Input Format : @Expected Text

Condition Format : JSON Path of the tag

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	assertJSONelementEquals	@value	JSONPath		<< Hardcoded Input
Webservice	assertJSONelementEquals	Sheet:Column	JSONPath		<< Input from Datasheet
Webservice	assertJSONelementEquals	%dynamicVar%	JSONPath		<<Input from variable

Corresponding Code:

@Action(object = ObjectType.WEBSERVICE, desc = "Assert JSON Element Equals ", input = InputType.YES, condition = InputType.YES)
    public void assertJSONelementEquals() {
        try {
            String response = responsebodies.get(key);
            String jsonpath = Condition;
            String value = JsonPath.read(response, jsonpath).toString();
            if (value.equals(Data)) {
                Report.updateTestLog(Action, "Element text [" + value + "] is as expected", Status.PASSNS);
            } else {
                Report.updateTestLog(Action, "Element text is [" + value + "] but is expected to be [" + Data + "]",Status.FAILNS);
            }
        } catch (Exception ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error in validating JSON element :" + "\n" + ex.getMessage(), Status.DEBUG);
        }
    }

---

assertXMLelementEquals

Description: This function is used to validate whether a certain XML tag of the response body of SOAP request contains an expected text or not.

Input Format : @Expected Text

Condition Format: XPath of the tag

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	assertXMLelementEquals	@value	XPath		<< Hardcoded Input
Webservice	assertXMLelementEquals	Sheet:Column	XPath		<< Input from Datasheet
Webservice	assertXMLelementEquals	%dynamicVar%	XPath		<<Input from variable

Corresponding Code:

@Action(object = ObjectType.WEBSERVICE, desc = "Assert XML Element Equals ", input = InputType.YES, condition = InputType.YES)
    public void assertXMLelementEquals() {

        try {
            DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
            DocumentBuilder dBuilder;
            InputSource inputSource = new InputSource();
            inputSource.setCharacterStream(new StringReader(responsebodies.get(key)));
            dBuilder = dbFactory.newDocumentBuilder();
            Document doc = dBuilder.parse(inputSource);
            doc.getDocumentElement().normalize();
            XPath xPath = XPathFactory.newInstance().newXPath();
            String expression = Condition;
            NodeList nodeList = (NodeList) xPath.compile(expression).evaluate(doc, XPathConstants.NODESET);
            Node nNode = nodeList.item(0);
            String value = nNode.getNodeValue();
            if (value.equals(Data)) {
                Report.updateTestLog(Description, "Element text [" + value + "] is as expected", Status.PASSNS);
            } else {
                Report.updateTestLog(Description, "Element text  is [" + value + "] but is expected to be ["+Data+"]", Status.FAILNS);
            }
        } catch (IOException | ParserConfigurationException | XPathExpressionException | DOMException
                | SAXException ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Description, "Error validating XML element :" + "\n" + ex.getMessage(), Status.DEBUG);
        }
    }

---

storeJSONelementInDataSheet

Description: This function is used to store a certain JSON tag value inside the response body of REST request, into a respective column of a given datasheet.

Input Format : @Expected datasheet name:column name

Condition Format: JSONPath of the tag

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	storeJSONelementInDataSheet	Sheet:Column	JSONPath		<< Datasheet to where value is supposed br stored

Note: Ensure that your data sheet doesn't contain column names with spaces.

Corresponding Code:

@Action(object = ObjectType.WEBSERVICE, desc = "Store JSON Element In DataSheet ", input = InputType.YES, condition = InputType.YES)
    public void storeJSONelementInDataSheet() {

        try {
            String strObj = Input;
            if (strObj.matches(".*:.*")) {
                try {
                    System.out.println("Updating value in SubIteration " + userData.getSubIteration());
                    String sheetName = strObj.split(":", 2)[0];
                    String columnName = strObj.split(":", 2)[1];
                    String response = responsebodies.get(key);
                    String jsonpath = Condition;
                    String value = JsonPath.read(response, jsonpath).toString();
                    userData.putData(sheetName, columnName, value);
                    Report.updateTestLog(Action, "Element text [" + value + "] is stored in " + strObj, Status.DONE);
                } catch (Exception ex) {
                    Logger.getLogger(this.getClass().getName()).log(Level.OFF, ex.getMessage(), ex);
                    Report.updateTestLog(Action, "Error Storing JSON element in datasheet :" + "\n" + ex.getMessage(),Status.DEBUG);
                }
            } else {
                Report.updateTestLog(Action,"Given input [" + Input + "] format is invalid. It should be [sheetName:ColumnName",Status.DEBUG);
            }
        } catch (Exception ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error Storing JSON element in datasheet :" + "\n" + ex.getMessage(),Status.DEBUG);
        }
    }

---

storeXMLelementInDataSheet

Description: This function is used to store a certain XML tag value inside the response body of SOAP request, into a respective column of a given datasheet.

Input Format : @Expected datasheet name:column name

Condition Format: XPath of the tag

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	storeXMLelementInDataSheet	Sheet:Column	XPath		<< Datasheet to where value is supposed br stored

Note: Ensure that your data sheet doesn't contain column names with spaces.

Corresponding Code:

@Action(object = ObjectType.WEBSERVICE, desc = "Store XML Element In DataSheet ", input = InputType.YES, condition = InputType.YES)
    public void storeXMLelementInDataSheet() {

        try {
            String strObj = Input;
            if (strObj.matches(".*:.*")) {
                try {
                    String expression = "";
                    System.out.println("Updating value in SubIteration " + userData.getSubIteration());
                    String sheetName = strObj.split(":", 2)[0];
                    String columnName = strObj.split(":", 2)[1];
                    String xmlText = responsebodies.get(key);
                    DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
                    DocumentBuilder dBuilder;
                    InputSource inputSource = new InputSource();
                    inputSource.setCharacterStream(new StringReader(xmlText));
                    dBuilder = dbFactory.newDocumentBuilder();
                    Document doc = dBuilder.parse(inputSource);
                    doc.getDocumentElement().normalize();
                    XPath xPath = XPathFactory.newInstance().newXPath();
                    if (Condition.matches("%.*%"))
                        expression = getVar(Condition);
                    else
                        expression = Condition;
                    NodeList nodeList = (NodeList) xPath.compile(expression).evaluate(doc, XPathConstants.NODESET);
                    Node nNode = nodeList.item(0);
                    String value = nNode.getNodeValue();
                    userData.putData(sheetName, columnName, value);
                    Report.updateTestLog(Action, "Element text [" + value + "] is stored in " + strObj, Status.DONE);
                } catch (IOException | ParserConfigurationException | XPathExpressionException | DOMException| SAXException ex) {
                    Logger.getLogger(this.getClass().getName()).log(Level.OFF, ex.getMessage(), ex);
                    Report.updateTestLog(Action, "Error Storing XML element in datasheet :" + "\n" + ex.getMessage(),Status.DEBUG);
                }
            } else {
                Report.updateTestLog(Action,
                        "Given input [" + Input + "] format is invalid. It should be [sheetName:ColumnName]",Status.DEBUG);
            }
        } catch (Exception ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error Storing XML element in datasheet :" + "\n" + ex.getMessage(),Status.DEBUG);
        }

    }

---

storeJSONelement

Description: This function is used to store a certain JSON tag value from the response body of REST request, into a variable.

Input Format : @JSONPath of the tag

Condition Format: %variable%

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	storeJSONelement	@JSONPath	%var%		<< Hardcoded Input
Webservice	storeJSONelement	Sheet:Column containing JSONPath	%var%		<< Input from Datasheet
Webservice	storeJSONelement	%Var% containing JSONPath	%var%		<<Input from variable

Corresponding Code:

@Action(object = ObjectType.WEBSERVICE, desc = "Store JSON Element", input = InputType.YES, condition = InputType.YES)
    public void storeJSONelement() {
        try {
            String variableName = Condition;
            String jsonpath = Data;
            if (variableName.matches("%.*%")) {
                addVar(variableName, JsonPath.read(responsebodies.get(key), jsonpath).toString());
                Report.updateTestLog(Action, "JSON element value stored", Status.DONE);
            } else {
                Report.updateTestLog(Action, "Variable format is not correct", Status.DEBUG);
            }
        } catch (Exception ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error Storing JSON element :" + "\n" + ex.getMessage(), Status.DEBUG);
        }
    }

---

storeXMLelement

Description: This function is used to store a certain XML tag value inside the response body of SOAP request, into a variable.

Input Format : @XPath of the tag

Condition Format: %variable%

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	storeXMLelement	@XPath	%var%		<< Hardcoded Input
Webservice	storeXMLelement	Sheet:Column containing XPath	%var%		<< Input from Datasheet
Webservice	storeXMLelement	%Var% containing XPath	%var%		<<Input from variable

Corresponding Code:

@Action(object = ObjectType.WEBSERVICE, desc = "Store XML Element", input = InputType.YES, condition = InputType.YES)
    public void storeXMLelement() {
        try {
            String variableName = Condition;
            String expression = Data;
            if (variableName.matches("%.*%")) {
                DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
                DocumentBuilder dBuilder;
                InputSource inputSource = new InputSource();
                inputSource.setCharacterStream(new StringReader(responsebodies.get(key)));
                dBuilder = dbFactory.newDocumentBuilder();
                Document doc = dBuilder.parse(inputSource);
                doc.getDocumentElement().normalize();
                XPath xPath = XPathFactory.newInstance().newXPath();
                NodeList nodeList = (NodeList) xPath.compile(expression).evaluate(doc, XPathConstants.NODESET);
                Node nNode = nodeList.item(0);
                String value = nNode.getNodeValue();
                addVar(variableName, value);
                Report.updateTestLog(Action, "XML element value stored", Status.DONE);
            } else {
                Report.updateTestLog(Action, "Variable format is not correct", Status.DEBUG);
            }
        } catch (IOException | ParserConfigurationException | XPathExpressionException | DOMException
                | SAXException ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error Storing XML element :" + "\n" + ex.getMessage(), Status.DEBUG);
        }
    }

---

storeResponseBodyInDataSheet

Description: This function is used to store the response body of SOAP/REST request, into a respective column of a given datasheet.

Input Format : @Expected DatasheetName:ColumnName

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	storeResponseBodyInDataSheet	Sheet:Column			<< Datasheet to where value is supposed br stored

Note: Ensure that your data sheet doesn't contain column names with spaces.

Corresponding Code:

@Action(object = ObjectType.WEBSERVICE, desc = "Store Response Message In DataSheet ", input = InputType.YES)
    public void storeResponseBodyInDataSheet() {
        try {
            String strObj = Input;
            if (strObj.matches(".*:.*")) {
                try {
                    System.out.println("Updating value in SubIteration " + userData.getSubIteration());
                    String sheetName = strObj.split(":", 2)[0];
                    String columnName = strObj.split(":", 2)[1];
                    userData.putData(sheetName, columnName, responsebodies.get(key));
                    Report.updateTestLog(Action, "Response body is stored in " + strObj, Status.DONE);
                } catch (Exception ex) {
                    Logger.getLogger(this.getClass().getName()).log(Level.OFF, ex.getMessage(), ex);
                    Report.updateTestLog(Action, "Error Storing text in datasheet :" + ex.getMessage(), Status.DEBUG);
                }
            } else {
                Report.updateTestLog(Action,
                        "Given input [" + Input + "] format is invalid. It should be [sheetName:ColumnName]",Status.DEBUG);
            }
        } catch (Exception ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error Storing response body in datasheet :" + "\n" + ex.getMessage(),Status.DEBUG);
        }
    }

---

storeHeaderElementByName

Description: This function is used to store a Header Value of the response of SOAP/REST request, into a variable.

Input Format : @HeaderName

Condition Format : %variable%

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	storeHeaderElementByName	@HeaderName	%var%		<< Hardcoded Input
Webservice	storeHeaderElementByName	Sheet:Column containing HeaderName	%var%		<< Input from Datasheet
Webservice	storeHeaderElementByName	%Var% containing HeaderName	%var%		<<Input from variable

Corresponding Code:

@Action(object = ObjectType.WEBSERVICE, desc = "Store Header Element in Datasheet", input = InputType.YES, condition = InputType.YES)
    public void storeHeaderElementByName() {
        try {
            String variableName = Condition;
            String headerName = Data;
            if (variableName.matches("%.*%")) {
                addVar(variableName, httpConnections.get(key).getHeaderField(headerName));
                Report.updateTestLog(Action, "Header value stored", Status.DONE);
            } else {
                Report.updateTestLog(Action, "Variable format is not correct", Status.DEBUG);
            }
        } catch (Exception ex) {
            Logger.getLogger(this.getClass().getName()).log(Level.OFF, null, ex);
            Report.updateTestLog(Action, "Error Storing Header Element element :" + "\n" + ex.getMessage(),
                    Status.DEBUG);
        }
    }

---

setEndPoint

Description: This function is used to set the End Point for a Rest/SOAP API.

Input Format : @EndPoint

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	setEndPoint	@Endpoint (from Editor)			<< Hardcoded Input
Webservice	setEndPoint	Sheet:Column			<< Input from Datasheet
Webservice	setEndPoint	%dynamicVar%			<<Input from variable

Inputs in the Input column can be either hardcoded, passed inside the Endpoint editor which is capable of parameterising the Endpoint (Press ctrl+space to see the list of variables available ), passed from the data sheet (datasheet name : column name) or passed from a variable value (%variable name%), as given in the above example.

Corresponding Code:

Performs opening of URL Connection

httpConnections.put(key, (HttpURLConnection) url.openConnection());

---

addHeader

Description: This function is used to add a header for a Rest/SOAP API request.

Input Format : @HeaderName=HeaderValue

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	addHeader	@HeaderName=HeaderValue			<< Hardcoded Input
Webservice	addHeader	Sheet:Column containing HeaderName=HeaderValue			<< Input from Datasheet
Webservice	addHeader	%dynamicVar% containing HeaderName=HeaderValue			<<Input from variable

Corresponding Code:

This function adds all the Headers into a HashMap headerlist. Then those are applied to the request as :

if (headerlist.size() > 0) {
    headerlist.forEach((header) -> {
        httpConnections.get(key).setRequestProperty(header.split("=")[0], header.split("=")[1]);
    });
}

---

closeConnection

Description: This function is used to close a connection for a Rest/SOAP API request.

Usage:

ObjectName	Action	Input	Condition	Reference
Webservice	closeConnection

Corresponding Code:

Performs disconnection of the URL connection

httpConnection.disconnect();

---