.pytool/SpellCheck: Fix silent cspell run error

In the implementation of the SpellCheck prior to this commit, the logic
assumed that if it was able to successfully call `cspell --version` to
get the version, then any future usage of cspell would work without
error. PR #11783 brought to light an issue in this logic where if the
node version was too out of date, `cspell` could successfully run
`cspell --version` but would hit a runtime error when actually
performing a spell check on a package. This ultimetly resulted in
cspell not running for any package but still reporting a "Success".

This commit updates the error handling logic in the SpellCheck when
running cspell to ensure that when cspell error lines were reported, at
least one misspelled word must be found. In the scenario where error
lines are reported, but no misspelled words were found, we now assume a
runtime error occurred in cspell, log it, and fail the plugin.

Signed-off-by: Joey Vagedes <[email protected]>

Author: Javagedes

.pytool/Plugin/SpellCheck/SpellCheck.py

@@ -163,12 +163,14 @@ def RunBuildPlugin(self, packagename, Edk2pathObj, pkgconfig, environment, PLM,
         # result is a list of strings like this
         #  C:\src\sp-edk2\edk2\FmpDevicePkg\FmpDevicePkg.dec:53:9 - Unknown word (Capule)
         EasyFix = []
+        MisspelledWordFound = False
         results = self._check_spelling(cpsell_paths, config_file_path)
         for r in results:
             path, _, word = r.partition(" - Unknown word ")
             if len(word) == 0:
                 # didn't find pattern
                 continue
+            MisspelledWordFound = True
 
             pathinfo = path.rsplit(":", 2)  # remove the line no info
             if(ignore(pathinfo[0])):  # check against ignore list
@@ -179,6 +181,14 @@ def RunBuildPlugin(self, packagename, Edk2pathObj, pkgconfig, environment, PLM,
             EasyFix.append(word.strip().strip("()"))
             Errors.append(r)
 
+        # _check_spelling reported errors lines, but none of them were misspelled words
+        # This indicates a different kind of error occured, e.g. an error in running cspell
+        if len(results) > 0 and not MisspelledWordFound:
+            tc.LogStdError("Error running cspell. See output below:")
+            tc.LogStdError("\n".join(results))
+            tc.SetFailed(f"SpellCheck for {packagename} Failed to run cspell.", "CHECK_FAILED")
+            return -1
+
         # Log all errors tc StdError
         for l in Errors:
             tc.LogStdError(l.strip())