BaseTools/Plugin: Too many execute files cause "cmd too long" failure

Windows command prompt have 8191 characters limitation,
enhance it to make command too long can be resloved.

Provide an example, if have too many cov files, it causes to run single
command over the 8191 characters limitation.
> OpenCppCoverage
>  --export_type binary:coverage.cov
>  --working_dir={workspace}Build
>  --input_coverage=AAA.cov
>  ...
>  --input_coverage=NNN.cov

The solution is passing many coverage files in single command line to
breaking it up into many command lines with one coverage file per
command line in order to prevent single line is over to 8191 characters.

- Command Line 1
> OpenCppCoverage
>  --export_type binary:coverage.cov
>  --working_dir={workspace}Build
>  --input_coverage=AAA.cov
>  --input_coverage=coverage.cov
...

- Command Line N
> OpenCppCoverage
>  --export_type. binary:coverage.cov
>  --working_dir={workspace}Build
>  --input_coverage=NNN.cov
>  --input_coverage=coverage.cov

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael Kubacki <mikuback@linux.microsoft.com>
Cc: Rebecca Cran <rebecca@bsdio.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Signed-off-by: Gua Guo <gua.guo@intel.com>
Reviewed-by: Michael Kubacki <mikuback@linux.microsoft.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>

diff --git a/BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner.py b/BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner.py
index d993de941272954a891cac417431892d8721b603..2e5c462cd2fbe514220a51dded83dab70d2afc75 100644 (file)
--- a/BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner.py
+++ b/BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner.py
@@ -205,28 +205,64 @@ class HostBasedUnitTestRunner(IUefiBuildPlugin):
         testList = glob.glob(os.path.join(buildOutputBase, "**","*Test*.exe"), recursive=True)\r
         workspace = thebuilder.env.GetValue("WORKSPACE")\r
         workspace = (workspace + os.sep) if workspace[-1] != os.sep else workspace\r
+        workspaceBuild = os.path.join(workspace, 'Build')\r
         # Generate coverage file\r
         coverageFile = ""\r
         for testFile in testList:\r
             ret = RunCmd("OpenCppCoverage", f"--source {workspace} --export_type binary:{testFile}.cov -- {testFile}")\r
-            coverageFile += " --input_coverage=" + testFile + ".cov"\r
+            if ret != 0:\r
+                logging.error("UnitTest Coverage: Failed to collect coverage data.")\r
+                return 1\r
+\r
+            coverageFile  = f" --input_coverage={testFile}.cov"\r
+            totalCoverageFile = os.path.join(buildOutputBase, 'coverage.cov')\r
+            if os.path.isfile(totalCoverageFile):\r
+                coverageFile += f" --input_coverage={totalCoverageFile}"\r
+            ret = RunCmd(\r
+                "OpenCppCoverage",\r
+                f"--export_type binary:{totalCoverageFile} " +\r
+                f"--working_dir={workspaceBuild} " +\r
+                f"{coverageFile}"\r
+                )\r
             if ret != 0:\r
                 logging.error("UnitTest Coverage: Failed to collect coverage data.")\r
                 return 1\r
 \r
         # Generate and XML file if requested.by each package\r
-        ret = RunCmd("OpenCppCoverage", f"--export_type cobertura:{os.path.join(buildOutputBase, 'coverage.xml')} --working_dir={workspace}Build {coverageFile}")\r
+        ret = RunCmd(\r
+            "OpenCppCoverage",\r
+            f"--export_type cobertura:{os.path.join(buildOutputBase, 'coverage.xml')} " +\r
+            f"--working_dir={workspaceBuild} " +\r
+            f"--input_coverage={totalCoverageFile} "\r
+            )\r
         if ret != 0:\r
             logging.error("UnitTest Coverage: Failed to generate cobertura format xml in single package.")\r
             return 1\r
 \r
         # Generate total report XML file for all package\r
-        testCoverageList = glob.glob(os.path.join(workspace, "Build", "**","*Test*.exe.cov"), recursive=True)\r
+        testCoverageList = glob.glob(os.path.join(workspace, "Build", "**", "*Test*.exe.cov"), recursive=True)\r
         coverageFile = ""\r
+        totalCoverageFile = os.path.join(workspaceBuild, 'coverage.cov')\r
         for testCoverage in testCoverageList:\r
-            coverageFile += " --input_coverage=" + testCoverage\r
+            coverageFile  = f" --input_coverage={testCoverage}"\r
+            if os.path.isfile(totalCoverageFile):\r
+                coverageFile += f" --input_coverage={totalCoverageFile}"\r
+            ret = RunCmd(\r
+                "OpenCppCoverage",\r
+                f"--export_type binary:{totalCoverageFile} " +\r
+                f"--working_dir={workspaceBuild} " +\r
+                f"{coverageFile}"\r
+                )\r
+            if ret != 0:\r
+                logging.error("UnitTest Coverage: Failed to collect coverage data.")\r
+                return 1\r
 \r
-        ret = RunCmd("OpenCppCoverage", f"--export_type cobertura:{workspace}Build/coverage.xml --working_dir={workspace}Build {coverageFile}")\r
+        ret = RunCmd(\r
+            "OpenCppCoverage",\r
+            f"--export_type cobertura:{os.path.join(workspaceBuild, 'coverage.xml')} " +\r
+            f"--working_dir={workspaceBuild} " +\r
+            f"--input_coverage={totalCoverageFile}"\r
+            )\r
         if ret != 0:\r
             logging.error("UnitTest Coverage: Failed to generate cobertura format xml.")\r
             return 1\r