Rpc development (#1200) (#2098)

* [projmgr] Introduce JSON-RPC server mode
* Add `GetComponentsInfo` request
* Add `GetPacksInfo` and `ValidateComponents` requests
* Add `GetLogMessages` requests
* Add `bundles` to `GetComponentsInfo` request
* GetComponentsTree  request added
* Make more RPC data optional
* Taxonomy
* Fix for cclass level
  Initial unit tests preparation
* Only report aggregates belonging to the bundle
* report selected components in the tree
* Fix adding api and taxonomy to group
* Select methods and use of individual contexts
* Check if component exists for variant change
* add flag to list components from all packs
* Components from all/solution packs
* Extend jrpc commands and structures.
Always write active bundle
* Correct GetUsedData
* Add layer information
consistent use of selectedCount
* Add layer filed to CtAggregate
Ensure value is set and propagated.
Remove Component Instance from CtAggregate structure
Add helper method in XmlItem class to assign an attribute from one
object to another

* [json-rpc] Add `RpcInterface.h`

---------

Co-authored-by: Daniel Brondani <daniel.brondani@arm.com>

Co-authored-by: Evgueni Driouk <edriouk@arm.com>
Co-authored-by: Daniel Brondani <daniel.brondani@arm.com>

Author: 3 people

.github/.cppcheck_suppressions

@@ -3,3 +3,4 @@
 unusedFunction:libs/xmltree/src/XMLTree.cpp:47
 unusedFunction:libs/xmlschemachecker/src/XmlErrorHandler.cpp:27
 unusedFunction:libs/xmlschemachecker/src/XmlErrorHandler.cpp:32
+unusedFunction:tools/projmgr/src/ProjMgrRpcServer.cpp

.gitmodules

@@ -29,3 +29,6 @@
 	path = external/xerces-c
 	url = https://github.com/apache/xerces-c.git
 	ignore = dirty
+[submodule "external/json-rpc-cxx"]
+	path = external/json-rpc-cxx
+	url = https://github.com/jsonrpcx/json-rpc-cxx.git

external/json-rpc-cxx

@@ -20,6 +20,7 @@
 #include "RteInstance.h"
 #include "RteProject.h"
 #include "RteGenerator.h"
+#include "RteConstants.h"
 
 #include "XMLTree.h"
 
@@ -608,6 +609,7 @@ void RteComponentAggregate::SetComponentInstance(RteComponentInstance* ci, int c
   RteItem* ei = ci->GetEffectiveItem(targetName);
   m_selectedVariant = ei->GetCvariantName();
   m_selectedVersion = ei->GetVersionString();
+  AssignAttribute("layer", *ci);
 
   if (m_components.empty()) {
     if (c) {
@@ -1625,8 +1627,9 @@ string RteComponentGroup::GetTaxonomyDescriptionID() const
   string id;
   if (m_parent)
     id = m_parent->GetTaxonomyDescriptionID();
-  if (!id.empty())
-    id += ".";
+  if(!id.empty()) {
+    id += RteConstants::PREFIX_CGROUP;
+  }
   id += GetName();
   return id;
 }

libs/rtemodel/src/RteComponent.cpp

@@ -832,6 +832,8 @@ bool RteProject::Apply()
           }
         }
         ci = AddComponent(c, count, target, ci);
+        ci->AssignAttribute("layer", *a);
+
         // add API if any
         RteApi* api = c->GetApi(target, true);
         if (api) {

libs/rtemodel/src/RteProject.cpp

@@ -1127,6 +1127,12 @@ TEST_F(RteModelPrjTest, LoadCprjM4) {
   EXPECT_EQ(allLayerDescriptors.size(), 10);
   auto& filteredLayerDescriptors = activeTarget->GetFilteredModel()->GetLayerDescriptors();
   EXPECT_EQ(filteredLayerDescriptors.size(), 10);
+  ca = activeTarget->GetComponentAggregate("ARM::Device:Startup");
+  ASSERT_NE(ca, nullptr);
+  EXPECT_EQ(ca->GetAttribute("layer"), "LayerOne");
+  ci = ca->GetComponentInstance();
+  EXPECT_EQ(ci->GetAttribute("layer"), "LayerOne");
+  ASSERT_NE(ci, nullptr);
 
   const string projDir = RteUtils::ExtractFilePath(RteTestM4_cprj, true);
   const string rteDir = projDir + "RTE/";

libs/rtemodel/test/src/RteModelTest.cpp

@@ -160,11 +160,19 @@ class XmlItem
 
   /**
    * @brief replace instance attributes with the given ones
-   * @param attributes given instance of XmlItem
+   * @param attributes instance of XmlItem containing attributes to assign
    * @return true if attributes are set
   */
   bool SetAttributes(const XmlItem &attributes);
 
+  /**
+   * @brief assign specified attribute value from supplied object to this one
+   * @param name attribute name
+   * @param from instance of XmlItem to get value from
+   * @return true if attribute is changed
+  */
+  bool AssignAttribute(const std::string& name, const XmlItem &from);
+
   /**
    * @brief remove attribute
    * @param name attribute name

libs/xmltree/include/XmlItem.h

@@ -62,9 +62,12 @@ bool XmlItem::AddAttribute(const string& name, const string& value, bool insertE
       return true;
     }
   }
-  if (insertEmpty || !value.empty())
+
+  if(insertEmpty || !value.empty()) {
     m_attributes[name] = value;
-  return true;
+    return true;
+  }
+  return false;
 }
 
 bool XmlItem::SetAttribute(const char* name, const char* value)
@@ -104,6 +107,10 @@ bool XmlItem::SetAttributes(const XmlItem& attributes)
   return SetAttributes(attributes.GetAttributes());
 }
 
+bool XmlItem::AssignAttribute(const std::string& name, const XmlItem& from) {
+  return AddAttribute(name, from.GetAttribute(name), false);
+}
+
 bool XmlItem::RemoveAttribute(const std::string& name)
 {
   map<string, string>::iterator it = m_attributes.find(name);

libs/xmltree/src/XmlItem.cpp

@@ -26,6 +26,19 @@ TEST(XmlTreeTest, GetAttribute) {
   e.AddAttribute("zeroTen", "010");
   e.AddAttribute("minusOne", "-1");
 
+  XMLTreeElement another;
+  EXPECT_FALSE(another.AssignAttribute("unknown",e));
+  EXPECT_FALSE(another.HasAttribute("unknown"));
+  EXPECT_TRUE(another.SetAttribute("unknown", "unknown"));
+  EXPECT_TRUE(another.AssignAttribute("unknown",e));
+  EXPECT_FALSE(another.HasAttribute("unknown"));
+
+  EXPECT_TRUE(another.AssignAttribute("ten",e));
+  EXPECT_TRUE(another.HasAttribute("ten"));
+  EXPECT_FALSE(another.AssignAttribute("ten",e)); // already assigned
+  EXPECT_TRUE(another.SetAttribute("ten","010"));
+  EXPECT_TRUE(another.AssignAttribute("ten",e));
+
   EXPECT_EQ(e.GetAttribute("unknown").empty(), true);
   EXPECT_EQ(e.GetAttribute("string"), "strVal");
   EXPECT_EQ(e.GetAttribute("empty").empty(), true);

libs/xmltree/test/src/XmlTreeTest.cpp

@@ -22,12 +22,15 @@ SET(PROJMGR_SOURCE_FILES ProjMgr.cpp ProjMgrKernel.cpp ProjMgrCallback.cpp
   ProjMgrCbuildBase.cpp ProjMgrCbuild.cpp ProjMgrCbuildIdx.cpp
   ProjMgrCbuildGenIdx.cpp ProjMgrCbuildPack.cpp ProjMgrCbuildSet.cpp
   ProjMgrCbuildRun.cpp ProjMgrRunDebug.cpp
+  ProjMgrRpcServer.cpp ProjMgrRpcServerData.cpp
 )
 SET(PROJMGR_HEADER_FILES ProjMgr.h ProjMgrKernel.h ProjMgrCallback.h
   ProjMgrParser.h ProjMgrWorker.h ProjMgrGenerator.h ProjMgrXmlParser.h
   ProjMgrYamlParser.h ProjMgrLogger.h ProjMgrYamlSchemaChecker.h
   ProjMgrYamlEmitter.h ProjMgrUtils.h ProjMgrExtGenerator.h
   ProjMgrCbuildBase.h ProjMgrRunDebug.h
+  ProjMgrRpcServer.h ProjMgrRpcServerData.h
+  RpcInterface.h
 )
 
 list(TRANSFORM PROJMGR_SOURCE_FILES PREPEND src/)
@@ -37,8 +40,12 @@ add_library(projmgrlib OBJECT ${PROJMGR_SOURCE_FILES} ${PROJMGR_HEADER_FILES})
 target_link_libraries(projmgrlib
   PUBLIC
   CrossPlatform RteFsUtils RteUtils XmlTree XmlTreeSlim XmlReader
-  RteModel cxxopts yaml-cpp YmlSchemaChecker)
-target_include_directories(projmgrlib PRIVATE include ${PROJECT_BINARY_DIR})
+  RteModel cxxopts yaml-cpp YmlSchemaChecker
+)
+target_include_directories(projmgrlib PUBLIC include ${PROJECT_BINARY_DIR}
+  ${CMAKE_SOURCE_DIR}/external/json
+  ${CMAKE_SOURCE_DIR}/external/json-rpc-cxx/include
+)
 
 if(SWIG_LIBS)
   # projmgr swig