API Coverage File in a Parsable format. about specmatic HOT 4 CLOSED

@barath121 thanks for reporting this, I will take a look and get back to you.

from specmatic.

hello @barath121, thanks for reaching out.

If your objective is to enforce a certain minimum API coverage percentage and fail the build based on the same, I recommend setting the same in specmatic.json and Specmatic itself will fail the contract test suite if the criteria is not met. Here is a snippet which is setting the minThresholdPercentage to 100.

"report": {
    "formatters": [
      {
        "type": "text",
        "layout": "table"
      }
    ],
    "types": {
      "APICoverage": {
        "OpenAPI": {
          "successCriteria": {
            "minThresholdPercentage": 100,
            "maxMissedEndpointsInSpec": 0,
            "enforce": true
          },
          "excludedEndpoints": [
            "/health"
          ]
        }
      }
    }
  }

Here is a short video and detailed reference - API Coverage Report

However if you do want to parse the API coverage report, we do have a JSON format output now. It should be available under build/reports/specmatic/coverage_report.json. Hope this helps.

from specmatic.

Hey @harikrishnan83
The coverage_report.json is not being generated when using with python tested for verison 0.26.6 of Specmatic.

from specmatic.

@barath121 we ran tests on our sample project with latest Specmatic Python release 0.26.7 and the coverage_report.json is getting generated under build folder as expected. Can you please check?

from specmatic.