tboudreaux/libconfig
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(loading): robust error reporting and mutation

Browse Source 
cfg now reports which fields are missing when loading. Further, the mutate method has been added for easier mutation of the underlying configuration struct
This commit is contained in:
Emily Boudreaux
2026-04-07 09:28:27 -04:00
parent 46dce35eaf
commit d4bbd9cb3a
9 changed files with 382 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
tests/config/configTest.cpp
View File

@@ -18,11 +18,20 @@ std::string get_good_example_file() {
return std::string(source_root) + "/tests/config/example_config_files/example.good.toml";
}
std::string get_good_missing_keys_example_file() {
const char* source_root = getenv("MESON_SOURCE_ROOT");
if (source_root == nullptr) {
throw std::runtime_error("MESON_SOURCE_ROOT environment variable is not set.");
}
return std::string(source_root) + "/tests/config/example_config_files/example.good.missing.field.toml";
}
enum class BAD_FILES {
UNKNOWN_KEY,
INVALID_TYPE,
INCORRECT_ARRAY_SIZE
INCORRECT_ARRAY_SIZE,
MISSING_NONDEFAULT_KEY
};
std::string get_bad_example_file(BAD_FILES type) {
@@ -37,6 +46,8 @@ std::string get_bad_example_file(BAD_FILES type) {
return std::string(source_root) + "/tests/config/example_config_files/example.invalidtype.toml";
case BAD_FILES::INCORRECT_ARRAY_SIZE:
return std::string(source_root) + "/tests/config/example_config_files/example.incorrectarraysize.toml";
case BAD_FILES::MISSING_NONDEFAULT_KEY:
return std::string(source_root) + "/tests/config/example_config_files/example.missing.nondefault.field.toml";
}
throw std::runtime_error("Invalid BAD_FILES type.");
}
@@ -131,3 +142,36 @@ TEST_F(configTest, save_schema) {
Config<TestConfigSchema> cfg;
EXPECT_NO_THROW(cfg.save_schema("TestConfigSchema.schema.json"));
}
TEST_F(configTest, missing_default_keys) {
using namespace fourdst::config;
Config<TestConfigSchema> cfg;
EXPECT_NO_THROW(cfg.load(get_good_example_file()));
}
TEST_F(configTest, missing_nondefault_keys) {
using namespace fourdst::config;
Config<TestConfigSchema> cfg;
EXPECT_THROW(cfg.load(get_bad_example_file(BAD_FILES::MISSING_NONDEFAULT_KEY)), exceptions::ConfigParseError);
}
TEST_F(configTest, mutate_and_reset) {
using namespace fourdst::config;
Config<TestConfigSchema> cfg;
EXPECT_NO_THROW(cfg.load(get_good_example_file()));
EXPECT_TRUE(cfg->physics.diffusion);
EXPECT_EQ(cfg.get_state(), ConfigState::LOADED_FROM_FILE);
EXPECT_NO_THROW(
cfg.mutate([](auto& data) {
data.physics.diffusion = false;
});
);
EXPECT_FALSE(cfg->physics.diffusion);
EXPECT_EQ(cfg.get_state(), ConfigState::MODIFIED);
EXPECT_NO_THROW(cfg.reset());
EXPECT_TRUE(cfg->physics.diffusion);
EXPECT_EQ(cfg.get_state(), ConfigState::LOADED_FROM_FILE);
}