sonda-core 1.5.0

Core engine for Sonda — synthetic telemetry generation library
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

//! Scenario metadata types for the built-in scenario catalog.
//!
//! This module defines the [`BuiltinScenario`] struct used by the CLI to
//! represent scenario entries discovered from the filesystem. Scenario YAML
//! files live outside the binary as standalone files in `scenarios/` at the
//! repository root, discovered via a search path.
//!
//! The CLI crate (`sonda`) owns the discovery logic (search path construction,
//! directory scanning, metadata probing). This module provides only the shared
//! data type.

/// A scenario entry discovered from the filesystem.
///
/// Populated by reading metadata fields (`scenario_name`, `category`,
/// `signal_type`, `description`) from the YAML file header. The full YAML
/// content is loaded lazily when the scenario is actually run.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BuiltinScenario {
    /// Kebab-case identifier (e.g. `"cpu-spike"`).
    pub name: String,
    /// Broad grouping: `"infrastructure"`, `"network"`, `"application"`,
    /// or `"observability"`.
    pub category: String,
    /// The signal type this scenario produces: `"metrics"`, `"logs"`,
    /// `"multi"`, `"histogram"`, or `"summary"`.
    pub signal_type: String,
    /// One-line human-readable description for list display.
    pub description: String,
    /// Absolute path to the YAML file on disk.
    pub source_path: std::path::PathBuf,
}

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

    // ---- Contract tests ---------------------------------------------------------

    #[test]
    fn builtin_scenario_is_send_and_sync() {
        fn assert_send_sync<T: Send + Sync>() {}
        assert_send_sync::<BuiltinScenario>();
    }

    #[test]
    fn builtin_scenario_clone_produces_equal_value() {
        let scenario = BuiltinScenario {
            name: "cpu-spike".to_string(),
            category: "infrastructure".to_string(),
            signal_type: "metrics".to_string(),
            description: "Test scenario".to_string(),
            source_path: std::path::PathBuf::from("/tmp/cpu-spike.yaml"),
        };
        let cloned = scenario.clone();
        assert_eq!(scenario, cloned);
    }

    #[test]
    fn builtin_scenario_debug_output_is_non_empty() {
        let scenario = BuiltinScenario {
            name: "test".to_string(),
            category: "test".to_string(),
            signal_type: "metrics".to_string(),
            description: "test".to_string(),
            source_path: std::path::PathBuf::from("/tmp/test.yaml"),
        };
        let debug = format!("{:?}", scenario);
        assert!(!debug.is_empty());
    }
}