mithril_aggregator/tools/file_archiver/
entities.rs

1use std::path::{Path, PathBuf};
2
3use mithril_common::entities::CompressionAlgorithm;
4
5/// Parameters for creating an archive.
6#[derive(Debug, Clone, PartialEq, Eq)]
7pub struct ArchiveParameters {
8    pub archive_name_without_extension: String,
9    pub target_directory: PathBuf,
10    pub compression_algorithm: CompressionAlgorithm,
11}
12
13impl ArchiveParameters {
14    pub(super) fn target_path(&self) -> PathBuf {
15        self.target_directory.join(format!(
16            "{}.{}",
17            self.archive_name_without_extension,
18            self.compression_algorithm.tar_file_extension()
19        ))
20    }
21
22    pub(super) fn temporary_archive_path(&self) -> PathBuf {
23        self.target_directory
24            .join(format!("{}.tar.tmp", self.archive_name_without_extension))
25    }
26}
27
28/// Result of a file archiving operation, containing the path to the archive and its size.
29#[derive(Debug, Clone, PartialEq, Eq)]
30pub struct FileArchive {
31    pub(super) filepath: PathBuf,
32    pub(super) archive_filesize: u64,
33    pub(super) uncompressed_size: u64,
34    pub(super) compression_algorithm: CompressionAlgorithm,
35}
36
37impl FileArchive {
38    /// Create a new instance of FileArchive.
39    pub fn new(
40        filepath: PathBuf,
41        archive_filesize: u64,
42        uncompressed_size: u64,
43        compression_algorithm: CompressionAlgorithm,
44    ) -> Self {
45        Self {
46            filepath,
47            archive_filesize,
48            uncompressed_size,
49            compression_algorithm,
50        }
51    }
52
53    #[cfg(test)]
54    pub fn dummy() -> Self {
55        Self {
56            filepath: PathBuf::from("archive.tar.gz"),
57            archive_filesize: 10,
58            uncompressed_size: 789,
59            compression_algorithm: CompressionAlgorithm::Gzip,
60        }
61    }
62
63    /// Get the path of the archive.
64    pub fn get_file_path(&self) -> &Path {
65        &self.filepath
66    }
67
68    /// Get the size of the archive.
69    pub fn get_archive_size(&self) -> u64 {
70        self.archive_filesize
71    }
72
73    /// Get the size of the data before compression.
74    pub fn get_uncompressed_size(&self) -> u64 {
75        self.uncompressed_size
76    }
77
78    /// Get the compression algorithm used to create the archive.
79    pub fn get_compression_algorithm(&self) -> CompressionAlgorithm {
80        self.compression_algorithm
81    }
82
83    /// Unpack the archive to a directory.
84    ///
85    /// An 'unpack' directory will be created in the given parent directory.
86    #[cfg(test)]
87    pub fn unpack_gzip<P: AsRef<Path>>(&self, parent_dir: P) -> PathBuf {
88        use super::test_tools::create_dir;
89        use flate2::read::GzDecoder;
90        use std::fs::File;
91        use tar::Archive;
92        if self.compression_algorithm != CompressionAlgorithm::Gzip {
93            panic!("Only Gzip compression is supported");
94        }
95
96        let parent_dir = parent_dir.as_ref();
97        let file_tar_gz = File::open(self.get_file_path()).unwrap();
98        let file_tar_gz_decoder = GzDecoder::new(file_tar_gz);
99        let mut archive = Archive::new(file_tar_gz_decoder);
100        let unpack_path = parent_dir.join(create_dir(parent_dir, "unpack"));
101        archive.unpack(&unpack_path).unwrap();
102
103        unpack_path
104    }
105}
106
107#[cfg(test)]
108mod tests {
109    use super::*;
110
111    #[test]
112    fn getting_archive_parameters_target_path_should_not_override_trailing_dot_text() {
113        let archive_parameters = ArchiveParameters {
114            archive_name_without_extension: "archive.test_xxx".to_owned(),
115            target_directory: PathBuf::from("/tmp"),
116            compression_algorithm: CompressionAlgorithm::Gzip,
117        };
118
119        assert_eq!(
120            PathBuf::from("/tmp/archive.test_xxx.tar.gz"),
121            archive_parameters.target_path()
122        );
123    }
124
125    #[test]
126    fn getting_archive_parameters_temporary_archive_path_should_not_override_trailing_dot_text() {
127        let archive_parameters = ArchiveParameters {
128            archive_name_without_extension: "archive.test_xxx".to_owned(),
129            target_directory: PathBuf::from("/tmp"),
130            compression_algorithm: CompressionAlgorithm::Gzip,
131        };
132
133        assert_eq!(
134            PathBuf::from("/tmp/archive.test_xxx.tar.tmp"),
135            archive_parameters.temporary_archive_path()
136        );
137    }
138}
mithril_aggregator/tools/file_archiver/entities.rs

mithril_aggregator/tools/file_archiver/
entities.rs
