Merge pull request #14 from tboudreaux/feature/config

Added Config module

.gitignore

@@ -60,5 +60,6 @@ tags
 
 subprojects/mfem/
 subprojects/tetgen/
+subprojects/yaml-cpp/
 
 .vscode/

build-config/meson.build

@@ -1 +1,4 @@
+cmake = import('cmake')
+
 subdir('mfem')
+subdir('yaml-cpp')

build-config/mfem/meson.build

@@ -1,4 +1,3 @@
-cmake = import('cmake')
 patchFile = files('disable_mfem_selfcheck.patch')
 
 patch_check = run_command('grep', '-q', 'MFEM_CHECK_TARGET_NAME', 'subprojects/mfem/CMakeLists.txt', check: false)

build-config/yaml-cpp/meson.build

@@ -0,0 +1,5 @@
+yaml_cpp_sp = cmake.subproject(
+    'yaml-cpp'
+)
+yaml_cpp_dep = yaml_cpp_sp.dependency('yaml-cpp')
+add_project_arguments('-I' + meson.current_build_dir() + '/subprojects/yaml-cpp/__CMake_build', language: 'cpp')

src/config/meson.build

@@ -0,0 +1,26 @@
+# Define the library
+config_sources = files(
+  'private/config.cpp',
+)
+
+config_headers = files(
+    'public/config.h'
+)
+
+# Define the libconfig library so it can be linked against by other parts of the build system
+libconfig = static_library('config',
+    config_sources, 
+    include_directories: include_directories('public'),
+    cpp_args: ['-fvisibility=default'],
+    dependencies: [yaml_cpp_dep],
+    install : true)
+
+config_dep = declare_dependency(
+    include_directories: include_directories('public'),
+    link_with: libconfig,
+    sources: config_sources,
+    dependencies: [yaml_cpp_dep],
+)
+
+# Make headers accessible
+install_headers(config_headers, subdir : '4DSSE/config')

src/config/private/config.cpp

@@ -0,0 +1,31 @@
+#include <string>
+#include <iostream>
+#include <fstream>
+#include <sstream>
+#include <vector>
+#include <map>
+
+#include "yaml-cpp/yaml.h"
+
+#include "config.h"
+
+Config::Config() {}
+
+Config::~Config() {}
+
+Config& Config::getInstance() {
+    static Config instance;
+    return instance;
+}
+
+bool Config::loadConfig(const std::string& configFile) {
+    configFilePath = configFile;
+    try {
+        yamlRoot = YAML::LoadFile(configFile);
+    } catch (YAML::BadFile& e) {
+        std::cerr << "Error: " << e.what() << std::endl;
+        return false;
+    }
+    return true;
+}
+

src/config/public/config.h

@@ -0,0 +1,91 @@
+#ifndef CONFIG_H
+#define CONFIG_H
+
+#include <string>
+#include <iostream>
+#include <fstream>
+#include <sstream>
+#include <vector>
+#include <map>
+
+#include "yaml-cpp/yaml.h"
+
+/**
+ * @class Config
+ * @brief Singleton class to manage configuration settings loaded from a YAML file.
+ */
+class Config {
+ private:
+    /**
+     * @brief Private constructor to prevent instantiation.
+     */
+    Config();
+
+    /**
+     * @brief Destructor.
+     */
+    ~Config();
+
+    YAML::Node yamlRoot; ///< Root node of the YAML configuration.
+    std::string configFilePath; ///< Path to the configuration file.
+
+ public:
+    /**
+     * @brief Get the singleton instance of the Config class.
+     * @return Reference to the Config instance.
+     */
+    static Config& getInstance();
+
+    Config (const Config&) = delete;
+    Config& operator= (const Config&) = delete;
+    Config (Config&&) = delete;
+    Config& operator= (Config&&) = delete;
+
+    /**
+     * @brief Load configuration from a YAML file.
+     * @param configFilePath Path to the YAML configuration file.
+     * @return True if the configuration was loaded successfully, false otherwise.
+     */
+    bool loadConfig(const std::string& configFilePath);
+
+    /**
+     * @brief Get the input table from the configuration.
+     * @return Input table as a string.
+     */
+    std::string getInputTable() const;
+
+    /**
+     * @brief Get a configuration value by key.
+     * @tparam T Type of the value to retrieve.
+     * @param key Key of the configuration value.
+     * @param defaultValue Default value to return if the key does not exist.
+     * @return Configuration value of type T.
+     * 
+     * @example
+     * @code
+     * Config& config = Config::getInstance();
+     * config.loadConfig("example.yaml");
+     * int maxIter = config.get<int>("opac:lowTemp:numeric:maxIter", 10);
+     */
+   template <typename T>
+   T get(const std::string &key, T defaultValue) {
+      YAML::Node node = YAML::Clone(yamlRoot);
+      std::istringstream keyStream(key);
+      std::string subKey;
+      while (std::getline(keyStream, subKey, ':')) {
+         if (!node[subKey]) {
+               return defaultValue;
+         }
+         node = node[subKey]; // go deeper
+      }
+
+      try {
+         return node.as<T>();
+      } catch (const YAML::Exception& e) {
+         return defaultValue; // return default value if the key does not exist
+      }
+   }
+
+};
+
+#endif

src/meson.build

@@ -6,3 +6,4 @@ subdir('dobj')
 subdir('const')
 subdir('opatIO')
 subdir('meshIO')
+subdir('config')

subprojects/yaml-cpp.wrap

@@ -0,0 +1,5 @@
+[wrap-git]
+url = https://github.com/jbeder/yaml-cpp.git
+revision = yaml-cpp-0.7.0
+
+[cmake]

tests/config/configTest.cpp

@@ -0,0 +1,60 @@
+#include <gtest/gtest.h>
+#include "config.h"
+#include <iostream>
+#include <string>
+#include <vector>
+#include <set>
+#include <sstream>
+
+std::string EXAMPLE_FILENAME = std::string(getenv("MESON_SOURCE_ROOT")) + "/tests/config/example.yaml";
+/**
+ * @file configTest.cpp
+ * @brief Unit tests for the Config class.
+ */
+
+/**
+ * @brief Test suite for the Config class.
+ */
+class configTest : public ::testing::Test {};
+
+/**
+ * @brief Test the constructor of the Config class.
+ */
+TEST_F(configTest, constructor) {
+    EXPECT_NO_THROW(Config::getInstance());
+}
+
+TEST_F(configTest, loadConfig) {
+    Config& config = Config::getInstance();
+    EXPECT_TRUE(config.loadConfig(EXAMPLE_FILENAME));
+}
+
+TEST_F(configTest, singletonTest) {
+    Config& config1 = Config::getInstance();
+    Config& config2 = Config::getInstance();
+    EXPECT_EQ(&config1, &config2);
+}
+
+TEST_F(configTest, getTest) {
+    Config& config = Config::getInstance();
+    config.loadConfig(EXAMPLE_FILENAME);
+    int maxIter = config.get<int>("opac:lowTemp:numeric:maxIter", 10);
+    EXPECT_EQ(maxIter, 100);
+    EXPECT_NE(maxIter, 10);
+
+    std::string logLevel = config.get<std::string>("logLevel", "DEBUG");
+    EXPECT_EQ(logLevel, "INFO");
+    EXPECT_NE(logLevel, "DEBUG");
+
+    float polytropicIndex = config.get<float>("poly:physics:index", 2);
+    EXPECT_EQ(polytropicIndex, 1.5);
+    EXPECT_NE(polytropicIndex, 2);
+
+    float polytropicIndex2 = config.get<float>("poly:physics:index2", 2.0);
+    EXPECT_EQ(polytropicIndex2, 2.0);
+}
+
+TEST_F(configTest, secondSingleton) {
+    Config& config = Config::getInstance();
+    EXPECT_EQ(config.get<int>("opac:lowTemp:numeric:maxIter", 10), 100);
+}

tests/config/example.yaml

@@ -0,0 +1,32 @@
+# High level options
+logLevel: "INFO"
+outputDir: output
+
+# Module options
+poly:
+  numeric:
+    newtonTol: 1e-6
+    newtonMaxIter: 100
+    gmresTol: 1e-6
+    gmresMaxIter: 100
+  physics:
+    index: 1.5
+  
+# Module options
+opac:
+  highTemp:
+    physics:
+      table: "/path/to/highTempTable.dat"
+    numeric:
+      tol: 1e-6
+      maxIter: 100
+  lowTemp:
+    physics:
+      table: "/path/to/lowTempTable.dat"
+    numeric:
+      tol: 1e-6
+      maxIter: 100
+
+mesh:
+  structure:
+    refine: 2

tests/config/meson.build

@@ -0,0 +1,25 @@
+# Test files for const
+test_sources = [
+    'configTest.cpp',
+]
+
+foreach test_file : test_sources
+  exe_name = test_file.split('.')[0]
+  message('Building test: ' + exe_name)
+
+  # Create an executable target for each test
+  test_exe = executable(
+      exe_name,
+      test_file,
+      dependencies: [gtest_dep, config_dep],
+      include_directories: include_directories('../../src/config/public'),
+      link_with: libconst,  # Link the dobj library
+      install_rpath: '@loader_path/../../src'  # Ensure runtime library path resolves correctly
+  )
+
+  # Add the executable as a test
+  test(
+    exe_name,
+    test_exe,
+    env: ['MESON_SOURCE_ROOT=' + meson.project_source_root(), 'MESON_BUILD_ROOT=' + meson.project_build_root()])
+endforeach

tests/meson.build

@@ -7,6 +7,7 @@ subdir('dobj')
 subdir('const')
 subdir('opatIO')
 subdir('meshIO')
+subdir('config')
 
 # Subdirectories for sandbox tests
 subdir('dobj_sandbox')