tweag / tweag/cooked-validators

Improve test coverage

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

Nobody has claimed this yet.

Dominant language
Haskell
Stars
44
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Test coverage in cooked-validators is now tracked whenever somebody runs cabal test all. By taking a look at the coverage log produced by the command we notice that:

  • current test coverage is decent and covers a huge chunk of the codebase (48% total) with a few modules with a 100% coverage rate.
  • current test coverage is still not enough thought, with some modules with 0% coverage and some others with important features lacking coverage.

image
We need to bump these numbers. This would be unrealistic to aim for 100% coverage overall, but important features should be handled and this report should be used in that purpose.

Contributor guide

Open the contributing guide

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 running cabal test all and reviewing the coverage log for cooked-validators. Identify modules with 0% coverage and important features lacking tests, then add focused coverage for those areas. Done means the selected important features are covered and the report shows improved results without aiming for 100% overall.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
testing-qa
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.