[projmgr] Add ConvertSolution RPC method handling

brondani · brondani · commit 3e0a1ea7f200 · 2025-08-20T16:50:35.000+02:00
diff --git a/tools/projmgr/CMakeLists.txt b/tools/projmgr/CMakeLists.txt
@@ -17,8 +17,8 @@ include(FetchContent)
 FetchContent_Declare(
   rpc-interface
   DOWNLOAD_EXTRACT_TIMESTAMP ON
-  URL https://github.com/brondani/csolution-rpc/releases/download/v0.0.4/csolution-rpc.zip
-  URL_HASH SHA256=643ab30d25f47b55735bc6fecd3622ad1c7619d8fac901e2b19cd594a01df8b2
+  URL https://github.com/Open-CMSIS-Pack/csolution-rpc/releases/download/v0.0.4/csolution-rpc.zip
+  URL_HASH SHA256=ca9bfdacb35b44b6cadf29d87123adbfc1a5e944af7f2aefda0ccf7fd4bd216f
 )
 FetchContent_MakeAvailable(rpc-interface)
 
diff --git a/tools/projmgr/include/ProjMgr.h b/tools/projmgr/include/ProjMgr.h
@@ -70,6 +70,16 @@ class ProjMgr {
   */
   bool LoadSolution(const std::string& csolution, const std::string& activeTargetSet);
 
+  /**
+   * @brief convert solution and generate yml files
+   * @param path to <solution>.csolution.yml file
+   * @param active target set in the format <target-type>[@<set>]
+   * @param update-rte: create/update configuration files
+   * @return processing status
+  */
+  bool RunConvert(const std::string&csolution = RteUtils::EMPTY_STRING,
+    const std::string& activeTargetSet = RteUtils::EMPTY_STRING, const bool& updateRte = false);
+
 protected:
   /**
    * @brief parse command line options
@@ -185,7 +195,6 @@ class ProjMgr {
   std::set<std::string> m_failedContext;
 
   bool RunConfigure();
-  bool RunConvert();
   bool RunCodeGenerator();
   bool RunListPacks();
   bool RunListBoards();
@@ -212,6 +221,7 @@ class ProjMgr {
   bool ParseAndValidateContexts();
   bool ProcessContexts();
   bool IsSolutionImageOnly();
+  void InitSolution(const std::string& csolution, const std::string& activeTargetSet, const bool& updateRte);
 };
 
 #endif  // PROJMGR_H
diff --git a/tools/projmgr/src/ProjMgr.cpp b/tools/projmgr/src/ProjMgr.cpp
@@ -563,7 +563,7 @@ bool ProjMgr::PopulateContexts(void) {
 
 bool ProjMgr::GenerateYMLConfigurationFiles(bool previousResult) {
   // Generate cbuild pack file
-  const bool isUsingContexts = m_contextSet || m_context.size() != 0;
+  const bool isUsingContexts = m_contextSet || m_activeTargetSet.has_value() || m_context.size() != 0;
   if (!m_emitter.GenerateCbuildPack(m_processedContexts, isUsingContexts, m_frozenPacks)) {
     return false;
   }
@@ -750,7 +750,12 @@ bool ProjMgr::RunConfigure() {
   return success;
 }
 
-bool ProjMgr::RunConvert(void) {
+bool ProjMgr::RunConvert(const std::string& csolution, const std::string& activeTargetSet, const bool& updateRte) {
+  // Set csolution.yml file and options
+  if (!csolution.empty()) {
+    InitSolution(csolution, activeTargetSet, updateRte);
+  }
+  
   // Configure
   bool Success = Configure();
 
@@ -1286,19 +1291,22 @@ void ProjMgr::Clear() {
   ProjMgrLogger::Get().Clear();
 }
 
-bool ProjMgr::LoadSolution(const std::string& csolution, const std::string& activeTargetSet) {
+void ProjMgr::InitSolution(const std::string& csolution, const std::string& activeTargetSet, const bool& updateRte) {
   Clear();
-
   m_csolutionFile = csolution;
   m_rootDir = RteUtils::ExtractFilePath(m_csolutionFile, false);
-  m_updateRteFiles = false;
-
+  m_updateRteFiles = updateRte;
   if (activeTargetSet.empty()) {
     // fallback to 'context-set' for backward compatibility
     m_contextSet = true;
   } else {
     m_activeTargetSet = activeTargetSet;
   }
+}
+
+bool ProjMgr::LoadSolution(const std::string& csolution, const std::string& activeTargetSet) {
+
+  InitSolution(csolution, activeTargetSet, false);
 
   if (!PopulateContexts()) {
     return false;
diff --git a/tools/projmgr/src/ProjMgrRpcServer.cpp b/tools/projmgr/src/ProjMgrRpcServer.cpp
@@ -95,6 +95,7 @@ class RpcHandler : public RpcMethods {
   RpcArgs::Results ValidateComponents(const string& context) override;
   RpcArgs::LogMessages GetLogMessages(void) override;
   RpcArgs::DraftProjectsInfo GetDraftProjects(const RpcArgs::DraftProjectsFilter& filter) override;
+  RpcArgs::ConvertSolutionResult ConvertSolution(const string& solution, const string& activeTarget, const bool& updateRte) override;
 
 protected:
   enum Exception
@@ -674,4 +675,28 @@ RpcArgs::DraftProjectsInfo RpcHandler::GetDraftProjects(const RpcArgs::DraftProj
   return applications;
 }
 
+RpcArgs::ConvertSolutionResult RpcHandler::ConvertSolution(const string& solution, const string& activeTarget, const bool& updateRte) {
+  RpcArgs::ConvertSolutionResult result = { false };
+  const auto csolutionFile = RteFsUtils::MakePathCanonical(solution);
+  if (!regex_match(csolutionFile, regex(".*\\.csolution\\.(yml|yaml)"))) {
+    result.message = solution + " is not a *.csolution.yml file";
+    return result;
+  }
+  if (!m_manager.RunConvert(csolutionFile, activeTarget, updateRte) || !ProjMgrLogger::Get().GetErrors().empty()) {
+    if (m_worker.HasVarDefineError()) {
+      const auto& vars = m_worker.GetUndefLayerVars();
+      result.undefinedLayers = StrVec(vars.begin(), vars.end());
+      result.message = "Layer variables undefined, names can be found under 'undefinedLayers'";
+    } else if (m_worker.HasCompilerDefineError()) {
+      result.selectCompiler = m_worker.GetSelectableCompilers();
+      result.message = "Compiler undefined, selectable values can be found under 'selectCompiler'";
+    } else {
+      result.message = "Convert solution failed, see log messages";
+    }
+    return result;
+  }
+  result.success = true;
+  return result;
+}
+
 // end of ProkMgrRpcServer.cpp
diff --git a/tools/projmgr/test/src/ProjMgrRpcTests.cpp b/tools/projmgr/test/src/ProjMgrRpcTests.cpp
@@ -12,6 +12,7 @@
 
 #include "CrossPlatformUtils.h"
 #include "ProductInfo.h"
+#include "RteFsUtils.h"
 #include "yaml-cpp/yaml.h"
 
 #include <fstream>
@@ -72,7 +73,7 @@ vector<json> ProjMgrRpcTests::RunRpcMethods(const string& strIn) {
   StdStreamRedirect streamRedirect;
   streamRedirect.SetInString(strIn);
   char* argv[] = { (char*)"csolution", (char*)"rpc" };
-  EXPECT_EQ(0, RunProjMgr(2, argv, 0));
+  EXPECT_EQ(0, RunProjMgr(2, argv, m_envp));
   string line;
   vector<json> responses;
   istringstream iss(streamRedirect.GetOutString());
@@ -86,7 +87,7 @@ string ProjMgrRpcTests::RunRpcMethodsWithContent(const string& strIn) {
   StdStreamRedirect streamRedirect;
   streamRedirect.SetInString(strIn);
   char* argv[] = { (char*)"csolution", (char*)"rpc", (char*)"--content-length" };
-  EXPECT_EQ(0, RunProjMgr(3, argv, 0));
+  EXPECT_EQ(0, RunProjMgr(3, argv, m_envp));
   return streamRedirect.GetOutString();
 }
 
@@ -704,4 +705,39 @@ TEST_F(ProjMgrRpcTests, RpcGetDraftProjects) {
   EXPECT_EQ(responses[0]["result"]["message"], "Packs must be loaded before retrieving draft projects");
 }
 
+TEST_F(ProjMgrRpcTests, RpcConvertSolution) {
+  auto csolutionPath = testinput_folder + "/TestRpc/minimal.csolution.yml";
+  auto requests = FormatRequest(1, "ConvertSolution",
+    json({ { "solution", csolutionPath }, { "activeTarget", "TestHW" }, { "updateRte", true } }));
+  auto responses = RunRpcMethods(requests);
+  EXPECT_TRUE(responses[0]["result"]["success"]);
+  EXPECT_TRUE(RteFsUtils::Exists(testinput_folder + "/TestRpc/minimal.cbuild-idx.yml"));
+  EXPECT_TRUE(RteFsUtils::Exists(testinput_folder + "/TestRpc/minimal.cbuild-pack.yml"));
+  EXPECT_TRUE(RteFsUtils::Exists(testinput_folder + "/TestRpc/out/minimal+TestHW.cbuild-run.yml"));
+  EXPECT_TRUE(RteFsUtils::Exists(testinput_folder + "/TestRpc/out/minimal/TestHW/minimal+TestHW.cbuild.yml"));
+  
+  // convert fail
+  csolutionPath = testinput_folder + "/TestRpc/unknown-component.csolution.yml";
+  requests = FormatRequest(1, "ConvertSolution",
+    json({ { "solution", csolutionPath }, { "activeTarget", "" }, { "updateRte", true } }));
+  responses = RunRpcMethods(requests);
+  EXPECT_FALSE(responses[0]["result"]["success"]);
+
+  // undefined compiler
+  csolutionPath = testinput_folder + "/TestSolution/SelectableToolchains/select-compiler.csolution.yml";
+  requests = FormatRequest(1, "ConvertSolution",
+    json({ { "solution", csolutionPath }, { "activeTarget", "" }, { "updateRte", true } }));
+  responses = RunRpcMethods(requests);
+  EXPECT_FALSE(responses[0]["result"]["success"]);
+  EXPECT_EQ(responses[0]["result"]["selectCompiler"][0], "AC6@>=6.0.0");
+  EXPECT_EQ(responses[0]["result"]["selectCompiler"][1], "GCC@>=8.0.0");
+
+  // undefined layer
+  csolutionPath = testinput_folder + "/TestLayers/variables-notdefined.csolution.yml";
+  requests = FormatRequest(1, "ConvertSolution",
+    json({ { "solution", csolutionPath }, { "activeTarget", "" }, { "updateRte", true } }));
+  responses = RunRpcMethods(requests);
+  EXPECT_FALSE(responses[0]["result"]["success"]);
+  EXPECT_EQ(responses[0]["result"]["undefinedLayers"][0], "NotDefined");
+}
 // end of ProjMgrRpcTests.cpp
diff --git a/tools/projmgr/test/src/ProjMgrTestEnv.cpp b/tools/projmgr/test/src/ProjMgrTestEnv.cpp
@@ -23,6 +23,7 @@ string schema_folder;
 string templates_folder;
 string etc_folder;
 string bin_folder;
+char* m_envp[4];
 
 StdStreamRedirect::StdStreamRedirect() :
   m_outbuffer(""), m_cerrbuffer(""),
@@ -153,10 +154,13 @@ void ProjMgrTestEnv::SetUp() {
 
   // copy linker script template files
   fs::copy(fs::path(templates_folder), fs::path(testcmsiscompiler_folder), fs::copy_options::recursive, ec);
+
+  // env vars
+  SetUpEnvp();
 }
 
 void ProjMgrTestEnv::TearDown() {
-  // Reserved
+  CleanUpEnvp();
 }
 
 void ProjMgrTestEnv::CompareFile(const string& file1, const string& file2, LineReplaceFunc_t file2LineReplaceFunc) {
@@ -277,6 +281,31 @@ int ProjMgrTestEnv::CountOccurrences(const std::string input, const std::string
   return occurrences;
 }
 
+void ProjMgrTestEnv::SetUpEnvp() {
+  std::string ac6 = "AC6_TOOLCHAIN_6_18_0=" + testinput_folder;
+  std::string gcc = "GCC_TOOLCHAIN_11_2_1=" + testinput_folder;
+  std::string iar = "IAR_TOOLCHAIN_8_50_6=" + testinput_folder;
+
+  // Allocate memory for environment variables
+  m_envp[0] = new char[ac6.size() + 1];
+  m_envp[1] = new char[iar.size() + 1];
+  m_envp[2] = new char[gcc.size() + 1];
+
+  // Copy strings to allocated memory
+  strcpy(m_envp[0], ac6.c_str());
+  strcpy(m_envp[1], iar.c_str());
+  strcpy(m_envp[2], gcc.c_str());
+
+  // Null terminator
+  m_envp[3] = nullptr;
+}
+
+void ProjMgrTestEnv::CleanUpEnvp() {
+  delete[] m_envp[0];
+  delete[] m_envp[1];
+  delete[] m_envp[2];
+}
+
 int main(int argc, char **argv) {
   try {
     testing::InitGoogleTest(&argc, argv);
diff --git a/tools/projmgr/test/src/ProjMgrTestEnv.h b/tools/projmgr/test/src/ProjMgrTestEnv.h
@@ -20,6 +20,8 @@ extern std::string testcmsiscompiler_folder;
 extern std::string schema_folder;
 extern std::string etc_folder;
 extern std::string bin_folder;
+extern char* m_envp[4];
+
 /**
  * @brief direct console output to string
 */
@@ -66,6 +68,8 @@ class ProjMgrTestEnv : public ::testing::Environment {
   static bool FilterId(const std::string& id, const std::string& includeIds);
   static bool IsFileInCbuildFilesList(const std::vector<std::map<std::string, std::string>> files, const std::string file);
   static int CountOccurrences(const std::string input, const std::string substring);
+  void SetUpEnvp();
+  void CleanUpEnvp();
 };
 
 #endif  // PROJMGRTESTENV_H
diff --git a/tools/projmgr/test/src/ProjMgrUnitTests.cpp b/tools/projmgr/test/src/ProjMgrUnitTests.cpp
@@ -33,32 +33,10 @@ class ProjMgrUnitTests : public ProjMgr, public ::testing::Test {
 
   void SetUp() {
     m_context.clear();
-    std::string ac6 = "AC6_TOOLCHAIN_6_18_0=" + testinput_folder;
-    std::string gcc = "GCC_TOOLCHAIN_11_2_1=" + testinput_folder;
-    std::string iar = "IAR_TOOLCHAIN_8_50_6=" + testinput_folder;
-
-    // Allocate memory for environment variables
-    m_envp[0] = new char[ac6.size() + 1];
-    m_envp[1] = new char[iar.size() + 1];
-    m_envp[2] = new char[gcc.size() + 1];
-
-    // Copy strings to allocated memory
-    std::strcpy(m_envp[0], ac6.c_str());
-    std::strcpy(m_envp[1], iar.c_str());
-    std::strcpy(m_envp[2], gcc.c_str());
-
-    // Null terminator
-    m_envp[3] = nullptr;
   };
 
   void TearDown() {
-    cleanupEnvp();
-  }
-
-  void cleanupEnvp() {
-    delete[] m_envp[0];
-    delete[] m_envp[1];
-    delete[] m_envp[2];
+    // reserved
   }
 
   void GetFilesInTree(const string& dir, set<string>& files) {
@@ -98,8 +76,6 @@ class ProjMgrUnitTests : public ProjMgr, public ::testing::Test {
     fout.close();
     return csolutionFile;
   }
-
-  char* m_envp[4];
 };
 
 TEST_F(ProjMgrUnitTests, Validate_Logger) {
