Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pactumjs/pactum-swagger-coverage
JSON swagger coverage reporter for Pactum tests
https://github.com/pactumjs/pactum-swagger-coverage
api-testing coverage pactum reporting swagger swagger-coverage
Last synced: about 1 month ago
JSON representation
JSON swagger coverage reporter for Pactum tests
- Host: GitHub
- URL: https://github.com/pactumjs/pactum-swagger-coverage
- Owner: pactumjs
- License: mit
- Created: 2020-11-01T12:32:42.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-22T17:33:55.000Z (about 1 year ago)
- Last Synced: 2023-12-23T18:02:31.511Z (12 months ago)
- Topics: api-testing, coverage, pactum, reporting, swagger, swagger-coverage
- Language: JavaScript
- Homepage:
- Size: 37.1 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pactum-swagger-coverage
JSON swagger/openapi3 coverage reporter for [Pactum](https://www.npmjs.com/package/pactum) tests. It's capable of reading the swagger/oas3 definitions from either `swagger.yaml` or `swagger.json` or `openapi3.yaml` (served on a http server endpoint).
## Installation
```shell
npm install --save-dev pactum pactum-swagger-coverage
```
## Usage
```javascript
const pactum = require('pactum');
const psc = require('pactum-swagger-coverage');
const reporter = pactum.reporter;
// global before block
before(() => {
reporter.add(psc);
});
// global after block
after(() => {
return reporter.end();
});
```
## Reporter Options
```javascript
const psc = require('pactum-swagger-coverage');
// name of the report file - defaults to "swagger-cov-report.json"
psc.reportFile = 'report-name.json';
// folder path for the report file - defaults to "./reports"
psc.reportPath = './reports-path';
/**
* base path - defaults to `basePath` for swagger 2.0/openapi2 and first server url
* or empty if either of them doesn't exist or not set explicitly
*/
psc.basePath = '/api/server/v1';
// Swagger json url of the server - defaults to ""
psc.swaggerJsonUrl = "http://localhost:3010/api/server/v1/json";
// Swagger Yaml file path - defaults to ""
psc.swaggerYamlPath = './tests/testObjects/swagger.yaml';
```
### Report Json Output (example)
```javascript
{
"basePath": "/api/server/v1",
"coverage": 0.2,
"coveredApiCount": 1,
"missedApiCount": 4,
"totalApiCount": 5,
"coveredApiList": [
"/getallninjas"
],
"missedApiList": [
"/health",
"/getninjabyid/{id}",
"/getninjabyname/{name}",
"/getninjabyrank/{rank}"
]
}
```
> **Note**: Either 'swaggerJsonUrl' or 'swaggerYamlPath' should be provided for reporter to work.
## Notes
Read more about Pactum [here](https://www.npmjs.com/package/pactum).
Inspired by [swagger-coverage-postman](https://github.com/abelmokadem/swagger-coverage-postman).
----------------------------------------------------------------------------------------------------------------
