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.

Practice

1. What is the main purpose of setting coverage thresholds in JUnit testing?

easy

A. To automatically fix bugs in the code

B. To speed up test execution time

C. To ensure a minimum percentage of code is tested

D. To generate user interface reports

Solution

1. Step 1: Understand coverage thresholds

   Coverage thresholds define the minimum amount of code that must be tested to pass.

2. Step 2: Identify the main goal

   The goal is to keep tests thorough by enforcing minimum test coverage.

3. Final Answer:

   To ensure a minimum percentage of code is tested -> Option C

4. Quick Check:

   Coverage thresholds = minimum tested code [OK]

Hint: Coverage thresholds set minimum tested code percentage [OK]

Common Mistakes:

• Thinking thresholds speed up tests
• Believing thresholds fix bugs automatically
• Confusing thresholds with report generation

2. Which of the following is the correct way to set a line coverage threshold of 80% using JaCoCo in a Maven pom.xml?

easy

A. <rule><limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>0.8</minimum></limit></rule>

B. <rule><limit><counter>LINE</counter><value>MISSEDCOUNT</value><maximum>0.8</maximum></limit></rule>

C. <rule><limit><counter>BRANCH</counter><value>COVEREDRATIO</value><minimum>80</minimum></limit></rule>

D. <rule><limit><counter>LINE</counter><value>COVEREDCOUNT</value><minimum>0.8</minimum></limit></rule>

Solution

1. Step 1: Identify correct counter and value

   For line coverage, the counter is LINE and the value to check coverage ratio is COVEREDRATIO.

2. Step 2: Check threshold value format

   Minimum coverage is set as a decimal ratio (0.8 for 80%).

3. Final Answer:

   Rule with LINE counter, COVEREDRATIO value, and minimum 0.8 -> Option A

4. Quick Check:

   Line coverage threshold = 0.8 COVEREDRATIO [OK]

Hint: Use LINE + COVEREDRATIO + minimum 0.8 for 80% threshold [OK]

Common Mistakes:

• Using MISSEDCOUNT instead of COVEREDRATIO
• Setting minimum as 80 instead of 0.8
• Confusing BRANCH counter with LINE

3. Given the following JaCoCo coverage report snippet:

{"LINE": {"covered": 40, "missed": 10}}

What is the line coverage ratio, and does it meet a threshold of 85%?

medium

A. Coverage is 75%, which does not meet the 85% threshold

B. Coverage is 75%, which meets the 85% threshold

C. Coverage is 80%, which meets the 85% threshold

D. Coverage is 80%, which does not meet the 85% threshold

Solution

1. Step 1: Calculate coverage ratio

   Total lines = covered + missed = 40 + 10 = 50. Coverage ratio = 40 / 50 = 0.8 or 80%.

2. Step 2: Compare with threshold

   Threshold is 85%, coverage is 80%, so coverage does not meet threshold.

3. Final Answer:

   Coverage is 80%, which does not meet the 85% threshold -> Option D

4. Quick Check:

   40/50 = 0.8 < 0.85 [OK]

Hint: Divide covered by total lines, compare to threshold [OK]

Common Mistakes:

• Adding covered and missed incorrectly
• Confusing coverage percentage with missed percentage
• Assuming 80% meets 85% threshold

4. You set a branch coverage threshold of 90% in your JaCoCo config, but the build passes even when coverage is 85%. What is the most likely cause?

medium

A. The JaCoCo plugin is not configured to fail the build on threshold violation

B. The threshold value is set as maximum instead of minimum

C. Branch coverage cannot be enforced with JaCoCo

D. The threshold is set on LINE coverage, not BRANCH coverage

Solution

1. Step 1: Understand threshold enforcement

   Thresholds require configuration to fail the build if coverage is below minimum.

2. Step 2: Identify common misconfiguration

   If the build passes despite low coverage, likely the fail-on-violation setting is missing or disabled.

3. Final Answer:

   JaCoCo plugin not configured to fail build on threshold violation -> Option A

4. Quick Check:

   Fail build setting missing = threshold ignored [OK]

Hint: Fail build must be enabled to enforce coverage thresholds [OK]

Common Mistakes:

• Confusing LINE and BRANCH counters
• Setting maximum instead of minimum threshold
• Believing branch coverage can't be enforced

5. You want to enforce multiple coverage thresholds in your JUnit project using JaCoCo: 85% line coverage and 75% branch coverage. Which configuration snippet correctly enforces both thresholds?

hard

A. <rules>
<rule><limit><counter>LINE</counter><value>COVEREDCOUNT</value><minimum>85</minimum></limit></rule>
<rule><limit><counter>BRANCH</counter><value>COVEREDCOUNT</value><minimum>75</minimum></limit></rule>
</rules>

B. <rules>
<rule>
<limits>
<limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>0.85</minimum></limit>
<limit><counter>BRANCH</counter><value>COVEREDRATIO</value><minimum>0.75</minimum></limit>
</limits>
</rule>
</rules>

C. <rules>
<rule><limit><counter>LINE</counter><value>MISSEDCOUNT</value><maximum>0.15</maximum></limit></rule>
<rule><limit><counter>BRANCH</counter><value>MISSEDCOUNT</value><maximum>0.25</maximum></limit></rule>
</rules>

D. <rules>
<rule><limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>0.75</minimum></limit></rule>
<rule><limit><counter>BRANCH</counter><value>COVEREDRATIO</value><minimum>0.85</minimum></limit></rule>
</rules>

Solution

1. Step 1: Check counters and values

   Use LINE and BRANCH counters with COVEREDRATIO values for coverage percentages.

2. Step 2: Verify minimum thresholds and structure

   Minimum values must be decimals (0.85 and 0.75) inside a single rule with multiple limits.

3. Final Answer:

   Rules with LINE and BRANCH counters, COVEREDRATIO values, minimum 0.85 and 0.75 -> Option B

4. Quick Check:

   Multiple limits in one rule with correct decimals [OK]

Hint: Use multiple limits inside one rule with decimals for thresholds [OK]

Common Mistakes:

• Using COVEREDCOUNT with integer minimums instead of decimals
• Swapping threshold values between LINE and BRANCH
• Splitting limits into separate rules incorrectly