Document how to run the tests in tests/README.md #26

New issue

Closed

opened 2026-10-03 10:59:14 -03:00 by marcos-mendez · 1 comment

marcos-mendez commented

2026-10-03 10:59:14 -03:00

(Migrated from github.com)

Context
confconsole has more than 900 tests, but nothing tells a new contributor how to run them. keel, inithooks, keel-core and keel-web each have a tests/README.md; confconsole does not, and README.rst still describes only the TurnKey usage.

What to do

Create tests/README.md that explains:
- What is needed (Python 3.13, pytest, coverage, pyyaml) and that no root, network or real console is needed (see the docstring of tests/conftest.py: netinfo and dialog are stubbed).
- The commands, as CI runs them:
```
PYTHONPATH=. python -m coverage run --branch --source=<modules> -m pytest -q tests
python -m coverage report --show-missing
```
  with the module list copied from package: in .github/workflows/tests.yml.
- The threshold (100 percent for measured modules) and where the plan lives (COVERAGE.md).
- One line per test file group (network, Keel screens, Let's Encrypt, and so on).
Add a short "Tests" section to README.rst that links to tests/README.md.
Follow the commands from a clean clone yourself and fix anything the README gets wrong.

Done when
A person who has never seen the repository can run the full suite and the coverage report by following tests/README.md alone, and README.rst links to it.

Help
Ask in https://github.com/orgs/Keel-Linux/discussions

**Context** confconsole has more than 900 tests, but nothing tells a new contributor how to run them. keel, inithooks, keel-core and keel-web each have a `tests/README.md`; confconsole does not, and `README.rst` still describes only the TurnKey usage. **What to do** 1. Create `tests/README.md` that explains: - What is needed (Python 3.13, `pytest`, `coverage`, `pyyaml`) and that no root, network or real console is needed (see the docstring of `tests/conftest.py`: `netinfo` and `dialog` are stubbed). - The commands, as CI runs them: ``` PYTHONPATH=. python -m coverage run --branch --source=<modules> -m pytest -q tests python -m coverage report --show-missing ``` with the module list copied from `package:` in `.github/workflows/tests.yml`. - The threshold (100 percent for measured modules) and where the plan lives (`COVERAGE.md`). - One line per test file group (network, Keel screens, Let's Encrypt, and so on). 2. Add a short "Tests" section to `README.rst` that links to `tests/README.md`. 3. Follow the commands from a clean clone yourself and fix anything the README gets wrong. **Done when** A person who has never seen the repository can run the full suite and the coverage report by following `tests/README.md` alone, and `README.rst` links to it. **Help** Ask in https://github.com/orgs/Keel-Linux/discussions

Nandika-Gupta commented

2026-10-03 11:35:53 -03:00

(Migrated from github.com)

Hi @marcos-mendez, I'd like to work on this. I'll add tests/README.md and a "Tests" section in README.rst, and check the commands. Could you assign it to me?