Coverage Guardrails

Validates code coverage collection and thresholds.

Overview

This policy enforces that code coverage data is collected in CI and meets a minimum threshold. It is vendor-agnostic and works with any coverage collector that writes to the standard .testing.coverage paths (e.g., Codecov, Coveralls, or custom collectors).

Policies

This plugin provides the following policies (use include to select a subset):

Required Data

This policy reads from the following Component JSON paths:

Note: Object presence is the signal—the collected policy uses assert_exists(".testing.coverage") and the reported policy uses assert_exists(".testing.coverage.percentage").

Installation

Add to your lunar-config.yml:

policies:
  - uses: github://earthly/lunar-lib/policies/coverage@main
    on: [backend]
    enforcement: block-pr
    # include: [collected]  # Only run specific checks (omit to run all)
    # with:
    #   min_coverage: "90"

Examples

Passing Example

{
  "testing": {
    "coverage": {
      "source": {
        "tool": "codecov",
        "integration": "ci"
      },
      "percentage": 85.5
    }
  }
}

Failing Example

{
  "testing": {
    "coverage": {
      "source": {
        "tool": "codecov",
        "integration": "ci"
      },
      "percentage": 72.0
    }
  }
}

Failure message: "Coverage 72.0% is below minimum 80%"

Remediation

When this policy fails, you can resolve it by:

1. collected failure: Configure a coverage collector to run in your CI pipeline
2. reported failure: Ensure your coverage tool successfully uploads/reports coverage data
3. min-coverage failure: Add more tests to increase code coverage, or adjust the min_coverage input if the threshold is too aggressive