settings_loader 1.0.0

Opinionated configuration settings load mechanism for Rust applications
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use serde_json::json;
use settings_loader::introspection::SettingsIntrospection;
use settings_loader::metadata::{ConfigSchema, Constraint, SettingMetadata, SettingType, Visibility};
use std::fs;
use tempfile::tempdir;

#[test]
fn test_json_schema_generation() {
    let schema = ConfigSchema {
        name: "test-app".to_string(),
        version: "1.0.0".to_string(),
        settings: vec![
            SettingMetadata {
                key: "port".to_string(),
                label: "Server Port".to_string(),
                description: "The port to listen on".to_string(),
                setting_type: SettingType::Integer { min: Some(1), max: Some(65535) },
                default: Some(json!(8080)),
                constraints: vec![Constraint::Required],
                visibility: Visibility::Public,
                group: None,
            },
            SettingMetadata {
                key: "database.host".to_string(),
                label: "Database Host".to_string(),
                description: "Hostname of the database server".to_string(),
                setting_type: SettingType::String { pattern: None, min_length: None, max_length: None },
                default: Some(json!("localhost")),
                constraints: vec![],
                visibility: Visibility::Public,
                group: Some("database".to_string()),
            },
        ],
        groups: vec![],
    };

    let json_schema = schema.to_json_schema();

    // Verify structure
    assert_eq!(json_schema["type"], "object");
    assert_eq!(json_schema["title"], "test-app");
    assert!(json_schema["properties"]["port"].is_object());
    assert_eq!(json_schema["properties"]["port"]["type"], "integer");
    assert_eq!(json_schema["properties"]["port"]["minimum"], 1);

    // Verify nesting
    assert!(json_schema["properties"]["database"].is_object());
    assert_eq!(json_schema["properties"]["database"]["type"], "object");
    assert!(json_schema["properties"]["database"]["properties"]["host"].is_object());
}

#[test]
fn test_html_generation() {
    let schema = ConfigSchema {
        name: "test-app".to_string(),
        version: "1.0.0".to_string(),
        settings: vec![SettingMetadata {
            key: "port".to_string(),
            label: "Server Port".to_string(),
            description: "The port to listen on".to_string(),
            setting_type: SettingType::Integer { min: Some(1), max: Some(65535) },
            default: Some(json!(8080)),
            constraints: vec![Constraint::Required],
            visibility: Visibility::Public,
            group: None,
        }],
        groups: vec![],
    };

    let html = schema.to_html();
    assert!(html.contains("test-app Configuration Reference"));
    assert!(html.contains("Server Port"));
    assert!(html.contains("The port to listen on"));
    assert!(html.contains("8080"));
}

#[test]
fn test_toml_example_generation() {
    let schema = ConfigSchema {
        name: "test-app".to_string(),
        version: "1.0.0".to_string(),
        settings: vec![SettingMetadata {
            key: "database.host".to_string(),
            label: "Database Host".to_string(),
            description: "Hostname of the database server".to_string(),
            setting_type: SettingType::String { pattern: None, min_length: None, max_length: None },
            default: Some(json!("localhost")),
            constraints: vec![],
            visibility: Visibility::Public,
            group: Some("database".to_string()),
        }],
        groups: vec![],
    };

    let toml = schema.to_example_toml();
    assert!(toml.contains("[database]"));
    assert!(toml.contains("# Hostname of the database server"));
    assert!(toml.contains("host = \"localhost\""));
}

#[test]
fn test_export_methods() {
    let temp_dir = tempdir().unwrap();
    let schema = ConfigSchema {
        name: "test-app".to_string(),
        version: "1.0.0".to_string(),
        settings: vec![SettingMetadata {
            key: "port".to_string(),
            label: "Server Port".to_string(),
            description: "Port".to_string(),
            setting_type: SettingType::Integer { min: None, max: None },
            default: None,
            constraints: vec![],
            visibility: Visibility::Public,
            group: None,
        }],
        groups: vec![],
    };

    let json_path = temp_dir.path().join("schema.json");
    let html_path = temp_dir.path().join("docs.html");
    let toml_path = temp_dir.path().join("example.toml");

    schema.export_json_schema(&json_path).unwrap();
    schema.export_docs(&html_path).unwrap();
    schema.export_example_config(&toml_path).unwrap();

    assert!(json_path.exists());
    assert!(html_path.exists());
    assert!(toml_path.exists());

    let json_content = fs::read_to_string(json_path).unwrap();
    assert!(json_content.contains("\"type\": \"integer\""));
}