Sanitise input data

src/HealthGPS.Console/CMakeLists.txt

@@ -5,16 +5,15 @@ find_package(TBB CONFIG REQUIRED)
 find_path(RAPIDCSV_INCLUDE_DIRS "rapidcsv.h")
 find_package(Threads REQUIRED)
 
-add_executable(HealthGPS.Console "")
-target_compile_features(HealthGPS.Console PUBLIC cxx_std_${CMAKE_CXX_STANDARD})
-
-configure_file("version.h.in" "version.h" ESCAPE_QUOTES)
-include_directories(${CMAKE_CURRENT_BINARY_DIR})
-
-target_sources(HealthGPS.Console
-	PRIVATE
+add_executable(HealthGPS.Console "program.cpp")
+add_library(HealthGPS.LibConsole STATIC 
+        "command_options.cpp"
+        "command_options.h"
 		"configuration.cpp"
 		"configuration.h"
+        "configuration_parsing.cpp"
+        "configuration_parsing.h"
+        "configuration_parsing_helpers.h"
 		"csvparser.cpp"
 		"csvparser.h"
 		"event_monitor.cpp"
@@ -27,7 +26,6 @@ target_sources(HealthGPS.Console
 		"jsonparser.cpp"
 		"jsonparser.h"
 		"model_info.h"
-		"options.h"
 		"resource.h"
 		"result_writer.h"
 		"riskmodel.h"
@@ -40,7 +38,21 @@ if(WIN32)
 	target_sources(HealthGPS.Console PRIVATE versioninfo.rc)
 endif(WIN32)
 
+target_include_directories(HealthGPS.LibConsole PUBLIC ${CMAKE_CURRENT_BINARY_DIR})
+
 target_link_libraries(HealthGPS.Console
+PRIVATE
+    HealthGPS.Core
+    HealthGPS.Datastore
+    HealthGPS.LibConsole
+    HealthGPS
+    fmt::fmt
+    Threads::Threads
+    cxxopts::cxxopts
+    nlohmann_json::nlohmann_json
+    TBB::tbb)
+
+target_link_libraries(HealthGPS.LibConsole
 PRIVATE
     HealthGPS.Core
     HealthGPS.Datastore
@@ -56,4 +68,4 @@ if(WIN32)
 	install(IMPORTED_RUNTIME_ARTIFACTS fmt::fmt)
 endif()
 
-set(ROOT_NAMESPACE hgps)
+set(ROOT_NAMESPACE hgps)

src/HealthGPS.Console/command_options.cpp

@@ -0,0 +1,96 @@
+#include "command_options.h"
+#include "version.h"
+
+#include <fmt/color.h>
+
+#include <iostream>
+
+namespace host {
+
+cxxopts::Options create_options() {
+    cxxopts::Options options("HealthGPS.Console", "Health-GPS microsimulation for policy options.");
+    options.add_options()("f,file", "Configuration file full name.", cxxopts::value<std::string>())(
+        "s,storage", "Path to root folder of the data storage.", cxxopts::value<std::string>())(
+        "j,jobid", "The batch execution job identifier.",
+        cxxopts::value<int>())("verbose", "Print more information about progress",
+                               cxxopts::value<bool>()->default_value("false"))(
+        "help", "Help about this application.")("version", "Print the application version number.");
+
+    return options;
+}
+
+CommandOptions parse_arguments(cxxopts::Options &options, int &argc, char *argv[]) {
+    namespace fs = std::filesystem;
+
+    CommandOptions cmd;
+    try {
+        cmd.success = true;
+        cmd.exit_code = EXIT_SUCCESS;
+        cmd.verbose = false;
+        auto result = options.parse(argc, argv);
+        if (result.count("help")) {
+            std::cout << options.help() << std::endl;
+            cmd.success = false;
+            return cmd;
+        }
+
+        if (result.count("version")) {
+            fmt::print("Version {}\n\n", PROJECT_VERSION);
+            cmd.success = false;
+            return cmd;
+        }
+
+        cmd.verbose = result["verbose"].as<bool>();
+        if (cmd.verbose) {
+            fmt::print(fg(fmt::color::dark_salmon), "Verbose output enabled\n");
+        }
+
+        if (result.count("file")) {
+            cmd.config_file = result["file"].as<std::string>();
+            if (cmd.config_file.is_relative()) {
+                cmd.config_file = std::filesystem::absolute(cmd.config_file);
+                fmt::print("Configuration file..: {}\n", cmd.config_file.string());
+            }
+        }
+
+        if (!fs::exists(cmd.config_file)) {
+            fmt::print(fg(fmt::color::red), "\nConfiguration file: {} not found.\n",
+                       cmd.config_file.string());
+            cmd.exit_code = EXIT_FAILURE;
+        }
+
+        if (result.count("storage")) {
+            cmd.storage_folder = result["storage"].as<std::string>();
+            if (cmd.storage_folder.is_relative()) {
+                cmd.storage_folder = std::filesystem::absolute(cmd.storage_folder);
+                fmt::print("File storage folder.: {}\n", cmd.storage_folder.string());
+            }
+        }
+
+        if (!fs::exists(cmd.storage_folder)) {
+            fmt::print(fg(fmt::color::red), "\nFile storage folder: {} not found.\n",
+                       cmd.storage_folder.string());
+            cmd.exit_code = EXIT_FAILURE;
+        }
+
+        if (result.count("jobid")) {
+            cmd.job_id = result["jobid"].as<int>();
+            if (cmd.job_id < 1) {
+                fmt::print(fg(fmt::color::red),
+                           "\nJob identifier value outside range: (0 < x) given: {}.\n",
+                           std::to_string(cmd.job_id));
+                cmd.exit_code = EXIT_FAILURE;
+            }
+        }
+
+        cmd.success = cmd.exit_code == EXIT_SUCCESS;
+    } catch (const cxxopts::exceptions::exception &ex) {
+        fmt::print(fg(fmt::color::red), "\nInvalid command line argument: {}.\n", ex.what());
+        fmt::print("\n{}\n", options.help());
+        cmd.success = false;
+        cmd.exit_code = EXIT_FAILURE;
+    }
+
+    return cmd;
+}
+} // namespace host

src/HealthGPS.Console/command_options.h

@@ -0,0 +1,43 @@
+/**
+ * @file
+ * @brief Functionality for parsing console application's command-line arguments
+ */
+#pragma once
+#include <cxxopts.hpp>
+
+#include <filesystem>
+
+namespace host {
+/// @brief Defines the Command Line Interface (CLI) arguments options
+struct CommandOptions {
+    /// @brief Indicates whether the argument parsing succeed
+    bool success{};
+
+    /// @brief The exit code to return, in case of CLI arguments parsing failure
+    int exit_code{};
+
+    /// @brief The configuration file argument value
+    std::filesystem::path config_file{};
+
+    /// @brief The back-end storage full path argument value
+    std::filesystem::path storage_folder{};
+
+    /// @brief Indicates whether the application logging is verbose
+    bool verbose{};
+
+    /// @brief The batch job identifier value, optional.
+    int job_id{};
+};
+
+/// @brief Creates the command-line interface (CLI) options
+/// @return Health-GPS CLI options
+cxxopts::Options create_options();
+
+/// @brief Parses the command-line interface (CLI) arguments
+/// @param options The valid CLI options
+/// @param argc Number of input arguments
+/// @param argv List of input arguments
+/// @return User command-line options
+CommandOptions parse_arguments(cxxopts::Options &options, int &argc, char *argv[]);
+
+} // namespace host