Very rough version of repository verification (#287)

Author: Byron

git-odb/src/store_impls/dynamic/verify.rs

@@ -10,6 +10,9 @@ pub mod integrity {
     use crate::pack;
     use std::path::PathBuf;
 
+    /// Options for use in [`Store::verify_integrity()`][crate::Store::verify_integrity()].
+    pub type Options<F> = pack::index::verify::integrity::Options<F>;
+
     /// Returned by [`Store::verify_integrity()`][crate::Store::verify_integrity()].
     #[derive(Debug, thiserror::Error)]
     #[allow(missing_docs)]
@@ -81,7 +84,7 @@ impl super::Store {
         &self,
         mut progress: P,
         should_interrupt: &AtomicBool,
-        options: pack::index::verify::integrity::Options<F>,
+        options: integrity::Options<F>,
     ) -> Result<integrity::Outcome<P>, integrity::Error>
     where
         P: Progress,

gitoxide-core/src/repository.rs

@@ -6,3 +6,29 @@ pub fn init(directory: Option<PathBuf>) -> Result<git_repository::Path> {
     git_repository::path::create::into(directory.unwrap_or_default(), git_repository::Kind::WorkTree)
         .with_context(|| "Repository initialization failed")
 }
+
+pub mod verify {
+    use crate::OutputFormat;
+    use git_repository::Progress;
+    use std::path::PathBuf;
+    use std::sync::atomic::AtomicBool;
+
+    pub const PROGRESS_RANGE: std::ops::RangeInclusive<u8> = 1..=4;
+
+    pub fn integrity(
+        repo: PathBuf,
+        _format: OutputFormat,
+        _out: impl std::io::Write,
+        progress: impl Progress,
+        should_interrupt: &AtomicBool,
+    ) -> anyhow::Result<()> {
+        let repo = git_repository::open(repo)?;
+        // TODO: a way to get the pack cache from a handle
+        repo.objects.verify_integrity(
+            progress,
+            should_interrupt,
+            git_repository::odb::pack::index::verify::integrity::Options::default(),
+        )?;
+        Ok(())
+    }
+}

src/plumbing/main.rs

@@ -14,6 +14,7 @@ use gitoxide_core::pack::verify;
 
 #[cfg(any(feature = "gitoxide-core-async-client", feature = "gitoxide-core-blocking-client"))]
 use crate::plumbing::options::remote;
+use crate::plumbing::options::repo;
 use crate::{
     plumbing::options::{commitgraph, pack, Args, Subcommands},
     shared::pretty::prepare_and_run,
@@ -73,6 +74,18 @@ pub fn main() -> Result<()> {
     })?;
 
     match cmd {
+        Subcommands::Repository(subcommands) => match subcommands {
+            repo::Subcommands::Verify { repository } => prepare_and_run(
+                "repository-verify",
+                verbose,
+                progress,
+                progress_keep_open,
+                core::repository::verify::PROGRESS_RANGE,
+                move |progress, out, _err| {
+                    core::repository::verify::integrity(repository, format, out, progress, &should_interrupt)
+                },
+            ),
+        },
         Subcommands::Pack(subcommands) => match subcommands {
             pack::Subcommands::Create {
                 repository,

src/plumbing/options.rs

@@ -3,7 +3,7 @@ use gitoxide_core as core;
 
 #[derive(Debug, clap::Parser)]
 #[clap(name = "gix-plumbing", about = "The git underworld", version = clap::crate_version!())]
-#[clap(setting = AppSettings::SubcommandRequired)]
+#[clap(setting = AppSettings::SubcommandRequiredElseHelp)]
 pub struct Args {
     #[clap(long, short = 't')]
     /// The amount of threads to use for some operations.
@@ -56,6 +56,9 @@ pub enum Subcommands {
     /// Subcommands for interacting with commit-graphs
     #[clap(subcommand)]
     CommitGraph(commitgraph::Subcommands),
+    /// Subcommands for interacting with entire git repositories
+    #[clap(subcommand)]
+    Repository(repo::Subcommands),
 }
 
 ///
@@ -313,6 +316,23 @@ pub mod pack {
     }
 }
 
+///
+pub mod repo {
+    use clap::AppSettings;
+    use std::path::PathBuf;
+
+    #[derive(Debug, clap::Parser)]
+    #[clap(alias = "repo")]
+    pub enum Subcommands {
+        /// Verify the integrity of the entire repository
+        #[clap(setting = AppSettings::DisableVersionFlag)]
+        Verify {
+            #[clap(short = 'r', long, default_value = ".")]
+            repository: PathBuf,
+        },
+    }
+}
+
 ///
 pub mod commitgraph {
     use clap::AppSettings;

tests/journey/gix.sh

@@ -39,6 +39,22 @@ title "git-tempfile crate"
   )
 )
 
+  title "gix repository"
+  (when "running 'repository'"
+    snapshot="$snapshot/repository"
+    (small-repo-in-sandbox
+      (with "the 'verify' sub-command"
+        snapshot="$snapshot/verify"
+        (with 'human output format'
+          it "generates correct output" && {
+            WITH_SNAPSHOT="$snapshot/success-format-human" \
+            expect_run $SUCCESSFULLY "$exe_plumbing" --format human repo verify
+          }
+        )
+      )
+    )
+  )
+
 title "gix pack"
 (when "running 'pack'"
   snapshot="$snapshot/pack"