facebookresearch/hydra

Improving the test coverage in Hydra

Open

#802 opened on Jul 21, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Python (7,539 stars) (608 forks)batch import
help wantedmaintenance

Description

We need to start working on improving the test coverage in Hydra. There are some roadblocks like how to ensure examples coverage is properly accounted for.

Originally posted by @omry in https://github.com/facebookresearch/hydra/pull/800#discussion_r457554277

Steps:

  1. Calculate the current coverage.

Contributor guide

Tech stack
python
Domain
testing
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Pythonpytestcoverage tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Calculate current coverage using a tool like pytest cov. Identify uncovered branches and write tests to cover them. Refer to the existing test structure in the tests/ directory and the discussion in the linked PR #800 for context on examples coverage.