apache/beam

Code coverage numbers are not accurate

Open

#18,194 opened on Jun 3, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (4,097 forks)batch import
P3bugbuildcoregood first issuejavatests

Repository metrics

Stars
 (7,313 stars)
PR merge metrics
 (Avg merge 6d) (243 merged PRs in 30d)

Description

We've started adding Java Code Coverage numbers to PRs using the jacoco gradle plugin.

When we ran this in Maven, we got very low coverage reported for things like the Java SDK core. This was likely because we test the bulk of the SDK not in the SDK module, but in fact in the DirectRunner and other similar modules.

This is the still the case in gradle. So we'll need to make sure to watch for it.

This is a good "random improvement" issue for anyone to pick up.

Imported from Jira BEAM-1399. Original Jira may contain additional context. Reported by: dhalperi.

Contributor guide

Research direction
Investigate how code coverage is measured for Java modules in Apache Beam, particularly for the SDK core that is tested in other modules like DirectRunner, and propose adjustments to the jacoco configuration to include all relevant test sources.
Tech stack
java
Domain
backendtesting qa
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaGradle
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65