soar-config 0.10.0

Configuration management for soar package manager
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use std::path::PathBuf;

use documented::{Documented, DocumentedFields};
use serde::{Deserialize, Serialize};
use soar_utils::path::resolve_path;

use crate::error::Result;

/// A profile defines a local package store and its configuration.
#[derive(Clone, Deserialize, Serialize, Documented, DocumentedFields)]
pub struct Profile {
    /// Root directory for this profile’s data and packages.
    ///
    /// If `packages_path` is not set, packages will be stored in `root_path/packages`.
    pub root_path: String,

    /// Optional path where packages are stored.
    ///
    /// If unset, defaults to `root_path/packages`.
    pub packages_path: Option<String>,
}

impl Profile {
    pub(crate) fn get_bin_path(&self) -> Result<PathBuf> {
        Ok(self.get_root_path()?.join("bin"))
    }

    pub(crate) fn get_db_path(&self) -> Result<PathBuf> {
        Ok(self.get_root_path()?.join("db"))
    }

    pub fn get_packages_path(&self) -> Result<PathBuf> {
        if let Some(ref packages_path) = self.packages_path {
            Ok(resolve_path(packages_path)?)
        } else {
            Ok(self.get_root_path()?.join("packages"))
        }
    }

    pub fn get_cache_path(&self) -> Result<PathBuf> {
        Ok(self.get_root_path()?.join("cache"))
    }

    pub(crate) fn get_repositories_path(&self) -> Result<PathBuf> {
        Ok(self.get_root_path()?.join("repos"))
    }

    pub(crate) fn get_portable_dirs(&self) -> Result<PathBuf> {
        Ok(self.get_root_path()?.join("portable-dirs"))
    }

    pub fn get_root_path(&self) -> Result<PathBuf> {
        if let Ok(env_path) = std::env::var("SOAR_ROOT") {
            return Ok(resolve_path(&env_path)?);
        }
        Ok(resolve_path(&self.root_path)?)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_utils::with_env;

    #[test]
    fn test_profile_creation() {
        let profile = Profile {
            root_path: "/test/root".to_string(),
            packages_path: Some("/test/packages".to_string()),
        };

        assert_eq!(profile.root_path, "/test/root");
        assert_eq!(profile.packages_path, Some("/test/packages".to_string()));
    }

    #[test]
    fn test_profile_get_packages_path_explicit() {
        let profile = Profile {
            root_path: "/test/root".to_string(),
            packages_path: Some("/custom/packages".to_string()),
        };

        let path = profile.get_packages_path().unwrap();
        assert!(path.ends_with("packages"));
    }

    #[test]
    fn test_profile_get_packages_path_default() {
        let profile = Profile {
            root_path: "/test/root".to_string(),
            packages_path: None,
        };

        let path = profile.get_packages_path().unwrap();
        assert!(path.ends_with("packages"));
    }

    #[test]
    fn test_profile_get_root_path_env_override() {
        with_env(vec![("SOAR_ROOT", "/custom/root")], || {
            let profile = Profile {
                root_path: "/test/root".to_string(),
                packages_path: None,
            };

            let path = profile.get_root_path().unwrap();
            assert_eq!(path, PathBuf::from("/custom/root"));
        });
    }
}