[packchk] Report warning when deprecated attribute attr="copy" is used in <file> element #1371 (#1143) (#1967)

* [packchk] Report warning when deprecated attribute attr="copy" is used
in <file> element #1371

Co-authored-by: Thorsten de Buhr <[email protected]>

Author: spcaipers-arm

tools/packchk/include/CheckFiles.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2025 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -31,6 +31,7 @@ class CheckFiles {
   const std::string& GetPackagePath() const;
   bool CheckFile(RteItem* item);
   bool CheckUrls(RteItem* item);
+  bool CheckDeprecated(RteItem* item);
   bool CheckDescription(RteItem* item);
   bool CheckFileExists(const std::string& fileName, int lineNo, bool associated = false);
   bool CheckCaseSense(const std::string& fileName, int lineNo);

tools/packchk/src/CheckFiles.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2025 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -41,6 +41,7 @@ VISIT_RESULT CheckFilesVisitor::Visit(RteItem* item)
 {
   m_checkFiles.CheckFile(item);
   m_checkFiles.CheckUrls(item);
+  m_checkFiles.CheckDeprecated(item);
   m_checkFiles.CheckDescription(item);
 
   return VISIT_RESULT::CONTINUE_VISIT;
@@ -172,6 +173,31 @@ bool CheckFiles::ToUpper(string& text)
   return true;
 }
 
+/**
+ * @brief check deprecated aspects of an RTE item
+ * @param item RteItem item to check
+ * @return passed / failed
+*/
+bool CheckFiles::CheckDeprecated(RteItem* item)
+{
+  if(!item || item->GetTag() == "package") {
+    return true;
+  }
+
+  bool bOk = true;
+  const auto lineNo = item->GetLineNumber();
+
+  const auto& tag = item->GetTag();
+  if(tag == "file") {
+    if(item->GetAttribute("attr") == "copy") {
+      LogMsg("M600", VAL("ATTR", "copy"), TAG(tag), lineNo);
+      bOk = false;
+    }
+  }
+
+  return bOk;
+}
+
 /**
  * @brief check aspects of an RTE url item
  * @param item RteItem item to check

tools/packchk/src/PackChk_Msgs.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2025 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -230,6 +230,20 @@ const MsgTable PackChk::msgTable = {
 
   { "M510", { MsgLevel::LEVEL_WARNING,  CRLF_B, "Xerxes reports: %MSG%" } },
   { "M511", { MsgLevel::LEVEL_ERROR,    CRLF_B, "Xerxes reports: %MSG%" } },
+
+  // 600... further PackCHk Errors
+  { "M600", { MsgLevel::LEVEL_WARNING,  CRLF_B, "Attribute '%ATTR%' on '%TAG%' is deprecated." } },
+  { "M601", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M602", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M603", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M604", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M605", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M606", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M607", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M608", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M609", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+  { "M610", { MsgLevel::LEVEL_WARNING,  CRLF_B, "" } },
+
 };
 
 const MsgTableStrict PackChk::msgStrictTable = {

tools/packchk/test/data/FileAttributeDeprecated/Files/header1.h

@@ -0,0 +1 @@
+//header 1

tools/packchk/test/data/FileAttributeDeprecated/TestVendor.FileAttributeDeprecated.pdsc

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<package schemaVersion="1.4" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="PACK.xsd">
+  <vendor>TestVendor</vendor>
+  <url>https://www.testurl.com/pack/</url>
+  <name>FileAttributeDeprecated</name>
+  <description>Test for deprecated file attributes</description>
+
+  <releases>
+    <release version="0.0.1" date="2025-02-17">>
+      Initial release of FileAttributeDeprecated.
+    </release>
+  </releases>
+
+  <keywords>
+    <keyword>FileAttributeDeprecated</keyword>
+  </keywords>
+
+  <conditions>
+    <condition id="TestDevices">
+      <description>Test devices</description>
+      <require Dvendor="ARM:82" Dname="Test*"/>
+    </condition>
+    <condition id="Test ARMCC">
+      <description>filter for the Device and the ARM compiler</description>
+      <require condition="TestDevices"/>
+      <require Tcompiler="ARMCC"/>
+    </condition>
+  </conditions>
+
+  <components>
+    <component Cclass="Device" Cgroup="Startup" Cversion="1.0.0" condition="TestDevices">
+      <description>Test device series</description>
+      <files>
+        <file category="source"  name="Files/header1.h" attr="copy" version="1.0.0" condition="Test ARMCC"/>
+      </files>
+    </component>
+  </components>
+
+</package>

tools/packchk/test/integtests/src/PackChkIntegTests.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2021 Arm Limited. All rights reserved.
+ * Copyright (c) 2020-2025 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -996,6 +996,33 @@ TEST_F(PackChkIntegTests, CheckSupportCcFiles) {
   }
 }
 
+TEST_F(PackChkIntegTests, CheckFileAttributeDeprecated) {
+  const char* argv[3];
+
+  string pdscFile = PackChkIntegTestEnv::localtestdata_dir +
+    "/FileAttributeDeprecated/TestVendor.FileAttributeDeprecated.pdsc";
+  ASSERT_TRUE(RteFsUtils::Exists(pdscFile));
+
+  argv[0] = (char*)"";
+  argv[1] = (char*)pdscFile.c_str();
+  argv[2] = (char*)"--disable-validation";
+
+  PackChk packChk;
+  EXPECT_EQ(0, packChk.Check(3, argv, nullptr));
+
+  auto errMsgs = ErrLog::Get()->GetLogMessages();
+  int M600_foundCnt = 0;
+  for (const string& msg : errMsgs) {
+    if (msg.find("M600", 0) != string::npos) {
+      M600_foundCnt++;
+    }
+  }
+
+  if(!M600_foundCnt) {
+    FAIL() << "error: Missing message M600: deprecated attributes";
+  }
+}
+
 TEST_F(PackChkIntegTests, CheckConditionComponentDependency_Pos) {
   const char* argv[7];