Coverage thresholds in JUnit - Framework Patterns

Framework Mode - Coverage thresholds

Folder Structure

project-root/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── App.java
│   └── test/
│       └── java/
│           └── com/example/app/
│               └── AppTest.java
├── build.gradle
├── settings.gradle
├── jacoco.gradle
└── README.md

This structure separates production code and test code under src/main/java and src/test/java. The jacoco.gradle file contains coverage configuration including thresholds.

Test Framework Layers

• Production Code: Application source code under src/main/java.
• Test Code: JUnit test classes under src/test/java.
• Build & Coverage: Gradle build scripts including JaCoCo plugin for coverage measurement and threshold enforcement.
• Utilities: Helper classes or test utilities if needed, placed under src/test/java or separate utility packages.
• Configuration: Gradle files and properties files to manage environment and coverage settings.

Configuration Patterns

Use Gradle with the JaCoCo plugin to configure coverage thresholds.

plugins {
    id 'java'
    id 'jacoco'
}

jacoco {
    toolVersion = "0.8.10"
}

jacocoTestReport {
    reports {
        xml.required.set(true)
        html.required.set(true)
    }
}

jacocoTestCoverageVerification {
    violationRules {
        rule {
            limit {
                minimum = 0.80 // 80% coverage threshold
            }
        }
    }
}

test {
    finalizedBy jacocoTestReport, jacocoTestCoverageVerification
}

This config sets a minimum coverage threshold of 80%. The build will fail if coverage is below this.

Test Reporting and CI/CD Integration

• Generate coverage reports in HTML and XML formats using JaCoCo.
• Publish reports in CI pipelines (e.g., Jenkins, GitHub Actions) for visibility.
• Fail the build automatically if coverage thresholds are not met, enforcing quality gates.
• Integrate with code quality tools like SonarQube to visualize coverage trends.

Best Practices

1. Set realistic thresholds: Start with achievable coverage goals and increase gradually.
2. Fail fast: Configure the build to fail immediately if coverage drops below threshold.
3. Use multiple coverage metrics: Consider line, branch, and instruction coverage for better quality insight.
4. Keep coverage reports accessible: Publish reports in CI for team visibility and accountability.
5. Automate threshold enforcement: Avoid manual checks by integrating coverage verification in build scripts.

Self Check

Where in this framework structure would you add a new coverage threshold rule to require at least 90% branch coverage?

Key Result

Use JaCoCo with Gradle to enforce coverage thresholds that fail builds if minimum coverage is not met.