test(cli): foundation for CLI-contract unit-test campaign

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) · May 19, 2026 · May 19, 2026 · May 20, 2026 · 6cb84b8c4456cbcca1ceabb9beea386f1a0fe272
commit 6cb84b8c4456cbcca1ceabb9beea386f1a0fe272
diff --git a/crates/socket-patch-cli/CLI_CONTRACT.md b/crates/socket-patch-cli/CLI_CONTRACT.md
@@ -0,0 +1,266 @@
+# socket-patch CLI contract
+
+This document defines the **public surface** of the `socket-patch` binary. Anything listed here is part of the user-visible contract: third-party scripts, CI pipelines, and the npm/pypi/cargo wrappers depend on it. Changes are governed by the semver policy at the bottom of this file.
+
+> **Why this exists.** Until late 2026 the CLI crate had zero unit tests under `src/` — only network-dependent `tests/e2e_*.rs` suites that run with `--ignored`. A flag rename, a default-value change, or a JSON key rename could land green and break every shipped wrapper silently. The contract below is now backed by the unit tests under `crates/socket-patch-cli/src/**` (`#[cfg(test)] mod tests`) and the parser tests under `crates/socket-patch-cli/tests/cli_parse_*.rs`. Changes that violate the contract must update those tests in lock-step with a major version bump.
+
+## Subcommands
+
+| Name | Visible alias(es) | Notes |
+|---|---|---|
+| `apply` | — | Apply patches from the local manifest |
+| `rollback` | — | Restore original files; takes optional positional `identifier` |
+| `get` | `download` | Fetch + apply patch; requires positional `identifier` |
+| `scan` | — | Crawl installed packages for available patches |
+| `list` | — | Print patches in the local manifest |
+| `remove` | — | Remove patch from manifest (rolls back first); requires positional `identifier` |
+| `setup` | — | Configure package.json postinstall scripts |
+| `repair` | `gc` | Download missing blobs + clean up unused ones |
+
+**Bare-UUID fallback.** `socket-patch <UUID>` is rewritten to `socket-patch get <UUID>`. The UUID shape checked is the standard 8-4-4-4-12 hex pattern (case-insensitive). See [`src/lib.rs::looks_like_uuid`](src/lib.rs).
+
+## Flags — long and short forms
+
+Every flag below is part of the contract. The default values are pinned by parser tests.
+
+### `apply`
+
+| Long | Short | Default | Type |
+|---|---|---|---|
+| `--cwd` | — | `.` | path |
+| `--dry-run` | `-d` | `false` | bool |
+| `--silent` | `-s` | `false` | bool |
+| `--manifest-path` | `-m` | `.socket/manifest.json` | string |
+| `--offline` | — | `false` | bool |
+| `--global` | `-g` | `false` | bool |
+| `--global-prefix` | — | (none) | path |
+| `--ecosystems` | — | (none) | CSV → `Vec<String>` |
+| `--force` | `-f` | `false` | bool |
+| `--json` | — | `false` | bool |
+| `--verbose` | `-v` | `false` | bool |
+| `--download-mode` | — | **`diff`** | string |
+
+### `rollback`
+
+Same as `apply` plus: `--one-off` (bool), `--org` (string), `--api-url` (string), `--api-token` (string). Positional `identifier` is **optional** (omit to rollback everything).
+
+### `get`
+
+Required positional `identifier`. Flags:
+
+| Long | Short | Alias | Default | Type |
+|---|---|---|---|---|
+| `--org` | — | — | (none) | string |
+| `--cwd` | — | — | `.` | path |
+| `--id` | — | — | `false` | bool |
+| `--cve` | — | — | `false` | bool |
+| `--ghsa` | — | — | `false` | bool |
+| `--package` | `-p` | — | `false` | bool |
+| `--yes` | `-y` | — | `false` | bool |
+| `--api-url` | — | — | (none) | string |
+| `--api-token` | — | — | (none) | string |
+| `--save-only` | — | **`--no-apply`** | `false` | bool |
+| `--global` | `-g` | — | `false` | bool |
+| `--global-prefix` | — | — | (none) | path |
+| `--one-off` | — | — | `false` | bool |
+| `--json` | — | — | `false` | bool |
+| `--download-mode` | — | — | **`diff`** | string |
+
+The hidden alias `--no-apply` on `--save-only` is **part of the contract** — it does not appear in `--help` but is widely used in existing scripts.
+
+### `scan`
+
+| Long | Short | Default | Type |
+|---|---|---|---|
+| `--cwd` | — | `.` | path |
+| `--org` | — | (none) | string |
+| `--json` | — | `false` | bool |
+| `--yes` | `-y` | `false` | bool |
+| `--global` | `-g` | `false` | bool |
+| `--global-prefix` | — | (none) | path |
+| `--batch-size` | — | **`100`** | usize |
+| `--api-url` | — | (none) | string |
+| `--api-token` | — | (none) | string |
+| `--ecosystems` | — | (none) | CSV → `Vec<String>` |
+| `--download-mode` | — | **`diff`** | string |
+
+### `list`
+
+| Long | Short | Default | Type |
+|---|---|---|---|
+| `--cwd` | — | `.` | path |
+| `--manifest-path` | `-m` | `.socket/manifest.json` | string |
+| `--json` | — | `false` | bool |
+
+### `remove`
+
+Required positional `identifier`. Flags:
+
+| Long | Short | Default | Type |
+|---|---|---|---|
+| `--cwd` | — | `.` | path |
+| `--manifest-path` | `-m` | `.socket/manifest.json` | string |
+| `--skip-rollback` | — | `false` | bool |
+| `--yes` | `-y` | `false` | bool |
+| `--global` | `-g` | `false` | bool |
+| `--global-prefix` | — | (none) | path |
+| `--json` | — | `false` | bool |
+
+### `setup`
+
+| Long | Short | Default | Type |
+|---|---|---|---|
+| `--cwd` | — | `.` | path |
+| `--dry-run` | `-d` | `false` | bool |
+| `--yes` | `-y` | `false` | bool |
+| `--json` | — | `false` | bool |
+
+### `repair`
+
+| Long | Short | Default | Type |
+|---|---|---|---|
+| `--cwd` | — | `.` | path |
+| `--manifest-path` | `-m` | `.socket/manifest.json` | string |
+| `--dry-run` | `-d` | `false` | bool |
+| `--offline` | — | `false` | bool |
+| `--download-only` | — | `false` | bool |
+| `--json` | — | `false` | bool |
+| `--download-mode` | — | **`file`** | string |
+
+**Note:** `repair`'s `--download-mode` default differs from every other command (`file` vs `diff`). This is intentional — repair restores legacy per-file blobs needed to apply any patch.
+
+## CSV value parsing
+
+`--ecosystems` on `apply`, `rollback`, and `scan` uses clap's `value_delimiter = ','`. Input `--ecosystems npm,pypi,cargo` becomes `vec!["npm", "pypi", "cargo"]`. Switching to space-separated or dropping the delimiter is a **breaking** change.
+
+## JSON output shapes
+
+When `--json` is set, commands print a single JSON object to stdout. The schemas below are stable.
+
+### Missing-manifest error (`apply`/`list`/`remove`/`repair`/`rollback`)
+
+```json
+{
+  "status": "error",
+  "error": "Manifest not found",
+  "path": "<absolute path that was looked up>"
+}
+```
+
+### Invalid-manifest error
+
+```json
+{ "status": "error", "error": "Invalid manifest" }
+```
+
+### Generic error
+
+```json
+{ "status": "error", "error": "<message>" }
+```
+
+### `list` success — empty manifest
+
+```json
+{ "status": "success", "patches": [] }
+```
+
+### `list` success — populated
+
+```json
+{
+  "status": "success",
+  "patches": [
+    {
+      "purl": "pkg:npm/foo@1.2.3",
+      "uuid": "…",
+      "exportedAt": "…",
+      "tier": "free|paid",
+      "license": "…",
+      "description": "…",
+      "files": ["…"],
+      "vulnerabilities": [
+        { "id": "…", "cves": ["…"], "summary": "…", "severity": "…", "description": "…" }
+      ]
+    }
+  ]
+}
+```
+
+### `setup` — no package.json files found
+
+```json
+{
+  "status": "no_files",
+  "updated": 0,
+  "alreadyConfigured": 0,
+  "errors": 0,
+  "files": []
+}
+```
+
+### `get` — multiple-patch selection required (JSON mode)
+
+```json
+{
+  "status": "selection_required",
+  "error": "Multiple patches available for <purl>. Specify --id <UUID> to select one.",
+  "purl": "<purl>",
+  "options": [
+    { "uuid": "…", "tier": "…", "published_at": "…", "description": "…", "vulnerabilities": [ … ] }
+  ]
+}
+```
+
+## Exit codes
+
+| Code | Meaning |
+|---|---|
+| `0` | Success |
+| `1` | Error (missing/invalid manifest, fetch failed, apply failed, selection cancelled in non-JSON mode, etc.) |
+
+`list` returns **`0`** for an empty manifest and **`1`** for a missing manifest — these are distinct and load-bearing.
+
+## Semver policy
+
+Versioning lives in **`Cargo.toml`** at the workspace root (`version = "..."`) and is propagated to npm, pypi, and cargo wrappers by **`scripts/version-sync.sh <new-version>`**.
+
+| Change | Bump |
+|---|---|
+| Rename or remove a subcommand | **MAJOR** |
+| Rename or remove a visible alias (`download`, `gc`) | **MAJOR** |
+| Rename or remove a hidden alias (`--no-apply`) | **MAJOR** |
+| Rename, remove, or change short form of a flag (`-d`, `-m`, etc.) | **MAJOR** |
+| Change a default value (`--download-mode`, `--batch-size`, `--manifest-path`, …) | **MAJOR** |
+| Change an exit code's meaning or add a new non-zero code with different semantics | **MAJOR** |
+| Rename a JSON output key or change a `status` string | **MAJOR** |
+| Remove a JSON output key | **MAJOR** |
+| Drop the bare-UUID fallback | **MAJOR** |
+| Add a *required* new flag | **MAJOR** |
+| Add a new subcommand | **MINOR** |
+| Add a new optional flag | **MINOR** |
+| Add a new optional JSON output key (additive) | **MINOR** |
+| Add a new visible alias to an existing subcommand | **MINOR** |
+| Fix a bug without changing any of the above | **PATCH** |
+
+After bumping `Cargo.toml`, run:
+
+```bash
+scripts/version-sync.sh <new-version>
+```
+
+This syncs the workspace package version into:
+
+- `npm/socket-patch/package.json` (and its `optionalDependencies`)
+- every per-platform `npm/socket-patch-*/package.json`
+- `pypi/socket-patch/pyproject.toml`
+
+## How the contract is enforced
+
+Every item in this document is locked in by at least one of:
+
+- **clap parser snapshots** in `crates/socket-patch-cli/tests/cli_parse_*.rs` — assert flag names, short forms, defaults, aliases, and CSV delimiters by calling `socket_patch_cli::Cli::try_parse_from(...)`.
+- **Helper unit tests** in `crates/socket-patch-cli/src/**` (`#[cfg(test)] mod tests` blocks) — cover `looks_like_uuid`, `parse_with_uuid_fallback`, `detect_identifier_type`, `select_patches`, `find_patches_to_rollback`, `partition_purls`, `verify_status_str`, `format_severity`, `color`, and the JSON serializers.
+- **Async `run()` integration tests** in `tests/cli_parse_list.rs`, `tests/cli_parse_remove.rs`, `tests/cli_parse_setup.rs` — exercise the no-network error paths and assert JSON shape via `serde_json::from_str::<Value>` + per-key assertions.
+
+If you add a new flag/subcommand/JSON key, add a test here that locks the new surface in the same PR.
diff --git a/crates/socket-patch-cli/Cargo.toml b/crates/socket-patch-cli/Cargo.toml
@@ -7,6 +7,10 @@ license.workspace = true
 repository.workspace = true
 readme = "README.md"
 
+[lib]
+name = "socket_patch_cli"
+path = "src/lib.rs"
+
 [[bin]]
 name = "socket-patch"
 path = "src/main.rs"

diff --git a/crates/socket-patch-cli/src/commands/apply.rs b/crates/socket-patch-cli/src/commands/apply.rs
@@ -6,7 +6,7 @@ use socket_patch_core::api::blob_fetcher::{
 use socket_patch_core::api::client::get_api_client_from_env;
 use socket_patch_core::constants::DEFAULT_PATCH_MANIFEST_PATH;
 use socket_patch_core::crawlers::{CrawlerOptions, Ecosystem};
-use socket_patch_core::manifest::operations::read_manifest;
+use socket_patch_core::manifest::operations::{read_manifest, resolve_manifest_path};
 use socket_patch_core::patch::apply::{
     apply_package_patch, verify_file_patch, ApplyResult, PatchSources, VerifyStatus,
 };
@@ -113,11 +113,7 @@ pub async fn run(args: ApplyArgs) -> i32 {
     let api_token = telemetry_client.api_token().cloned();
     let org_slug = telemetry_client.org_slug().cloned();
 
-    let manifest_path = if Path::new(&args.manifest_path).is_absolute() {
-        PathBuf::from(&args.manifest_path)
-    } else {
-        args.cwd.join(&args.manifest_path)
-    };
+    let manifest_path = resolve_manifest_path(&args.cwd, &args.manifest_path);
 
     // Check if manifest exists - exit successfully if no .socket folder is set up
     if tokio::fs::metadata(&manifest_path).await.is_err() {

diff --git a/crates/socket-patch-cli/src/commands/list.rs b/crates/socket-patch-cli/src/commands/list.rs
@@ -1,7 +1,7 @@
 use clap::Args;
 use socket_patch_core::constants::DEFAULT_PATCH_MANIFEST_PATH;
-use socket_patch_core::manifest::operations::read_manifest;
-use std::path::{Path, PathBuf};
+use socket_patch_core::manifest::operations::{read_manifest, resolve_manifest_path};
+use std::path::PathBuf;
 
 #[derive(Args)]
 pub struct ListArgs {
@@ -19,11 +19,7 @@ pub struct ListArgs {
 }
 
 pub async fn run(args: ListArgs) -> i32 {
-    let manifest_path = if Path::new(&args.manifest_path).is_absolute() {
-        PathBuf::from(&args.manifest_path)
-    } else {
-        args.cwd.join(&args.manifest_path)
-    };
+    let manifest_path = resolve_manifest_path(&args.cwd, &args.manifest_path);
 
     // Check if manifest exists
     if tokio::fs::metadata(&manifest_path).await.is_err() {

diff --git a/crates/socket-patch-cli/src/commands/remove.rs b/crates/socket-patch-cli/src/commands/remove.rs
@@ -1,6 +1,8 @@
 use clap::Args;
 use socket_patch_core::constants::DEFAULT_PATCH_MANIFEST_PATH;
-use socket_patch_core::manifest::operations::{read_manifest, write_manifest};
+use socket_patch_core::manifest::operations::{
+    read_manifest, resolve_manifest_path, write_manifest,
+};
 use socket_patch_core::manifest::schema::PatchManifest;
 use socket_patch_core::utils::cleanup_blobs::{cleanup_unused_blobs, format_cleanup_result};
 use socket_patch_core::utils::telemetry::{track_patch_removed, track_patch_remove_failed};
@@ -49,11 +51,7 @@ pub async fn run(args: RemoveArgs) -> i32 {
     let api_token = telemetry_client.api_token().cloned();
     let org_slug = telemetry_client.org_slug().cloned();
 
-    let manifest_path = if Path::new(&args.manifest_path).is_absolute() {
-        PathBuf::from(&args.manifest_path)
-    } else {
-        args.cwd.join(&args.manifest_path)
-    };
+    let manifest_path = resolve_manifest_path(&args.cwd, &args.manifest_path);
 
     if tokio::fs::metadata(&manifest_path).await.is_err() {
         if args.json {

diff --git a/crates/socket-patch-cli/src/commands/repair.rs b/crates/socket-patch-cli/src/commands/repair.rs
@@ -5,7 +5,7 @@ use socket_patch_core::api::blob_fetcher::{
 };
 use socket_patch_core::api::client::get_api_client_from_env;
 use socket_patch_core::constants::DEFAULT_PATCH_MANIFEST_PATH;
-use socket_patch_core::manifest::operations::read_manifest;
+use socket_patch_core::manifest::operations::{read_manifest, resolve_manifest_path};
 use socket_patch_core::patch::apply::PatchSources;
 use socket_patch_core::utils::cleanup_blobs::{
     cleanup_unused_archives, cleanup_unused_blobs, format_cleanup_result,
@@ -46,11 +46,7 @@ pub struct RepairArgs {
 }
 
 pub async fn run(args: RepairArgs) -> i32 {
-    let manifest_path = if Path::new(&args.manifest_path).is_absolute() {
-        PathBuf::from(&args.manifest_path)
-    } else {
-        args.cwd.join(&args.manifest_path)
-    };
+    let manifest_path = resolve_manifest_path(&args.cwd, &args.manifest_path);
 
     if tokio::fs::metadata(&manifest_path).await.is_err() {
         if args.json {

diff --git a/crates/socket-patch-cli/src/commands/rollback.rs b/crates/socket-patch-cli/src/commands/rollback.rs
@@ -5,7 +5,7 @@ use socket_patch_core::api::blob_fetcher::{
 use socket_patch_core::api::client::get_api_client_from_env;
 use socket_patch_core::constants::DEFAULT_PATCH_MANIFEST_PATH;
 use socket_patch_core::crawlers::CrawlerOptions;
-use socket_patch_core::manifest::operations::read_manifest;
+use socket_patch_core::manifest::operations::{read_manifest, resolve_manifest_path};
 use socket_patch_core::manifest::schema::{PatchManifest, PatchRecord};
 use socket_patch_core::patch::rollback::{rollback_package_patch, RollbackResult, VerifyRollbackStatus};
 use socket_patch_core::utils::telemetry::{track_patch_rolled_back, track_patch_rollback_failed};
@@ -212,11 +212,7 @@ pub async fn run(args: RollbackArgs) -> i32 {
         return 1;
     }
 
-    let manifest_path = if Path::new(&args.manifest_path).is_absolute() {
-        PathBuf::from(&args.manifest_path)
-    } else {
-        args.cwd.join(&args.manifest_path)
-    };
+    let manifest_path = resolve_manifest_path(&args.cwd, &args.manifest_path);
 
     if tokio::fs::metadata(&manifest_path).await.is_err() {
         if args.json {