leap-stc / leap-stc/ClimSim

Increase unit test coverage of `data_utils` to > 95%

Open
#24 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
164
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Our current test coverage of climsim_utils.data_utils is 12%, as seen here:

https://github.com/leap-stc/ClimSim/actions/runs/5898192566/job/15998878076#step:5:43

That is not surprising because our only test is a smoke test for importability:

https://github.com/leap-stc/ClimSim/blob/f7d092cbaf57d79d47fa56dc0fd3e00a391da696/tests/test_data_utils.py#L5-L6

We should increase unit test coverage of data_utils to establish a benchmark of functionality before attempting any refactoring, such as proposed in #17. 95% or greater coverage would be a strong basis to shoot for.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading climsim_utils.data_utils and the existing smoke test in tests/test_data_utils.py. Use the linked CI coverage result as the baseline, then add unit tests for the module's behavior until coverage reaches at least 95%, confirming the result through the project's test coverage workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.