quilt-rs 0.31.1

Rust library for accessing Quilt data packages.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use tracing::debug;
use tracing::info;

use crate::Error;
use crate::InstallPackageError;
use crate::Res;
use crate::io::storage::Storage;
use crate::lineage::DomainLineage;
use crate::paths;
use quilt_uri::Namespace;

/// Uninstall package: remove files from working directory, manifest from `.quilt` and from
/// `.quilt/lineage.json`.
pub async fn uninstall_package(
    mut lineage: DomainLineage,
    paths: &paths::DomainPaths,
    storage: &impl Storage,
    namespace: Namespace,
) -> Res<DomainLineage> {
    info!("âŗ Uninstalling package {}", namespace);

    debug!("🔍 Checking if package exists in lineage");
    lineage
        .packages
        .remove(&namespace)
        .ok_or(Error::InstallPackage(InstallPackageError::NotInstalled(
            namespace.clone(),
        )))?;
    debug!("✔ī¸ Package removed from lineage");

    debug!("âŗ Removing installed manifests");
    let manifest_path = paths.installed_manifests_dir(&namespace);
    storage.remove_dir_all(&manifest_path).await?;
    debug!("✔ī¸ Removed manifests at: {}", manifest_path.display());

    debug!("âŗ Removing working directory");
    let package_home = paths::package_home(&lineage.home, &namespace);
    storage.remove_dir_all(&package_home).await?;
    debug!("✔ī¸ Removed working directory: {}", package_home.display());

    // TODO: Remove object files? But need to make sure no other manifest uses them.
    debug!("ℹī¸ Skipping object files cleanup - may be used by other packages");

    info!("✔ī¸ Successfully uninstalled package {}", namespace);
    Ok(lineage)
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;
    use test_log::test;

    use super::*;

    use crate::io::storage::mocks::MockStorage;
    use crate::lineage::Home;
    use crate::lineage::PackageLineage;

    #[test(tokio::test)]
    async fn test_panic_if_no_installed_package() {
        let lineage = DomainLineage::default();
        let storage = MockStorage::default();
        let paths = paths::DomainPaths::default();

        let namespace: Namespace = ("foo", "bar").into();
        let result = uninstall_package(lineage, &paths, &storage, namespace.clone()).await;
        assert!(matches!(
            result.unwrap_err(),
            Error::InstallPackage(InstallPackageError::NotInstalled(ns)) if ns == namespace
        ));
    }

    #[test(tokio::test)]
    async fn test_uninstall_package() -> Res {
        let (home, _temp_dir) = Home::from_temp_dir()?;

        let namespace = Namespace::from(("foo", "bar"));

        let paths = paths::DomainPaths::default();
        let storage = MockStorage::default();

        paths
            .scaffold_for_installing(&storage, &home, &namespace)
            .await?;

        let lineage = DomainLineage {
            home,
            packages: BTreeMap::from([(namespace.clone(), PackageLineage::default())]),
        };

        let lineage = uninstall_package(lineage, &paths, &storage, namespace).await?;
        assert!(lineage.packages.is_empty());
        Ok(())
    }
}