Line and branch coverage in JUnit - Framework Patterns

Framework Mode - Line and branch coverage

Folder Structure

project-root/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── Calculator.java
│   └── test/
│       └── java/
│           └── com/example/app/
│               └── CalculatorTest.java
├── build.gradle
├── settings.gradle
└── jacoco.gradle

Test Framework Layers

• Source Code Layer: Contains application code (e.g., Calculator.java).
• Test Layer: Contains JUnit test classes (e.g., CalculatorTest.java) that verify code behavior.
• Coverage Tool Layer: Uses JaCoCo plugin integrated with Gradle to measure line and branch coverage.
• Build and Configuration Layer: Gradle scripts to compile, run tests, and generate coverage reports.
• Reporting Layer: Generates HTML and XML reports showing line and branch coverage details.

Configuration Patterns

• Gradle Build File (build.gradle): Apply JaCoCo plugin and configure test tasks to enable coverage data collection.
• jacoco.gradle: Separate file to configure JaCoCo report formats and thresholds for line and branch coverage.
• Environment Handling: Use Gradle properties or environment variables to switch between local and CI environments.
• Browser/Platform: Not applicable for JUnit unit tests but can be extended for integration tests.
• Credentials: Store sensitive data securely outside the repository, not needed for coverage setup.

Test Reporting and CI/CD Integration

• Generate JaCoCo HTML reports after test execution to visualize line and branch coverage.
• Use XML reports for CI tools like Jenkins, GitHub Actions, or GitLab to fail builds if coverage thresholds are not met.
• Integrate coverage checks in CI pipelines to enforce quality gates on line and branch coverage.
• Publish coverage reports as build artifacts or on dashboards for team visibility.

Best Practices

1. Measure Both Line and Branch Coverage: Line coverage shows which lines ran; branch coverage ensures all decision paths are tested.
2. Set Coverage Thresholds: Define minimum acceptable coverage percentages to maintain code quality.
3. Write Meaningful Tests: Cover edge cases and different branches to improve branch coverage.
4. Automate Coverage Reporting: Integrate with CI to get immediate feedback on coverage changes.
5. Keep Tests Maintainable: Organize tests clearly to easily identify coverage gaps.

Self Check

Where in this framework structure would you add a new test class to improve branch coverage for the Calculator's division method?

Key Result

Use JUnit tests with JaCoCo integration to measure and enforce line and branch coverage in Java projects.

Practice

1. What does line coverage measure in JUnit testing?

easy

A. Whether the program runs without errors

B. Whether all possible input values are tested

C. Whether the test cases run in parallel

D. Whether each line of code is executed during tests

Solution

1. Step 1: Understand line coverage concept

   Line coverage measures if every line of code is executed at least once during testing.

2. Step 2: Compare with other options

   Options A, B, and D describe different testing aspects, not line coverage.

3. Final Answer:

   Whether each line of code is executed during tests -> Option D

4. Quick Check:

   Line coverage = executed lines [OK]

Hint: Line coverage = Did each line run? Check executed lines [OK]

Common Mistakes:

• Confusing line coverage with branch coverage
• Thinking line coverage checks input values
• Assuming line coverage means no errors

2. Which of the following is the correct JUnit annotation to mark a test method for coverage measurement?

easy

A. @Test

B. @Coverage

C. @RunCoverage

D. @Measure

Solution

1. Step 1: Recall JUnit test annotation

   The standard annotation to mark a test method in JUnit is @Test.

2. Step 2: Verify other options

   Annotations like @Coverage, @RunCoverage, and @Measure do not exist in JUnit.

3. Final Answer:

   @Test -> Option A

4. Quick Check:

   JUnit test method = @Test [OK]

Hint: JUnit test methods always use @Test annotation [OK]

Common Mistakes:

• Assuming coverage requires special annotation
• Using non-existent annotations
• Confusing coverage tools with JUnit annotations

3. Consider this Java method tested with JUnit:

public int max(int a, int b) {
  if (a > b) {
    return a;
  } else {
    return b;
  }
}

If your tests only call max(5, 3), what coverage is achieved?

medium

A. 100% line coverage, 100% branch coverage

B. 100% line coverage, 50% branch coverage

C. 50% line coverage, 100% branch coverage

D. 50% line coverage, 50% branch coverage

Solution

1. Step 1: Analyze lines executed by max(5, 3)

   Calling max(5, 3) executes the if condition and return a;, as well as the else block's closing brace, so all lines are executed, resulting in 100% line coverage.

2. Step 2: Analyze branches covered

   Only the 'if' branch (a > b true) is taken; the 'else' branch is not tested, so 50% branch coverage.

3. Final Answer:

   100% line coverage, 50% branch coverage -> Option B

4. Quick Check:

   One path = full line coverage, partial branch coverage [OK]

Hint: Test all if-else paths for full branch coverage [OK]

Common Mistakes:

• Thinking one test achieves 100% line coverage
• Confusing line coverage with branch coverage
• Ignoring else branch execution

4. You wrote tests for this method:

public boolean isPositive(int n) {
  if (n > 0) {
    return true;
  }
  return false;
}

But coverage report shows branch coverage less than 100%. What is the likely cause?

medium

A. Tests never call with n ≤ 0, missing else branch coverage

B. Tests have syntax errors causing incomplete runs

C. JUnit does not support branch coverage

D. Method has no branches to cover

Solution

1. Step 1: Identify branches in method

   The method has two branches: if (n > 0) true, else false.

2. Step 2: Understand branch coverage less than 100%

   If tests never call with n ≤ 0, the else branch is not executed, lowering branch coverage.

3. Final Answer:

   Tests never call with n ≤ 0, missing else branch coverage -> Option A

4. Quick Check:

   Branch coverage needs both if and else tested [OK]

Hint: Test both true and false conditions for full branch coverage [OK]

Common Mistakes:

• Assuming syntax errors cause coverage issues
• Believing JUnit lacks branch coverage support
• Ignoring else branch execution

5. Given this method:

public int classify(int x) {
  if (x > 0) {
    if (x % 2 == 0) {
      return 1;
    } else {
      return 2;
    }
  } else {
    return 3;
  }
}

What is the minimum number of JUnit test cases needed to achieve 100% line and branch coverage?

hard

A. 4

B. 2

C. 3

D. 5

Solution

1. Step 1: Identify branches

   There are three branches: outer if (x > 0) true and false, and inner if (x % 2 == 0) true and false.

2. Step 2: Determine test cases to cover all branches

   Tests needed: one with x > 0 and even (return 1), one with x > 0 and odd (return 2), and one with x ≤ 0 (return 3).

3. Final Answer:

   3 -> Option C

4. Quick Check:

   Three tests cover all branches and lines [OK]

Hint: Cover all if-else paths with minimal tests [OK]

Common Mistakes:

• Thinking two tests cover all branches
• Ignoring nested if branches
• Overestimating tests needed