test(cli): pin RemoveArgs/SetupArgs flag surface + run() error paths#78
Closed
Mikola Lysenko (mikolalysenko) wants to merge 2 commits into
Closed
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
Adds two parser-snapshot integration test files that lock in every flag
in the `remove` and `setup` tables of CLI_CONTRACT.md (long + short
forms, defaults) plus the documented no-network exit paths:
- crates/socket-patch-cli/tests/cli_parse_remove.rs (16 tests):
defaults with PURL or UUID positional, every flag in long + short form
(`-y`/`--yes`, `-g`/`--global`, `-m`/`--manifest-path`, `--cwd`,
`--skip-rollback`, `--json`, `--global-prefix`), an all-flags-combined
case, missing-positional → MissingRequiredArgument, unknown flag →
UnknownArgument, and an async `run()` against an empty tempdir
asserting exit code 1 for missing manifest.
- crates/socket-patch-cli/tests/cli_parse_setup.rs (11 tests):
defaults, every flag in long + short form (`-d`/`--dry-run`,
`-y`/`--yes`, `--cwd`, `--json`), all-flags-combined, unknown flag →
UnknownArgument, an async `run()` against an empty tempdir asserting
exit 0, and a subprocess test using `env!("CARGO_BIN_EXE_socket-patch")`
that parses the `--json` output and asserts the documented
`status: "no_files"` shape (updated/alreadyConfigured/errors all 0,
files == []).
Both files are net-new and test-only — no production code touched.
Verified from /tmp/spw/remove-setup:
- cargo build --workspace --all-features: clean
- cargo clippy --workspace --all-features -- -D warnings: clean
- cargo test --workspace --all-features --lib --tests: 415 lib + 16
cli_parse_remove + 11 cli_parse_setup + all existing pass
Assisted-by: Claude Code:claude-opus-4-7
Mikola Lysenko (mikolalysenko)
force-pushed
the
tests/cli-parse-remove-setup
branch
from
da64192 to
8d3866f
Compare
Mikola Lysenko (mikolalysenko)
added a commit
that referenced
this pull request
May 20, 2026
Add unit-test coverage for every subcommand, flag, default, alias, and
helper in the socket-patch CLI, plus a new CLI_CONTRACT.md that documents
the surface as semver-significant.
Before this change the CLI crate had zero unit tests under src/ —
only network-dependent tests/e2e_*.rs suites gated on --ignored. A flag
rename, a default change, or a JSON key drift could land green and break
every shipped wrapper (npm @socketsecurity/socket-patch, pypi
socket-patch, cargo, prebuilt binaries).
## What's covered
Library surface (new src/lib.rs):
- Cli, Commands, looks_like_uuid, parse_with_uuid_fallback extracted
from main.rs so integration tests can verify the parser without
spawning the binary.
- main.rs becomes a thin wrapper that delegates to the lib.
- Cargo.toml gains [lib] alongside [[bin]].
Core helper extraction:
- socket_patch_core::manifest::operations::resolve_manifest_path
replaces the 5-line absolute-vs-relative join block previously
copy-pasted into apply/rollback/list/remove/repair (5 callers).
CLI_CONTRACT.md (new):
- Documents every subcommand, flag, default value, visible alias
(download, gc), hidden alias (--no-apply), JSON output shape, and
exit code as semver-significant.
- Pins the divergent defaults: --download-mode=diff for apply/get/scan
and --download-mode=file for repair, --batch-size=100 for scan.
- Spells out the bump policy and how to invoke scripts/version-sync.sh.
Helper unit tests (#[cfg(test)] mod tests in each file):
- src/lib.rs — looks_like_uuid (valid/invalid shapes, case-insensitive),
parse_with_uuid_fallback (success, fallback, fallback-fails preserves
original error, no double-rewrite).
- src/output.rs — format_severity, color, confirm (skip_prompt and
is_json short-circuits; interactive path intentionally not tested).
- src/ecosystem_dispatch.rs — partition_purls (filter, dedup, unknown
ecosystem dropped).
- commands/apply.rs — verify_status_str (all 4 VerifyStatus variants),
result_to_json (top-level + filesVerified key sets).
- commands/rollback.rs — find_patches_to_rollback (None=all, PURL match,
UUID match, no-match=empty).
- commands/get.rs — detect_identifier_type (UUID/CVE/GHSA/PURL/None,
case-insensitive for CVE+GHSA), select_patches (paid auto, free
single auto, free multi+is_json -> Err(1)).
Clap parser snapshot tests (new tests/cli_parse_*.rs):
- One file per command: apply, get, list, main, remove, repair,
rollback, scan, setup.
- Every flag (long + short) has at least one parser assertion.
- Every #[arg(default_value)] is asserted on the no-flag parse.
- The download visible alias on get is exercised.
- The gc visible alias on repair is exercised.
- The hidden --no-apply alias on get --save-only is exercised.
- --ecosystems CSV splitting is verified on apply/rollback/scan.
- The bare-UUID rewrite is exercised end-to-end via Cli::try_parse_from.
- Failure paths assert clap::error::ErrorKind variants.
Async run() integration tests:
- tests/cli_parse_list.rs covers missing manifest -> 1, empty -> 0,
populated -> 0, absolute-path override, and a subprocess JSON-shape
assertion against the compiled binary.
- tests/cli_parse_remove.rs covers missing-manifest -> 1.
- tests/cli_parse_setup.rs covers no-package-json -> 0 with the
JSON status:"no_files" shape pinned via subprocess.
## Verification
cargo build --workspace --all-features
cargo clippy --workspace --all-features -- -D warnings
cargo test --workspace --all-features
All clean. 79 new lib tests + 156 new integration tests added on top of
the existing 415 unit tests; cumulative 650 tests pass.
## Why squashed
Originally landed as a foundation PR (#68) plus 10 sibling test PRs
(#69-#78), one per command/file, dispatched in parallel. Squashing the
sibling PRs back into #68 so the contract + tests land as one
self-contained unit — reviewers see the full picture, and a future
revert touches one commit instead of eleven.
Assisted-by: Claude Code:claude-opus-4-7
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 |
Mikola Lysenko (mikolalysenko)
added a commit
that referenced
this pull request
May 20, 2026
* test(cli): comprehensive unit-test campaign for the CLI contract
Add unit-test coverage for every subcommand, flag, default, alias, and
helper in the socket-patch CLI, plus a new CLI_CONTRACT.md that documents
the surface as semver-significant.
Before this change the CLI crate had zero unit tests under src/ —
only network-dependent tests/e2e_*.rs suites gated on --ignored. A flag
rename, a default change, or a JSON key drift could land green and break
every shipped wrapper (npm @socketsecurity/socket-patch, pypi
socket-patch, cargo, prebuilt binaries).
## What's covered
Library surface (new src/lib.rs):
- Cli, Commands, looks_like_uuid, parse_with_uuid_fallback extracted
from main.rs so integration tests can verify the parser without
spawning the binary.
- main.rs becomes a thin wrapper that delegates to the lib.
- Cargo.toml gains [lib] alongside [[bin]].
Core helper extraction:
- socket_patch_core::manifest::operations::resolve_manifest_path
replaces the 5-line absolute-vs-relative join block previously
copy-pasted into apply/rollback/list/remove/repair (5 callers).
CLI_CONTRACT.md (new):
- Documents every subcommand, flag, default value, visible alias
(download, gc), hidden alias (--no-apply), JSON output shape, and
exit code as semver-significant.
- Pins the divergent defaults: --download-mode=diff for apply/get/scan
and --download-mode=file for repair, --batch-size=100 for scan.
- Spells out the bump policy and how to invoke scripts/version-sync.sh.
Helper unit tests (#[cfg(test)] mod tests in each file):
- src/lib.rs — looks_like_uuid (valid/invalid shapes, case-insensitive),
parse_with_uuid_fallback (success, fallback, fallback-fails preserves
original error, no double-rewrite).
- src/output.rs — format_severity, color, confirm (skip_prompt and
is_json short-circuits; interactive path intentionally not tested).
- src/ecosystem_dispatch.rs — partition_purls (filter, dedup, unknown
ecosystem dropped).
- commands/apply.rs — verify_status_str (all 4 VerifyStatus variants),
result_to_json (top-level + filesVerified key sets).
- commands/rollback.rs — find_patches_to_rollback (None=all, PURL match,
UUID match, no-match=empty).
- commands/get.rs — detect_identifier_type (UUID/CVE/GHSA/PURL/None,
case-insensitive for CVE+GHSA), select_patches (paid auto, free
single auto, free multi+is_json -> Err(1)).
Clap parser snapshot tests (new tests/cli_parse_*.rs):
- One file per command: apply, get, list, main, remove, repair,
rollback, scan, setup.
- Every flag (long + short) has at least one parser assertion.
- Every #[arg(default_value)] is asserted on the no-flag parse.
- The download visible alias on get is exercised.
- The gc visible alias on repair is exercised.
- The hidden --no-apply alias on get --save-only is exercised.
- --ecosystems CSV splitting is verified on apply/rollback/scan.
- The bare-UUID rewrite is exercised end-to-end via Cli::try_parse_from.
- Failure paths assert clap::error::ErrorKind variants.
Async run() integration tests:
- tests/cli_parse_list.rs covers missing manifest -> 1, empty -> 0,
populated -> 0, absolute-path override, and a subprocess JSON-shape
assertion against the compiled binary.
- tests/cli_parse_remove.rs covers missing-manifest -> 1.
- tests/cli_parse_setup.rs covers no-package-json -> 0 with the
JSON status:"no_files" shape pinned via subprocess.
## Verification
cargo build --workspace --all-features
cargo clippy --workspace --all-features -- -D warnings
cargo test --workspace --all-features
All clean. 79 new lib tests + 156 new integration tests added on top of
the existing 415 unit tests; cumulative 650 tests pass.
## Why squashed
Originally landed as a foundation PR (#68) plus 10 sibling test PRs
(#69-#78), one per command/file, dispatched in parallel. Squashing the
sibling PRs back into #68 so the contract + tests land as one
self-contained unit — reviewers see the full picture, and a future
revert touches one commit instead of eleven.
Assisted-by: Claude Code:claude-opus-4-7
* ci: tighten CI matrix — add macOS, release-mode tests, explicit build step
The CI workflow's unit-test job ran on ubuntu-latest + windows-latest;
extend the matrix with macos-latest so the new CLI parser tests are
exercised on every platform the binary ships for. socket-patch ships
prebuilt binaries for x86_64-apple-darwin and aarch64-apple-darwin (see
release.yml), so silent macOS-specific regressions in path handling,
TTY detection, or terminal escapes are real risks today.
Three changes:
- Add `macos-latest` to the test matrix.
- Add `fail-fast: false` so a failure on one OS doesn't mask failures
on the others.
- Add an explicit `cargo build --workspace --all-features` step
before `cargo test`. `cargo test` already builds, but a dedicated
build step gives a cleaner red signal when a build-only failure
happens (e.g. a feature-gated compile error) without the noise of
test-discovery output.
- New `test-release` job: `cargo test --workspace --all-features
--release` on ubuntu-latest. Catches optimization-level regressions
that debug mode hides (e.g. release-mode-only inlining changes that
affect assertion behavior). One OS keeps total CI time reasonable
while still locking in release-mode correctness.
Assisted-by: Claude Code:claude-opus-4-7
* fix(patch): reject POSIX-style absolute paths in archive entries on Windows
`read_archive_to_map` rejects entries whose path is absolute or contains
a `..` component, but the check used `Path::is_absolute()` alone. On
Windows that function requires a drive letter or UNC prefix, so a tar
entry like `/etc/passwd` is NOT considered absolute and would slip
through the guard — when later joined to the target directory, Windows
would treat it as relative to the current drive's root.
Add an explicit check for a leading `/` or `\` byte alongside
`Path::is_absolute()` so the guard rejects POSIX-style absolute paths
on every platform. The new test_read_archive_rejects_backslash_absolute_paths
case locks the symmetric backslash form in.
This was uncovered when the CI matrix was extended to actually run on
Windows. The existing test_read_archive_rejects_absolute_paths failed on
windows-latest because it constructed the archive with a POSIX-style
path that the platform-specific `is_absolute()` did not catch.
Assisted-by: Claude Code:claude-opus-4-7
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
Stacked on PR #67 (
tests/cli-contract-foundation). Adds two parser-snapshot integration test files that lock in the public CLI surface for the two smallest commands (removeandsetup) and the documented no-network exit paths. No production code touched.crates/socket-patch-cli/tests/cli_parse_remove.rs(16 tests):removetable inCLI_CONTRACT.mdin long + short form:-y/--yes,-g/--global,-m/--manifest-path,--cwd,--skip-rollback,--json,--global-prefix.clap::error::ErrorKind::MissingRequiredArgument.clap::error::ErrorKind::UnknownArgument.run()against an empty tempdir → exit code1(missing manifest).crates/socket-patch-cli/tests/cli_parse_setup.rs(11 tests):setuptable in long + short form:-d/--dry-run,-y/--yes,--cwd,--json.clap::error::ErrorKind::UnknownArgument.run()against an empty tempdir → exit code0.env!(\"CARGO_BIN_EXE_socket-patch\")invoking the real binary withsetup --json --yes --cwd <empty tempdir>and asserting the documented JSON shape:status == \"no_files\",updated == 0,alreadyConfigured == 0,errors == 0,files == [].Test plan
From
/tmp/spw/remove-setup:cargo build --workspace --all-featuresclean.cargo clippy --workspace --all-features -- -D warningsclean.cargo test --workspace --all-features --lib --tests— all green (415 lib + 16cli_parse_remove+ 11cli_parse_setup+ all existing integration tests pass).Assisted-by: Claude Code:claude-opus-4-7