config: add export final participant configuration as string (#218)

When a participant configuration was processed, it may include fragments included by `includes:` statements.
This adds a new API to retrieve the finalized participant configuration as a JSON string.

---------

Co-authored-by: Daniel Edwards <daniel.edwards@vector.com>

Author: MariusBgm

SilKit/IntegrationTests/CMakeLists.txt

@@ -255,6 +255,10 @@ add_silkit_test_to_executable(SilKitIntegrationTests
     SOURCES ITest_MultiSim.cpp
 )
 
+add_silkit_test_to_executable(SilKitIntegrationTests
+    SOURCES ITest_Config.cpp
+)
+
 if(SILKIT_BUILD_DASHBOARD)
     add_silkit_test_to_executable(SilKitInternalIntegrationTests
         SOURCES ITest_Dashboard.cpp

SilKit/IntegrationTests/Hourglass/MockCapi.cpp

@@ -808,6 +808,12 @@ extern "C"
         return globalCapi->SilKit_ParticipantConfiguration_Destroy(participantConfiguration);
     }
 
+    SilKit_ReturnCode SilKitCALL SilKit_ParticipantConfiguration_ToJson(const SilKit_ParticipantConfiguration* inParticipantConfiguration,
+                 char** outString, size_t* requiredSize)
+    {
+        return globalCapi->SilKit_ParticipantConfiguration_ToJson(inParticipantConfiguration, outString, requiredSize);
+    }
+
     // Logger
 
     SilKit_ReturnCode SilKitCALL SilKit_Logger_Log(SilKit_Logger* logger, SilKit_LoggingLevel level,

SilKit/IntegrationTests/Hourglass/MockCapi.hpp

@@ -1,23 +1,6 @@
-/* Copyright (c) 2022 Vector Informatik GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
+// SPDX-FileCopyrightText: 2022 Vector Informatik GmbH
+//
+// SPDX-License-Identifier: MIT
 
 #include "gtest/gtest.h"
 #include "gmock/gmock.h"
@@ -437,6 +420,10 @@ class MockCapi
     MOCK_METHOD(SilKit_ReturnCode, SilKit_ParticipantConfiguration_Destroy,
                 (SilKit_ParticipantConfiguration * participantConfiguration));
 
+    MOCK_METHOD(SilKit_ReturnCode, SilKit_ParticipantConfiguration_ToJson,
+                (const SilKit_ParticipantConfiguration* inParticipantConfiguration,
+                 char** outString, size_t* requiredSize));
+
     // Logger
 
     MOCK_METHOD(SilKit_ReturnCode, SilKit_Logger_Log,

SilKit/IntegrationTests/Hourglass/Test_HourglassParticipantLogger.cpp

@@ -1,23 +1,6 @@
-/* Copyright (c) 2022 Vector Informatik GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
+// SPDX-FileCopyrightText: 2022 Vector Informatik GmbH
+//
+// SPDX-License-Identifier: MIT
 
 #include "gtest/gtest.h"
 #include "gmock/gmock.h"
@@ -87,6 +70,33 @@ TEST_F(Test_HourglassParticipantLogger, SilKit_ParticipantConfiguration_Destroy)
     }
 }
 
+TEST_F(Test_HourglassParticipantLogger, SilKit_ParticipantConfiguration_ToJson)
+{
+    auto&& configString = R"(schemaVersion: 1
+Description: test
+
+Middleware:
+  RegistryUri: silkit://localhost:8501
+  ConnectAttempts: 1
+  TcpNoDelay: true
+  AcceptorUris: [tcp://0.0.0.0:8502]
+  RegistryAsFallbackProxy: true
+
+Logging:
+  Sinks:
+    - Type: Stdout
+      Level: Debug
+)";
+
+    auto&& config = SilKit::Config::ParticipantConfigurationFromString(configString);
+    EXPECT_CALL(capi, SilKit_ParticipantConfiguration_ToJson(testing::_, testing::_, testing::_))
+        .Times(1);
+    {
+        auto jsonString = SilKit::Config::ParticipantConfigurationToJson(config);
+    }
+
+}
+
 TEST_F(Test_HourglassParticipantLogger, SilKit_Participant_Create1)
 {
     std::string name = "Participant1";

SilKit/IntegrationTests/ITest_Config.cpp

@@ -0,0 +1,93 @@
+// SPDX-FileCopyrightText: 2025 Vector Informatik GmbH
+//
+// SPDX-License-Identifier: MIT
+
+
+#include <iostream>
+#include <cstring>
+
+#include "silkit/services/all.hpp"
+#include "SimTestHarness.hpp"
+
+#include "gmock/gmock.h"
+#include "gtest/gtest.h"
+
+
+namespace {
+
+using namespace std::chrono_literals;
+using namespace SilKit;
+
+
+TEST(ITest_Config, test_to_json)
+{
+    auto&& configString = R"(schemaVersion: 1
+Description: test
+
+Middleware:
+  RegistryUri: silkit://localhost:8501
+  ConnectAttempts: 1
+  TcpNoDelay: true
+  AcceptorUris: [tcp://0.0.0.0:8502]
+  RegistryAsFallbackProxy: true
+
+Logging:
+  Sinks:
+    - Type: Stdout
+      Level: Debug
+)";
+
+    auto&& config = SilKit::Config::ParticipantConfigurationFromString(configString);
+    auto jsonString = SilKit::Config::ParticipantConfigurationToJson(config);
+    ASSERT_GT(jsonString.size(), 0u);
+    auto&& config2 = SilKit::Config::ParticipantConfigurationFromString(jsonString);
+    auto jsonString2 = SilKit::Config::ParticipantConfigurationToJson(config2);
+    ASSERT_GT(jsonString2.size(), 0u);
+    EXPECT_EQ(jsonString, jsonString2) << "The parsed config should be the same as the original yaml";
+}
+
+TEST(ITest_Config, test_to_json_in_capi)
+{
+    auto&& configString = R"(schemaVersion: 1
+Description: test
+
+Middleware:
+  RegistryUri: silkit://localhost:8501
+  ConnectAttempts: 1
+  TcpNoDelay: true
+  AcceptorUris: [tcp://0.0.0.0:8502]
+  RegistryAsFallbackProxy: true
+
+Logging:
+  Sinks:
+    - Type: Stdout
+      Level: Debug
+)";
+
+    SilKit_ParticipantConfiguration* config{nullptr};
+    auto result = SilKit_ParticipantConfiguration_FromString(&config, configString);
+    ASSERT_EQ(result, SilKit_ReturnCode_SUCCESS);
+
+    std::array<char, 1024> buf{};
+    std::memset(buf.data(), 'A', buf.size());
+    size_t size{};
+
+    // get size
+    result = SilKit_ParticipantConfiguration_ToJson(config, nullptr, &size);
+    ASSERT_EQ(result, SilKit_ReturnCode_SUCCESS);
+    ASSERT_GT(size, 0) << "the string should have length > 0";
+    ASSERT_LT(size, buf.size()) << "the string should have length <= buf.size()";
+
+    //get contents, n
+    auto&& ptr = buf.data();
+    result = SilKit_ParticipantConfiguration_ToJson(config, &ptr, &size);
+    ASSERT_EQ(result, SilKit_ReturnCode_SUCCESS);
+    ASSERT_GT(size, 0) << "the string should have length > 0";
+    ASSERT_EQ(ptr[size], 'A') << "there should be no trailing \0";
+
+    result = SilKit_ParticipantConfiguration_Destroy(config);
+    ASSERT_EQ(result, SilKit_ReturnCode_SUCCESS);
+}
+
+
+} // anonymous namespace

SilKit/include/silkit/capi/SilKit.h

@@ -1,23 +1,6 @@
-/* Copyright (c) 2022 Vector Informatik GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
+// SPDX-FileCopyrightText: 2022 Vector Informatik GmbH
+//
+// SPDX-License-Identifier: MIT
 
 #pragma once
 
@@ -104,4 +87,14 @@ typedef SilKit_ReturnCode(SilKitFPTR* SilKit_ParticipantConfiguration_Destroy_t)
     SilKit_ParticipantConfiguration* participantConfiguration);
 
 
+/*! \brief Return a JSON-string of the complete parsed participant configuration.
+*  \param outputJsonString the JSON string of the configuration. When this is NULL outputSize will contain the required size for the JSON string.
+*  \param outputSize the size of the outputJsonString is stored here. Can be called with outputJsonString set to NULL to get the required size.
+*/
+SilKitAPI SilKit_ReturnCode SilKitCALL SilKit_ParticipantConfiguration_ToJson(
+    const SilKit_ParticipantConfiguration* inParticipantConfiguration, char** outputJsonString, size_t* outputSize);
+
+typedef SilKit_ReturnCode(SilKitFPTR* SilKit_ParticipantConfiguration_ToJson_t)(
+    const SilKit_ParticipantConfiguration* intParticipantConfiguration, char** outputJsonString, size_t* outputSize);
+
 SILKIT_END_DECLS

SilKit/include/silkit/config/IParticipantConfiguration.hpp

@@ -1,23 +1,6 @@
-/* Copyright (c) 2022 Vector Informatik GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
+// SPDX-FileCopyrightText: 2022 Vector Informatik GmbH
+//
+// SPDX-License-Identifier: MIT
 
 #pragma once
 
@@ -73,6 +56,10 @@ DETAIL_SILKIT_CPP_API auto ParticipantConfigurationFromString(const std::string&
 DETAIL_SILKIT_CPP_API auto ParticipantConfigurationFromFile(const std::string& filename)
     -> std::shared_ptr<SilKit::Config::IParticipantConfiguration>;
 
+//! \brief Returns the parsed configuration with all includes processed.
+DETAIL_SILKIT_CPP_API auto ParticipantConfigurationToJson(
+    std::shared_ptr<SilKit::Config::IParticipantConfiguration> config) -> std::string;
+
 } // namespace Config
 DETAIL_SILKIT_DETAIL_VN_NAMESPACE_CLOSE
 } // namespace SilKit

SilKit/include/silkit/detail/impl/config/IParticipantConfiguration.ipp

@@ -1,23 +1,6 @@
-// Copyright (c) 2023 Vector Informatik GmbH
+// SPDX-FileCopyrightText: 2023 Vector Informatik GmbH
 //
-// Permission is hereby granted, free of charge, to any person obtaining
-// a copy of this software and associated documentation files (the
-// "Software"), to deal in the Software without restriction, including
-// without limitation the rights to use, copy, modify, merge, publish,
-// distribute, sublicense, and/or sell copies of the Software, and to
-// permit persons to whom the Software is furnished to do so, subject to
-// the following conditions:
-//
-// The above copyright notice and this permission notice shall be
-// included in all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// SPDX-License-Identifier: MIT
 
 #pragma once
 
@@ -26,6 +9,9 @@
 #include "silkit/detail/impl/ThrowOnError.hpp"
 #include "silkit/detail/impl/config/ParticipantConfiguration.hpp"
 
+#include <string>
+#include <vector>
+
 namespace SilKit {
 DETAIL_SILKIT_DETAIL_VN_NAMESPACE_BEGIN
 namespace Config {
@@ -52,6 +38,25 @@ auto ParticipantConfigurationFromFile(const std::string& path)
     return std::make_shared<Impl::Config::ParticipantConfiguration>(participantConfiguration);
 }
 
+auto ParticipantConfigurationToJson(std::shared_ptr<SilKit::Config::IParticipantConfiguration> config) -> std::string
+{
+    size_t size{};
+    auto&& concreteConfig = std::dynamic_pointer_cast<Impl::Config::ParticipantConfiguration>(config);
+    auto returnCode = SilKit_ParticipantConfiguration_ToJson(concreteConfig->Get(), nullptr, &size);
+    Impl::ThrowOnError(returnCode);
+
+    std::vector<char> buffer;
+    if( size > 0)
+    {
+        buffer.resize(size);
+        auto&& data = buffer.data();
+        returnCode = SilKit_ParticipantConfiguration_ToJson(concreteConfig->Get(), &data, &size);
+        Impl::ThrowOnError(returnCode);
+    }
+    return {buffer.data(), buffer.size()};
+}
+
+
 } // namespace Config
 DETAIL_SILKIT_DETAIL_VN_NAMESPACE_CLOSE
 } // namespace SilKit
@@ -61,5 +66,6 @@ namespace SilKit {
 namespace Config {
 using SilKit::DETAIL_SILKIT_DETAIL_NAMESPACE_NAME::Config::ParticipantConfigurationFromString;
 using SilKit::DETAIL_SILKIT_DETAIL_NAMESPACE_NAME::Config::ParticipantConfigurationFromFile;
+using SilKit::DETAIL_SILKIT_DETAIL_NAMESPACE_NAME::Config::ParticipantConfigurationToJson;
 } // namespace Config
 } // namespace SilKit