test(cli): unit-test looks_like_uuid + parse_with_uuid_fallback#72
Closed
Mikola Lysenko (mikolalysenko) wants to merge 2 commits into
Closed
test(cli): unit-test looks_like_uuid + parse_with_uuid_fallback#72Mikola Lysenko (mikolalysenko) wants to merge 2 commits into
Mikola Lysenko (mikolalysenko) wants to merge 2 commits into
Conversation
Sets up the foundation for a comprehensive unit-test campaign on the
socket-patch CLI. No behavior change to the binary.
Two changes:
1. Expose the clap parser as a library so integration tests can verify
the public CLI contract without spawning the binary:
- new crates/socket-patch-cli/src/lib.rs hosting Cli, Commands,
looks_like_uuid, and parse_with_uuid_fallback (extracted from main.rs)
- Cargo.toml gains [lib] entry alongside the existing [[bin]]
- main.rs is now a thin wrapper that delegates to the lib
2. De-duplicate the manifest-path resolution block that was copy-pasted
into 5 commands (apply, rollback, list, remove, repair). New helper
socket_patch_core::manifest::operations::resolve_manifest_path
handles the absolute-vs-relative join in one place, with 3 unit tests.
3. New CLI_CONTRACT.md next to the crate documenting every subcommand,
flag, default, alias, JSON shape, and exit code as semver-significant
surface. Adds a comment block above pub enum Commands pointing to it
so anyone editing the parser sees the contract reminder.
Verified: cargo build/clippy/test --workspace --all-features all clean
(415 unit tests pass, including 3 new resolve_manifest_path tests).
Foundation for follow-up PRs that add the per-command parser snapshot
tests and helper unit tests.
Assisted-by: Claude Code:claude-opus-4-7
Mikola Lysenko (mikolalysenko)
force-pushed
the
tests/cli-contract-foundation
branch
from
0bd4f50 to
6cb84b8
Compare
Add inline #[cfg(test)] coverage for the bare-UUID fallback in src/lib.rs — case-insensitive shape predicate, the get-rewrite shortcut, no-double-rewrite invariant, and original-error preservation when the rewrite parse also fails. Add a new tests/cli_parse_main.rs integration suite that locks down the top-level Cli parser: --help / --version / no-subcommand / unknown-subcommand error kinds, every subcommand name, and the download/gc visible aliases. Assisted-by: Claude Code:claude-opus-4-7
Mikola Lysenko (mikolalysenko)
force-pushed
the
tests/cli-parse-main
branch
from
301691c to
ab0b1ac
Compare
Mikola Lysenko (mikolalysenko)
force-pushed
the
tests/cli-contract-foundation
branch
from
6cb84b8 to
ef0deac
Compare
Contributor
Author
|
Squashed into #68. All tests from this PR are now part of the single combined commit on |
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
1 participant
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
Locks in two of the most fragile undocumented surfaces in the
socket-patchCLI: the bare-UUID rewrite shortcut(
socket-patch <UUID>→socket-patch get <UUID>) and thetop-level
Cliparser. Until now nothing guarded either —a flag rename or a subcommand-alias drop could land green and
break every shipped wrapper silently.
This PR is part of the CLI-contract unit-test campaign on top of
PR #67 (
tests/cli-contract-foundation).Coverage
src/lib.rs::tests(inline) — 13 testslooks_like_uuid:truefalse8-4-4-4-13and7-4-4-4-12group-length variants returnfalsefalsefalsefalse----, five empty groups) returnfalseparse_with_uuid_fallback:socket-patch <UUID>rewrites toCommands::Get { identifier }socket-patch <UUID> --jsonforwards the flag to the synthesizedgetsocket-patch not-a-uuidreturns the ORIGINAL clap error(
InvalidSubcommand), no rewrite attemptedsocket-patch listparses normally — fallback never runssocket-patch get <UUID>already parses — no double-rewritesocket-patch <UUID> --invalid-flagsurfaces the originalInvalidSubcommanderror (not the rewrite'sUnknownArgument)tests/cli_parse_main.rs(integration) — 14 testsTop-level error kinds:
DisplayHelpOnMissingArgumentOrSubcommand--version→DisplayVersion--help→DisplayHelpInvalidSubcommandEvery subcommand name in the contract parses (Apply, Rollback,
Get, Scan, List, Remove, Setup, Repair) with the right
positional-arg requirements (Get/Remove need
<identifier>;Rollback's
identifieris optional; the rest take none).Visible aliases prove out:
socket-patch download <id>parses asCommands::Getsocket-patch gcparses asCommands::RepairContract sections locked in
CLI_CONTRACT.md— "Subcommands" table (all 8 names + thedownload/gcvisible aliases)CLI_CONTRACT.md— "Bare-UUID fallback" paragraph (the8-4-4-4-12 case-insensitive predicate and the rewrite shortcut)
Test plan
cargo build --workspace --all-featurescleancargo clippy --workspace --all-features -- -D warningscleancargo test --workspace --all-features --lib --tests— all pass(415 core + 17 cli lib + 14 cli_parse_main + e2e suites)
Assisted-by: Claude Code:claude-opus-4-7