Test framework for automating rest api & JS & typescript!
npm install cucumberjs-rest-assured-New version 0.21 release note
- Increased default timeout to 30,000 seconds few srvices might take time, it returns results immediatly if response is quick
-In future will provide timeout option
- https://www.npmjs.com/package/rest-assured-ts
- This API automation tool designed to support API automation like other tools Postman, RestAssured and Karate
- It supports CommonJS, ES6 and TypeScript
- Pretty easy to use this library for non JavaScript developers as well
- It supports Cucumber, Mocha and other frameworks as well
- This tool helps integration testing with webui , mobile and other applications
- It helps API integration (example : to automate combination of promo, tax and price services) testing as well.
- Best feature, Chai asserts are supported implicitly for json response validations
- Easy to find json paths and node values like https://jsonpath.com/
- Easy to externalize test data request and response json files
- Supports huge jsons request and responses
- Can send json request body as File and String
- where Include or exclude parameters from the request body for the negative testing
- Mutations on JSON objects where Dynamic parameters can be applied on json objects
- Can send full json response as file for complete json schema validations
- Https API
- Promise API
- Handled exceptions internally
- Easy to use Request API's with basic knowledge of javascript and typescript
- Going to add more utils for json validation to meet API's functionality
- it supports fixtures similar to https://www.npmjs.com/package/fixtures
- Actively maintained
Extra features: Chai asserts supported implicitly for json response validations
Passing request body as json file , full json response validation as file for complete schema validations.
It supports json path validations
|json path|value|
|username| myname|
using exact path :
example:
|json path|value|
|data[*].username| myname|
Easy way of automation
js
const { prettyPrintJSON } = require("cucumberjs-rest-assured"); const response = await makeHttpRequest("https://gorest.co.in/public-api/users");
console.log(prettyPrintJSON(JSON.parse(response.body)));
`
typescript jsx
const { prettyPrintJSON } = require("cucumberjs-rest-assured");(async () => {
const inputbody =
{"username: "firstname", "lastname" : "lst" };
const headerOptions: string = JSON.stringify({"Authorization": authToken});
const response = makeHttpRequest(url, JSON.parse(headerOptions), "POST", inputbody);
console.log(${jsonValidationUtils.prettyPrintJSON(response.body)});
//=> ' ...'
})();
`FormData, uploading file
typescript jsx
const { prettyPrintJSON } = require("cucumberjs-rest-assured");
import * as fs from "fs";(async () => {
const url: string = baseapiurl.toString() + urlParams;
const headerOptions: string = JSON.stringify({"Authorization": authToken});
const formDataMap: Map = new Map ();
formDataMap.set(key, fs.createReadStream(value));
const response: object = await makeHttpRequestWithFormData(url, JSON.parse(headerOptions), "POST", formDataMap);
const responseBody = JSON.parse(response.body);
logger.info(() =>
File Upload Response: ${jsonValidationUtils.prettyPrintJSON(responseBody)});
})();`typescript jsx
/**
* This method used to making http request
* @param {string} url - form full url including path parameters if applicable
* @param {object} headerOptions - pass header values
* @param {string} HttpMethod - GET, POST , PUT, PATCH , DELETE etc , GET is default
* @param {string} inputBody - json string
* @param {boolean} formFlag - default false
*/method
export async function makeHttpRequest(url: string, headerOptions?: object,
HttpMethod?: string, inputBody?: string, formFlag?: boolean): Promise
`typescript jsx/**
* This method used to make http request for FormData
* @param {string} url - form full url including path parameters if applicable
* @param {object} headerOptions - pass header values
* @param {string} HttpMethod - GET, POST , PUT, PATCH , DELETE etc , GET is default
* @param {Map} formDataMap - json string
* @returns {Promise
export async function makeHttpRequestWithFormData(url: string, headerOptions?: object,
HttpMethod?: string,
formDataMap?: Map): Promise
`typescript jsx/**
* This method used to making http request
* @param {string} url - form full url including path parameters if applicable
* @param {string} _localHost - proxy server
* @param {number} _port - port number
* @param {object} headerOptions - pass header values
* @param {string} HttpMethod - GET, POST , PUT, PATCH , DELETE etc , GET is default
* @param {string} inputBody - json string
* @param {boolean} formFlag - default false
*/
export async function makeHttpRequestWithProxy(url: string, _localHost: string, _port: number, _headerOptions?: object,
HttpMethod?: string, inputBody?: string, formFlag?: boolean): Promise
`
findNodeByName
(async) findNodeByName(jsonData, nodename)
This method used to find the parent node by name , it returns json paths associated with json key.
This helps to find json path for given node.
js
const { prettyPrintJSON, jsonValidationUtils } = require("cucumberjs-rest-assured"); const jsonfilepath = "./userresponse.json";
const jsonfileobject = await jsonValidationUtils.readJsonToObject(jsonfilepath);
const jsonpaths: string[] = await jsonValidationUtils.findNodeByName(jsonfileobject, "username");
`findNodeValue
(async) findNodeValue(jsonData, nodename)
This method used to find the parent node value by node name
js
const response = await makeHttpRequest(url, JSON.parse(headerOptions), "POST", resultString); logger.info(() =>
Post Response is: ${jsonValidationUtils.prettyPrintJSON(JSON.parse(response.body))});
const userid = await jsonValidationUtils.findNodeValue(JSON.parse(response.body), "id"); // it returns string array
//sometimes will be having multiple id's(with same node name) for user , security roles and external id's
// Better to give exact path, users[*].id or if index is fixed users[0].id
`
Fixtures
js
/*
Ex: users.json
{
"my_own_user": {
"name": "Charles",
"type": "M"
},
"female": {
"name": "Susana",
"type": "F"
}
} */
const userdata = await jsonValidationUtils.readJson("./users.json");
const username: string[] = await jsonValidationUtils.findNodeValue(userdata,
"my_own_user.name");
logger.info(username[0]);
`ACCESS_TOKEN generation where sending request body as string
replacing dynamic values {username} if when sending username and password from env or config
see github example
tsx
/*world is like global variable in cucumberjs, you can initialize to local or global variables
whichever supports for other frameworks like Mocha */
const inputbody = "{
\"grant_type\": \"password\",
\"username\": \"{username}\",
\"password\": \"{password}\",
}"; const urlparams = urlparams.replace("denim_default", realmID);
const url: string = baseidmurl + urlparams;
let requestBody: string = inputbody.replace("{username}", idmUsername);
requestBody = requestBody.replace("{password}", decodedPassword);
const headerOptions: string = JSON.stringify({"Content-Type": "application/x-www-form-urlencoded"});
response = await makeHttpRequest(url, JSON.parse(headerOptions), "POST", requestBody, true);
logger.info(() =>
Status code is: ${JSON.stringify(response.body)});
world.responseBody = JSON.parse(response.body);
const authenticationToken: string[] = await jsonValidationUtils.findNodeValue(world.responseBody,
"access_token"); //access_token is a node name(json path parameter) from the JSON response"
// world is global variable in cucumberjs, so you can store token global variable or file however you want it
world.accessTokenConstants.authToken = "Bearer " + authenticationToken.toString();
logger.info(() => Access token is: ${world.accessTokenConstants.authToken});
world.accessTokenConstants.statusCode = response.statusCode.toString();
`ACCESS_TOKEN generation where request body sending it as a file
tsx
const url: string = baseidmurl + urlParams;
//json file path ./accessToken/accessTokenRequest.json
const accessTokenRequest = await jsonValidationUtils.readJson("./accessToken/accessTokenRequest.json");
let requestBody: string = JSON.stringify(accessTokenRequest).replace("{username}", idmUsername);
requestBody = requestBody.replace("{password}", decodedPassword);
logger.info(() => Url is: ${baseidmurl});
const headerOptions: string = JSON.stringify({"Content-Type": "application/x-www-form-urlencoded"});
response = await makeHttpRequest(url, JSON.parse(headerOptions), "POST", requestBody, true);
logger.info(() => Status code is: ${JSON.stringify(response.body)});
world.responseBody = JSON.parse(response.body);
const authenticationToken: string[] = await jsonValidationUtils.findNodeValue(world.responseBody,
"access_token");
world.accessTokenConstants.authToken = "Bearer " + authenticationToken.toString();
logger.info(() => Access token is: ${world.accessTokenConstants.authToken});
``#createJsonResponseObjectFromMap
#deepCompareOfJsonObjects
#excludeFirstRowAndValidateJsonPathFollowedByParentIndex
#excludeFirstRowFromTableAndValidateJsonPath
#excludeHeadersAndPostRequestParametersFromDataTable
#findNodeByName
#findNodeValue
#invalidJsonPathWithRegularExpression
#invalidJsonPathWithRegularExpressionForMap
#iterateNestedObects
#makeHttpRequest
#makeHttpRequestWithFormData
#makeHttpRequestWithProxy
#postJsonObjectRequestFromMap
#postRequestParametersAsFile
#postRequestParametersFromDataTable
#postRequestParametersFromMap
#prettyPrintJSON
#readJson
#readJsonToObject
#readJsonToString
#replaceJsonPathFollowedByParentIndex
#validateJsonDataTableFollowedByParentIndex
#validateJsonMapFollowedByParentIndex
#validateJsonPathWithRegularExpression
#validateJsonResponseFile
#validJsonPathWithRegularExpressionForMap
#### Publishing changes
More documentation will be added, refer github link
Please refer github links for code snippets , these methods can be used for mocha and other frameworks as well
contact letautomate@gmail.com , let.automate@gmail.com
Please see LICENSE.md.