[projmgr] Collect and report packs-unused for each selected context

Author: spcaipers-arm

tools/projmgr/include/ProjMgrWorker.h

@@ -296,6 +296,7 @@ struct ContextItem {
   std::vector<PackageItem> packRequirements;
   std::map<std::string, std::pair<std::string, std::string>> pdscFiles;
   std::vector<PackInfo> missingPacks;
+  StrVec unusedPacks;
   std::vector<std::pair<ComponentItem, std::string>> componentRequirements;
   std::string compiler;
   ToolchainItem toolchain;
@@ -724,6 +725,11 @@ class ProjMgrWorker {
   */
   bool CheckMissingFiles();
 
+  /**
+   * @brief collect unused packs for each selected context
+  */
+  void CollectUnusedPacks();
+
 protected:
   ProjMgrParser* m_parser = nullptr;
   ProjMgrKernel* m_kernel = nullptr;

tools/projmgr/include/ProjMgrYamlParser.h

@@ -139,6 +139,7 @@ static constexpr const char* YAML_OUTPUT_TMPDIR = "tmpdir";
 static constexpr const char* YAML_PACK = "pack";
 static constexpr const char* YAML_PACKS = "packs";
 static constexpr const char* YAML_PACKS_MISSING = "packs-missing";
+static constexpr const char* YAML_PACKS_UNUSED = "packs-unused";
 static constexpr const char* YAML_PATH = "path";
 static constexpr const char* YAML_PROCESSOR = "processor";
 static constexpr const char* YAML_PROJECT = "project";

tools/projmgr/schemas/common.schema.json

@@ -957,7 +957,8 @@
           }
         },
         "errors": { "type": "boolean", "description": "Indicates error(s) during conversion" },
-        "packs-missing": { "$ref": "#/definitions/BuildPacksMissingType" },
+        "packs-missing": { "$ref": "#/definitions/BuildPacksInfoType", "description": "Names of the missing packs" },
+        "packs-unused": { "$ref": "#/definitions/BuildPacksInfoType", "description": "Names of the unused packs" },
         "clayers": { "$ref": "#/definitions/BuildLayersType" },
         "rebuild": { "type": "boolean", "description": "Flag indicating intermediate files need to be cleaned before the next build" },
         "messages": { "$ref": "#/definitions/MessagesType" }
@@ -1090,13 +1091,13 @@
       },
       "additionalProperties": false
     },
-    "BuildPacksMissingType": {
+    "BuildPacksInfoType": {
       "type": "array",
       "uniqueItems": true,
       "minItems": 1,
-      "items": { "$ref": "#/definitions/BuildPackMissingType", "description": "Names of the missing packs" }
+      "items": { "$ref": "#/definitions/BuildPackInfoType" }
     },
-    "BuildPackMissingType": {
+    "BuildPackInfoType": {
       "type": "object",
       "properties": {
         "pack": { "type": "string", "description": "Name of the missing pack" }

tools/projmgr/src/ProjMgr.cpp

@@ -612,6 +612,9 @@ bool ProjMgr::Configure() {
     error = true;
   }
 
+  // Collect unused packs
+  m_worker.CollectUnusedPacks();
+
   // Print warnings for missing filters
   m_worker.PrintMissingFilters();
   if (m_verbose) {

tools/projmgr/src/ProjMgrWorker.cpp

@@ -5156,3 +5156,18 @@ bool ProjMgrWorker::CheckMissingFiles() {
   }
   return !error;
 }
+
+void ProjMgrWorker::CollectUnusedPacks() {
+  for (const auto& contextName : m_selectedContexts) {
+    auto& context = m_contexts[contextName];
+    if (context.packRequirements.empty()) {
+      continue;
+    }
+    context.unusedPacks.clear();
+    for (const auto& [packId, _] : context.rteFilteredModel->GetPackages()) {
+      if (context.packages.find(packId) == context.packages.end()) {
+        CollectionUtils::PushBackUniquely(context.unusedPacks, packId);
+      }
+    }
+  }
+}

tools/projmgr/src/ProjMgrYamlEmitter.cpp

@@ -359,6 +359,12 @@ ProjMgrYamlCbuildIdx::ProjMgrYamlCbuildIdx(YAML::Node node,
         SetNodeValue(packNode[YAML_PACK], pack);
         cbuildNode[YAML_PACKS_MISSING].push_back(packNode);
       }
+
+      for (const auto& pack : context->unusedPacks) {
+        YAML::Node packNode;
+        SetNodeValue(packNode[YAML_PACK], pack);
+        cbuildNode[YAML_PACKS_UNUSED].push_back(packNode);
+      }
       node[YAML_CBUILDS].push_back(cbuildNode);
     }
   }

tools/projmgr/test/data/TestAccessSequences/pack-access-sequences.csolution.yml

@@ -7,7 +7,7 @@ solution:
       add-path:
         - $Dpack$
         - $Bpack$
-        - $Pack(ARM::RteTest)$
+        - $Pack(ARM::RteTestBoard)$
       add-path-asm:
         - $Pack(ARM::NotLoaded)$
         - $Pack(Wrong.Format)$ 
@@ -18,7 +18,6 @@ solution:
   packs:
     - pack: ARM::[email protected]
     - pack: ARM::RteTestBoard
-    - pack: ARM::RteTest
 
   executes:
     - execute: fcarm

tools/projmgr/test/data/TestAccessSequences/ref/pack-access-sequences+CM4-Board.cbuild.yml

@@ -25,7 +25,6 @@ build:
   add-path:
     - ${CMSIS_PACK_ROOT}/ARM/RteTest_DFP/0.1.1
     - ${CMSIS_PACK_ROOT}/ARM/RteTestBoard/0.1.0
-    - ${CMSIS_PACK_ROOT}/ARM/RteTest/0.1.0
     - ../data/TestAccessSequences/RTE/_CM4-Board
     - ${CMSIS_PACK_ROOT}/ARM/RteTest_DFP/0.1.1/Device/ARM/ARMCM4/Include
   add-path-asm:

tools/projmgr/test/data/TestSolution/PacksUnused/packs.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
+    - type: Board
+      board: RteTest CM4 board
+
+  compiler: AC6
+
+  packs:
+    - pack: ARM::RteTestGenerator
+    - pack: ARM::RteTest_DFP
+    - pack: ARM::RteTestBoard
+
+  projects:
+    - project: ./project.cproject.yml

tools/projmgr/test/data/TestSolution/PacksUnused/project.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: RteTest:[email protected]