test coverage - #43

• Add pytest-cov to dev dependencies for local/CI coverage measurement.
• Run pytest with coverage reporting and fail CI below 90% threshold.
• Surface missing lines in CI output to guide test additions.

graph TD
  CI[".github/workflows/cicd.yml"] --> DevDeps["requirements-dev.txt"] --> Pytest["pytest"] --> Cov["pytest-cov"] --> Gate{"Coverage >= 90%"}
  Cov --> Package["Algorithms package"]

Loading

The following are alternative approaches to this PR:

1. Move coverage args into pyproject.toml / pytest.ini

• ➕ Single source of truth for local + CI runs
• ➕ Shorter CI commands; easier to evolve options
• ➖ Less obvious from the workflow alone what CI enforces
• ➖ Requires adding/maintaining additional config file entries

2. Add a dedicated coverage job/artifact upload (e.g., Codecov)

• ➕ Richer historical reporting and PR annotations
• ➕ Can keep CI pass/fail separate from reporting concerns
• ➖ Adds external dependency/service configuration
• ➖ More moving parts than an inline fail-under gate

Recommendation: The current approach (inline pytest-cov invocation with --cov-fail-under) is the simplest way to enforce a hard coverage gate in CI. If the team expects to tune coverage settings frequently or wants parity with local runs, consider moving the coverage flags into project config (pyproject.toml/pytest.ini) while keeping CI as the enforcement point.

Other (2) +7 / -3

cicd.ymlRun pytest with coverage and enforce 90% minimum in CI +3/-2

Run pytest with coverage and enforce 90% minimum in CI

• Updates the CI workflow to run pytest with pytest-cov enabled. Adds terminal missing-line reporting and fails the job if coverage is below 90%.

.github/workflows/cicd.yml

requirements-dev.txtAdd pytest-cov to development requirements +4/-1

Add pytest-cov to development requirements

• Adds pytest-cov as a dev dependency for coverage measurement. Also fixes the missing trailing newline in the file.

requirements-dev.txt

Description

CI now enforces --cov-fail-under=90 for Algorithms, but the current tests import modules that
contain significant method bodies that are never exercised (e.g., RandomizedCollection in
hash_table.py), which will reduce measured coverage and make the new gate prone to failing until
those lines are tested or excluded.

Code

.github/workflows/cicd.yml[R29-31]

+      - name: Run tests with coverage
+        run: |
+          pytest -q --cov=Algorithms --cov-report=term-missing --cov-fail-under=90

Evidence

The workflow change introduces a hard 90% coverage gate. The test suite imports
Algorithms.datastructs.hash_table.hash_table, but only tests RandomizedSet; the same imported
module also defines RandomizedCollection and there are no test references to it anywhere, so its
method bodies remain uncovered and reduce coverage once enforced. Similarly, the imported cache.py
and bucket_hash_table.py define __str__/__repr__ helpers that are not called anywhere in
tests/, leaving more uncovered lines under the same --cov=Algorithms measurement scope.

.github/workflows/cicd.yml[23-32]
tests/algorithms/test_hash_table.py[1-40]
Algorithms/datastructs/hash_table/hash_table.py[1-66]
tests/algorithms/test_cache.py[1-127]
Algorithms/datastructs/hash_table/cache.py[1-100]
tests/algorithms/test_bucket_hash_table.py[1-120]
Algorithms/datastructs/hash_table/bucket_hash_table.py[7-105]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The workflow now runs pytest with coverage enforcement (`--cov-fail-under=90`). Several modules under `Algorithms/` that are imported by the existing tests contain code that is never executed by those tests (e.g., an entire extra class in `hash_table.py`, plus `__str__`/`__repr__` helpers), which reduces measured coverage and makes the 90% gate brittle.

## Issue Context
- `pytest-cov` measures executed vs. non-executed lines in imported source files under the specified `--cov` source.
- Current tests import these modules, but do not call the identified functions/methods, so their bodies remain uncovered.

## Fix Focus Areas
- .github/workflows/cicd.yml[29-31]
- Algorithms/datastructs/hash_table/hash_table.py[33-66]
- Algorithms/datastructs/hash_table/cache.py[60-66]
- Algorithms/datastructs/hash_table/bucket_hash_table.py[7-18]
- tests/algorithms/test_hash_table.py[1-40]
- tests/algorithms/test_cache.py[1-127]
- tests/algorithms/test_bucket_hash_table.py[1-120]

## What to change
Pick one (or combine):
1. **Add tests** that exercise `RandomizedCollection` and the `__str__`/`__repr__` helpers (simple smoke tests calling these methods is sufficient).
2. **Exclude intentionally-non-critical lines** from coverage (e.g., add `# pragma: no cover` to `__repr__`/`__str__`, or configure coverage omission via a config file).
3. **Adjust the gate scope/threshold** to match what is realistically covered today (e.g., lower `--cov-fail-under` or target a narrower `--cov` source until coverage is expanded).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools