Tsekaro

Summary

Tsekaro is an open system framework for creating/executing/managing API tests and integration tests. It is mainly aimed to help testing in a Microservices rich ecosystem.

Tsekaro is built with the idea of Testing as a Service, meaning it can easily be deployed as a microservice to help teams during development as well as during regression.

Index

• Tsekaro
  • Summary
  • Index
  • API Documentation
    • 1. Add Flow
    • 2. Add Testcase
    • 3. Delete Flow
    • 4. Delete Testcase
    • 5. Execute Flow
    • 6. Execute Testcase
    • 7. Get All Flows
      • I. Example Request: Get All Flows
      • I. Example Response: Get All Flows
    • 8. Get All Testcases
    • 9. Get Flow
    • 10. Get Testcase
    • 11. Status
    • 12. Update Flows
    • 13. Update Testcase

---

API Documentation

1. Add Flow

Endpoint:

Method: POST
Type: RAW
URL: http://localhost:8080/v1/flows

Body:

{
    "name": "flow2"
}

2. Add Testcase

Endpoint:

Method: POST
Type: RAW
URL: http://localhost:8080/v1/testcases

Body:

{
    "name": "step1",
    "flow_id": 11,
    "api": "GRPC",
    "test_case_id": 1,
    "operation": "EQUAL",
    "expected": {
        "data": "Hello thejas!"
    },
    "actual": "message",
    "scheme": "http",
    "host": "localhost",
    "port": 50051,
    "path": "helloworld.Greeter/SayHello",
    "body": "{\"message\": \"thejas\"}"
}

3. Delete Flow

Endpoint:

Method: DELETE
Type:
URL: http://localhost:8080/v1/flows/1

4. Delete Testcase

Endpoint:

Method: DELETE
Type:
URL: http://localhost:8080/v1/testcases/3

5. Execute Flow

Endpoint:

Method: GET
Type:
URL: http://localhost:8080/v1/flows/execute/11

6. Execute Testcase

Endpoint:

Method: GET
Type:
URL: http://localhost:8080/v1/testcases/execute/5

7. Get All Flows

Endpoint:

Method: GET
Type:
URL: http://localhost:8080/v1/flows

Query params:

Key	Value	Description
page	5
pagesize	1
order	name

More example Requests/Responses:

I. Example Request: Get All Flows

Query:

Key	Value	Description
page	5
pagesize	1
order	name

I. Example Response: Get All Flows

{
    "page": 5,
    "page_size": 1,
    "data": [],
    "total_records": 2
}

Status Code: 200

8. Get All Testcases

Endpoint:

Method: GET
Type:
URL: http://localhost:8080/v1/testcases

9. Get Flow

Endpoint:

Method: GET
Type:
URL: http://localhost:8080/v1/flows/10

10. Get Testcase

Endpoint:

Method: GET
Type:
URL: http://localhost:8080/v1/testcases/5

11. Status

Endpoint:

Method: GET
Type:
URL: http://localhost:8080/v1/status

12. Update Flows

Endpoint:

Method: PUT
Type: RAW
URL: http://localhost:8080/v1/flows/2

Body:

{
    "name": "name2"
}

13. Update Testcase

Endpoint:

Method: PUT
Type: RAW
URL: http://localhost:8080/v1/testcases/6

Body:

{
    "name": "step1",
    "flow_id": 11,
    "api": "GRPC",
    "test_case_id": 1,
    "operation": "EQUAL",
    "expected": {
        "data": "Hello thejas"
    },
    "actual": "message",
    "scheme": "http",
    "host": "localhost",
    "port": 50051,
    "path": "helloworld.Greeter/SayHello",
    "body": "{\"name\": \"thejas\"}"
}

---

Back to top