Version: 1x

@qavajs/steps-api v1

Step library to work with API

Installation

npm install @qavajs/steps-api@1

Configuration

module.exports = {
    default: {
        require: [
            'node_modules/@qavajs/steps-api/index.js'
        ]
    }
}

Parameter Types

gqlRequestProperty

Used to initialize one of two possible GraphQl body properties

query
variables

bodyParsingType

Used for parsing responses body

arrayBuffer
formData
blob
json
text

apiValidation

Used for validation function (can be negated with not)

to equal
to match schema
to have member
to match
to contain
to be above
to be below
to be greater than
to be less than
to have type

Action Steps

I send {method} request to {url} and save response as {key}

Send request to the endpoint

param	type	description
method	string	request method
url	string	endpoint url
key	string	key that should be used for saving response

When I send "GET" request to "$BASE_API_URL" and save response as "response"

I send {method} request to {url} with headers {headers} and save response as {key}

Send request to the endpoint

param	type	description
method	string	request method
url	string	endpoint url
headers	string	memory key with headers
key	string	key that should be used for saving response

When I send "GET" request to "$BASE_API_URL" with headers "$headers" and save response as "response"

I send {method} request to {url} with qs {params} and save response as {key}

Send request to the endpoint with query string

param	type	description
method	string	request method
url	string	endpoint url
params	string	query string parameters
key	string	key that should be used for saving response

When I send "GET" request to "$BASE_API_URL" with qs "?category=HR&name=test" and save response as "response"

I send {method} request to {url} with headers {headers} with qs {params} and save response as {key}

Send request to the endpoint with query string

param	type	description
method	string	request method
url	string	endpoint url
headers	string	memory key with headers
params	string	query string parameters
key	string	key that should be used for saving response

When I send "GET" request to "$BASE_API_URL" with headers "$headers" with qs "?category=HR&name=test" and save response as "response"

I send {method} request to {url} with Body {requestBody} and save response as {key}

Send request with body

param	type	description
method	string	request method
url	string	endpoint url
requestBody	JSON	request body
key	string	key that should be used for saving response

When I send "POST" request to "$BASE_API_URL" with Body "test_data_file.json" and save response as "response"

I send {method} request to {url} with headers {headers} with Body {requestBody} and save response as {key}

Send request with body

param	type	description
method	string	request method
url	string	endpoint url
headers	string	memory key with headers
requestBody	JSON	request body
key	string	key that should be used for saving response

When I send "POST" request to "$BASE_API_URL" with headers "$json('headers.json')" with Body "test_data_file.json" and save response as "response"

I send {method} request to {url} with qs {params} and Body {requestBody} and save response as {key}

Send request with body and query string

param	type	description
method	string	request method
url	string	endpoint url
params	string	query string parameters
requestBody	JSON	request body
key	string	key that should be used for saving response

When I send "PUT" request to "https://www.some_service.com/some_endpoint/" with qs "?category=HR&name=test" and Body "test_data_file.json" and save response as "response"

I send {method} request to {url} with headers {headers} with qs {params} and Body {requestBody} and save response as {key}

Send request with body and query string

param	type	description
method	string	request method
url	string	endpoint url
headers	string	memory key with headers
params	string	query string parameters
requestBody	JSON	request body
key	string	key that should be used for saving response

When I send "PUT" request to "https://www.some_service.com/some_endpoint/" with headers "$headers" with qs "?category=HR&name=test" and Body "test_data_file.json" and save response as "response"

I send {method} request and save response as {key} to {url} with Body: [requestBody]

Send request with body that given as part of Cucumber step

param	type	description
method	string	request method
key	string	key that should be used for saving response
url	string	endpoint url
requestBody	string (Multiline)	request body

When I send "POST" request and save response as "response" to "$BASE_API_URL" with Body:
   """
   {
      "title": "Test Post Request with Body passed as string"
   }
   """

I parse {response} body as {type}

MANDATORY STEP THAT SHOULD BE USED AFTER SENDING REQUEST Parsing body in needed way and adds payload property to response

param	type	description
response	string	response key in memory
type	bodyParsingType	type of payload

When I parse '$response' body as 'json'
Then I expect '$response.payload.foo' to equal 'bar'

Validation Steps

Response {response} Status Code {validation} {statusCode}

Verify response status code

param	type	description
response	Response	saved response
validation	apiValidation	function to wait condition
statusCode	string	expected status code

Then Response "$response" Status Code equals to "200"

Response {response} Status Message {validation} {statusMessage}

Verify response status code

param	type	description
response	Response	saved response
validation	apiValidation	function to wait condition
statusMessage	string	expected status message

Then Response "$response" Status Message equals to "OK"

Response {property} contains:

Verify that response contains needed properties

param	type	description
property	Any	property from saved response
dataTable	Object	data table with all properties

Then Response "$response.payload.data.items" contains:
      | _id               |
      | appId             |
      | serviceCategory   |

Response {response} {validation} {type}

Verifying that response model has necessary type

param	type	description
response	Response	saved response
validation	apiValidation	function to wait condition
type	string	expected property type

   Then Response "$response.payload.data.items" equals to "array"

Response {response} size {validation} {expectedValue}

Verify that response array size is equal to|less than|greater than given number

param	type	description
response	Response	saved response
validation	apiValidation	function to wait condition
expectedValue	string	expected property size

Then Response "$response.payload.data.items" size to be above "0"

I verify response {response} {validation} {expectedValue}

Execute any jsonPath query against response and verify result is equal to expected value

param	type	description
response	Response	saved response
validation	apiValidation	function to wait condition
expectedValue	string	expected property value

Then I verify response "$response.payload.data.items[0].title" equals to "TEST"

Construction API Steps

I create {method} request {requestKey}

Create request and save it to memory

param	type	description
method	string	API method
requestKey	string	key to save request

When I create 'GET' request 'request'

I add headers to {requestKey}: [headersDataTable]

Add data table of headers to request

param	type	description
requestKey	string	memory key of request
headersDataTable	DataTable	key value array of headers

When I create 'GET' request 'request'
And I add headers to '$request':
    | Content-Type | application/json |

I add {requestKey} headers to {headersKey}

Add headers to request

param	type	description
requestKey	string	memory key of request
headersKey	string	memory key of headers that resolves to JS object

When I create 'GET' request 'request'
And I add '$headers' headers to '$request'

I add body to {requestKey}: [body]

Add body to request as multiline parameter

param	type	description
requestKey	string	memory key of request
body	string (Multiline)	body

When I create 'GET' request 'request'
And I add body to '$request':
    """
     {
         "message": "qavajs"
     }
    """

I add {requestKey} body to {body}

Add body to request

param	type	description
requestKey	string	memory key of request
body	string	body

When I create 'GET' request 'request'
And I add '$body' body to '$request'

I add {requestKey} url to {url}

Add url to request

param	type	description
requestKey	string	memory key of request
url	string	url

When I create 'GET' request 'request'
And I add 'https://qavajs.github.io/' url to '$request'

I send {requestKey} request and save response as {responseKey}

Send prepared request and save response

param	type	description
requestKey	string	memory key of request
responseKey	string	memory key to save response

When I create 'GET' request 'request'
And I add 'https://qavajs.github.io/' url to '$request'
And I send '$request' request and save response as 'response'

I add form data body to {requestKey}: [dataTable]

Send prepared request and save response

param	type	description
requestKey	string	memory key of request
dataTable	DataTable	body

When I add body to '$request':
| key      | value                    | filename | contentType      |
| formKey  | formValue                |          | application/json |
| otherKey | otherValue               |          | text/plain       |
| fileKey  | $file('./path/file.png') | file.png | image/png        |

I create GraphQL request {requestKey}

Create GraphQL request and save it to memory

param	type	description
requestKey	string	key to save request

When I create GraphQL request 'request'

I add {property} to GraphQL {string}: [value]

Add GraphQL property

param	type	description
property	gqlRequestProperty	query or variables
requestKey	string	memory key of request
value	string (Multiline)	value multiline string

When I create GraphQL request 'request'
And I add query to GraphQL '$request':
"""
query {
  characters(page: 2, filter: { name: "rick" }) {
    results {
      name
    }
  }
}
"""    
And I add variables to GraphQL '$request':
"""
{
  "value": 42
}
"""

Websocket Steps

I connect to {string} ws endpoint {string}

Connect to websocket endpoint and save connection to memory

param	type	description
url	string	websocket endpoint
requestKey	string	key to save request

When I connect to 'ws://localhost:3000' ws endpoint 'ws'

I save message from {string} ws endpoint as {string}

Save message from websocket connection to memory

param	type	description
connectionKey	string	memory key of saved connection
memoryKey	string	memory key to save message

When I connect to 'ws://localhost:3000' ws endpoint 'ws'
And I save message from '$ws' ws endpoint as 'message'

I save message matching {string} from {string} ws endpoint as {string}'

Save message matching regexp from websocket connection to memory

param	type	description
regexp	string	regexp to filter messages
connectionKey	string	memory key of saved connection
memoryKey	string	memory key to save message

When I connect to 'ws://localhost:3000' ws endpoint 'ws'
And I save message matching 'qavajs test' from '$ws' ws endpoint as 'message'

I send {string} message to {string} ws endpoint

Send message to websocket

param	type	description
message	string	message to send
connectionKey	string	memory key of saved connection

When I connect to 'ws://localhost:3000' ws endpoint 'ws'
And I send 'qavajs' message to '$ws' ws endpoint

I send message to {string} ws endpoint: [message]

Send message to websocket

param	type	description
connectionKey	string	memory key of saved connection
message	string (Multiline)	message to send

When I connect to 'ws://localhost:3000' ws endpoint 'ws'
And I send message to '$ws' ws endpoint:
"""
qavajs
"""

I close {string} ws connection

Close websocket connection

param	type	description
connectionKey	string	memory key of saved connection

When I connect to 'ws://localhost:3000' ws endpoint 'ws'
And I close '$ws' ws connection

Installation​

Configuration​

Parameter Types​

gqlRequestProperty​

bodyParsingType​

apiValidation​

Action Steps​

I send {method} request to {url} and save response as {key}​

I send {method} request to {url} with headers {headers} and save response as {key}​

I send {method} request to {url} with qs {params} and save response as {key}​

I send {method} request to {url} with headers {headers} with qs {params} and save response as {key}​

I send {method} request to {url} with Body {requestBody} and save response as {key}​

I send {method} request to {url} with headers {headers} with Body {requestBody} and save response as {key}​

I send {method} request to {url} with qs {params} and Body {requestBody} and save response as {key}​

I send {method} request to {url} with headers {headers} with qs {params} and Body {requestBody} and save response as {key}​

I send {method} request and save response as {key} to {url} with Body: [requestBody]​

I parse {response} body as {type}​

Validation Steps​

Response {response} Status Code {validation} {statusCode}​

Response {response} Status Message {validation} {statusMessage}​

Response {property} contains:​

Response {response} {validation} {type}​

Response {response} size {validation} {expectedValue}​

I verify response {response} {validation} {expectedValue}​

Construction API Steps​

I create {method} request {requestKey}​

I add headers to {requestKey}: [headersDataTable]​

I add {requestKey} headers to {headersKey}​

I add body to {requestKey}: [body]​

I add {requestKey} body to {body}​

I add {requestKey} url to {url}​

I send {requestKey} request and save response as {responseKey}​

I add form data body to {requestKey}: [dataTable]​

I create GraphQL request {requestKey}​

I add {property} to GraphQL {string}: [value]​

Websocket Steps​

I connect to {string} ws endpoint {string}​

I save message from {string} ws endpoint as {string}​

I save message matching {string} from {string} ws endpoint as {string}'​

I send {string} message to {string} ws endpoint​

I send message to {string} ws endpoint: [message]​

I close {string} ws connection​