Coverage reports in JUnit - Framework Patterns

Framework Mode - Coverage reports

Folder Structure for JUnit Test Project with Coverage

my-java-project/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/
│   │           └── App.java
│   └── test/
│       └── java/
│           └── com/example/app/
│               └── AppTest.java
├── build.gradle (or pom.xml)
├── jacoco.exec (generated after tests)
└── reports/
    └── coverage/
        ├── index.html
        └── jacoco.xml

Test Framework Layers

• Source Code Layer: Application code under src/main/java.
• Test Layer: JUnit test classes under src/test/java.
• Build & Coverage Layer: Build tool (Gradle or Maven) manages compilation, test execution, and coverage collection using JaCoCo plugin.
• Reporting Layer: Coverage reports generated in reports/coverage folder as HTML and XML.
• Utilities Layer: Helper classes or test utilities if needed, usually under src/test/java or separate utility packages.

Configuration Patterns for Coverage Reports

• Build Tool Integration: Use JaCoCo plugin in build.gradle or pom.xml to enable coverage collection.
• Environment Profiles: Configure different profiles or tasks to run tests with or without coverage.
• Browser/Platform: Not applicable for JUnit unit tests but can configure JVM options if needed.
• Credentials: Not required for coverage but keep sensitive data out of reports.
• Report Output Location: Define consistent output folder for coverage reports for easy access and CI integration.

Test Reporting and CI/CD Integration

• Coverage Reports: Generate HTML reports for easy visual inspection and XML reports for CI tools.
• CI Integration: Configure CI pipelines (e.g., Jenkins, GitHub Actions) to run tests and publish coverage reports.
• Fail Builds on Low Coverage: Set coverage thresholds in build config to fail builds if coverage drops below target.
• Report Archiving: Archive coverage reports as build artifacts for historical tracking.
• Notifications: Notify team on coverage changes via CI notifications or dashboards.

Best Practices for Coverage Reports in JUnit Framework

1. Integrate Coverage in Build: Always integrate JaCoCo or similar tool in your build to automate coverage collection.
2. Use Meaningful Thresholds: Set realistic coverage thresholds to encourage quality without blocking progress.
3. Keep Reports Accessible: Store reports in a known folder and publish them in CI for easy team access.
4. Combine Unit and Integration Coverage: Collect coverage from all test types for full picture.
5. Review Coverage Regularly: Use reports to find untested code and improve tests continuously.

Self-Check Question

Where in this folder structure would you add a new JUnit test class for a feature called UserLogin?

Key Result

Use JaCoCo integrated with JUnit tests and build tools to generate and report code coverage automatically.

Practice

1. What is the main purpose of a coverage report in JUnit testing?

easy

A. To show which parts of the code were executed during tests

B. To list all test cases in the project

C. To measure the speed of test execution

D. To generate test data automatically

Solution

1. Step 1: Understand coverage report purpose

   A coverage report shows which lines or branches of code were run during testing.

2. Step 2: Compare options to definition

   Only To show which parts of the code were executed during tests matches this purpose; others describe unrelated features.

3. Final Answer:

   To show which parts of the code were executed during tests -> Option A

4. Quick Check:

   Coverage report = executed code lines [OK]

Hint: Coverage reports highlight tested code lines quickly [OK]

Common Mistakes:

• Confusing coverage with test case listing
• Thinking coverage measures test speed
• Assuming coverage generates test data

2. Which tool is commonly used with JUnit to generate coverage reports?

easy

A. JaCoCo

B. JUnitParams

C. Mockito

D. Selenium

Solution

1. Step 1: Identify coverage tools for JUnit

   JaCoCo is a popular Java code coverage tool that integrates with JUnit.

2. Step 2: Eliminate unrelated tools

   Selenium is for UI testing, Mockito for mocking, JUnitParams for parameterized tests, not coverage.

3. Final Answer:

   JaCoCo -> Option A

4. Quick Check:

   Coverage tool with JUnit = JaCoCo [OK]

Hint: JaCoCo is the go-to coverage tool for Java tests [OK]

Common Mistakes:

• Confusing Selenium with coverage tools
• Mixing mocking frameworks with coverage
• Assuming JUnitParams generates coverage

3. Given this JaCoCo coverage summary:
Lines covered: 80
Lines missed: 20
What is the coverage percentage?

medium

A. 100%

B. 20%

C. 80%

D. 60%

Solution

1. Step 1: Calculate total lines

   Total lines = covered + missed = 80 + 20 = 100 lines.

2. Step 2: Calculate coverage percentage

   Coverage % = (covered / total) * 100 = (80 / 100) * 100 = 80%.

3. Final Answer:

   80% -> Option C

4. Quick Check:

   80 covered of 100 total = 80% [OK]

Hint: Coverage % = covered lines ÷ total lines x 100 [OK]

Common Mistakes:

• Using missed lines as coverage
• Forgetting to add covered and missed for total
• Mixing up numerator and denominator

4. You ran tests with JaCoCo but the coverage report shows 0% coverage. What is the most likely cause?

medium

A. Tests did not execute any code

B. JaCoCo was not properly attached to the test run

C. All tests passed successfully

D. The source code is empty

Solution

1. Step 1: Analyze 0% coverage meaning

   0% coverage means no code was recorded as executed during tests.

2. Step 2: Identify common causes

   If tests ran but coverage is zero, JaCoCo likely was not attached or configured correctly.

3. Final Answer:

   JaCoCo was not properly attached to the test run -> Option B

4. Quick Check:

   0% coverage usually means missing JaCoCo setup [OK]

Hint: Check JaCoCo setup if coverage is zero [OK]

Common Mistakes:

• Assuming tests passed means coverage is full
• Thinking empty source code is common
• Ignoring JaCoCo configuration errors

5. You want to improve your test coverage report by including branch coverage in JaCoCo. Which configuration change is needed?

hard

A. Increase the number of test classes

B. Add @BranchCoverage annotation to test methods

C. Use a different testing framework instead of JUnit

D. Enable branchCoverage option in JaCoCo plugin settings

Solution

1. Step 1: Understand branch coverage

   Branch coverage measures if all decision branches (like if/else) are tested.

2. Step 2: Configure JaCoCo for branch coverage

   JaCoCo supports branch coverage via plugin settings; enabling branchCoverage activates it.

3. Step 3: Eliminate incorrect options

   No annotation @BranchCoverage exists; changing framework or test count doesn't enable branch coverage reporting.

4. Final Answer:

   Enable branchCoverage option in JaCoCo plugin settings -> Option D

5. Quick Check:

   Branch coverage = enable in JaCoCo config [OK]

Hint: Enable branchCoverage in JaCoCo config to track branches [OK]

Common Mistakes:

• Looking for annotations to enable coverage
• Thinking more tests auto-enable branch coverage
• Switching frameworks unnecessarily