lib-humus-configuration 0.2.0

Helper crate for reading configuration files into data structures using serde.
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

// SPDX-FileCopyrightText: 2025 Slatian
//
// SPDX-License-Identifier: LGPL-3.0-or-later

use crate::ConfigFormat;
use crate::Settings;
use crate::read_from_file;
#[cfg(feature = "json")]
use crate::read_from_json_file;
#[cfg(feature = "json5")]
use crate::read_from_json5_file;
#[cfg(feature = "toml")]
use crate::read_from_toml_file;
use serde::Deserialize;

#[derive(Debug, Deserialize, PartialEq, Eq)]
struct TestData {
	text: String,
	n: i64,
}

impl Default for TestData {
	fn default() -> Self {
		Self {
			text: "Foo Bar".to_string(),
			n: 123,
		}
	}
}

#[cfg(feature = "json")]
#[test]
fn test_reading_json() {
	// Test happy path
	let test_data: TestData = read_from_json_file("test-data/test.json").unwrap();
	assert_eq!(test_data, TestData::default());

	// Happy path with auto detection
	let (test_data, format): (TestData, ConfigFormat) =
		read_from_file("test-data/test.json", Settings::prefer_json()).unwrap();
	assert_eq!(test_data, TestData::default());
	assert_eq!(format, ConfigFormat::Json);
}

#[cfg(all(feature = "json", feature = "toml"))]
#[test]
fn test_reading_json_preferred_format_mismatch() {
	let (test_data, format): (TestData, ConfigFormat) =
		read_from_file("test-data/test.json", Settings::prefer_toml()).unwrap();
	assert_eq!(test_data, TestData::default());
	assert_eq!(format, ConfigFormat::Json);
}

#[cfg(all(feature = "json", feature = "json5"))]
#[test]
fn test_reading_json_format_mismatch() {
	// Test format mismatch
	let test_err = read_from_json_file::<TestData>("test-data/test.json5")
		.expect_err("Parsing JSON5 as JSON should fail");
	assert!(
		matches!(
			test_err.cause,
			crate::ErrorCause::FormatNotAllowed {
				format: ConfigFormat::Json5,
				prefer: ConfigFormat::Json
			}
		),
		"Expected a format not allowed error with the format set to Json5 and prefer set to Json, got: {test_err:?}"
	);
}

#[cfg(feature = "json5")]
#[test]
fn test_reading_json5() {
	// Test happy path
	let test_data: TestData = read_from_json5_file("test-data/test.json5").unwrap();
	assert_eq!(test_data, TestData::default());
	let test_data: TestData = read_from_json5_file("test-data/test.json").unwrap();
	assert_eq!(test_data, TestData::default());

	// Happy path with auto detection
	let (test_data, format): (TestData, ConfigFormat) =
		read_from_file("test-data/test.json5", Settings::prefer_json5()).unwrap();
	assert_eq!(test_data, TestData::default());
	assert_eq!(format, ConfigFormat::Json5);
}

#[cfg(all(feature = "json5", feature = "toml"))]
#[test]
fn test_reading_json5_preferred_format_mismatch() {
	let (test_data, format): (TestData, ConfigFormat) =
		read_from_file("test-data/test.json5", Settings::prefer_toml()).unwrap();
	assert_eq!(test_data, TestData::default());
	assert_eq!(format, ConfigFormat::Json5);
}

#[cfg(all(feature = "json5", feature = "toml"))]
#[test]
fn test_reading_json5_format_mismatch() {
	// Test format mismatch
	let test_err = read_from_json5_file::<TestData>("test-data/test.toml")
		.expect_err("Parsing TOML as JSON5 should fail");
	assert!(
		matches!(
			test_err.cause,
			crate::ErrorCause::FormatNotAllowed {
				format: ConfigFormat::Toml,
				prefer: ConfigFormat::Json5
			}
		),
		"Expected a format not allowed error with the format set to Json5 and prefer set to Json, got: {test_err:?}"
	);
}

#[cfg(feature = "toml")]
#[test]
fn test_reading_toml() {
	// Test happy path
	let test_data: TestData = read_from_toml_file("test-data/test.toml").unwrap();
	assert_eq!(test_data, TestData::default());

	// Happy path with auto detection
	let (test_data, format): (TestData, ConfigFormat) =
		read_from_file("test-data/test.toml", Settings::prefer_toml()).unwrap();
	assert_eq!(test_data, TestData::default());
	assert_eq!(format, ConfigFormat::Toml);
}

#[cfg(all(feature = "toml", feature = "json"))]
#[test]
fn test_reading_tom_preferred_format_mismatch() {
	let (test_data, format): (TestData, ConfigFormat) =
		read_from_file("test-data/test.toml", Settings::prefer_json()).unwrap();
	assert_eq!(test_data, TestData::default());
	assert_eq!(format, ConfigFormat::Toml);
}

#[cfg(all(feature = "toml", feature = "json"))]
#[test]
fn test_reading_toml_format_mismatch() {
	// Test format mismatch
	let test_err = read_from_toml_file::<TestData>("test-data/test.json")
		.expect_err("Parsing JSON as TOML should fail");
	assert!(
		matches!(
			test_err.cause,
			crate::ErrorCause::FormatNotAllowed {
				format: ConfigFormat::Json,
				prefer: ConfigFormat::Toml
			}
		),
		"Expected a format not allowed error with the format set to Json5 and prefer set to Json, got: {test_err:?}"
	);
}