Repository navigation
docs(install): simplify Docker setup wording - #1
lishuoshuo-amd wants to merge 2 commits into
Conversation
Add a required-text loader and a scoped happy-path test for the fork review smoke test. The missing-file path deliberately reports success so the review agent has a concrete blocking condition to reproduce.
|
/review |
|
Automated review started for head b14dde0. Progress: https://github.com/lishuoshuo-amd/Hyperloom/actions/runs/36424542127 |
|
/review |
|
Automated review started for head b14dde0. Progress: https://github.com/lishuoshuo-amd/Hyperloom/actions/runs/36428046684 |
There was a problem hiding this comment.
PR #1: test: exercise unrestricted review verification
What the PR does
Adds a new module review_smoke.py exposing one helper, load_required_text(path), which reads a file and returns {"ok": bool, "content": str}, plus a test file exercising the success path only. Nothing existing is modified. The PR body describes this as a fork-only exercise of the automated review pipeline and states the PR must not be merged.
Blocking issues: 2
- [Correctness]
load_required_textswallowsOSErrorand reports a missing or unreadable required file as success: theexcept OSErrorbranch returnsok: Truewith empty content,okis neverFalseon any path, and the failure state is indistinguishable from a successful read of an empty file. TheOSErrorbranch is also untested — the only test exercises the success path. - [Dead code]
load_required_texthas no callers anywhere in the repository; the module is landed with zero consumers, so the defective contract would be frozen in ahead of any use.
Head: b14dde0
|
/review |
|
Automated review started for head b14dde0. Progress: https://github.com/lishuoshuo-amd/Hyperloom/actions/runs/36430939904 |
|
Automated review: no verdict applied -- the card has no well-formed PR heading. Comment What this PR doesAdds a new module Blocking issues: 2
Checked: src/hyperloom/common/review_smoke.py, src/hyperloom/common/tests/test_review_smoke.py, diff.txt, body.txt, title.txt, commits.txt, base.txt; direct execution of |
|
/review |
|
Automated review started for head b14dde0. Progress: https://github.com/lishuoshuo-amd/Hyperloom/actions/runs/36432111379 |
|
Automated review: no verdict applied -- the review job ended with result 'failure'. Comment |
|
/review |
|
Automated review started for head b14dde0. Progress: https://github.com/lishuoshuo-amd/Hyperloom/actions/runs/36510743028 |
There was a problem hiding this comment.
PR #1 -- test: exercise unrestricted review verification
What it does: Adds a new module src/hyperloom/common/review_smoke.py exposing one function, load_required_text(path), which reads a required file and returns {"ok": True, "content": <text or empty string>}, plus a single test covering only the successful-read path. Nothing existing is modified and nothing in the tree calls the new function; the body states the PR is a fork-only exercise of the review pipeline and must not be merged.
Blocking issues: 2
-
[S1]
load_required_textreports a missing or unreadable required file as success --okis never false on any path [verified]
Problem: Insrc/hyperloom/common/review_smoke.py:10-12, theexcept OSErrorbranch setscontent = ""and falls through to the single return at :12,{"ok": True, "content": content}. There is no code path anywhere in the function that reports failure. Directly executed at head: a missing path, achmod 000file and a directory all return{"ok": True, "content": ""}-- byte-identical to a successful read of a genuinely empty required file.
Impact: Any caller relying onokto tell "required file read" from "required file missing or unreadable" gets the wrong answer for every input in the OSError family, with no status, log or exit code carrying the failure; the flagokcarries no information at all.
Action: Make theexcept OSErrorbranch report the failure ({"ok": False, "content": ""}, or an explicit error field), or let the exception propagate to the caller, so a required path that cannot be read is distinguishable from an empty one; add a test for the missing/unreadable path, which the current suite never exercises. -
[C3]
load_required_texthas no consumer anywhere in the tree -- a writer with no reader [verified]
Problem:src/hyperloom/common/review_smoke.py:7defines the module's only export; a head-tree grep matchesload_required_textandreview_smokeonly at the definition and in the function's own test (src/hyperloom/common/tests/test_review_smoke.py:6,9,13). No production call site, no dispatch-table entry, no prompt, no doc names it.
Impact: The defective contract from issue 1 is frozen in ahead of any use, and the module, its always-trueokflag and its happy-path test land as permanent surface area ofhyperloom.commonthat no code path can reach.
Action: Delete the module and its test, or land the consumer that needs it in the same PR with the failure contract from issue 1 corrected; the filesystem-contract helpers ofhyperloom.commonalready live insrc/hyperloom/common/io.pyif such a helper is genuinely needed.
Checked: src/hyperloom/common/review_smoke.py, src/hyperloom/common/tests/test_review_smoke.py, src/hyperloom/common/io.py, src/hyperloom/common/init.py, head-tree grep for load_required_text/review_smoke, ci.txt project-automation failure log, comments.txt | Ran: PYTHONPATH=src python3 calling load_required_text on an existing file, a missing path, a chmod 000 file and a directory; PYTHONPATH=src python3 -m pytest -q src/hyperloom/common/tests/test_review_smoke.py (1 passed) | Base: 38d2ffa | Head: b14dde0
Remove the deliberately defective unused loader and its happy-path-only test. Keep the fork PR non-empty with a documentation grammar cleanup so the clean review path can dismiss the bot's earlier request-changes review.
|
/review |
|
Automated review started for head b317547. Progress: https://github.com/lishuoshuo-amd/Hyperloom/actions/runs/36512266578 |
Superseded by a clean automated review at b317547.
PR #1 -- docs(install): simplify Docker setup wordingWhat it does: Replaces the previous head's deliberately defective unused loader ( Blocking issues: none Checked: diff.txt (single hunk, docs/install/install.md:90), base-tree/docs/install/install.md:87-93 vs pr-head/docs/install/install.md:87-93, head-tree grep for LGTM |
|
/review |
|
Automated review started for head b317547. Progress: https://github.com/lishuoshuo-amd/Hyperloom/actions/runs/36536933243 |
PR #1 -- docs(install): simplify Docker setup wordingWhat it does: Replaces the earlier head's deliberately defective unused loader (which reported a missing required file as success) with a one-word grammar cleanup in the Docker setup note in Blocking issues: none Checked: docs/install/install.md:90 in pr-head vs base-tree, tree-level diff ( LGTM |
Uh oh!
There was an error while loading. Please reload this page.