| id | auto-test-generation | ||||
|---|---|---|---|---|---|
| title | Auto Test Generation | ||||
| sidebar_label | Test Generation | ||||
| tags |
|
||||
| keywords |
|
import ProductTier from '@site/src/components/ProductTier';
Auto Test Generation simplifies the testing process by automating the generation of test cases based on the provided OpenAPI Schema file.
Keploy can generate tests automatically, with the help of schema file of the application:-
keploy generate-tests -c "<appCmd>" -s "<schemaFilePath>"Let's consider the employee-manager application as the example. First we need to create the schema.json file for the app, which would like something:-
{
"openapi": "3.0.3",
"info": {
"title": "Employee API",
"description": "CRUD API for managing employees",
"version": "1.0.0"
},
"servers": [
{
"url": "http://localhost:8080/api/"
}
],
"paths": {
"/employees": {
"get": {
"summary": "Get all employees",
"operationId": "getEmployees",
"responses": {
"200": {
"description": "List of employees",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Employee"
}
}
}
}
},
"400": {
"description": "Invalid request parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"summary": "Create a new employee",
"operationId": "createEmployee",
"requestBody": {
"description": "Employee object to be created",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeRequestBody"
}
}
}
},
"responses": {
"200": {
"description": "Created employee",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeResponse"
}
}
},
"links": {
"getCreatedEmployee": {
"description": "The `GET /employees/{id}` endpoint for the newly created employee",
"operationId": "getEmployeeById",
"parameters": {
"id": "$response.body#/id"
}
}
}
},
"400": {
"description": "Invalid request body or parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/employees/{id}": {
"get": {
"summary": "Get an employee by ID",
"operationId": "getEmployeeById",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
},
"description": "ID of the employee to retrieve"
}
],
"responses": {
"200": {
"description": "Employee with the specified ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeResponse"
}
}
},
"links": {
"updateEmployee": {
"description": "The `PUT /employees/{id}` endpoint to update the employee",
"operationId": "updateEmployeeById",
"parameters": {
"id": "$response.body#/id"
}
},
"deleteEmployee": {
"description": "The `DELETE /employees/{id}` endpoint to delete the employee",
"operationId": "deleteEmployeeById",
"parameters": {
"id": "$response.body#/id"
}
}
}
},
"400": {
"description": "Invalid request parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Employee with the specified ID not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"put": {
"summary": "Update an employee by ID",
"operationId": "updateEmployeeById",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
},
"description": "ID of the employee to update"
}
],
"requestBody": {
"description": "Employee object with updated information",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeRequestBody"
}
}
}
},
"responses": {
"200": {
"description": "Updated employee",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeResponse"
}
}
},
"links": {
"getUpdatedEmployee": {
"description": "The `GET /employees/{id}` endpoint for the updated employee",
"operationId": "getEmployeeById",
"parameters": {
"id": "$response.body#/id"
}
},
"deleteEmployee": {
"description": "The `DELETE /employees/{id}` endpoint to delete the employee",
"operationId": "deleteEmployeeById",
"parameters": {
"id": "$response.body#/id"
}
}
}
},
"400": {
"description": "Invalid request body or parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Employee with the specified ID not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"delete": {
"summary": "Delete an employee by ID",
"operationId": "deleteEmployeeById",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer"
},
"description": "ID of the employee to delete"
}
],
"responses": {
"200": {
"description": "Employee deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean"
}
}
}
}
},
"links": {
"createEmployee": {
"description": "The POST /employees endpoint for creating a new employee with the request body containing employee details.",
"operationId": "createEmployee",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeRequestBody"
}
}
}
}
},
"getEmployees": {
"description": "The `GET /employees` endpoint for all employees",
"operationId": "getEmployees"
}
}
},
"400": {
"description": "Invalid request parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Employee with the specified ID not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Employee": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
},
"lastName": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
},
"email": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
}
},
"required": ["firstName", "lastName", "email"]
},
"EmployeeRequestBody": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
},
"lastName": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
},
"email": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
}
},
"required": ["firstName", "lastName", "email"]
},
"EmployeeResponse": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
},
"lastName": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
},
"email": {
"type": "string",
"pattern": "[A-Za-z0-9_]"
}
}
},
"Error": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
}
}
}Let's start our postgres database instance via docker:-
docker-compose up -d postgresNow that we have our schema file, we need to create create jar file since we are using java sample-application :-
mvn clean install -DskipTestsNow that we have our jar file ready, let's start the application with keploy : -
keploy generate-tests -c "java -jar <JAR_FILE_PATH>" -s "schema.json"We will get similar output: -
