Merge branch 'fix-commitgraph'

gitoxide-core/src/commitgraph/mod.rs

@@ -1,5 +1,2 @@
-pub mod list;
-pub use list::function::list;
-
 pub mod verify;
 pub use verify::function::verify;

gitoxide-core/src/commitgraph/verify.rs

@@ -9,26 +9,35 @@ pub struct Context<W1: std::io::Write, W2: std::io::Write> {
     pub output_statistics: Option<OutputFormat>,
 }
 
-pub(crate) mod function {
-    use std::io;
+impl Default for Context<Vec<u8>, Vec<u8>> {
+    fn default() -> Self {
+        Context {
+            err: Vec::new(),
+            out: Vec::new(),
+            output_statistics: None,
+        }
+    }
+}
 
-    use crate::commitgraph::verify::Context;
+pub(crate) mod function {
     use crate::OutputFormat;
     use anyhow::{Context as AnyhowContext, Result};
+    use gix::commitgraph::{verify::Outcome, Graph};
+    use std::{io, path::Path};
 
     pub fn verify<W1, W2>(
-        repo: gix::Repository,
-        Context {
+        path: impl AsRef<Path>,
+        super::Context {
             err: _err,
             mut out,
             output_statistics,
-        }: Context<W1, W2>,
+        }: super::Context<W1, W2>,
     ) -> Result<gix::commitgraph::verify::Outcome>
     where
         W1: io::Write,
         W2: io::Write,
     {
-        let g = repo.commit_graph()?;
+        let g = Graph::at(path).with_context(|| "Could not open commit graph")?;
 
         #[allow(clippy::unnecessary_wraps, unknown_lints)]
         fn noop_processor(_commit: &gix::commitgraph::file::Commit<'_>) -> std::result::Result<(), std::fmt::Error> {
@@ -49,7 +58,7 @@ pub(crate) mod function {
         Ok(stats)
     }
 
-    fn print_human_output(out: &mut impl io::Write, stats: &gix::commitgraph::verify::Outcome) -> io::Result<()> {
+    fn print_human_output(out: &mut impl io::Write, stats: &Outcome) -> io::Result<()> {
         writeln!(out, "number of commits with the given number of parents")?;
         let mut parent_counts: Vec<_> = stats.parent_counts.iter().map(|(a, b)| (*a, *b)).collect();
         parent_counts.sort_by_key(|e| e.0);

gitoxide-core/src/lib.rs

@@ -63,9 +63,9 @@ impl FromStr for OutputFormat {
     }
 }
 
+pub mod commitgraph;
 pub mod net;
 
-pub mod commitgraph;
 #[cfg(feature = "estimate-hours")]
 pub mod hours;
 pub mod index;

gitoxide-core/src/repository/commitgraph/mod.rs

@@ -0,0 +1,5 @@
+pub mod list;
+pub use list::function::list;
+
+pub mod verify;
+pub use verify::function::verify;

gitoxide-core/src/repository/commitgraph/verify.rs

@@ -0,0 +1,70 @@
+use crate::OutputFormat;
+
+/// A general purpose context for many operations provided here
+pub struct Context<W1: std::io::Write, W2: std::io::Write> {
+    /// A stream to which to output errors
+    pub err: W2,
+    /// A stream to which to output operation results
+    pub out: W1,
+    pub output_statistics: Option<OutputFormat>,
+}
+
+pub(crate) mod function {
+    use std::io;
+
+    use crate::repository::commitgraph::verify::Context;
+    use crate::OutputFormat;
+    use anyhow::{Context as AnyhowContext, Result};
+
+    pub fn verify<W1, W2>(
+        repo: gix::Repository,
+        Context {
+            err: _err,
+            mut out,
+            output_statistics,
+        }: Context<W1, W2>,
+    ) -> Result<gix::commitgraph::verify::Outcome>
+    where
+        W1: io::Write,
+        W2: io::Write,
+    {
+        let g = repo.commit_graph()?;
+
+        #[allow(clippy::unnecessary_wraps, unknown_lints)]
+        fn noop_processor(_commit: &gix::commitgraph::file::Commit<'_>) -> std::result::Result<(), std::fmt::Error> {
+            Ok(())
+        }
+        let stats = g
+            .verify_integrity(noop_processor)
+            .with_context(|| "Verification failure")?;
+
+        #[cfg_attr(not(feature = "serde"), allow(clippy::single_match))]
+        match output_statistics {
+            Some(OutputFormat::Human) => drop(print_human_output(&mut out, &stats)),
+            #[cfg(feature = "serde")]
+            Some(OutputFormat::Json) => serde_json::to_writer_pretty(out, &stats)?,
+            _ => {}
+        }
+
+        Ok(stats)
+    }
+
+    fn print_human_output(out: &mut impl io::Write, stats: &gix::commitgraph::verify::Outcome) -> io::Result<()> {
+        writeln!(out, "number of commits with the given number of parents")?;
+        let mut parent_counts: Vec<_> = stats.parent_counts.iter().map(|(a, b)| (*a, *b)).collect();
+        parent_counts.sort_by_key(|e| e.0);
+        for (parent_count, commit_count) in parent_counts.into_iter() {
+            writeln!(out, "\t{parent_count:>2}: {commit_count}")?;
+        }
+        writeln!(out, "\t->: {}", stats.num_commits)?;
+
+        write!(out, "\nlongest path length between two commits: ")?;
+        if let Some(n) = stats.longest_path_length {
+            writeln!(out, "{n}")?;
+        } else {
+            writeln!(out, "unknown")?;
+        }
+
+        Ok(())
+    }
+}

gitoxide-core/src/repository/mod.rs

@@ -25,6 +25,7 @@ pub mod fetch;
 pub use clone::function::clone;
 #[cfg(feature = "blocking-client")]
 pub use fetch::function::fetch;
+pub mod commitgraph;
 pub mod index;
 pub mod mailmap;
 pub mod odb;

src/plumbing/main.rs

@@ -13,12 +13,11 @@ use gitoxide_core as core;
 use gitoxide_core::pack::verify;
 use gix::bstr::io::BufReadExt;
 
-use crate::plumbing::options::commitgraph;
 use crate::{
     plumbing::{
         options::{
-            attributes, commit, config, credential, exclude, free, index, mailmap, odb, revision, tree, Args,
-            Subcommands,
+            attributes, commit, commitgraph, config, credential, exclude, free, index, mailmap, odb, revision, tree,
+            Args, Subcommands,
         },
         show_progress,
     },
@@ -136,7 +135,9 @@ pub fn main() -> Result<()> {
                 progress,
                 progress_keep_open,
                 None,
-                move |_progress, out, _err| core::commitgraph::list(repository(Mode::Lenient)?, spec, out, format),
+                move |_progress, out, _err| {
+                    core::repository::commitgraph::list(repository(Mode::Lenient)?, spec, out, format)
+                },
             )
             .map(|_| ()),
             commitgraph::Subcommands::Verify { statistics } => prepare_and_run(
@@ -147,9 +148,9 @@ pub fn main() -> Result<()> {
                 None,
                 move |_progress, out, err| {
                     let output_statistics = if statistics { Some(format) } else { None };
-                    core::commitgraph::verify(
+                    core::repository::commitgraph::verify(
                         repository(Mode::Lenient)?,
-                        core::commitgraph::verify::Context {
+                        core::repository::commitgraph::verify::Context {
                             err,
                             out,
                             output_statistics,
@@ -301,6 +302,27 @@ pub fn main() -> Result<()> {
         )
         .map(|_| ()),
         Subcommands::Free(subcommands) => match subcommands {
+            free::Subcommands::CommitGraph(cmd) => match cmd {
+                free::commitgraph::Subcommands::Verify { path, statistics } => prepare_and_run(
+                    "commitgraph-verify",
+                    auto_verbose,
+                    progress,
+                    progress_keep_open,
+                    None,
+                    move |_progress, out, err| {
+                        let output_statistics = if statistics { Some(format) } else { None };
+                        core::commitgraph::verify(
+                            path,
+                            core::commitgraph::verify::Context {
+                                err,
+                                out,
+                                output_statistics,
+                            },
+                        )
+                    },
+                )
+                .map(|_| ()),
+            },
             free::Subcommands::Index(free::index::Platform {
                 object_hash,
                 index_path,

src/plumbing/options/free.rs

@@ -1,6 +1,9 @@
 #[derive(Debug, clap::Subcommand)]
 #[clap(visible_alias = "no-repo")]
 pub enum Subcommands {
+    /// Subcommands for interacting with commit-graphs
+    #[clap(subcommand)]
+    CommitGraph(commitgraph::Subcommands),
     /// Subcommands for interacting with mailmaps
     Mailmap {
         #[clap(flatten)]
@@ -13,6 +16,23 @@ pub enum Subcommands {
     Index(index::Platform),
 }
 
+///
+pub mod commitgraph {
+    use std::path::PathBuf;
+
+    #[derive(Debug, clap::Subcommand)]
+    pub enum Subcommands {
+        /// Verify the integrity of a commit graph
+        Verify {
+            /// The path to '.git/objects/info/', '.git/objects/info/commit-graphs/', or '.git/objects/info/commit-graph' to validate.
+            path: PathBuf,
+            /// output statistical information about the pack
+            #[clap(long, short = 's')]
+            statistics: bool,
+        },
+    }
+}
+
 pub mod index {
     use std::path::PathBuf;