[projmgr] Check loaded pack requirements

Author: brondani

tools/projmgr/include/ProjMgrUtils.h

@@ -265,8 +265,15 @@ class ProjMgrUtils {
   */
   static const std::string FormatPath(const std::string& original, const std::string& directory, bool useAbsolutePaths = false);
 
+  /**
+   * @brief check if list contains incompatible version of pack requirement
+   * @param list of packs
+   * @param string pack requirement
+   * @return true if incompatible pack is found
+  */
+  static bool ContainsIncompatiblePack(const std::list<RtePackage*>& packs, const std::string& requirement);
+
 protected:
-  static std::string ConstructID(const std::vector<std::pair<const char*, const std::string&>>& elements);
   /**
    * @brief get filtered list of contexts
    * @param allContexts list of all available contexts

tools/projmgr/src/ProjMgrUtils.cpp

@@ -416,3 +416,19 @@ const string ProjMgrUtils::FormatPath(const string& original, const string& dire
   }
   return path;
 }
+
+bool ProjMgrUtils::ContainsIncompatiblePack(const std::list<RtePackage*>& packs, const std::string& requirement) {
+  bool incompatible = false;
+  for (const auto& p : packs) {
+    const auto& id = p->GetPackageID();
+    if (RtePackage::VendorFromId(id) == RtePackage::VendorFromId(requirement) &&
+        RtePackage::NameFromId(id) == RtePackage::NameFromId(requirement)) {
+      if (VersionCmp::RangeCompare(RtePackage::VersionFromId(id), RtePackage::VersionFromId(requirement)) != 0) {
+        incompatible = true;
+      } else {
+        return false;
+      }
+    }
+  }
+  return incompatible;
+}

tools/projmgr/src/ProjMgrWorker.cpp

@@ -504,17 +504,14 @@ bool ProjMgrWorker::LoadPacks(ContextItem& context) {
 
 bool ProjMgrWorker::CheckMissingPackRequirements(const std::string& contextName)
 {
-  if(!m_debug) {
-    // perform check only in debug mode
-    return true;
-  }
   bool bRequiredPacksLoaded = true;
   // check if all pack requirements are fulfilled
   for(auto pack : m_loadedPacks) {
     RtePackageMap allRequiredPacks;
     pack->GetRequiredPacks(allRequiredPacks, m_model);
     for(auto [id, p] : allRequiredPacks) {
-      if(!p) {
+      bool incompatible = ProjMgrUtils::ContainsIncompatiblePack(m_loadedPacks, id);
+      if((!p && m_debug) || incompatible) {
         bRequiredPacksLoaded = false;
         string msg;
         if(!contextName.empty()) {
@@ -3673,13 +3670,11 @@ bool ProjMgrWorker::ProcessContext(ContextItem& context, bool loadGenFiles, bool
   ret &= ProcessConfigFiles(context);
   ret &= ProcessComponentFiles(context);
   ret &= ProcessExecutes(context);
-  bool bUnresolvedDependencies = false;
   if (resolveDependencies) {
     // TODO: Add uniquely identified missing dependencies to RTE Model
 
     // Get dependency validation results
     if (!ValidateContext(context)) {
-      bUnresolvedDependencies = true;
       string msg = "dependency validation for context '" + context.name + "' failed:";
       set<string> results;
       FormatValidationResults(results, context);
@@ -3693,9 +3688,7 @@ bool ProjMgrWorker::ProcessContext(ContextItem& context, bool loadGenFiles, bool
       }
     }
   }
-  if(!ret || bUnresolvedDependencies) {
-    CheckMissingPackRequirements(context.name);
-  }
+  CheckMissingPackRequirements(context.name);
   return ret;
 }
 

tools/projmgr/test/data/TestSolution/PackRequirements/incompatible.cproject.yml

@@ -0,0 +1,6 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/Open-CMSIS-Pack/devtools/main/tools/projmgr/schemas/cproject.schema.json
+
+project:
+  components:
+    - component: Startup
+    - component: CORE

tools/projmgr/test/data/TestSolution/PackRequirements/incompatible.csolution.yml

@@ -0,0 +1,18 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/Open-CMSIS-Pack/devtools/main/tools/projmgr/schemas/csolution.schema.json
+
+solution:
+  target-types:
+    - type: CM0
+      device: RteTest_ARMCM0
+
+  build-types:
+    - type: Debug
+      compiler: AC6
+
+  packs:
+    - pack: ARM::[email protected]
+    - pack: ARM::RteTestRequired
+      path: ./packs/required
+
+  projects:
+    - project: ./incompatible.cproject.yml

tools/projmgr/test/data/TestSolution/PackRequirements/packs/required/ARM.RteTestRequired.pdsc

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<package schemaVersion="1.3" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="PACK.xsd">
+  <name>RteTestRequired</name>
+  <description>Local pack 1.0</description>
+  <vendor>ARM</vendor>
+
+  <releases>
+    <release version="1.0.0" date="2024-11-27">
+      Local version
+    </release>
+  </releases>
+
+  <requirements>
+    <packages>
+      <package vendor="ARM" name="RteTest_DFP" version="3.0.0"/>
+    </packages>
+  </requirements>
+
+</package>

tools/projmgr/test/src/ProjMgrUnitTests.cpp

@@ -219,13 +219,27 @@ TEST_F(ProjMgrUnitTests, RunProjMgr_Packs_Required_Warning) {
   }
   streamRedirect.ClearStringStreams();
   argv[7] = (char*)"test1.Release+CM0";
-  EXPECT_EQ(0, RunProjMgr(9, argv, m_envp)); // succeeds regardless missing pack requirement  => no pack warnings
+  EXPECT_EQ(0, RunProjMgr(8, argv, m_envp)); // succeeds regardless missing pack requirement  => no pack warnings
   errStr = streamRedirect.GetErrorString();
   for(auto& w : warnings) {
     EXPECT_FALSE(errStr.find(w) != string::npos);
   }
 }
 
+TEST_F(ProjMgrUnitTests, RunProjMgr_Incompatible_Packs_Required_Warning) {
+  StdStreamRedirect streamRedirect;
+  const string warning = {
+    "pack 'ARM::[email protected]' required by pack 'ARM::[email protected]' is not specified"
+  };
+  const string csolution = testinput_folder + "/TestSolution/PackRequirements/incompatible.csolution.yml";
+  char* argv[3];
+  argv[1] = (char*)"convert";
+  argv[2] = (char*)csolution.c_str();
+  EXPECT_EQ(0, RunProjMgr(3, argv, m_envp));
+  auto errStr = streamRedirect.GetErrorString();
+  EXPECT_TRUE(errStr.find(warning) != string::npos);
+}
+
 TEST_F(ProjMgrUnitTests, RunProjMgr_ListPacks) {
   map<std::pair<string, string>, string> testInputs = {
     {{"TestSolution/test.csolution.yml", "test1.Debug+CM0"}, "ARM::[email protected]" },

tools/projmgr/test/src/ProjMgrUtilsUnitTests.cpp

@@ -510,3 +510,17 @@ TEST_F(ProjMgrUtilsUnitTests, FormatPath) {
     EXPECT_EQ("X:/Non_Existent/Absolute", ProjMgrUtils::FormatPath("X:/Non_Existent/Absolute", testoutput_folder));
   }
 }
+
+TEST_F(ProjMgrUtilsUnitTests, ContainsIncompatiblePack) {
+  ProjMgrKernel::Get()->SetCmsisPackRoot(testcmsispack_folder);
+  std::list<std::string> pdscFiles;
+  std::list<RtePackage*> loadedPacks;
+  auto kernel = ProjMgrKernel::Get();
+  kernel->GetEffectivePdscFiles(pdscFiles);
+  kernel->LoadAndInsertPacks(loadedPacks, pdscFiles);
+
+  EXPECT_FALSE(ProjMgrUtils::ContainsIncompatiblePack(loadedPacks, "ARM::[email protected]:0.2.0"));
+  EXPECT_FALSE(ProjMgrUtils::ContainsIncompatiblePack(loadedPacks, "ARM::[email protected]"));
+  EXPECT_TRUE(ProjMgrUtils::ContainsIncompatiblePack(loadedPacks, "ARM::[email protected]"));
+  EXPECT_FALSE(ProjMgrUtils::ContainsIncompatiblePack(loadedPacks, "Unknown::[email protected]"));
+}