Merge pull request #13 from lo-simon/is-14-backup-restore

IS-14: Add GetPropertiesByPath, ValidateSetPropertiesByPath and SetPropertiesByPath

Author: lo-simon

Development/cmake/NmosCppLibraries.cmake

@@ -1006,6 +1006,9 @@ set(NMOS_CPP_NMOS_SOURCES
     nmos/client_utils.cpp
     nmos/components.cpp
     nmos/configuration_api.cpp
+    nmos/configuration_methods.cpp
+    nmos/configuration_resources.cpp
+    nmos/configuration_utils.cpp
     nmos/connection_activation.cpp
     nmos/connection_api.cpp
     nmos/connection_events_activation.cpp
@@ -1100,6 +1103,10 @@ set(NMOS_CPP_NMOS_HEADERS
     nmos/components.h
     nmos/copyable_atomic.h
     nmos/configuration_api.h
+    nmos/configuration_handlers.h
+    nmos/configuration_methods.h
+    nmos/configuration_resources.h
+    nmos/configuration_utils.h
     nmos/connection_activation.h
     nmos/connection_api.h
     nmos/connection_events_activation.h

Development/cmake/NmosCppTest.cmake

@@ -43,7 +43,11 @@ set(NMOS_CPP_TEST_NMOS_TEST_SOURCES
     nmos/test/api_utils_test.cpp
     nmos/test/capabilities_test.cpp
     nmos/test/channels_test.cpp
+    nmos/test/configuration_resources_test.cpp
+    nmos/test/configuration_utils_test.cpp
     nmos/test/control_protocol_test.cpp
+    nmos/test/control_protocol_test.cpp
+    nmos/test/control_protocol_utils_test.cpp
     nmos/test/did_sdid_test.cpp
     nmos/test/event_type_test.cpp
     nmos/test/json_validator_test.cpp

Development/nmos-cpp-node/main.cpp

@@ -138,7 +138,7 @@ int main(int argc, char* argv[])
                 .on_request_authorization_code(nmos::experimental::make_request_authorization_code_handler(gate)); // may be omitted, only required for OAuth client which is using the Authorization Code Flow to obtain the access token
         }
 
-        nmos::experimental::control_protocol_state control_protocol_state(node_implementation.control_protocol_property_changed, node_implementation.get_properties_by_path, node_implementation.validate_set_properties_by_path, node_implementation.set_properties_by_path);
+        nmos::experimental::control_protocol_state control_protocol_state(node_implementation.control_protocol_property_changed, node_implementation.filter_property_value_holders, node_implementation.modify_rebuildable_block);
         if (0 <= nmos::fields::control_protocol_ws_port(node_model.settings))
         {
             node_implementation

Development/nmos-cpp-node/node_implementation.cpp

@@ -3,6 +3,7 @@
 
 #include "cpprest/api_router.h"
 #include "nmos/control_protocol_handlers.h"
+#include "nmos/configuration_handlers.h"
 
 namespace slog
 {
@@ -15,7 +16,7 @@ namespace nmos
 {
     struct node_model;
 
-    web::http::experimental::listener::api_router make_configuration_api(nmos::node_model& model, web::http::experimental::listener::route_handler validate_authorization, get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, get_control_protocol_datatype_descriptor_handler get_control_protocol_datatype_descriptor, get_control_protocol_method_descriptor_handler get_control_protocol_method_descriptor, control_protocol_property_changed_handler property_changed, slog::base_gate& gate);
+    web::http::experimental::listener::api_router make_configuration_api(nmos::node_model& model, web::http::experimental::listener::route_handler validate_authorization, get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, get_control_protocol_datatype_descriptor_handler get_control_protocol_datatype_descriptor, get_control_protocol_method_descriptor_handler get_control_protocol_method_descriptor, filter_property_value_holders_handler filter_property_value_holders, modify_rebuildable_block_handler modify_rebuildable_block, control_protocol_property_changed_handler property_changed, slog::base_gate& gate);
 }
 
 #endif

Development/nmos/configuration_api.cpp

@@ -0,0 +1,30 @@
+#ifndef NMOS_CONFIGURATION_HANDLERS_H
+#define NMOS_CONFIGURATION_HANDLERS_H
+
+#include <functional>
+#include "nmos/control_protocol_typedefs.h"
+#include "nmos/control_protocol_handlers.h"
+#include "nmos/resources.h"
+
+namespace slog
+{
+    class base_gate;
+}
+
+namespace nmos
+{
+    namespace experimental
+    {
+        struct control_protocol_state;
+    }
+    // This callback is invoked if attempting to modify read only properties when restoring a configuration.
+    // This function should modify the Device Model object directly and return a corresponding NcObjectPropertiesSetValidation object
+    typedef std::function<web::json::array(const nmos::resource& resource, const web::json::array& target_role_path, const web::json::array& object_properties_holders, bool recurse, bool validate, web::json::array& property_restore_notices, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor)> filter_property_value_holders_handler;
+
+    // This callback is invoked if attempting to modify a rebuildable block when restoring a configuration.
+    // This function should handle the modification of the Device Model and any corresponding NMOS resources
+    // and return correpsonding NcObjectPropertiesSetValidation objects for each object modified/added
+    typedef std::function<web::json::value(const nmos::resource& resource, const web::json::array& target_role_path, const web::json::array& property_values, bool recurse, bool validate, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor)> modify_rebuildable_block_handler;
+}
+
+#endif

Development/nmos/configuration_api.h

@@ -0,0 +1,148 @@
+#include "nmos/configuration_methods.h"
+
+#include <boost/range/adaptor/filtered.hpp>
+#include "cpprest/json_utils.h"
+#include "nmos/configuration_handlers.h"
+#include "nmos/configuration_utils.h"
+#include "nmos/control_protocol_resource.h"
+#include "nmos/control_protocol_resources.h"
+#include "nmos/control_protocol_state.h"
+#include "nmos/control_protocol_utils.h"
+#include "nmos/slog.h"
+
+namespace nmos
+{
+    namespace details
+    {
+        web::json::value make_property_value_holders(const nmos::resource& resource, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor)
+        {
+            using web::json::value;
+
+            value property_value_holders = value::array();
+
+            nmos::nc_class_id class_id = nmos::details::parse_nc_class_id(nmos::fields::nc::class_id(resource.data));
+
+            // make NcPropertyValueHolder objects
+            while (!class_id.empty())
+            {
+                const auto& control_class_descriptor = get_control_protocol_class_descriptor(class_id);
+
+                for (const auto& property_descriptor : control_class_descriptor.property_descriptors.as_array())
+                {
+                    value property_value_holder = nmos::details::make_nc_property_value_holder(nmos::details::parse_nc_property_id(nmos::fields::nc::id(property_descriptor)), nmos::fields::nc::name(property_descriptor), nmos::fields::nc::type_name(property_descriptor), nmos::fields::nc::is_read_only(property_descriptor), resource.data.at(nmos::fields::nc::name(property_descriptor)));
+
+                    web::json::push_back(property_value_holders, property_value_holder);
+                }
+                class_id.pop_back();
+            }
+            return property_value_holders;
+        }
+
+        void populate_object_property_holder(const nmos::resources& resources, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, const nmos::resource& resource, bool recurse, web::json::value& object_properties_holders)
+        {
+            using web::json::value;
+
+            // Get property_value_holders for this resource
+            const auto& property_value_holders = make_property_value_holders(resource, get_control_protocol_class_descriptor).as_array();
+
+            const auto role_path = get_role_path(resources, resource);
+
+            auto object_properties_holder = nmos::details::make_nc_object_properties_holder(role_path, property_value_holders, nmos::fields::nc::is_rebuildable(resource.data));
+
+            web::json::push_back(object_properties_holders, object_properties_holder);
+
+            // Recurse into members...if we want to...and the object has them
+            if (recurse && nmos::nc::is_block(nmos::details::parse_nc_class_id(nmos::fields::nc::class_id(resource.data))))
+            {
+                if (resource.data.has_field(nmos::fields::nc::members))
+                {
+                    const auto& members = nmos::fields::nc::members(resource.data);
+
+                    for (const auto& member : members)
+                    {
+                        const auto& found = find_resource(resources, utility::s2us(std::to_string(nmos::fields::nc::oid(member))));
+
+                        if (resources.end() != found)
+                        {
+                            populate_object_property_holder(resources, get_control_protocol_class_descriptor, *found, recurse, object_properties_holders);
+                        }
+                    }
+                }
+            }
+        }
+
+        std::size_t generate_validation_fingerprint(const nmos::resources& resources, const nmos::resource& resource)
+        {
+            // Generate a hash based on structure of the Device Model
+            size_t hash(0);
+
+            nmos::nc_class_id class_id = nmos::details::parse_nc_class_id(nmos::fields::nc::class_id(resource.data));
+
+            boost::hash_combine(hash, class_id);
+            boost::hash_combine(hash, nmos::fields::nc::role(resource.data));
+
+            // Recurse into members...if we want to...and the object has them
+            if (nmos::nc::is_block(nmos::details::parse_nc_class_id(nmos::fields::nc::class_id(resource.data))))
+            {
+                if (resource.data.has_field(nmos::fields::nc::members))
+                {
+                    const auto& members = nmos::fields::nc::members(resource.data);
+
+                    // Generate hash for block members
+                    for (const auto& member : members)
+                    {
+                        const auto& oid = nmos::fields::nc::oid(member);
+                        const auto& found = find_resource(resources, utility::s2us(std::to_string(oid)));
+                        if (resources.end() != found)
+                        {
+                            size_t sub_hash = generate_validation_fingerprint(resources, *found);
+                            boost::hash_combine(hash, sub_hash);
+                        }
+                    }
+                }
+            }
+
+            return hash;
+        }
+    }
+
+    web::json::value get_properties_by_path(const nmos::resources& resources, const nmos::resource& resource, bool recurse, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::get_control_protocol_datatype_descriptor_handler get_control_protocol_datatype_descriptor)
+    {
+        using web::json::value;
+        using web::json::value_of;
+
+        value object_properties_holders = value::array();
+
+        details::populate_object_property_holder(resources, get_control_protocol_class_descriptor, resource, recurse, object_properties_holders);
+
+        size_t validation_fingerprint = details::generate_validation_fingerprint(resources, resource);
+
+        utility::ostringstream_t ss;
+        ss << validation_fingerprint;
+
+        auto bulk_values_holder = nmos::details::make_nc_bulk_values_holder(ss.str(), object_properties_holders);
+
+        return nmos::details::make_nc_method_result({ nmos::nc_method_status::ok }, bulk_values_holder);
+    }
+
+    web::json::value validate_set_properties_by_path(nmos::resources& resources, const nmos::resource& resource, const web::json::value& backup_data_set, bool recurse, const web::json::value& restore_mode, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::filter_property_value_holders_handler filter_property_value_holders, nmos::modify_rebuildable_block_handler modify_rebuildable_block)
+    {
+        // Do something with validation fingerprint?
+        const auto& object_properties_holders = nmos::fields::nc::values(backup_data_set);
+
+        const auto& object_properties_set_validation = apply_backup_data_set(resources, resource, object_properties_holders, recurse, restore_mode, true, get_control_protocol_class_descriptor, filter_property_value_holders, modify_rebuildable_block);
+
+        return nmos::details::make_nc_method_result({ nmos::nc_method_status::ok }, object_properties_set_validation);
+    }
+
+    web::json::value set_properties_by_path(nmos::resources& resources, const nmos::resource& resource, const web::json::value& backup_data_set, bool recurse, const web::json::value& restore_mode, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::filter_property_value_holders_handler filter_property_value_holders, nmos::modify_rebuildable_block_handler modify_rebuildable_block)
+    {
+        // Do something with validation fingerprint?
+        const auto& object_properties_holders = nmos::fields::nc::values(backup_data_set);
+
+        const auto& object_properties_set_validation = apply_backup_data_set(resources, resource, object_properties_holders, recurse, restore_mode, false, get_control_protocol_class_descriptor, filter_property_value_holders, modify_rebuildable_block);
+
+        return nmos::details::make_nc_method_result({ nmos::nc_method_status::ok }, object_properties_set_validation);
+    }
+
+}

Development/nmos/configuration_handlers.h

@@ -0,0 +1,25 @@
+#ifndef NMOS_CONFIGURATION_METHODS_H
+#define NMOS_CONFIGURATION_METHODS_H
+
+#include "nmos/configuration_handlers.h"
+#include "nmos/control_protocol_handlers.h"
+#include "nmos/resources.h"
+
+namespace slog
+{
+    class base_gate;
+}
+
+namespace nmos
+{
+    struct control_protocol_resource;
+
+    // Implementation of IS-14 function for creating backup dataset from a Device Model
+    web::json::value get_properties_by_path(const nmos::resources& resources, const nmos::resource& resource, bool recurse, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::get_control_protocol_datatype_descriptor_handler get_control_protocol_datatype_descriptor);
+
+    web::json::value validate_set_properties_by_path(nmos::resources& resources, const nmos::resource& resource, const web::json::value& backup_data_set, bool recurse, const web::json::value& restore_mode, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::filter_property_value_holders_handler filter_property_value_holders, nmos::modify_rebuildable_block_handler modify_rebuildable_block);
+
+    web::json::value set_properties_by_path(nmos::resources& resources, const nmos::resource& resource, const web::json::value& backup_data_set, bool recurse, const web::json::value& restore_mode, nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::filter_property_value_holders_handler filter_property_value_holders, nmos::modify_rebuildable_block_handler modify_rebuildable_block);
+}
+
+#endif

Development/nmos/configuration_methods.cpp

@@ -0,0 +1,28 @@
+#include "nmos/configuration_resources.h"
+
+#include "cpprest/json_utils.h"
+#include "nmos/control_protocol_resource.h"
+#include "nmos/slog.h"
+
+namespace nmos
+{
+    web::json::value make_object_properties_set_validation(const web::json::array& role_path, const nmos::nc_restore_validation_status::status status, const web::json::array& notices, const utility::string_t& status_message)
+    {
+        return details::make_nc_object_properties_set_validation(role_path, status, notices, web::json::value::string(status_message));
+    }
+
+    web::json::value make_object_properties_set_validation(const web::json::array& role_path, const nmos::nc_restore_validation_status::status status, const web::json::array& notices)
+    {
+        return details::make_nc_object_properties_set_validation(role_path, status, notices, web::json::value::null());
+    }
+
+    web::json::value make_object_properties_set_validation(const web::json::array& role_path, const nmos::nc_restore_validation_status::status status)
+    {
+        return details::make_nc_object_properties_set_validation(role_path, status, web::json::value::array().as_array(), web::json::value::null());
+    }
+
+    web::json::value make_object_properties_set_validation(const web::json::array& role_path, const nmos::nc_restore_validation_status::status status, const utility::string_t& status_message)
+    {
+        return details::make_nc_object_properties_set_validation(role_path, status, web::json::value::array().as_array(), web::json::value::string(status_message));
+    }
+}

Development/nmos/configuration_methods.h

@@ -0,0 +1,18 @@
+#ifndef NMOS_CONFIGURATION_RESOURCES_H
+#define NMOS_CONFIGURATION_RESOURCES_H
+
+#include "nmos/control_protocol_typedefs.h"
+#include "nmos/resources.h"
+
+namespace nmos
+{
+    web::json::value make_object_properties_set_validation(const web::json::array& role_path, const nmos::nc_restore_validation_status::status status, const web::json::array& notices, const utility::string_t& status_message);
+
+    web::json::value make_object_properties_set_validation(const web::json::array& role_path, const nmos::nc_restore_validation_status::status status, const web::json::array& notices);
+
+    web::json::value make_object_properties_set_validation(const web::json::array& role_path, const nmos::nc_restore_validation_status::status status);
+
+    web::json::value make_object_properties_set_validation(const web::json::array& role_path, const nmos::nc_restore_validation_status::status status, const utility::string_t& status_message);
+}
+
+#endif