config: move to rapidyaml and remove yaml-cpp 🚀 (#207)

Add rapidyaml 0.9.0 as a header-only dependency, and remove yaml-cpp.

I refactored the code into a YamlReader and a YamlWriter, and tried to remove as much of rapidyaml from the parsing interface.
The `schemaVersion` field in yaml files is deprecated in favor of `SchemaVersion`  with capital s. 
The version so far was not validated when loading a config file.

SILKIT-1739

Author: MariusBgm

.gitmodules

@@ -1,9 +1,6 @@
 [submodule "spdlog"]
 	path = ThirdParty/spdlog
 	url = https://github.com/gabime/spdlog
-[submodule "ThirdParty/yaml-cpp"]
-	path = ThirdParty/yaml-cpp
-	url = https://github.com/jbeder/yaml-cpp
 [submodule "ThirdParty/asio"]
 	path = ThirdParty/asio
 	url = https://github.com/chriskohlhoff/asio.git

SilKit/source/CMakeLists.txt

@@ -266,7 +266,6 @@ if ((CMAKE_CXX_COMPILER_ID STREQUAL GNU OR CMAKE_CXX_COMPILER_ID STREQUAL Clang)
     set(SILKIT_LINK_EXCLUDE_LIBS "")
     # add the file name (xxx.a) to the list
     list(APPEND SILKIT_LINK_EXCLUDE_LIBS "$<TARGET_FILE_NAME:spdlog>")
-    list(APPEND SILKIT_LINK_EXCLUDE_LIBS "$<TARGET_FILE_NAME:yaml-cpp>")
     # format the list such that the linker flag accepts it
     list(JOIN SILKIT_LINK_EXCLUDE_LIBS ":" SILKIT_LINK_EXCLUDE_LIBS)
     # add the excluded libs to the linker command line

SilKit/source/config/CMakeLists.txt

@@ -29,6 +29,7 @@ target_link_libraries(I_SilKit_Config
     INTERFACE
         ${SILKIT_THIRD_PARTY_YAML_INTERFACE}
         I_SilKit_Util
+        rapidyaml
 )
 
 add_library(O_SilKit_Config OBJECT
@@ -40,12 +41,14 @@ add_library(O_SilKit_Config OBJECT
     ParticipantConfigurationFromXImpl.cpp
     Validation.hpp
     Validation.cpp
+
     YamlParser.hpp
     YamlParser.cpp
-    YamlConversion.hpp
-    YamlConversion.cpp
-    YamlSchema.hpp
-    YamlSchema.cpp
+    YamlReader.hpp
+    YamlReader.cpp
+    YamlWriter.hpp
+    YamlWriter.cpp
+    
     YamlValidator.hpp
     YamlValidator.cpp
 )
@@ -55,8 +58,9 @@ target_link_libraries(O_SilKit_Config
 
     PRIVATE SilKitInterface
     PRIVATE O_SilKit_Util_Filesystem
-    PUBLIC yaml-cpp
     PRIVATE I_SilKit_Util_FileHelpers
+    PUBLIC rapidyaml
+    PRIVATE fmt::fmt
 )
 
 target_include_directories(O_SilKit_Config
@@ -97,12 +101,12 @@ add_silkit_test_to_executable(SilKitUnitTests
 
 add_silkit_test_to_executable(SilKitUnitTests
     SOURCES Test_YamlParser.cpp
-    LIBS O_SilKit_Config yaml-cpp
+    LIBS O_SilKit_Config rapidyaml
 )
 
 add_silkit_test_to_executable(SilKitUnitTests
     SOURCES Test_YamlValidator.cpp
-    LIBS O_SilKit_Config yaml-cpp
+    LIBS O_SilKit_Config rapidyaml
 )
 
 set(ParticipantTestCanConfigs

SilKit/source/config/Configuration.hpp

@@ -40,7 +40,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
 namespace SilKit {
 namespace Config {
 
-inline namespace v1 {
+inline namespace V1 {
 
 // ================================================================================
 //  Shared configuration declarations
@@ -322,7 +322,7 @@ inline Aggregation from_string(const std::string& aggregationStr)
     return Aggregation::Auto;
 }
 
-} // namespace v1
+} // namespace V1
 
 } // namespace Config
 } // namespace SilKit

SilKit/source/config/ParticipantConfiguration.cpp

@@ -26,7 +26,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
 
 namespace SilKit {
 namespace Config {
-inline namespace v1 {
+inline namespace V1 {
 
 auto Label::ToPublicApi() const -> SilKit::Services::MatchingLabel
 {
@@ -81,12 +81,12 @@ auto Label::FromPublicApi(const SilKit::Services::MatchingLabel& label) -> Label
 
 auto Label::VectorFromPublicApi(const std::vector<SilKit::Services::MatchingLabel>& labels) -> std::vector<Label>
 {
-    std::vector<SilKit::Config::v1::Label> result;
+    std::vector<SilKit::Config::V1::Label> result;
     std::transform(labels.begin(), labels.end(), std::back_inserter(result), Label::FromPublicApi);
     return result;
 }
 
 
-} // namespace v1
+} // namespace V1
 } // namespace Config
 } // namespace SilKit

SilKit/source/config/ParticipantConfiguration.hpp

@@ -40,7 +40,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
 
 namespace SilKit {
 namespace Config {
-inline namespace v1 {
+inline namespace V1 {
 
 // ================================================================================
 //  Internal controller service
@@ -337,6 +337,17 @@ struct Experimental
     Metrics metrics;
 };
 
+// ================================================================================
+//  Includes
+// ================================================================================
+
+//! \brief Structure that contains experimental settings
+struct Includes
+{
+    std::vector<std::string> searchPathHints;
+    std::vector<std::string> files;
+};
+
 // ================================================================================
 //  Root
 // ================================================================================
@@ -349,8 +360,8 @@ struct ParticipantConfiguration : public IParticipantConfiguration
     //virtual auto ToYamlString() -> std::string override;
     //virtual auto ToJsonString() -> std::string override;
 
-    //! \brief Version of the JSON/YAML schema.
-    std::string schemaVersion{"1"};
+    //! \brief Version of the JSON/YAML schema. Currently is at 1
+    std::string schemaVersion{""};
     //! \brief An optional user description for documentation purposes. Currently unused.
     std::string description;
     //! \brief An optional file path.
@@ -374,6 +385,7 @@ struct ParticipantConfiguration : public IParticipantConfiguration
     HealthCheck healthCheck;
     Tracing tracing;
     Extensions extensions;
+    Includes includes;
     Middleware middleware;
     Experimental experimental;
 };
@@ -392,6 +404,7 @@ bool operator==(const MetricsSink& lhs, const MetricsSink& rhs);
 bool operator==(const Metrics& lhs, const Metrics& rhs);
 bool operator==(const Extensions& lhs, const Extensions& rhs);
 bool operator==(const Middleware& lhs, const Middleware& rhs);
+bool operator==(const Includes& lhs, const Includes& rhs);
 bool operator==(const ParticipantConfiguration& lhs, const ParticipantConfiguration& rhs);
 bool operator==(const TimeSynchronization& lhs, const TimeSynchronization& rhs);
 bool operator==(const Experimental& lhs, const Experimental& rhs);
@@ -403,6 +416,39 @@ auto operator<<(std::ostream& out, const Label& label) -> std::ostream&;
 bool operator<(const MetricsSink& lhs, const MetricsSink& rhs);
 bool operator>(const MetricsSink& lhs, const MetricsSink& rhs);
 
-} // namespace v1
+} // namespace V1
 } // namespace Config
 } // namespace SilKit
+
+namespace SilKitRegistry {
+namespace Config {
+namespace V1 {
+
+constexpr inline auto GetSchemaVersion() -> const char*
+{
+    return "1";
+}
+
+struct Experimental
+{
+    SilKit::Config::V1::Metrics metrics;
+};
+
+struct RegistryConfiguration
+{
+    std::string description{""};
+    std::string schemaVersion{""};
+    SilKit::Util::Optional<std::string> listenUri;
+    SilKit::Util::Optional<bool> enableDomainSockets;
+    SilKit::Util::Optional<std::string> dashboardUri;
+    SilKit::Config::Logging logging{};
+    Experimental experimental{};
+};
+
+bool operator==(const Experimental& lhs, const Experimental& rhs);
+
+
+
+} // namespace V1
+} // namespace Config
+} // namespace SilKitRegistry