Support yaml scenarios

.dockerfiles/Dockerfile.build

@@ -13,7 +13,7 @@ RUN apt-get update && \
     libevent-dev \
     libzip-dev \
     libmsgsl-dev \
-    nlohmann-json-dev \
+    libyaml-cpp-dev \
     libxerces-c-dev \
     libxerces-c3.2 \
     && rm -rf /var/lib/apt/lists/*

CMakeLists.txt

@@ -122,7 +122,7 @@ find_package(MS_GSL REQUIRED)
 find_package(Boost REQUIRED COMPONENTS ${Boost_components})
 find_package(FMILibrary REQUIRED)
 find_package(LIBZIP REQUIRED)
-find_package(nlohmann_json REQUIRED)
+find_package(yaml-cpp REQUIRED)
 find_package(XercesC REQUIRED)
 if(CSECORE_WITH_FMUPROXY)
     find_package(THRIFT REQUIRED)
@@ -225,7 +225,6 @@ install(FILES
         "${CMAKE_SOURCE_DIR}/cmake/FindFMILibrary.cmake"
         "${CMAKE_SOURCE_DIR}/cmake/FindLIBZIP.cmake"
         "${CMAKE_SOURCE_DIR}/cmake/FindMS_GSL.cmake"
-        "${CMAKE_SOURCE_DIR}/cmake/Findnlohmann_json.cmake"
         "${CMAKE_SOURCE_DIR}/cmake/FindTHRIFT.cmake"
         DESTINATION
         "${CSECORE_CMAKE_INSTALL_DIR}"

cmake/Findyaml-cpp.cmake

@@ -0,0 +1,36 @@
+# Find yaml-cpp
+#
+# Find the native yaml-cpp headers and libraries.
+#
+#   YAML_CPP_INCLUDE_DIRS   - where to find yaml-cpp/yaml.h
+#   YAML_CPP_LIBRARIES      - List of libraries when using yaml-cpp.
+#   YAML_CPP_FOUND          - True if yaml-cpp found.
+#
+
+find_path(YAML_CPP_INCLUDE_DIR NAMES yaml-cpp/yaml.h)
+mark_as_advanced(YAML_CPP_INCLUDE_DIR)
+
+find_library(YAML_CPP_LIBRARY NAMES yaml-cpp libyaml-cpp yaml-cppmd libyaml-cppmd)
+mark_as_advanced(YAML_CPP_LIBRARY)
+
+include(FindPackageHandleStandardArgs)
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(YAML_CPP
+        REQUIRED_VARS YAML_CPP_LIBRARY YAML_CPP_INCLUDE_DIR)
+
+if (YAML_CPP_FOUND)
+
+    set(YAML_CPP_INCLUDE_DIRS ${YAML_CPP_INCLUDE_DIR})
+
+    if (NOT YAML_CPP_LIBRARIES)
+        set(YAML_CPP_LIBRARIES ${YAML_CPP_LIBRARY})
+    endif()
+
+    if (NOT TARGET yaml-cpp)
+        add_library(yaml-cpp UNKNOWN IMPORTED)
+        set_target_properties(yaml-cpp PROPERTIES
+                INTERFACE_INCLUDE_DIRECTORIES "${YAML_CPP_INCLUDE_DIR}")
+        set_property(TARGET yaml-cpp APPEND PROPERTY
+                IMPORTED_LOCATION "${YAML_CPP_LIBRARY}")
+    endif()
+
+endif()

cmake/project-config.cmake.in

@@ -9,7 +9,7 @@ find_dependency(MS_GSL REQUIRED)
 find_dependency(Boost REQUIRED COMPONENTS date_time fiber filesystem log)
 find_dependency(FMILibrary REQUIRED)
 find_dependency(LIBZIP REQUIRED)
-find_dependency(nlohmann_json REQUIRED)
+find_dependency(yaml-cpp REQUIRED)
 find_dependency(XercesC REQUIRED)
 
 if(@CSECORE_WITH_FMUPROXY@)

conanfile.py

@@ -20,7 +20,7 @@ class CSECoreConan(ConanFile):
         "gsl_microsoft/20171020@bincrafters/stable",
         "libzip/1.5.2@bincrafters/stable",
         "zlib/1.2.11",
-        "jsonformoderncpp/3.5.0@vthiery/stable",
+        "yaml-cpp/0.6.2@bincrafters/stable",
         "bzip2/1.0.8",
         "xerces-c/3.2.2"
         )

include/cse/scenario_parser.hpp

@@ -12,7 +12,7 @@ namespace cse
  * Parses a scenario from file.
  *
  * \param scenarioFile
- *  The path to a proprietary `json` file defining the scenario.
+ *  The path to a proprietary `yaml` file defining the scenario.
  *
  * \param simulators
  *  A map containing the simulators currently loaded in the execution.

src/cpp/CMakeLists.txt

@@ -161,7 +161,7 @@ target_link_libraries(csecorecpp
         gsl
         XercesC::XercesC
     PRIVATE
-        nlohmann_json
+        yaml-cpp
     )
 
 if(CSECORE_WITH_FMUPROXY)

src/cpp/scenario_parser.cpp

@@ -1,7 +1,6 @@
 #include "cse/scenario_parser.hpp"
 
 #include <boost/filesystem/fstream.hpp>
-#include <nlohmann/json.hpp>
 
 #include <cstdlib>
 #include <functional>
@@ -12,6 +11,16 @@
 #include <string>
 #include <system_error>
 
+#ifdef _MSC_VER
+#    pragma warning(push)
+#    pragma warning(disable : 4127)
+#endif
+#include <yaml-cpp/yaml.h>
+#ifdef _MSC_VER
+#    pragma warning(pop)
+#endif
+
+
 namespace cse
 {
 
@@ -65,12 +74,12 @@ cse::variable_description find_variable(
 template<typename T>
 std::function<T(T)> generate_modifier(
     const std::string& kind,
-    const nlohmann::json& event)
+    const YAML::Node& event)
 {
     if ("reset" == kind) {
         return nullptr;
     }
-    T value = event.at("value").get<T>();
+    T value = event["value"].as<T>();
     if ("bias" == kind) {
         return [value](T original) { return original + value; };
     } else if ("override" == kind) {
@@ -83,12 +92,12 @@ std::function<T(T)> generate_modifier(
 
 std::function<std::string(std::string_view)> generate_string_modifier(
     const std::string& kind,
-    const nlohmann::json& event)
+    const YAML::Node& event)
 {
     if ("reset" == kind) {
         return nullptr;
     }
-    auto value = event.at("value").get<std::string>();
+    auto value = event["value"].as<std::string>();
     if ("override" == kind) {
         return [value](std::string_view /*original*/) { return value; };
     }
@@ -98,7 +107,7 @@ std::function<std::string(std::string_view)> generate_string_modifier(
 }
 
 cse::scenario::variable_action generate_action(
-    const nlohmann::json& event,
+    const YAML::Node& event,
     const std::string& mode,
     cse::simulator_index sim,
     cse::variable_type type,
@@ -141,20 +150,20 @@ struct defaults
 };
 
 std::optional<std::string> parse_element(
-    const nlohmann::json& j,
+    const YAML::Node& j,
     const std::string& name)
 {
-    if (j.count(name)) {
-        return j.at(name).get<std::string>();
+    if (j[name]) {
+        return j[name].as<std::string>();
     } else {
         return std::nullopt;
     }
 }
 
-defaults parse_defaults(const nlohmann::json& scenario)
+defaults parse_defaults(const YAML::Node& scenario)
 {
-    if (scenario.count("defaults")) {
-        auto j = scenario.at("defaults");
+    if (scenario["defaults"]) {
+        auto j = scenario["defaults"];
         return defaults{
             parse_element(j, "model"),
             parse_element(j, "variable"),
@@ -164,12 +173,12 @@ defaults parse_defaults(const nlohmann::json& scenario)
 }
 
 std::string specified_or_default(
-    const nlohmann::json& j,
+    const YAML::Node& j,
     const std::string& name,
     std::optional<std::string> defaultOption)
 {
-    if (j.count(name)) {
-        return j.at(name).get<std::string>();
+    if (j[name]) {
+        return j[name].as<std::string>();
     } else if (defaultOption.has_value()) {
         return *defaultOption;
     }
@@ -178,10 +187,10 @@ std::string specified_or_default(
     throw std::invalid_argument(oss.str());
 }
 
-std::optional<cse::time_point> parse_end_time(const nlohmann::json& j)
+std::optional<cse::time_point> parse_end_time(const YAML::Node& j)
 {
-    if (j.count("end")) {
-        auto endTime = j.at("end").get<double>();
+    if (j["end"]) {
+        auto endTime = j["end"].as<double>();
         return to_time_point(endTime);
     }
     return std::nullopt;
@@ -201,15 +210,14 @@ scenario::scenario parse_scenario(
         oss << "Cannot load scenario. Failed to open file " << scenarioFile;
         throw std::system_error(errno, std::system_category(), oss.str());
     }
-    nlohmann::json j;
-    i >> j;
+    YAML::Node j = YAML::Load(i);
 
     std::vector<scenario::event> events;
     defaults defaultOpts = parse_defaults(j);
 
-    for (auto& event : j.at("events")) {
-        auto trigger = event.at("time");
-        auto triggerTime = trigger.get<double>();
+    for (const auto& event : j["events"]) {
+        auto trigger = event["time"];
+        auto triggerTime = trigger.as<double>();
         auto time = to_time_point(triggerTime);
 
         const auto& [index, simulator] =

test/cpp/CMakeLists.txt

@@ -11,7 +11,6 @@ set(tests
     "trend_buffer_test"
     "monitor_modified_variables_test"
     "scenario_manager_test"
-    "scenario_parser_test"
     "synchronized_xy_series_test"
 )
 
@@ -28,6 +27,7 @@ set(unittests
     "fmi_v2_fmu_unittest"
     "model_unittest"
     "orchestration_unittest"
+    "scenario_parser_unittest"
     "ssp_parser_unittest"
     "uri_unittest"
     "utility_concurrency_unittest"