test: add backup integration tests using snapshots (#175)

This PR adds some integration tests (mostly inspired by restic's
integration tests). We use `insta` for "snapshotting" internal state and
then compare against it depending on which operating system we are on.

---------

Signed-off-by: simonsan <[email protected]>
Co-authored-by: simonsan <[email protected]>

Author: aawsome

.github/workflows/ci-heavy.yml

@@ -83,7 +83,7 @@ jobs:
           toolchain: ${{ matrix.rust }}
       - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
       - name: Run Cargo Test
-        run: cargo +${{ matrix.rust }} test -r --all-targets --all-features --workspace --examples
+        run: cargo +${{ matrix.rust }} test --all-targets --all-features --workspace --examples
         id: run_tests
         env:
           INSTA_UPDATE: new

.github/workflows/ci.yml

@@ -4,6 +4,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
 
+env:
+  CI: true
+
 on:
   pull_request:
 
@@ -40,6 +43,8 @@ jobs:
     name: Test
     runs-on: ${{ matrix.job.os }}
     strategy:
+      # Don't fail fast, so we can actually see all the results
+      fail-fast: false
       matrix:
         rust: [stable]
         job:
@@ -64,7 +69,16 @@ jobs:
           toolchain: ${{ matrix.rust }}
       - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2
       - name: Run Cargo Test
-        run: cargo +${{ matrix.rust }} test -r --all-targets --all-features --workspace --examples
+        run: cargo +${{ matrix.rust }} test --all-targets --all-features --workspace --examples
+        id: run_tests
+        env:
+          INSTA_UPDATE: new
+      - name: Upload snapshots of failed tests
+        if: ${{ failure() && steps.run_tests.outcome == 'failure' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: failed-snapshots-${{ matrix.job.os }}
+          path: "**/snapshots/*.snap.new"
 
   docs:
     name: Build docs

.gitignore

@@ -15,3 +15,6 @@ coverage/*.info
 
 # local repo config
 .cargo/config.toml
+
+# Generated by Tests
+crates/core/tests/generated/

Cargo.toml

@@ -13,8 +13,12 @@ rust-version = "1.72.1"
 
 [workspace.dependencies]
 aho-corasick = "1.1.2"
+anyhow = "1.0.81"
+bytes = "1.5.0"
+enum-map = "2.7.3"
 rustic_backend = { path = "crates/backend" }
 rustic_core = { path = "crates/core" }
+rustic_testing = { path = "crates/testing" }
 simplelog = "0.12.2"
 
 # dev-dependencies

crates/core/Cargo.toml

@@ -102,11 +102,11 @@ futures = { version = "0.3", optional = true }
 runtime-format = "0.1.3"
 
 # other dependencies
-anyhow = "1.0.81"
-bytes = "1.5.0"
+anyhow = { workspace = true }
+bytes = { workspace = true }
 bytesize = "1.3.0"
 chrono = { version = "0.4.35", default-features = false, features = ["clock", "serde"] }
-enum-map = "2.7.3"
+enum-map = { workspace = true }
 enum-map-derive = "0.17.0"
 enumset = { version = "1.1.3", features = ["serde"] }
 gethostname = "0.4.3"
@@ -132,6 +132,8 @@ xattr = "1"
 
 [dev-dependencies]
 expect-test = "1.4.1"
+flate2 = "1.0.28"
+insta = { version = "1.36.1", features = ["redactions", "ron"] }
 mockall = "0.12.1"
 pretty_assertions = "1.4.0"
 quickcheck = "1.0.3"
@@ -140,8 +142,10 @@ rstest = { workspace = true }
 rustdoc-json = "0.8.9"
 # We need to have rustic_backend here, because the doc-tests in lib.rs of rustic_core
 rustic_backend = { workspace = true }
+rustic_testing = { workspace = true }
 rustup-toolchain = "0.1.6"
 simplelog = "0.12.2"
+tar = "0.4.40"
 tempfile = { workspace = true }
 
 [lints]

crates/core/src/backend.rs

@@ -13,9 +13,12 @@ use std::{io::Read, ops::Deref, path::PathBuf, sync::Arc};
 
 use anyhow::Result;
 use bytes::Bytes;
+use enum_map::Enum;
 use log::trace;
+
 #[cfg(test)]
-use mockall::*;
+use mockall::mock;
+
 use serde_derive::{Deserialize, Serialize};
 
 use crate::{
@@ -34,7 +37,7 @@ pub const ALL_FILE_TYPES: [FileType; 4] = [
 ];
 
 /// Type for describing the kind of a file that can occur.
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, Enum)]
 pub enum FileType {
     /// Config file
     #[serde(rename = "config")]
@@ -295,7 +298,9 @@ pub trait WriteBackend: ReadBackend {
     /// # Returns
     ///
     /// The result of the creation.
-    fn create(&self) -> Result<()>;
+    fn create(&self) -> Result<()> {
+        Ok(())
+    }
 
     /// Writes bytes to the given file.
     ///

crates/core/src/commands/merge.rs

@@ -39,7 +39,12 @@ pub(crate) fn merge_snapshots<P: ProgressBars, S: IndexedTree>(
 ) -> RusticResult<SnapshotFile> {
     let now = Local::now();
 
-    let paths = PathList::from_strings(snapshots.iter().flat_map(|snap| snap.paths.iter())).merge();
+    let paths = snapshots
+        .iter()
+        .flat_map(|snap| snap.paths.iter())
+        .collect::<PathList>()
+        .merge();
+
     snap.paths.set_paths(&paths.paths())?;
 
     // set snapshot time to time of latest snapshot to be merged

crates/core/src/lib.rs

@@ -45,10 +45,10 @@ implement [`serde::Serialize`] and [`serde::Deserialize`].
 
     let config_opts = ConfigOptions::default();
 
-    let _repo = Repository::new(&repo_opts, backends.clone()).unwrap().init(&key_opts, &config_opts).unwrap();
+    let _repo = Repository::new(&repo_opts, &backends.clone()).unwrap().init(&key_opts, &config_opts).unwrap();
 
     // We could have used _repo directly, but open the repository again to show how to open it...
-    let repo = Repository::new(&repo_opts, backends).unwrap().open().unwrap();
+    let repo = Repository::new(&repo_opts, &backends).unwrap().open().unwrap();
 
     // Get all snapshots from the repository
     let snaps = repo.get_all_snapshots().unwrap();

crates/core/src/repofile/snapshotfile.rs

@@ -1100,25 +1100,31 @@ impl Display for PathList {
     }
 }
 
-impl PathList {
-    /// Create a `PathList` from `String`s.
-    ///
-    /// # Arguments
-    ///
-    /// * `source` - The `String`s to use
-    pub fn from_strings<I>(source: I) -> Self
-    where
-        I: IntoIterator,
-        I::Item: AsRef<str>,
-    {
-        Self(
-            source
-                .into_iter()
-                .map(|source| PathBuf::from(source.as_ref()))
-                .collect(),
-        )
+impl FromIterator<PathBuf> for PathList {
+    fn from_iter<I: IntoIterator<Item = PathBuf>>(iter: I) -> Self {
+        Self(iter.into_iter().collect())
     }
+}
 
+impl<'a> FromIterator<&'a String> for PathList {
+    fn from_iter<I: IntoIterator<Item = &'a String>>(iter: I) -> Self {
+        Self(iter.into_iter().map(PathBuf::from).collect())
+    }
+}
+
+impl FromIterator<String> for PathList {
+    fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> Self {
+        Self(iter.into_iter().map(PathBuf::from).collect())
+    }
+}
+
+impl<'a> FromIterator<&'a str> for PathList {
+    fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self {
+        Self(iter.into_iter().map(PathBuf::from).collect())
+    }
+}
+
+impl PathList {
     /// Create a `PathList` by parsing a Strings containing paths separated by whitspaces.
     ///
     /// # Arguments
@@ -1132,7 +1138,7 @@ impl PathList {
     /// [`SnapshotFileErrorKind::FromSplitError`]: crate::error::SnapshotFileErrorKind::FromSplitError
     pub fn from_string(sources: &str) -> RusticResult<Self> {
         let sources = split(sources).map_err(SnapshotFileErrorKind::FromSplitError)?;
-        Ok(Self::from_strings(sources))
+        Ok(Self::from_iter(sources))
     }
 
     /// Number of paths in the `PathList`.

crates/core/src/repository.rs

@@ -1452,6 +1452,7 @@ impl<P, S: IndexedTree> Repository<P, S> {
     /// # Arguments
     ///
     /// * `id` - The `Id` of the tree
+    // TODO!: This ID should be a tree ID, we should refactor it to wrap it in a TreeId type
     ///
     /// # Errors
     ///
@@ -1475,6 +1476,7 @@ impl<P, S: IndexedTree> Repository<P, S> {
     /// # Arguments
     ///
     /// * `root_tree` - The `Id` of the root tree
+    // TODO!: This ID should be a tree ID, we should refactor it to wrap it in a TreeId type
     /// * `path` - The path
     ///
     /// # Errors