rcman 0.1.9

Framework-agnostic settings management with schema, backup/restore, secrets and derive macro support
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
//! Settings Workflow Integration Tests
//!
//! Tests for the complete settings lifecycle including:
//! - Creating and loading settings
//! - Saving and caching behavior
//! - Reset functionality
//! - Default value handling
//! - Environment variable overrides

mod common;

use common::{TestFixture, read_settings_file};
use serde_json::json;
use std::sync::{Arc, Mutex};

// =============================================================================
// Basic CRUD Operations
// =============================================================================

#[test]
fn test_create_and_load_settings() {
    let fixture = TestFixture::new();

    // Load settings (should get defaults)
    let settings = fixture.manager.get_all().unwrap();

    // Verify defaults match schema
    assert_eq!(settings.ui.theme, "dark");
    assert!((settings.ui.font_size - 14.0).abs() < f64::EPSILON);
    assert!(settings.general.tray_enabled);
    assert_eq!(settings.general.language, "en");
}

#[test]
fn test_save_setting_updates_cache() {
    let fixture = TestFixture::new();

    // Load initial settings
    let _ = fixture.manager.get_all().unwrap();

    // Save a new value
    fixture
        .manager
        .save_setting("ui", "theme", &json!("light"))
        .unwrap();

    // Load again - should get the cached/saved value
    let metadata = fixture.manager.metadata().unwrap();
    let theme_meta = metadata.get("ui.theme").unwrap();
    assert_eq!(theme_meta.value, Some(json!("light")));
}

#[test]
fn test_save_and_reload_persists() {
    let temp_dir = tempfile::TempDir::new().unwrap();
    let config_path = temp_dir.path().to_path_buf();

    // First session: save a value
    {
        let config = rcman::SettingsConfig::builder("test-app", "1.0.0")
            .with_config_dir(&config_path)
            .with_schema::<common::TestSettings>()
            .build();
        let manager = rcman::SettingsManager::new(config).unwrap();

        let _ = manager.get_all().unwrap();
        manager
            .save_setting("ui", "font_size", &json!(20.0))
            .unwrap();
    }

    // Second session: reload and verify
    {
        let config = rcman::SettingsConfig::builder("test-app", "1.0.0")
            .with_config_dir(&config_path)
            .with_schema::<common::TestSettings>()
            .build();
        let manager = rcman::SettingsManager::new(config).unwrap();

        let settings = manager.get_all().unwrap();
        assert!((settings.ui.font_size - 20.0).abs() < f64::EPSILON);
    }
}

// =============================================================================
// Reset Functionality
// =============================================================================

#[test]
fn test_reset_single_setting() {
    let fixture = TestFixture::new();

    // Load and modify
    let _ = fixture.manager.get_all().unwrap();
    fixture
        .manager
        .save_setting("ui", "theme", &json!("light"))
        .unwrap();

    // Reset to default
    let default_value = fixture.manager.reset_setting("ui", "theme").unwrap();

    assert_eq!(default_value, json!("dark"));

    // Verify it's back to default
    let metadata = fixture.manager.metadata().unwrap();
    let theme_meta = metadata.get("ui.theme").unwrap();
    assert_eq!(theme_meta.value, Some(json!("dark")));
}

#[test]
fn test_reset_all_settings() {
    let fixture = TestFixture::new();

    // Load and modify multiple settings
    let _ = fixture.manager.get_all().unwrap();
    fixture
        .manager
        .save_setting("ui", "theme", &json!("light"))
        .unwrap();
    fixture
        .manager
        .save_setting("ui", "font_size", &json!(20.0))
        .unwrap();
    fixture
        .manager
        .save_setting("general", "language", &json!("tr"))
        .unwrap();

    // Reset all
    fixture.manager.reset_all().unwrap();

    // Verify all are back to defaults
    let settings = fixture.manager.get_all().unwrap();
    assert_eq!(settings.ui.theme, "dark");
    assert!((settings.ui.font_size - 14.0).abs() < f64::EPSILON);
    assert_eq!(settings.general.language, "en");
}

#[test]
fn test_reset_all_emits_callbacks_for_changed_keys() {
    let fixture = TestFixture::new();

    let _ = fixture.manager.get_all().unwrap();

    fixture
        .manager
        .save_setting("ui", "theme", &json!("light"))
        .unwrap();
    fixture
        .manager
        .save_setting("general", "language", &json!("tr"))
        .unwrap();

    let events = Arc::new(Mutex::new(Vec::new()));
    let events_clone = Arc::clone(&events);
    fixture.manager.events().on_change(move |key, old, new| {
        events_clone
            .lock()
            .unwrap()
            .push((key.to_string(), old.clone(), new.clone()));
    });

    fixture.manager.reset_all().unwrap();

    let captured = events.lock().unwrap();
    assert_eq!(captured.len(), 2);
    assert!(captured.iter().any(|(key, old, new)| key == "ui.theme"
        && *old == json!("light")
        && *new == json!("dark")));
    assert!(captured.iter().any(|(key, old, new)| {
        key == "general.language" && *old == json!("tr") && *new == json!("en")
    }));
}

#[test]
fn test_reset_all_without_changes_emits_no_callbacks() {
    let fixture = TestFixture::new();

    let _ = fixture.manager.get_all().unwrap();

    let callback_count = Arc::new(Mutex::new(0usize));
    let callback_count_clone = Arc::clone(&callback_count);
    fixture.manager.events().on_change(move |_key, _old, _new| {
        let mut guard = callback_count_clone.lock().unwrap();
        *guard += 1;
    });

    fixture.manager.reset_all().unwrap();

    assert_eq!(*callback_count.lock().unwrap(), 0);
}

// =============================================================================
// Default Value Behavior
// =============================================================================

#[test]
fn test_default_value_not_stored_in_file() {
    let fixture = TestFixture::new();

    // Initially load settings
    let _ = fixture.manager.get_all().unwrap();

    // Save a non-default value first
    fixture
        .manager
        .save_setting("ui", "theme", &json!("light"))
        .unwrap();

    // Verify it's stored - checking for the category first
    let json = read_settings_file(&fixture).unwrap();
    assert!(json.get("ui").unwrap().get("theme").is_some());

    // Now save the default value back
    fixture
        .manager
        .save_setting("ui", "theme", &json!("dark"))
        .unwrap();

    // Default value should be REMOVED from the file
    let json = read_settings_file(&fixture).unwrap_or(json!({}));
    // Either the file is empty/non-existent (if all categories empty)
    // or the "ui" category might exist but "theme" should not be in it,
    // or "ui" category might be removed if empty.
    if let Some(ui) = json.get("ui") {
        assert!(ui.get("theme").is_none());
    }
}

#[test]
fn test_only_non_defaults_stored() {
    let fixture = TestFixture::new();

    // Load settings
    let _ = fixture.manager.get_all().unwrap();

    // Save one default and one non-default
    fixture
        .manager
        .save_setting("ui", "theme", &json!("dark")) // default
        .unwrap();
    fixture
        .manager
        .save_setting("ui", "font_size", &json!(20.0)) // non-default
        .unwrap();

    let json = read_settings_file(&fixture).unwrap();
    let ui = json.get("ui").expect("ui category should exist");

    // Default should not be stored
    assert!(ui.get("theme").is_none());
    // Non-default should be stored
    assert_eq!(ui.get("font_size"), Some(&json!(20.0)));
}

// =============================================================================
// Validation
// =============================================================================

#[test]
fn test_invalid_number_rejected() {
    let fixture = TestFixture::new();
    let _ = fixture.manager.get_all().unwrap();

    // Try to save a value outside the valid range (min=8, max=32)
    let result = fixture
        .manager
        .save_setting("ui", "font_size", &json!(100.0));

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("at most"));
}

#[test]
fn test_invalid_select_option_rejected() {
    let fixture = TestFixture::new();
    let _ = fixture.manager.get_all().unwrap();

    // Try to save an invalid option
    let result = fixture
        .manager
        .save_setting("ui", "theme", &json!("invalid_theme"));

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("available options"));
}

#[test]
fn test_setting_not_found_error() {
    let fixture = TestFixture::new();
    let _ = fixture.manager.get_all().unwrap();

    // Try to save a non-existent setting
    let result = fixture
        .manager
        .save_setting("nonexistent", "setting", &json!("value"));

    assert!(result.is_err());
}

// =============================================================================
// Environment Variable Overrides
// =============================================================================

#[test]
fn test_env_var_override() {
    let fixture = TestFixture::with_env_prefix("TESTAPP");

    // Set env var through mock
    fixture.env_source.set("TESTAPP_UI_THEME", "system");

    // Load settings
    let metadata = fixture.manager.metadata().unwrap();
    let theme_meta = metadata.get("ui.theme").unwrap();

    // Value should be overridden by env var
    assert_eq!(theme_meta.value, Some(json!("system")));
    assert!(theme_meta.get_meta_bool("env_override").unwrap_or(false));
}

#[test]
fn test_env_override_priority() {
    let temp_dir = tempfile::TempDir::new().unwrap();

    // First, save a value to file
    {
        let config = rcman::SettingsConfig::builder("test-app", "1.0.0")
            .with_config_dir(temp_dir.path())
            .with_schema::<common::TestSettings>()
            .build();
        let manager = rcman::SettingsManager::new(config).unwrap();

        let _ = manager.get_all().unwrap();
        manager
            .save_setting("ui", "theme", &json!("light"))
            .unwrap();
    }

    // Now load with env var override
    let env_source = std::sync::Arc::new(common::MockEnvSource::new());
    env_source.set("TEST2_UI_THEME", "system");

    let config = rcman::SettingsConfig::builder("test-app", "1.0.0")
        .with_config_dir(temp_dir.path())
        .with_schema::<common::TestSettings>()
        .with_env_prefix("TEST2")
        .with_env_source(env_source.clone() as std::sync::Arc<dyn rcman::EnvSource>)
        .build();
    let manager = rcman::SettingsManager::new(config).unwrap();

    let metadata = manager.metadata().unwrap();
    let theme_meta = metadata.get("ui.theme").unwrap();

    // Env var should override stored value
    assert_eq!(theme_meta.value, Some(json!("system")));
}

// =============================================================================
// Cache Invalidation
// =============================================================================

#[test]
fn test_invalidate_cache() {
    let fixture = TestFixture::new();

    // Load settings (populates cache)
    let _ = fixture.manager.get_all().unwrap();

    // Modify file directly (simulating external change)
    let path = fixture.settings_path();
    // Use correct nested structure
    std::fs::write(&path, r#"{"ui": {"theme": "light"}}"#).unwrap();

    // Cache still has old value
    let metadata = fixture.manager.metadata().unwrap();
    let theme_meta = metadata.get("ui.theme").unwrap();
    assert_eq!(theme_meta.value, Some(json!("dark"))); // cached default

    // Invalidate cache
    fixture.manager.invalidate_cache();

    // Now should pick up the file change
    let metadata = fixture.manager.metadata().unwrap();
    let theme_meta = metadata.get("ui.theme").unwrap();
    assert_eq!(theme_meta.value, Some(json!("light")));
}

// =============================================================================
// Path and File Settings
// =============================================================================

#[test]
fn test_path_and_file_settings() {
    let fixture = TestFixture::new();
    let _ = fixture.manager.get_all().unwrap();

    // Save directory path
    fixture
        .manager
        .save_setting("paths", "config_dir", &json!("/home/user/.config/myapp"))
        .unwrap();

    // Save file path
    fixture
        .manager
        .save_setting("paths", "log_file", &json!("/var/log/myapp.log"))
        .unwrap();

    // Reload and verify
    let metadata = fixture.manager.metadata().unwrap();

    let config_dir_meta = metadata.get("paths.config_dir").unwrap();
    assert_eq!(
        config_dir_meta.value,
        Some(json!("/home/user/.config/myapp"))
    );

    let log_file_meta = metadata.get("paths.log_file").unwrap();
    assert_eq!(log_file_meta.value, Some(json!("/var/log/myapp.log")));
}

// =============================================================================
// Concurrency
// =============================================================================

#[test]
fn test_concurrent_access() {
    use std::sync::Arc;
    use std::thread;

    let fixture = Arc::new(TestFixture::new());
    let mut handles = vec![];

    // Spawn 10 threads reading settings
    for _ in 0..10 {
        let fixture = Arc::clone(&fixture);
        handles.push(thread::spawn(move || {
            for _ in 0..50 {
                let _ = fixture.manager.metadata().unwrap();
            }
        }));
    }

    // Spawn 5 threads writing settings
    for i in 0..5 {
        let fixture = Arc::clone(&fixture);
        handles.push(thread::spawn(move || {
            for _ in 0..10 {
                let val = if i % 2 == 0 {
                    json!("light")
                } else {
                    json!("dark")
                };
                fixture.manager.save_setting("ui", "theme", &val).unwrap();
            }
        }));
    }

    // Wait for all
    for handle in handles {
        handle.join().unwrap();
    }

    // Verify consistency: data should be readable and valid JSON
    let metadata = fixture.manager.metadata().unwrap();
    let theme = metadata.get("ui.theme").unwrap();
    assert!(theme.value.is_some());
}