[commitgraph] Stub out commit-graph-verify plumbing command.

Commit graphs are optional, so commit-graph plumbing is guarded by a
`commitgraph` feature that is enabled by default.

Author: avoidscorn

Cargo.lock

@@ -25,7 +25,7 @@ doctest = false
 [features]
 default = ["max"]
 
-max = ["fast", "pretty-cli", "prodash/render-tui-crossterm", "prodash-render-line-crossterm", "http-client-curl"]
+max = ["fast", "pretty-cli", "prodash/render-tui-crossterm", "prodash-render-line-crossterm", "http-client-curl", "commitgraph"]
 max-termion = ["fast", "pretty-cli", "prodash/render-tui-termion", "prodash-render-line-termion", "http-client-curl"]
 
 lean = ["fast", "lean-cli", "prodash-render-line-crossterm", "git-features/interrupt-handler", "prodash/progress-tree", "http-client-curl"]
@@ -51,6 +51,8 @@ lean-cli = ["argh", "prodash/progress-log", "env_logger"]
 prodash-render-line-crossterm = ["prodash-render-line", "prodash/render-line-crossterm", "atty", "crosstermion"]
 prodash-render-line-termion = ["prodash-render-line", "prodash/render-line-termion", "atty", "crosstermion"]
 
+commitgraph = ["gitoxide-core/commitgraph"]
+
 # internal
 prodash-render-tui = ["prodash/render-tui"]
 prodash-render-line = ["prodash/render-line"]

Cargo.toml

@@ -12,6 +12,8 @@ doctest = false
 test = false
 
 [features]
+default = ["commitgraph"]
+commitgraph = ["git-commitgraph"]
 serde1 = ["git-object/serde1", "git-odb/serde1", "git-protocol/serde1", "serde_json", "serde"]
 
 [package.metadata.docs.rs]
@@ -28,3 +30,4 @@ anyhow = "1.0.31"
 quick-error = "2.0.0"
 bytesize = "1.0.1"
 serde_json = { version = "1.0.56", optional = true }
+git-commitgraph = { version = "^0.1.2", path = "../git-commitgraph", optional = true }

gitoxide-core/Cargo.toml

@@ -0,0 +1 @@
+pub mod verify;

gitoxide-core/src/commitgraph/mod.rs

@@ -0,0 +1,36 @@
+use anyhow::{Context as AnyhowContext, Result};
+use std::{io, path::Path};
+
+/// A general purpose context for many operations provided here
+pub struct Context<W1: io::Write, W2: io::Write> {
+    /// A stream to which to output operation results
+    pub out: W1,
+    /// A stream to which to errors
+    pub err: W2,
+}
+
+impl Default for Context<Vec<u8>, Vec<u8>> {
+    fn default() -> Self {
+        Context {
+            out: Vec::new(),
+            err: Vec::new(),
+        }
+    }
+}
+
+pub fn graph_or_file<W1, W2>(
+    path: impl AsRef<Path>,
+    Context {
+        out: mut _out,
+        err: mut _err,
+    }: Context<W1, W2>,
+) -> Result<()>
+where
+    W1: io::Write,
+    W2: io::Write,
+{
+    // TODO: Handle `path` being objects/info, objects/info/commit-graph,
+    // or objects/info/commit-graphs/graph-xyz.graph.
+    let _g = git_commitgraph::Graph::from_info_dir(path).with_context(|| "Could not open commit graph")?;
+    Err(anyhow::Error::msg("not implemented"))
+}

gitoxide-core/src/commitgraph/verify.rs

@@ -37,6 +37,8 @@ impl FromStr for OutputFormat {
 mod protocol;
 pub use protocol::Protocol;
 
+#[cfg(feature = "commitgraph")]
+pub mod commitgraph;
 pub mod pack;
 pub mod remote;
 pub mod repository;

gitoxide-core/src/lib.rs

@@ -140,5 +140,18 @@ pub fn main() -> Result<()> {
             )
             .map(|_| ())
         }
+        #[cfg(feature = "commitgraph")]
+        SubCommands::CommitGraphVerify(CommitGraphVerify { path }) => {
+            use self::core::commitgraph::verify;
+
+            verify::graph_or_file(
+                path,
+                verify::Context {
+                    out: stdout(),
+                    err: stderr(),
+                },
+            )
+            .map(|_| ())
+        }
     }
 }

src/plumbing/lean/main.rs

@@ -32,6 +32,8 @@ pub enum SubCommands {
     IndexFromPack(IndexFromPack),
     RemoteRefList(RemoteRefList),
     PackReceive(PackReceive),
+    #[cfg(feature = "commitgraph")]
+    CommitGraphVerify(CommitGraphVerify),
 }
 
 /// Create an index from a packfile.
@@ -188,3 +190,12 @@ pub struct PackVerify {
     #[argh(positional)]
     pub path: PathBuf,
 }
+
+/// Verify a commit graph
+#[cfg(feature = "commitgraph")]
+#[derive(FromArgs, PartialEq, Debug)]
+#[argh(subcommand, name = "commit-graph-verify")]
+pub struct CommitGraphVerify {
+    #[argh(positional)]
+    pub path: PathBuf,
+}

src/plumbing/lean/options.rs

@@ -256,6 +256,18 @@ pub fn main() -> Result<()> {
             },
         )
         .map(|_| ()),
+        #[cfg(feature = "commitgraph")]
+        Subcommands::CommitGraphVerify { path } => prepare_and_run(
+            "commit-graph-verify",
+            verbose,
+            progress,
+            progress_keep_open,
+            None,
+            move |_progress, out, err| {
+                core::commitgraph::verify::graph_or_file(path, core::commitgraph::verify::Context { out, err })
+            },
+        )
+        .map(|_| ()),
     }?;
     Ok(())
 }

src/plumbing/pretty/main.rs

@@ -186,4 +186,13 @@ pub enum Subcommands {
         #[clap(parse(from_os_str))]
         path: PathBuf,
     },
+    /// Verify the integrity of a commit graph
+    #[cfg(feature = "commitgraph")]
+    #[clap(setting = AppSettings::ColoredHelp)]
+    #[clap(setting = AppSettings::DisableVersion)]
+    CommitGraphVerify {
+        /// The 'objects/info/' dir, 'objects/info/commit-graphs' dir, or 'objects/info/commit-graph' file to validate.
+        #[clap(parse(from_os_str))]
+        path: PathBuf,
+    },
 }