[packchk] Validate overview attribute of <description> element is a reference to a markdown file contained in the pack that exists #1682 (#1134) (#1962)

* [packchk] Validate overview attribute of <description> element is a
reference to a markdown file contained in the pack that exists #1682

* Test MD file (from middleware) has errors, so shrinked.

* foxed md file

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

Author: 3 people

tools/packchk/src/CheckFiles.cpp

@@ -148,6 +148,12 @@ bool CheckFiles::GetFileName(RteItem* item, std::string& filename, FileType& fil
     filename = item->GetText();
     return true;
   }
+  else if(tag == "description") {
+    filename = item->GetAttribute("overview");
+    if(filename.length()) {
+      return true;
+    }
+  }
 
   return false;
 }

tools/packchk/src/PackChk_Msgs.cpp

@@ -152,7 +152,7 @@ const MsgTable PackChk::msgTable = {
                                                 "  No condition id set to specify a rule filtering for a device or set of devices." } },
   { "M336", { MsgLevel::LEVEL_WARNING,  CRLF_B, "Component 'Cclass=%CCLASS%, Cgroup=%CGROUP%, Cversion=%CVER%, condition=%COND%' is member of the Cclass='%CCLASS%' which shall contain device specific components.\n"\
                                                 "  The referenced condition id does not contain a rule filtering for a device or set of devices." } },  // No reference to a device or device not found
-  { "M337", { MsgLevel::LEVEL_WARNING,  CRLF_B, "File with category '%CAT%' has wrong extension '%EXT%': '%PATH%'" } },
+  { "M337", { MsgLevel::LEVEL_WARNING,  CRLF_B, "File with category '%CAT%' has wrong extension '%EXT%': '%PATH%'%MSG%" } },
   { "M338", { MsgLevel::LEVEL_WARNING,  CRLF_B, "No releases found!" } },
   { "M339", { MsgLevel::LEVEL_WARNING,  CRLF_B, "Include Path '%PATH%' must not be a file!" } },
   { "M340", { MsgLevel::LEVEL_WARNING,  CRLF_B, "Include Path '%PATH%' must end with '/'" } },

tools/packchk/src/ValidateSyntax.cpp

@@ -239,6 +239,19 @@ bool ValidateSyntax::CheckInfo(RtePackage* pKg)
     bInfoComplete = false;
   }
 
+  // Check for <description overview="MyPack.md" ...
+  const auto packDescription = pKg->GetFirstChild("description");
+  if(packDescription) {
+    const auto overview = packDescription->GetAttribute("overview"); 
+    if(!overview.empty()) {
+      const auto ext = RteUtils::ExtractFileExtension(overview);
+      if(ext != "md") {
+        LogMsg("M337", VAL("CAT", "overview"), EXT(ext), PATH(overview), MSG(", should be .md"));
+      }
+    }
+  }
+
+
   string pdscRef = pKg->GetAttribute("vendor") + "." + pKg->GetName();
   const string& pdscPkg = RteUtils::ExtractFileBaseName(fileName);
 

tools/packchk/test/data/DescriptionOverview/Documentation/README.md

@@ -0,0 +1,9 @@
+# MDK-Middleware
+
+The MDK-Middleware software pack.
+
+The MDK-Middleware can be used by any user application.
+
+## Availability
+
+The MDK-Middleware is available free-of-charge.

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

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

tools/packchk/test/data/DescriptionOverview/Files/test1.c

@@ -0,0 +1 @@
+// tests1.c

tools/packchk/test/data/DescriptionOverview/TestVendor.DescriptionOverviewPack.pdsc

@@ -0,0 +1,35 @@
+<?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>http://www.testurl.com/pack/</url>
+  <name>DescriptionOverviewPack</name>
+  <description overview="./Documentation/README.md">Keil MDK Middleware: File System, Network IPv4/IPv6, USB Device/Host</description>
+
+  <releases>
+    <release version="0.0.1" date="2021-09-06">>
+      Initial release of DescriptionOverview.
+    </release>
+  </releases>
+
+  <keywords>
+    <keyword>DescriptionOverview</keyword>
+  </keywords>
+
+  <conditions>
+    <condition id="Test_Condition">
+      <description>Test Device</description>
+      <require Dvendor="ARM:82"/>
+    </condition>
+  </conditions>
+
+  <components>
+    <component Cclass="TestClass" Cgroup="TestGlobal" Cversion="1.0.0" condition="Test_Condition">
+      <description>TestGlobal</description>
+      <files>
+        <file category="TestGlobal" name="Files/header1.h"/>
+      </files>
+    </component>
+  </components>
+
+</package>

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

@@ -753,7 +753,37 @@ TEST_F(PackChkIntegTests, CheckDuplicateFlashAlgo) {
   }
 }
 
-// Validate invalid file path (file is directory)
+
+// Validate file is .md
+TEST_F(PackChkIntegTests, CheckDescriptionOverviewMd) {
+  const char* argv[3];
+
+  const string& pdscFile = PackChkIntegTestEnv::localtestdata_dir +
+    "/DescriptionOverview/TestVendor.DescriptionOverviewPack.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 M337_foundCnt = 0;
+  for (const string& msg : errMsgs) {
+    size_t s;
+    if ((s = msg.find("M337")) != string::npos) {
+      M337_foundCnt++;
+    }
+  }
+
+  if (M337_foundCnt) {
+    FAIL() << "error: message M337 found";
+  }
+}
+
+// Validate config file vs. include path
 TEST_F(PackChkIntegTests, CheckConfigFileInIncludePath) {
   const char* argv[3];
 
@@ -782,7 +812,6 @@ TEST_F(PackChkIntegTests, CheckConfigFileInIncludePath) {
   }
 }
 
-
 // Test schema validation
 TEST_F(PackChkIntegTests, CheckSchemaValidation) {
   const char* argv[3];