Then Steps
If we want to test if the response to the request that we did is having the expected status code. Let say we are expecting a successful request having a 200 status code.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response status code should be 200
If the status code is not as expected this will generate a failed test.
This is the same as above but a negative test instead.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response status code should not be 404
This will assert if the expected HTTP Header exist from the response.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response status code should not be 200Then response header "Server" should exist
If the header does not exists then it will failed the test, and will have a message Expected header (Server) is missing.
This is the negative test of the previous HTTP Header test. If the expected header exists then the test will failed.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response status code should not be 200Then response header "Server" should not exist
If we want to test not just the existence of the header, we can also assert if the value of the response header is the same as what we are expecting.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response status code should not be 200Then response header "Server" should be "Autokin Server 2.1"
This step is the reverse or negative test for the HTTP Header and value check.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response status code should not be 200Then response header "Server" should not be "Autokin Server"
This is a simple assert step to validate if the response body is in JSON format.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response body should be valid json
If we want to assert the JSON body as a whole and compare to what we expect we can use this step.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response body should be json data of"""`{"id": 3001,"name": "Juan Pedro","country": "PH"}`"""
This step will compare each of the JSON property and value as well. If the structure or the value does not match to the response then it will fail the test.
The following steps will be used to assert paths and values of the JSON body response.
For our examples, we will use this response body
`{"id": 3001,"name": "Juan Pedro","country": "PH","city": null,"tasks": [`{"tid": 1,"name": "Task 1"}`,`{"tid": 2,"name": "Task 2"}`]}`
Let us assert for a specific path with expected value, for example, in the above reponse we want to check for
path for id to have the value 3001
and the path for country to have the expected value of PH
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen I expect that path "$.id" from body has value of 3001Then I expect that path "$.country" from body has value of "PH"
Let us assert for a specific path with expected null value, for example, in the above reponse we want to check path for city which has a null value.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen I expect that path "$.city" from body has null value
This simple step is just to assert if the expected path exists.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen response body should have path "$.id"Then response body should have path "$.tasks[0].tid"Then response body should have path "$.tasks[1].name"
For more information, see https://goessner.net/articles/JsonPath/, and Autokin is using https://github.com/json-path/JsonPath for JSON Path processing.
To chain scenarios, we need to keep some of the value that was part of the repponse from previous scenarios, to do this we can use the following steps.
Let us have an example to store a value form the response body using a specific JSON path.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen Then I keep the value of body path "$.id" as "userId"
Now, we can use userId in some of the steps to pass as value of the header or parameters.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen I keep the value of header "Server" as "serverName"
We can also assert if the value stored is the same as what we are expecting.
Scenario: Getting user informationGiven that a endpoint is up at mydomain.comGiven I set Content-Type header to application/jsonGiven I set DocId header to 3001When I GET /users/infoThen I keep the value of header "Server" as "serverName"Then I expect that the stored value in "serverName" is "Autokin Server"
