fix: protect qdocco source files - #41
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR hardens the qdocco CLI against accidentally overwriting its input source by rejecting output paths that resolve to the same file (including via symlinks), and codifies the safety contract in both tests and RFC documentation.
Changes:
- Add a
same_path()guard inqdoccoto reject output paths that match the input source after canonicalization (exit code2). - Add a CLI regression test covering the “output equals input” overwrite scenario.
- Document the safety contract in RFC 0083.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
tests/cli_tools.rs |
Adds a regression test to ensure qdocco -o cannot overwrite the input source file. |
src/bin/qdocco.rs |
Introduces a canonicalized path equality check to prevent input source overwrites. |
RFCs/0083-qdocco-markdown.md |
Documents the “output must differ from input (incl. symlink)” contract as part of the CLI spec. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
tiye
force-pushed
the
perf/core-rfc0100-workload
branch
from
August 23, 2026 04:50
0c1c326 to
5facc10
Compare
Base automatically changed from
perf/core-rfc0100-workload
to
feat/program-fingerprint
August 23, 2026 04:51
tiye
force-pushed
the
fix/qdocco-source-overwrite
branch
from
August 23, 2026 04:53
b063f9f to
75e5189
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
make checkgit diff --checkThis PR is chained after PR #40 and is intentionally not merged automatically.