[occ] Push configuration via boost::ptree

Author: teo

occ/occlib/OccServer.cxx

@@ -30,6 +30,7 @@
 #include <boost/uuid/uuid_generators.hpp>
 #include <boost/uuid/uuid_io.hpp>
 #include <boost/algorithm/string.hpp>
+#include <boost/property_tree/ptree.hpp>
 
 #include "RuntimeControlledObject.h"
 
@@ -188,9 +189,9 @@ grpc::Status OccServer::Transition(grpc::ServerContext* context,
               << " currentState: " << currentStateStr
               << " event: " << event << std::endl;
 
-    PropertyMap properties;
+    boost::property_tree::ptree properties;
     for (auto item : arguments) {
-        properties[item.key()] = item.value();
+        properties.put(item.key(), item.value());
     }
 
     t_State newState        = processStateTransition(event, properties);
@@ -211,7 +212,7 @@ grpc::Status OccServer::Transition(grpc::ServerContext* context,
     return grpc::Status::OK;
 }
 
-t_State OccServer::processStateTransition(const std::string& event, const PropertyMap& properties)
+t_State OccServer::processStateTransition(const std::string& event, const boost::property_tree::ptree& properties)
 {
     int err = 0;
     int invalidEvent = 0;

occ/occlib/OccServer.h

@@ -38,6 +38,17 @@
 
 namespace pb = occ_pb;
 
+
+namespace boost {
+namespace property_tree
+{
+template < class Key, class Data, class KeyCompare >
+class basic_ptree;
+
+typedef basic_ptree< std::string, std::string, std::less<std::string> > ptree;
+}
+}
+
 class RuntimeControlledObject;
 
 const std::unordered_map<std::string, std::string> EXPECTED_FINAL_STATE = {
@@ -89,7 +100,7 @@ class OccServer final : public pb::Occ::Service
     bool checkMachineDone();
 
 private:
-    t_State processStateTransition(const std::string& evt, const PropertyMap& properties);
+    t_State processStateTransition(const std::string& evt, const boost::property_tree::ptree& properties);
     void updateState(t_State s);
 
     void publishState(t_State s);

occ/occlib/OccState.h

@@ -48,9 +48,6 @@ typedef enum {
     done        /// Final state of the process, it is not possible to go back from here, only quit.
 } t_State;
 
-typedef std::unordered_map<std::string, std::string> PropertyMap;
-
-
 t_State OCC_EXPORT getStateFromString(const std::string& s);
 const std::string OCC_EXPORT getStringFromState(t_State s);
 

occ/occlib/RuntimeControlledObject.cxx

@@ -25,6 +25,8 @@
 
 #include "RuntimeControlledObject.h"
 
+#include <boost/property_tree/ptree.hpp>
+
 #include <thread>
 
 using namespace std::chrono_literals;
@@ -81,7 +83,7 @@ const std::string RuntimeControlledObject::getName()
     return dPtr->mName;
 }
 
-int RuntimeControlledObject::executeConfigure(const PropertyMap& properties)
+int RuntimeControlledObject::executeConfigure(const boost::property_tree::ptree& properties)
 {
     return 0;
 }

occ/occlib/RuntimeControlledObject.h

@@ -29,6 +29,16 @@
 #include "OccState.h"
 #include "occ_export.h"
 
+namespace boost {
+namespace property_tree
+{
+template < class Key, class Data, class KeyCompare >
+class basic_ptree;
+
+typedef basic_ptree< std::string, std::string, std::less<std::string> > ptree;
+}
+}
+
 class RuntimeControlledObjectPrivate;
 
 class OCC_EXPORT RuntimeControlledObject {
@@ -79,7 +89,7 @@ class OCC_EXPORT RuntimeControlledObject {
      *  transition all checks (iterateRunning/iterateCheck) are blocked until the transition
      *  finishes and returns success or error.
      */
-    virtual int executeConfigure(const PropertyMap& properties);
+    virtual int executeConfigure(const boost::property_tree::ptree& properties);
 
     /**
      * Transition from configured to standby.
@@ -180,8 +190,9 @@ class OCC_EXPORT RuntimeControlledObject {
      * @return 0 if the check completed successfully and the machine can stay in the current state,
      *  or any other value to immediately trigger a transition to the error state.
      *
-     * This function is called continuously by OccServer::runChecker in any state. Its purpose is for
-     * the implementer to report an unusual condition in order to trigger a transition to error.
+     * This function is called continuously by OccServer::runChecker in any state, including
+     * t_State::running. Its purpose is for the implementer to report an unusual condition in
+     * order to trigger a transition to t_State::error.
      */
     virtual int iterateCheck();