vutil provides REST API to perform CRUD operations on various databases. As of now, following databases are supported:
- MySQL
- Postgres
- MongoDB
We are also working on integration with other databases as well. Please stay tuned.
Now, with the help of this API, one can perform the database validation after a test case is executed.
API Endpoint for DB Validation API is
POST {{vutilBaseURL}}/execute/dbquery/{{connection}}
Here
- {{vutilBaseURL}} is the variable, and the value is base URL of vutil server.
- {{connection}} is the path variable, and the value is the connection name of the database which is configured in config.json file.
And this API accepts a single body parameter "query" which can be either in STRING format or in JSON Object depending on the database vendor.
Step by step guide to perform database validation:
Step 1: Configure connection details in vutil
First you need to configure database connection details in config.json file. If you have not created a config.json file, then create one by copying the config.sample.json into config.json file and provide the connection details as per the samples provided.
Step 2: Execute your API test case and validate its response. e.g. for this guide, we are creating a contact with our sample contact API as follows:
Step 3: Now, to validate the database state, we need to write a separate test case in vREST. With the help of DB API provided by vutil, we can write the test case for db validation as follows:
- First create a test case with DB Validation API as follows:
- Now, provide the connection name as follows:
- Now, provide the request body for the DB Validation API:
- Provide assertions as you provide for other test cases
- And expected body as per your need.
That's it. In this way, you may validate the DB state.