test(aggregator): streamline tooling for snapshotter & file archiver

Co-authored-by: Damien Lachaume <[email protected]>

Author: Alenar

mithril-aggregator/src/services/snapshotter/compressed_archive_snapshotter.rs

@@ -273,9 +273,10 @@ mod tests {
         let test_dir =
             get_test_directory("should_create_snapshots_in_its_ongoing_snapshot_directory");
         let pending_snapshot_directory = test_dir.join("pending_snapshot");
-        let db_directory = test_dir.join(create_dir(&test_dir, "db"));
+        let db_directory = test_dir.join("db");
 
-        create_file(&db_directory, "file_to_archive.txt");
+        fs::create_dir(&db_directory).unwrap();
+        File::create(&db_directory.join("file_to_archive.txt")).unwrap();
 
         let snapshotter = CompressedArchiveSnapshotter::new(
             db_directory,
@@ -313,7 +314,7 @@ mod tests {
                 .snapshot_immutable_trio(2, "immutable-2")
                 .unwrap();
 
-            let unpack_dir = unpack_gz_decoder(test_dir, snapshot);
+            let unpack_dir = snapshot.unpack_gzip(&test_dir);
             let unpacked_files = list_files(&unpack_dir);
             let unpacked_immutable_files = list_files(&unpack_dir.join(IMMUTABLE_DIR));
 
@@ -354,7 +355,7 @@ mod tests {
 
             let snapshot = snapshotter.snapshot_ancillary(2, "ancillary").unwrap();
 
-            let unpack_dir = unpack_gz_decoder(test_dir, snapshot);
+            let unpack_dir = snapshot.unpack_gzip(&test_dir);
 
             let expected_immutable_path = unpack_dir.join(IMMUTABLE_DIR);
             assert!(expected_immutable_path.join("00003.chunk").exists());

mithril-aggregator/src/services/snapshotter/mod.rs

@@ -8,38 +8,11 @@ pub use test_doubles::*;
 
 #[cfg(test)]
 pub(crate) mod test_tools {
-    use flate2::read::GzDecoder;
-    use std::fs::File;
-    use std::path::{Path, PathBuf};
-    use tar::Archive;
+    use std::path::PathBuf;
 
     use mithril_common::test_utils::TempDir;
 
-    use crate::tools::file_archiver::FileArchive;
-
     pub fn get_test_directory(dir_name: &str) -> PathBuf {
         TempDir::create("snapshotter", dir_name)
     }
-
-    pub fn create_file(root: &Path, filename: &str) -> PathBuf {
-        let file_path = PathBuf::from(filename);
-        File::create(root.join(file_path.clone())).unwrap();
-        file_path
-    }
-
-    pub fn create_dir(root: &Path, dirname: &str) -> PathBuf {
-        let dir_path = PathBuf::from(dirname);
-        std::fs::create_dir(root.join(dir_path.clone())).unwrap();
-        dir_path
-    }
-
-    pub fn unpack_gz_decoder(test_dir: PathBuf, snapshot: FileArchive) -> PathBuf {
-        let file_tar_gz = File::open(snapshot.get_file_path()).unwrap();
-        let file_tar_gz_decoder = GzDecoder::new(file_tar_gz);
-        let mut archive = Archive::new(file_tar_gz_decoder);
-        let unpack_path = test_dir.join(create_dir(&test_dir, "unpack"));
-        archive.unpack(&unpack_path).unwrap();
-
-        unpack_path
-    }
 }

mithril-aggregator/src/tools/file_archiver/api.rs

@@ -454,7 +454,7 @@ mod tests {
 
         assert_ne!(first_snapshot_size, second_snapshot_size);
 
-        let unpack_path = unpack_gz_decoder(test_dir, second_snapshot);
+        let unpack_path = second_snapshot.unpack_gzip(&test_dir);
         assert!(unpack_path.join("another_file_to_archive.txt").exists());
     }
 

mithril-aggregator/src/tools/file_archiver/appender.rs

@@ -197,7 +197,7 @@ mod tests {
             )
             .unwrap();
 
-        let unpack_path = unpack_gz_decoder(&test_dir, snapshot);
+        let unpack_path = snapshot.unpack_gzip(&test_dir);
 
         assert!(unpack_path.join(directory_to_archive_path).is_dir());
         assert!(unpack_path.join(file_to_archive_path).is_file());
@@ -262,7 +262,7 @@ mod tests {
             )
             .unwrap();
 
-        let unpack_path = unpack_gz_decoder(&test_dir, snapshot);
+        let unpack_path = snapshot.unpack_gzip(&test_dir);
 
         assert!(unpack_path.join(directory_to_archive_path).is_dir());
         assert!(unpack_path.join(file_to_archive_path).is_file());
@@ -285,7 +285,7 @@ mod tests {
             )
             .unwrap();
 
-        let unpack_path = unpack_gz_decoder(&test_dir, archive);
+        let unpack_path = archive.unpack_gzip(&test_dir);
 
         assert!(unpack_path.join(file_to_archive).exists());
     }

mithril-aggregator/src/tools/file_archiver/entities.rs

@@ -79,6 +79,29 @@ impl FileArchive {
     pub fn get_compression_algorithm(&self) -> CompressionAlgorithm {
         self.compression_algorithm
     }
+
+    /// Unpack the archive to a directory.
+    ///
+    /// An 'unpack' directory will be created in the given parent directory.
+    #[cfg(test)]
+    pub fn unpack_gzip<P: AsRef<Path>>(&self, parent_dir: P) -> PathBuf {
+        use super::test_tools::create_dir;
+        use flate2::read::GzDecoder;
+        use std::fs::File;
+        use tar::Archive;
+        if self.compression_algorithm != CompressionAlgorithm::Gzip {
+            panic!("Only Gzip compression is supported");
+        }
+
+        let parent_dir = parent_dir.as_ref();
+        let file_tar_gz = File::open(self.get_file_path()).unwrap();
+        let file_tar_gz_decoder = GzDecoder::new(file_tar_gz);
+        let mut archive = Archive::new(file_tar_gz_decoder);
+        let unpack_path = parent_dir.join(create_dir(parent_dir, "unpack"));
+        archive.unpack(&unpack_path).unwrap();
+
+        unpack_path
+    }
 }
 
 #[cfg(test)]

mithril-aggregator/src/tools/file_archiver/mod.rs

@@ -5,18 +5,13 @@ mod entities;
 pub use api::*;
 pub use entities::*;
 
-// Todo: unduplicate this code
 #[cfg(test)]
 pub(crate) mod test_tools {
-    use flate2::read::GzDecoder;
     use std::fs::File;
     use std::path::{Path, PathBuf};
-    use tar::Archive;
 
     use mithril_common::test_utils::TempDir;
 
-    use super::*;
-
     pub fn get_test_directory(dir_name: &str) -> PathBuf {
         TempDir::create("file_archiver", dir_name)
     }
@@ -38,15 +33,4 @@ pub(crate) mod test_tools {
         std::fs::create_dir(root.join(dir_path.clone())).unwrap();
         dir_path
     }
-
-    pub fn unpack_gz_decoder<P: AsRef<Path>>(test_dir: P, file_archive: FileArchive) -> PathBuf {
-        let test_dir = test_dir.as_ref();
-        let file_tar_gz = File::open(file_archive.get_file_path()).unwrap();
-        let file_tar_gz_decoder = GzDecoder::new(file_tar_gz);
-        let mut archive = Archive::new(file_tar_gz_decoder);
-        let unpack_path = test_dir.join(create_dir(test_dir, "unpack"));
-        archive.unpack(&unpack_path).unwrap();
-
-        unpack_path
-    }
 }