Ready-to-use OpenAPI test coverage analysis tool that helps teams improve integration
CoveAPI is an advanced test coverage analysis tool based on the OpenAPI standard. It offers a comprehensive solution for teams to effectively measure and improve their integration test coverage within CI/CD pipelines.
With CoveAPI, teams can easily establish and enforce specific coverage thresholds, ensuring that critical parts of their application are thoroughly tested. By integrating CoveAPI into their existing CI/CD workflows, teams can automatically track and monitor test coverage metrics, making it easier to identify areas that require additional testing.
Help
See documentation for more details.
Usage
Integrate CoveAPI into your CI/CD pipeline
Direct your integration tests towards the CoveAPI reverse proxy to enable analysis and interpretation of requests that occur during the testing process. This ensures that CoveAPI effectively handles requests during integration testing.
Configure your tests to target either http://localhost:13750 (without Docker) or http://coveapi:13750 (with Docker). If you are using Docker, CoveAPI will automatically set up the networking for your container to establish a connection with it.
Setup Preparation Stage
To ensure CoveAPI is properly configured for later use, follow these steps. Place this preparation stage after starting your service and before running your integration tests.
Please remember to replace the location of your OpenAPI spec and the instance URL. You can provide the OpenAPI spec as either a local file path or a URL.
- name: Initialize CoveAPI
uses: yezz123/[email protected]
with:
stage: "preparation"
openapi-source: "docs/swagger.json"
instance-url: "http://localhost:8080"
test-coverage: "75%"
Make sure to modify the openapi-source parameter to point to the location of your OpenAPI or Swagger specification. This can be either a local file path or a URL.
Similarly, adjust the instance-url parameter to match the base URL of your service, excluding the base path specified in your OpenAPI spec.
Optionally, you can set a desired test-coverage value for your endpoints.
By following these steps, CoveAPI will be properly prepared for integration testing, ensuring accurate analysis and interpretation of requests.
Setup Evaluation Stage
Place the CoveAPI evaluation stage somewhere after your integration tests have run.
- uses: yezz123/[email protected]
name: Evaluate CoveAPI
with:
stage: "evaluation"
This stage will fail if test coverage isn't met and can display additional information gathered during the integration tests.
Contributing
For guidance on setting up a development environment and how to make a contribution to CoveAPI, see Contributing to CoveAPI.
Reporting a Security Vulnerability
See our security policy.
4 Nov 29, 2022
486 Dec 28, 2022
5 Nov 17, 2021
19 Aug 28, 2022
26 Dec 27, 2022
4 Sep 19, 2022
287 Nov 25, 2022
32 Dec 25, 2022
2 Jan 28, 2022
3 Jul 30, 2022
99 Jan 5, 2023
11 Dec 15, 2022
5 Mar 6, 2023
3 Dec 12, 2023
534 Jan 1, 2023
78 Nov 27, 2022
4 Aug 23, 2022
14 Sep 26, 2023
13 Apr 7, 2023
406 Dec 31, 2022