app-json-settings 2.5.0

Tiny typed JSON settings persistence 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
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
use super::ConfigManager;
use super::validation::{is_plain_file_name, is_safe_path_component};

use serde::{Deserialize, Serialize};
use std::fs;
use std::path::PathBuf;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::time::{SystemTime, UNIX_EPOCH};

static TEST_COUNTER: AtomicUsize = AtomicUsize::new(0);

#[derive(Debug, Default, Deserialize, PartialEq, Serialize)]
struct TestSettings {
    volume: u32,
    enabled: bool,
}

fn temp_dir(name: &str) -> PathBuf {
    let unique = format!(
        "app-json-settings-{name}-{}-{}-{}",
        std::process::id(),
        SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .expect("system time should be after UNIX epoch")
            .as_nanos(),
        TEST_COUNTER.fetch_add(1, Ordering::SeqCst)
    );

    std::env::temp_dir().join(unique)
}

#[test]
fn with_root_dir_controls_settings_location() {
    let dir = temp_dir("root-dir");
    let manager = ConfigManager::<TestSettings>::new()
        .with_root_dir(&dir)
        .try_with_filename("user.json")
        .expect("file name should be valid");

    assert_eq!(manager.folder_path(), dir.as_path());
    assert_eq!(manager.file_name(), "user.json");
    assert_eq!(manager.path(), dir.join("user.json"));
}

#[test]
fn at_custom_dir_remains_backward_compatible_alias() {
    let dir = temp_dir("custom-dir");
    let manager = ConfigManager::<TestSettings>::new().at_custom_dir(&dir);

    assert_eq!(manager.folder_path(), dir.as_path());
}

#[test]
fn for_app_uses_explicit_app_identity() {
    let manager = ConfigManager::<TestSettings>::for_app("app-json-settings-test")
        .expect("app name should be valid");

    assert!(manager.folder_path().ends_with("app-json-settings-test"));
}

#[test]
fn new_does_not_panic() {
    // new() cannot report platform-resolution failure without an API break,
    // so it must fall back rather than panic even where resolution would
    // fail. Resolution failure itself is exercised directly against the
    // private seam in `core::dir::tests`, without mutating the real
    // environment; this test only proves the public constructor stays
    // infallible.
    let _ = ConfigManager::<TestSettings>::new();
}

#[test]
fn with_root_dir_works_independently_of_platform_resolution() {
    // with_root_dir() overwrites the folder path unconditionally, so it must
    // keep working as the documented escape hatch even in an environment
    // where platform resolution (HOME / %APPDATA%) would fail. This proves
    // the public escape hatch end to end; resolution failure itself is
    // proven directly against the private seam in `core::dir::tests`.
    let dir = temp_dir("root-dir-independent-of-resolution");
    let manager = ConfigManager::<TestSettings>::new()
        .with_root_dir(&dir)
        .try_with_filename("settings.json")
        .expect("file name should be valid");

    manager
        .save(&TestSettings {
            volume: 1,
            enabled: true,
        })
        .expect("save should succeed regardless of platform resolution");

    let loaded = manager.load().expect("load should succeed");
    assert_eq!(
        loaded,
        TestSettings {
            volume: 1,
            enabled: true,
        }
    );
}

#[test]
fn safe_file_name_validation_rejects_paths() {
    assert!(is_plain_file_name("settings.json"));
    assert!(is_safe_path_component("app-json-settings"));

    for value in [
        "",
        ".",
        "..",
        "../settings.json",
        "a/b.json",
        r"a\b.json",
        "C:settings.json",
    ] {
        assert!(!is_plain_file_name(value), "{value:?} should be invalid");
        assert!(
            ConfigManager::<TestSettings>::new()
                .try_with_filename(value)
                .is_err(),
            "{value:?} should be rejected by try_with_filename"
        );
    }
}

#[test]
fn save_and_load_round_trip_pretty_json() {
    let dir = temp_dir("round-trip");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    let expected = TestSettings {
        volume: 42,
        enabled: true,
    };

    manager.save(&expected).expect("save should succeed");

    let raw = fs::read_to_string(manager.path()).expect("settings file should be readable");
    assert!(raw.contains('\n'));

    let actual = manager.load().expect("load should succeed");
    assert_eq!(actual, expected);
}

#[test]
fn compact_json_can_be_selected() {
    let dir = temp_dir("compact");
    let manager = ConfigManager::<TestSettings>::new()
        .with_root_dir(&dir)
        .disable_pretty_json();

    manager
        .save(&TestSettings {
            volume: 7,
            enabled: true,
        })
        .expect("save should succeed");

    let raw = fs::read_to_string(manager.path()).expect("settings file should be readable");
    assert_eq!(raw, r#"{"volume":7,"enabled":true}"#);
}

#[test]
fn load_or_default_creates_missing_file() {
    let dir = temp_dir("default");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    let settings = manager
        .load_or_default()
        .expect("load_or_default should create default settings");

    assert_eq!(settings, TestSettings::default());
    assert!(manager.path().exists());
}

#[test]
fn load_reports_invalid_json_as_deserialization_error() {
    let dir = temp_dir("invalid-json");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    fs::create_dir_all(&dir).expect("test directory should be created");
    fs::write(manager.path(), "not-json").expect("invalid settings file should be written");

    let error = manager.load().expect_err("invalid JSON should fail");
    assert!(matches!(error, crate::ConfigError::Deserialize(_)));
}

#[test]
fn load_or_default_does_not_reset_an_existing_invalid_file() {
    // load_or_default() creates defaults only when the file is absent
    // (NotFound). An existing file that fails to parse must return
    // Deserialize, not silently reset to defaults -- and the file on disk
    // must be untouched, which is what actually proves no reset happened.
    let dir = temp_dir("invalid-json-no-reset");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    fs::create_dir_all(&dir).expect("test directory should be created");
    let invalid_content = "not-json";
    fs::write(manager.path(), invalid_content).expect("invalid settings file should be written");

    let error = manager
        .load_or_default()
        .expect_err("load_or_default should not silently reset an existing invalid file");
    assert!(matches!(error, crate::ConfigError::Deserialize(_)));

    let content_after =
        fs::read_to_string(manager.path()).expect("settings file should still be readable");
    assert_eq!(
        content_after, invalid_content,
        "the invalid file must be left exactly as it was, not reset"
    );
}

#[test]
fn update_modifies_and_persists_configuration() {
    let dir = temp_dir("update");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    let updated = manager
        .update(|settings| {
            settings.volume = 100;
            settings.enabled = true;
        })
        .expect("update should succeed");

    assert_eq!(
        updated,
        TestSettings {
            volume: 100,
            enabled: true,
        }
    );

    let loaded = manager.load().expect("saved settings should load");
    assert_eq!(loaded, updated);
}

#[test]
fn default_save_mode_is_atomic() {
    let manager = ConfigManager::<TestSettings>::new();
    assert_eq!(manager.save_mode(), super::SaveMode::Atomic);
}

#[test]
fn direct_save_mode_can_be_selected() {
    let manager = ConfigManager::<TestSettings>::new().with_direct_save();
    assert_eq!(manager.save_mode(), super::SaveMode::Direct);
}

#[test]
fn explicit_save_mode_can_be_selected() {
    let manager = ConfigManager::<TestSettings>::new().with_save_mode(super::SaveMode::Direct);
    assert_eq!(manager.save_mode(), super::SaveMode::Direct);
}

#[test]
fn direct_save_writes_settings_file() {
    let dir = temp_dir("direct-save");
    let manager = ConfigManager::<TestSettings>::new()
        .with_root_dir(&dir)
        .with_direct_save();

    manager
        .save(&TestSettings {
            volume: 9,
            enabled: false,
        })
        .expect("direct save should succeed");

    let loaded = manager.load().expect("direct-saved settings should load");
    assert_eq!(
        loaded,
        TestSettings {
            volume: 9,
            enabled: false,
        }
    );
}

#[test]
fn atomic_save_does_not_leave_temp_file_after_success() {
    let dir = temp_dir("atomic-temp-cleanup");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    manager
        .save(&TestSettings {
            volume: 11,
            enabled: true,
        })
        .expect("atomic save should succeed");

    let entries = fs::read_dir(&dir).expect("settings directory should exist");
    let temp_files: Vec<_> = entries
        .map(|entry| entry.expect("directory entry should be readable"))
        .filter(|entry| entry.file_name().to_string_lossy().contains(".tmp."))
        .collect();

    assert!(
        temp_files.is_empty(),
        "temporary files should be cleaned up"
    );
}

#[cfg(unix)]
#[test]
fn atomic_save_preserves_existing_mode_0600() {
    use std::os::unix::fs::PermissionsExt;

    let dir = temp_dir("mode-preserve-0600");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    manager
        .save(&TestSettings {
            volume: 1,
            enabled: false,
        })
        .expect("initial save should succeed");
    fs::set_permissions(manager.path(), fs::Permissions::from_mode(0o600))
        .expect("mode should be settable");

    manager
        .save(&TestSettings {
            volume: 2,
            enabled: true,
        })
        .expect("second save should succeed");

    let mode = fs::metadata(manager.path())
        .expect("settings file metadata should be readable")
        .permissions()
        .mode()
        & 0o777;
    assert_eq!(mode, 0o600, "mode was {mode:o}, expected preserved 0o600");
}

#[cfg(unix)]
#[test]
fn atomic_save_preserves_existing_mode_0644() {
    use std::os::unix::fs::PermissionsExt;

    let dir = temp_dir("mode-preserve-0644");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    manager
        .save(&TestSettings {
            volume: 1,
            enabled: false,
        })
        .expect("initial save should succeed");
    fs::set_permissions(manager.path(), fs::Permissions::from_mode(0o644))
        .expect("mode should be settable");

    manager
        .save(&TestSettings {
            volume: 2,
            enabled: true,
        })
        .expect("second save should succeed");

    let mode = fs::metadata(manager.path())
        .expect("settings file metadata should be readable")
        .permissions()
        .mode()
        & 0o777;
    assert_eq!(mode, 0o644, "mode was {mode:o}, expected preserved 0o644");
}

#[cfg(unix)]
#[test]
fn atomic_save_creates_new_file_owner_only() {
    use std::os::unix::fs::PermissionsExt;

    let dir = temp_dir("mode-new-file");
    let manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    manager
        .save(&TestSettings {
            volume: 3,
            enabled: true,
        })
        .expect("save should succeed");

    let mode = fs::metadata(manager.path())
        .expect("settings file metadata should be readable")
        .permissions()
        .mode()
        & 0o777;
    assert_eq!(mode, 0o600, "new file mode was {mode:o}, expected 0o600");
}

#[cfg(unix)]
#[test]
fn direct_save_mode_behavior_is_unchanged() {
    use std::os::unix::fs::PermissionsExt;

    let dir = temp_dir("mode-direct-save");
    let manager = ConfigManager::<TestSettings>::new()
        .with_root_dir(&dir)
        .with_direct_save();

    manager
        .save(&TestSettings {
            volume: 1,
            enabled: false,
        })
        .expect("initial save should succeed");
    fs::set_permissions(manager.path(), fs::Permissions::from_mode(0o600))
        .expect("mode should be settable");

    manager
        .save(&TestSettings {
            volume: 2,
            enabled: true,
        })
        .expect("second save should succeed");

    let mode = fs::metadata(manager.path())
        .expect("settings file metadata should be readable")
        .permissions()
        .mode()
        & 0o777;
    assert_eq!(
        mode, 0o600,
        "direct save should still preserve existing mode; was {mode:o}"
    );
}

#[derive(Debug, Deserialize)]
struct FailingSerializeSettings;

impl Serialize for FailingSerializeSettings {
    fn serialize<S>(&self, _serializer: S) -> std::result::Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        Err(serde::ser::Error::custom(
            "intentional serialization failure",
        ))
    }
}

#[test]
fn failed_serialization_preserves_existing_file() {
    let dir = temp_dir("serialization-failure-preserves-existing");
    let good_manager = ConfigManager::<TestSettings>::new().with_root_dir(&dir);

    good_manager
        .save(&TestSettings {
            volume: 5,
            enabled: true,
        })
        .expect("initial save should succeed");

    let before = fs::read_to_string(good_manager.path()).expect("existing file should be readable");

    let failing_manager = ConfigManager::<FailingSerializeSettings>::new().with_root_dir(&dir);
    let error = failing_manager
        .save(&FailingSerializeSettings)
        .expect_err("serialization should fail before touching storage");

    assert!(matches!(error, crate::ConfigError::Serialize(_)));
    let after =
        fs::read_to_string(good_manager.path()).expect("existing file should remain readable");
    assert_eq!(after, before);
}