re-organize for symmetry

Author: emostov

Cargo.toml

@@ -83,7 +83,6 @@ tonic-build = { version = "0.13", default-features = false, features = ["prost"]
 walkdir = { version = "2.5", default-features = false }
 
 # Environment and configuration
-dialoguer = { version = "0.11", default-features = false }
 dotenvy = { version = "0.15.0", default-features = false }
 clap = { version = "4.5", features = ["std", "derive", "help", "usage", "error-context"], default-features = false }
 

tvc/src/cli.rs

@@ -10,15 +10,15 @@ pub struct GlobalConfig {
     pub api_base_url: String,
 }
 
-/// CLI command parsing and dispatch
+/// CLI command parsing and dispatch.
 #[derive(Debug, Parser)]
 #[command(about = "CLI for building with Turnkey Verifiable Cloud", long_about = None)]
 pub struct Cli {
-    /// Turnkey organization ID
+    /// Turnkey organization ID.
     #[arg(long, global = true, env = "TVC_ORGANIZATION_ID")]
     pub organization_id: Option<String>,
 
-    /// API base URL
+    /// API base URL.
     #[arg(
         long,
         global = true,
@@ -32,7 +32,7 @@ pub struct Cli {
 }
 
 impl Cli {
-    /// Run the CLI
+    /// Run the CLI.
     pub async fn run() -> anyhow::Result<()> {
         let args = Cli::parse();
 
@@ -42,12 +42,14 @@ impl Cli {
         };
 
         match args.command {
-            Commands::ApproveManifest(cmd_args) => commands::approve::run(cmd_args, &config).await,
+            Commands::ApproveManifest(cmd_args) => {
+                commands::approve_manifest::run(cmd_args, &config).await
+            }
         }
     }
 }
 
 #[derive(Debug, Subcommand)]
 enum Commands {
-    ApproveManifest(commands::approve::ApproveManifest),
+    ApproveManifest(commands::approve_manifest::Args),
 }

tvc/src/commands/approve.rs tvc/src/commands/approve_manifest.rstvc/src/commands/approve.rs renamed to tvc/src/commands/approve_manifest.rs

@@ -4,22 +4,22 @@ use crate::pair::LocalPair;
 use crate::util::{read_file_to_string, write_file};
 use anyhow::anyhow;
 use anyhow::{bail, Context};
-use clap::{ArgGroup, Args};
+use clap::{ArgGroup, Args as ClapArgs};
 use qos_core::protocol::services::boot::Approval;
 use qos_core::protocol::services::boot::{
     Manifest, ManifestSet, Namespace, NitroConfig, PivotConfig, QuorumMember, ShareSet,
 };
 use qos_core::protocol::QosHash;
+use std::io::{BufRead, Write};
 use std::path::Path;
 use std::path::PathBuf;
-use std::io::{BufRead, Write};
 
-/// Approve a QOS manifest
-#[derive(Debug, Args)]
+/// Approve a QOS manifest.
+#[derive(Debug, ClapArgs)]
 #[command(about, long_about = None)]
 #[command(group(ArgGroup::new("operator").args(["operator_seed", "operator_id"])))]
 #[command(group(ArgGroup::new("manifest-source").args(["manifest", "deploy_id"])))]
-pub struct ApproveManifest {
+pub struct Args {
     /// Path to QOS manifest file.
     #[arg(
         short,
@@ -29,7 +29,7 @@ pub struct ApproveManifest {
     )]
     pub manifest: Option<PathBuf>,
 
-    /// ID of the deployment the manifest belongs to
+    /// ID of the deployment the manifest belongs to.
     #[arg(
         short,
         long,
@@ -38,41 +38,41 @@ pub struct ApproveManifest {
     )]
     pub deploy_id: Option<String>,
 
-    /// Path to the file containing the master seed for the operator key
+    /// Path to the file containing the master seed for the operator key.
     #[arg(
         long,
         help_heading = "Operator to approve with (pick one)",
         value_name = "PATH"
     )]
     pub operator_seed: Option<PathBuf>,
 
-    /// Operator ID to use
+    /// Operator ID to use.
     #[arg(
         long,
         help_heading = "Operator to approve with (pick one)",
         env = "TVC_OPERATOR_ID"
     )]
     pub operator_id: Option<String>,
 
-    /// Walk through manifest approval prompts but do not generate an approval
+    /// Walk through manifest approval prompts but do not generate an approval.
     #[arg(long)]
     pub dry_run: bool,
 
-    /// DANGEROUS: skip interactive prompts for approving each aspect of manifest
+    /// DANGEROUS: skip interactive prompts for approving each aspect of manifest.
     #[arg(long)]
     pub dangerous_skip_interactive: bool,
 
-    /// Write approval to file instead of stdout
+    /// Write approval to file instead of stdout.
     #[arg(short, long, value_name = "PATH")]
     pub output: Option<PathBuf>,
 
-    /// Don't post approval to the API
+    /// Don't post approval to the API.
     #[arg(long)]
     pub skip_post: bool,
 }
 
 /// Run the approve manifest command.
-pub async fn run(args: ApproveManifest, _config: &crate::cli::GlobalConfig) -> anyhow::Result<()> {
+pub async fn run(args: Args, _config: &crate::cli::GlobalConfig) -> anyhow::Result<()> {
     let manifest = match (&args.manifest, &args.deploy_id) {
         (Some(path), _) => read_manifest_from_path(path).await?,
         (_, Some(deploy_id)) => fetch_manifest_from_deploy(deploy_id).await?,

tvc/src/commands/mod.rs

@@ -1,14 +1,7 @@
 //! CLI commands.
 //!
 //! Each command module should contain:
-//! - An args struct deriving `clap::Args`
+//! - An `Args` struct deriving `clap::Args`
 //! - A `run(args) -> anyhow::Result<()>` function
-//!
-//! To add a new command:
-//! 1. Create a new module file (e.g., `verify.rs`)
-//! 2. Define your args struct and `run` function
-//! 3. Add `pub mod verify;` below
-//! 4. Add the command variant to `Commands` enum in `cli.rs`
-//! 5. Add the match arm in `Cli::run()`
 
-pub mod approve;
+pub mod approve_manifest;

tvc/src/pair.rs

@@ -6,9 +6,9 @@ use std::path::Path;
 use std::pin::Pin;
 use std::sync::Arc;
 
-/// Something that can do key pair operations with the qos p256 scheme.
+/// Something that can do key pair operations with the QOS p256 scheme.
 pub trait Pair: Send + Sync {
-    /// Sign the given message. This method will compute the digest before signing.
+    /// Sign the given message.
     fn sign(
         &self,
         message: Vec<u8>,

tvc/tests/cli.rs tvc/tests/approve_manifest.rstvc/tests/cli.rs renamed to tvc/tests/approve_manifest.rs

@@ -13,7 +13,7 @@ fn approve_manifest_requires_source() {
 }
 
 #[test]
-fn approve_manifest_with_file() {
+fn dangerous_approve_manifest_with_file() {
     cargo_bin_cmd!("tvc")
         .arg("approve-manifest")
         .arg("--manifest")
@@ -70,3 +70,35 @@ fn approve_manifest_interactive_reject() {
         .failure()
         .stderr(predicate::str::contains("approval cancelled by user"));
 }
+
+#[test]
+fn manifest_and_deploy_id_are_mutually_exclusive() {
+    cargo_bin_cmd!("tvc")
+        .arg("approve-manifest")
+        .arg("--manifest")
+        .arg("fixtures/manifest.json")
+        .arg("--deploy-id")
+        .arg("some-deploy-id")
+        .arg("--dangerous-skip-interactive")
+        .assert()
+        .failure()
+        .stderr(predicate::str::contains(
+            "the argument '--manifest <PATH>' cannot be used with '--deploy-id <DEPLOY_ID>'",
+        ));
+}
+
+#[test]
+fn operator_seed_and_operator_id_are_mutually_exclusive() {
+    cargo_bin_cmd!("tvc")
+        .arg("approve-manifest")
+        .arg("--manifest")
+        .arg("fixtures/manifest.json")
+        .arg("--operator-seed")
+        .arg("fixtures/seed.hex")
+        .arg("--operator-id")
+        .arg("some-operator-id")
+        .arg("--dangerous-skip-interactive")
+        .assert()
+        .failure()
+        .stderr(predicate::str::contains("the argument '--operator-seed <PATH>' cannot be used with '--operator-id <OPERATOR_ID>'"));
+}