frame for loose-db validation (#287)

Author: Byron

git-odb/src/store_impls/loose/mod.rs

@@ -52,6 +52,8 @@ fn hash_path(id: &git_hash::oid, mut root: PathBuf) -> PathBuf {
 pub mod find;
 ///
 pub mod iter;
+///
+pub mod verify;
 
 /// The type for an iterator over `Result<git_hash::ObjectId, Error>)`
 pub struct Iter {

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

@@ -0,0 +1,34 @@
+#![allow(missing_docs)]
+use crate::loose::Store;
+
+///
+pub mod integrity {
+    /// The error returned by [`verify_integrity()`][super::Store::verify_integrity()].
+    #[derive(Debug, thiserror::Error)]
+    #[allow(missing_docs)]
+    pub enum Error {
+        #[error("{kind} object {id} could not be decoded")]
+        ObjectDecode {
+            source: git_object::decode::Error,
+            kind: git_object::Kind,
+            id: git_hash::ObjectId,
+        },
+        #[error("{kind} object {expected} wasn't re-encoded without change - new hash is {actual}")]
+        ObjectEncodeMismatch {
+            kind: git_object::Kind,
+            actual: git_hash::ObjectId,
+            expected: git_hash::ObjectId,
+        },
+    }
+
+    pub struct Outcome {
+        /// The amount of loose objects we checked.
+        pub num_objects: usize,
+    }
+}
+
+impl Store {
+    pub fn verify_integrity(&self) -> Result<integrity::Outcome, integrity::Error> {
+        todo!()
+    }
+}

git-odb/tests/odb/sink/mod.rs

@@ -1,6 +1,6 @@
 use git_odb::Write;
 
-use crate::store::loose::backend::{locate_oid, object_ids};
+use crate::store::loose::{locate_oid, object_ids};
 
 #[test]
 fn write() -> Result<(), Box<dyn std::error::Error>> {

git-odb/tests/odb/store/loose/backend.rs renamed to git-odb/tests/odb/store/loose.rs

@@ -1,3 +1,6 @@
+use git_actor::{Sign, Time};
+use git_object::bstr::ByteSlice;
+
 use git_odb::loose::Store;
 use pretty_assertions::assert_eq;
 
@@ -29,10 +32,18 @@ pub fn locate_oid(id: git_hash::ObjectId, buf: &mut Vec<u8>) -> git_object::Data
     ldb().try_find(id, buf).expect("read success").expect("id present")
 }
 
+#[test]
+#[ignore]
+fn verify_integrity() {
+    let db = ldb();
+    let outcome = db.verify_integrity().unwrap();
+    assert_eq!(outcome.num_objects, 42);
+}
+
 mod write {
     use git_odb::{loose, Write};
 
-    use crate::store::loose::backend::{locate_oid, object_ids};
+    use crate::store::loose::{locate_oid, object_ids};
 
     #[test]
     fn read_and_write() -> Result<(), Box<dyn std::error::Error>> {
@@ -66,8 +77,7 @@ mod locate {
     use crate::{
         hex_to_id,
         store::loose::{
-            backend::{ldb, locate_oid},
-            signature,
+            signature, {ldb, locate_oid},
         },
     };
 
@@ -210,3 +220,15 @@ cjHJZXWmV4CcRfmLsXzU8s2cR9A0DBvOxhPD1TlKC2JhBFXigjuL9U4Rbq9tdegB
         Ok(())
     }
 }
+
+fn signature(time: u32) -> git_actor::SignatureRef<'static> {
+    git_actor::SignatureRef {
+        name: b"Sebastian Thiel".as_bstr(),
+        email: b"[email protected]".as_bstr(),
+        time: Time {
+            time,
+            offset: 7200,
+            sign: Sign::Plus,
+        },
+    }
+}

git-odb/tests/odb/store/loose/mod.rs

@@ -163,7 +163,7 @@ where
             match path.file_name() {
                 Some(file_name) if file_name == "multi-pack-index" => {
                     let multi_index = git::odb::pack::multi_index::File::at(path)?;
-                    let res = multi_index.verify_integrity(progress, should_interrupt, git::odb::pack::multi_index::verify::integrity::Options{
+                    let res = multi_index.verify_integrity(progress, should_interrupt, git::odb::pack::index::verify::integrity::Options{
                         verify_mode: mode,
                         traversal: algorithm.into(),
                         thread_limit,