cfgd-core 0.4.0

Core library for cfgd — shared types, providers, reconciler, state
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

//! Snapshot tests for the output renderer.
//!
//! Goldens live in `snapshots/`. Refresh by running:
//!   INSTA_UPDATE=always cargo test -p cfgd-core --features test-helpers output::tests
//!
//! Organized by topic covering ~91 cases — baseline, verbosity,
//! status × role, themes, indent, corners, and regression.

#[cfg(feature = "test-helpers")]
mod baseline;
#[cfg(feature = "test-helpers")]
mod corners;
#[cfg(feature = "test-helpers")]
mod indent;
#[cfg(feature = "test-helpers")]
mod regression;
#[cfg(feature = "test-helpers")]
mod status_role;
#[cfg(feature = "test-helpers")]
mod themes;
#[cfg(feature = "test-helpers")]
mod themes_raw;
#[cfg(feature = "test-helpers")]
mod verbosity;

/// Macro: build a Printer via `for_test_doc()`, run the body with `&p` and
/// `&cap`, then assert against `snapshots/<bucket>/<name>.txt`.
#[macro_export]
macro_rules! golden_doc {
    ($bucket:ident, $name:ident, |$p:ident, $cap:ident| $body:block) => {
        #[test]
        fn $name() {
            let ($p, $cap) = $crate::output::Printer::for_test_doc();
            $body
            $p.flush();
            $cap.assert_human_snapshot(&format!(
                "{}/{}.txt",
                stringify!($bucket),
                stringify!($name)
            ));
        }
    };
}

/// Macro: like `golden_doc!` but with explicit Verbosity. Used by the
/// verbosity tests to exercise verbosity gating without `for_test_doc()`'s
/// default Normal. Strips ANSI codes before snapshot comparison.
#[macro_export]
macro_rules! golden_at {
    ($bucket:ident, $name:ident, $verbosity:expr, |$p:ident| $body:block) => {
        #[test]
        fn $name() {
            let ($p, buf) = $crate::output::Printer::for_test_at($verbosity);
            $body
            $p.flush();
            let raw = buf.lock().unwrap().clone();
            let actual = $crate::output::strip_ansi(&raw);
            let path = std::path::Path::new("src/output/tests/snapshots")
                .join(stringify!($bucket))
                .join(format!("{}.txt", stringify!($name)));
            if std::env::var("INSTA_UPDATE").as_deref() == Ok("always") || !path.exists() {
                std::fs::create_dir_all(path.parent().unwrap()).unwrap();
                std::fs::write(&path, &actual).unwrap();
                return;
            }
            let expected = std::fs::read_to_string(&path).unwrap();
            // CRLF→LF: windows captures `\r\n`; committed snapshots use `\n`.
            let actual_norm = actual.replace("\r\n", "\n");
            let expected_norm = expected.replace("\r\n", "\n");
            pretty_assertions::assert_eq!(
                actual_norm, expected_norm, "snapshot mismatch: {}", stringify!($name));
        }
    };
}

/// Macro: like `golden_at!` but with an explicit Theme preset (Normal verbosity).
/// Used by the themes tests to render a representative Doc against every preset.
/// Strips ANSI codes before snapshot comparison so color-only theme differences
/// collapse — preset divergence comes from glyph swaps (e.g., `minimal`).
#[macro_export]
macro_rules! golden_themed {
    ($bucket:ident, $name:ident, $theme_name:expr, |$p:ident| $body:block) => {
        #[test]
        fn $name() {
            let ($p, buf) = $crate::output::Printer::for_test_with_theme(
                $crate::output::Theme::from_preset($theme_name),
                $crate::output::Verbosity::Normal,
            );
            $body
            $p.flush();
            let raw = buf.lock().unwrap().clone();
            let actual = $crate::output::strip_ansi(&raw);
            let path = std::path::Path::new("src/output/tests/snapshots")
                .join(stringify!($bucket))
                .join(format!("{}.txt", stringify!($name)));
            if std::env::var("INSTA_UPDATE").as_deref() == Ok("always") || !path.exists() {
                std::fs::create_dir_all(path.parent().unwrap()).unwrap();
                std::fs::write(&path, &actual).unwrap();
                return;
            }
            let expected = std::fs::read_to_string(&path).unwrap();
            // CRLF→LF: windows captures `\r\n`; committed snapshots use `\n`.
            let actual_norm = actual.replace("\r\n", "\n");
            let expected_norm = expected.replace("\r\n", "\n");
            pretty_assertions::assert_eq!(
                actual_norm, expected_norm, "snapshot mismatch: {}", stringify!($name));
        }
    };
}