Enable creating Input Manifests from the CLI (omnibor#184)

* feat: Refactor and update CLI.

Refactor the CLI to be more future-proof, easier to read, and to have
improved help text.

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>

* feat: Initial `manifest create` implementation.

This is the initial implementation of the `manifest create` subcommand,
which allows you to create OmniBOR manifests from the CLI.

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>

* fix: Switch from cache dir to data dir

We try to default-infer an OmniBOR root directory if none is specified.
In the prior version of this code we'd use the `dirs::cache_dir`
function, which doesn't quite get us the right directory.
`dirs::data_dir` is more accurately representative of what we want.

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>

* chore: General fixup of the CLI.

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>

* chore: Slight help text cleanup.

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>

* feat: Added `debug config` subcommand.

This subcommand helps with debugging the CLI, and will hopefully be
useful in the future.

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>

---------

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>

Author: alilleybrinker

Cargo.toml

@@ -22,7 +22,13 @@ ci = "github"
 # The installers to generate for each app
 installers = ["shell", "powershell"]
 # Target platforms to build apps for (Rust target-triple syntax)
-targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl", "x86_64-pc-windows-msvc"]
+targets = [
+    "aarch64-apple-darwin",
+    "x86_64-apple-darwin",
+    "x86_64-unknown-linux-gnu",
+    "x86_64-unknown-linux-musl",
+    "x86_64-pc-windows-msvc",
+]
 # Publish jobs to run in CI
 pr-run-mode = "plan"
 # Whether to install an updater program
@@ -111,14 +117,14 @@ split_commits = false
 
 # regex for parsing and grouping commits
 commit_parsers = [
-  { message = "^.*: add", group = "Added" },
-  { message = "^.*: support", group = "Added" },
-  { message = "^.*: remove", group = "Removed" },
-  { message = "^.*: delete", group = "Removed" },
-  { message = "^test", group = "Fixed" },
-  { message = "^fix", group = "Fixed" },
-  { message = "^.*: fix", group = "Fixed" },
-  { message = "^.*", group = "Changed" },
+    { message = "^.*: add", group = "Added" },
+    { message = "^.*: support", group = "Added" },
+    { message = "^.*: remove", group = "Removed" },
+    { message = "^.*: delete", group = "Removed" },
+    { message = "^test", group = "Fixed" },
+    { message = "^fix", group = "Fixed" },
+    { message = "^.*: fix", group = "Fixed" },
+    { message = "^.*", group = "Changed" },
 ]
 
 # protect breaking changes from being skipped due to matching a skipping commit_parser

omnibor-cli/Cargo.toml

@@ -28,20 +28,21 @@ path = "src/main.rs"
 
 [dependencies]
 
-omnibor = "0.5.1"
+omnibor = { version = "0.5.1", path = "../omnibor" }
 anyhow = "1.0.80"
 async-walkdir = "1.0.0"
 futures-lite = "2.2.0"
 serde_json = "1.0.114"
-smart-default = "0.7.1"
 url = "2.5.0"
 tracing = "0.1.40"
 tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
+dirs = "5.0.1"
+pathbuf = "1.0.0"
 
 [dependencies.clap]
 
 version = "4.5.1"
-features = ["derive"]
+features = ["derive", "env", "wrap_help"]
 
 [dependencies.tokio]
 

omnibor-cli/src/find.rs renamed to omnibor-cli/src/artifact_find.rs

@@ -1,30 +1,27 @@
-//! The `find` command, which finds files by ID.
+//! The `artifact find` command, which finds files by ID.
 
+use crate::cli::Config;
 use crate::cli::FindArgs;
 use crate::cli::SelectedHash;
 use crate::fs::*;
 use crate::print::PrinterCmd;
 use anyhow::Result;
 use async_walkdir::WalkDir;
 use futures_lite::stream::StreamExt as _;
-use omnibor::ArtifactId;
-use omnibor::Sha256;
 use tokio::sync::mpsc::Sender;
 
-/// Run the `find` subcommand.
-pub async fn run(tx: &Sender<PrinterCmd>, args: &FindArgs) -> Result<()> {
-    let FindArgs { url, path, format } = args;
+/// Run the `artifact find` subcommand.
+pub async fn run(tx: &Sender<PrinterCmd>, config: &Config, args: &FindArgs) -> Result<()> {
+    let FindArgs { aid, path } = args;
 
-    // TODO(alilleybrinker): Correctly handle possible future hash formats.
-    let id = ArtifactId::<Sha256>::try_from_url(url.clone())?;
-    let url = id.url();
+    let url = aid.url();
 
     let mut entries = WalkDir::new(path);
 
     loop {
         match entries.next().await {
             None => break,
-            Some(Err(e)) => tx.send(PrinterCmd::error(e, *format)).await?,
+            Some(Err(e)) => tx.send(PrinterCmd::error(e, config.format())).await?,
             Some(Ok(entry)) => {
                 let path = &entry.path();
 
@@ -36,7 +33,8 @@ pub async fn run(tx: &Sender<PrinterCmd>, args: &FindArgs) -> Result<()> {
                 let file_url = hash_file(SelectedHash::Sha256, &mut file, path).await?;
 
                 if url == file_url {
-                    tx.send(PrinterCmd::find(path, &url, *format)).await?;
+                    tx.send(PrinterCmd::find(path, &url, config.format()))
+                        .await?;
                 }
             }
         }

omnibor-cli/src/artifact_id.rs

@@ -0,0 +1,21 @@
+//! The `artifact id` command, which identifies files.
+
+use crate::cli::Config;
+use crate::cli::IdArgs;
+use crate::fs::*;
+use crate::print::PrinterCmd;
+use anyhow::Result;
+use tokio::sync::mpsc::Sender;
+
+/// Run the `artifact id` subcommand.
+pub async fn run(tx: &Sender<PrinterCmd>, config: &Config, args: &IdArgs) -> Result<()> {
+    let mut file = open_async_file(&args.path).await?;
+
+    if file_is_dir(&file).await? {
+        id_directory(tx, &args.path, config.format(), config.hash()).await?;
+    } else {
+        id_file(tx, &mut file, &args.path, config.format(), config.hash()).await?;
+    }
+
+    Ok(())
+}