Skip to content

docs: state the c64-test-harness prerequisite on the UCI path (#90) - #91

Merged
JC-000 merged 1 commit into
masterfrom
docs/uci-test-prereqs
Aug 14, 2026
Merged

docs: state the c64-test-harness prerequisite on the UCI path (#90)#91
JC-000 merged 1 commit into
masterfrom
docs/uci-test-prereqs

Conversation

@JC-000

Copy link
Copy Markdown
Owner

Closes#90.

A contributor built with make BACKEND=uci, ran a tools/uci/ script, and got:

ModuleNotFoundError: No module named 'c64_test_harness'

This is a documentation gap, not a bug. The instruction exists — README.md:155 has pip install -e ../c64-test-harness — but it lives in the general VICE testing section. Neither the "Ultimate 64 Elite Hardware Tests" section nor CLAUDE.md's "UCI test scripts" section mentions it; both go straight from make BACKEND=uci to invoking scripts. Someone following the UCI path never crosses the line that would have told them.

That is the same shape as the ip65-c64.bin report fixed in #89 an hour earlier: the information is present in the repo, just not on the path the reader is actually walking. Two independent newcomers, two setup walls, both from following a documented route with a prerequisite documented elsewhere.

What this adds

To both UCI sections:

  • the harness is a separate public repo, not vendored (requirements.txt carries only cryptography, which is why the wall isn't obvious)
  • the clone + pip install -e ../c64-test-harness commands
  • the exact error it prevents, so searching for the traceback finds the fix
  • install into the same interpreter you run the scripts with — the reporter invoked plain python3, and a venv mismatch reproduces the identical failure after an install that appears to succeed

🤖 Generated with Claude Code

A contributor built with `make BACKEND=uci`, ran a tools/uci/ script,
and hit ModuleNotFoundError: No module named 'c64_test_harness'.
The instruction existed — README.md's VICE testing section has
`pip install -e ../c64-test-harness` — but neither the "Ultimate 64
Elite Hardware Tests" section nor CLAUDE.md's "UCI test scripts"
section mentioned it. Both go straight from `make BACKEND=uci` to
invoking scripts, so someone on the UCI path never crosses the line
that would have told them. Same shape as the ip65 blob report: the
information exists, just not on the path the reader is walking.
Adds to both UCI sections: the harness is a separate public repo (not
vendored; requirements.txt carries only cryptography), the clone +
`pip install -e` commands, the exact error it prevents, and the note
that it must go into the same interpreter used to run the scripts —
a venv mismatch reproduces the identical failure after an install that
looks successful.
Reported-by: Armitage64
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Module c64_test_harness missing when running UCI test scripts

1 participant

@JC-000