sui-spec 0.1.13

Declarative Lisp-authored specs for CppNix-parity behaviors. Rust types are the hard boundary; Lisp forms are the free-middle authoring surface. Both engines (tree-walker + VM) drive the same spec, so they cannot drift.
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
111
112

//! Typed border for nix-env / nix profile generations.
//!
//! A profile is `/nix/var/nix/profiles/<name>` — a symlink to the
//! current generation, with sibling `<name>-<N>-link` symlinks for
//! historical generations.  `nix-env -i`, `nix profile install`,
//! `home-manager activate` all maintain generations.  This module
//! names the structure.

use serde::{Deserialize, Serialize};
use tatara_lisp::DeriveTataraDomain;

use crate::SpecError;

#[derive(DeriveTataraDomain, Serialize, Deserialize, Debug, Clone)]
#[tatara(keyword = "defprofile-format")]
pub struct ProfileFormat {
    pub name: String,
    pub kind: ProfileKind,
    /// Pattern for generation-N symlinks (cppnix uses
    /// `<profile>-<N>-link`).
    #[serde(rename = "generationLinkPattern")]
    pub generation_link_pattern: String,
    /// Pattern for the manifest file (cppnix profile.* nests a
    /// JSON manifest after Nix 2.4).
    #[serde(rename = "manifestPath")]
    pub manifest_path: String,
}

#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ProfileKind {
    /// `/nix/var/nix/profiles/<name>` — system-level profile (root
    /// profile, system profile).
    System,
    /// `~/.nix-profile/` (legacy) or
    /// `~/.local/state/nix/profiles/profile/` (per-user 2.4+).
    User,
    /// nix-shell / nix develop ephemeral profile.  Cleaned at exit.
    Ephemeral,
}

pub const CANONICAL_PROFILE_LISP: &str = include_str!("../specs/profile.lisp");

/// Compile every authored profile format.
///
/// # Errors
///
/// Returns an error if the Lisp source fails to parse.
pub fn load_canonical() -> Result<Vec<ProfileFormat>, SpecError> {
    crate::loader::load_all::<ProfileFormat>(CANONICAL_PROFILE_LISP)
}

// ── M3.0 generation-link helpers ───────────────────────────────────

/// Compute the generation-link path for a profile + generation
/// number, substituting the format's `<profile>` and `<N>`
/// placeholders.
#[must_use]
pub fn generation_link(format: &ProfileFormat, profile: &str, n: u32) -> String {
    format
        .generation_link_pattern
        .replace("<profile>", profile)
        .replace("<N>", &n.to_string())
}

/// Compute the next generation link given the current generation
/// number.  Convenience wrapper around [`generation_link`].
#[must_use]
pub fn next_generation(format: &ProfileFormat, profile: &str, current: u32) -> String {
    generation_link(format, profile, current + 1)
}

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

    #[test]
    fn canonical_profile_parses() {
        let formats = load_canonical().unwrap();
        assert!(!formats.is_empty());
    }

    // ── M3.0 generation-link tests ─────────────────────────────

    fn system_fmt() -> ProfileFormat {
        load_canonical().unwrap().into_iter()
            .find(|f| f.name == "cppnix-system-profile").unwrap()
    }

    #[test]
    fn generation_link_substitutes_placeholders() {
        let f = system_fmt();
        let link = generation_link(&f, "system", 42);
        assert_eq!(link, "system-42-link");
    }

    #[test]
    fn next_generation_increments() {
        let f = system_fmt();
        let next = next_generation(&f, "system", 41);
        assert_eq!(next, "system-42-link");
    }

    #[test]
    fn three_profile_kinds_present() {
        let formats = load_canonical().unwrap();
        let kinds: std::collections::HashSet<ProfileKind> =
            formats.iter().map(|f| f.kind).collect();
        for required in [ProfileKind::System, ProfileKind::User, ProfileKind::Ephemeral] {
            assert!(kinds.contains(&required), "missing profile kind {required:?}");
        }
    }
}