apache/pinot

Increase code coverage

Open

#5,150 opened on Mar 13, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (1,234 forks)batch import
good first issue

Repository metrics

Stars
 (4,937 stars)
PR merge metrics
 (Avg merge 6d 7h) (186 merged PRs in 30d)

Description

Currently the code coverage of pinot repo is just around 50% (Link). This issue tracks the status of increasing code coverage.

The following modules currently have less than 50% code coverage or don't have any test at all:

  1. pinot-clients/pinot-java-client (46.15%)
  2. pinot-common (47.96%)
  3. pinot-plugins (36.38%) No code coverage:
  • pinot-plugins/pinot-batch-ingestion/pinot-batch-ingestion-common
  • pinot-plugins/pinot-batch-ingestion/pinot-batch-ingestion-hadoop
  • pinot-plugins/pinot-batch-ingestion/pinot-batch-ingestion-spark
  • pinot-plugins/pinot-batch-ingestion/pinot-batch-ingestion-stadardalone
  • pinot-plugins/pinot-file-system/pinot-gcs
  • pinot-plugins/pinot-file-system/pinot-hdfs

The rest of the modules shown below seems fine but we should still bring them to at least 75%. pinot-broker (76.6%) pinot-controller (63.29%) pinot-core (76.85%) pinot-minion (68.98%) pinot-server (67.05%) pinot-spi (68.84%)

Contributor guide

Research direction
Choose a module with low code coverage (e.g., pinot java client) and write unit tests for its untested classes. Refer to existing tests in other modules for style and structure.
Tech stack
java
Domain
backenddata
Issue type
Test
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.
3-5 days
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.
Clear
Prerequisites
JavaJUnit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60