BaseTools/Plugin: Add HostBasedUnitTestRunner plugin

https://bugzilla.tianocore.org/show_bug.cgi?id=2505

Add plugin to BaseTools to run host based unit tests.

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Bret Barkelew <Bret.Barkelew@microsoft.com>
Acked-by: Bob Feng <bob.c.feng@intel.com>

BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner.py

@@ -0,0 +1,115 @@
+# @file HostBasedUnitTestRunner.py
+# Plugin to located any host-based unit tests in the output directory and execute them.
+##
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+import os
+import logging
+import glob
+import xml.etree.ElementTree
+from edk2toolext.environment.plugintypes.uefi_build_plugin import IUefiBuildPlugin
+from edk2toolext import edk2_logging
+import edk2toollib.windows.locate_tools as locate_tools
+from edk2toolext.environment import shell_environment
+from edk2toollib.utility_functions import RunCmd
+
+
+class HostBasedUnitTestRunner(IUefiBuildPlugin):
+
+    def do_pre_build(self, thebuilder):
+        '''
+        Works with the compiler (either the HostBasedCompilerPlugin or an other Builder) to set
+        up the environment that will be needed to build host-based unit tests.
+
+        EXPECTS:
+        - Build Var 'CI_BUILD_TYPE' - If not set to 'host_unit_test', will not do anything.
+
+        UPDATES:
+        - Shell Var (Several) - Updates the shell with all vars listed in interesting_keys.
+        - Shell Path - Updated from QueryVcVariables()
+        - Shell Var 'CMOCKA_MESSAGE_OUTPUT'
+        '''
+        ci_type = thebuilder.env.GetValue('CI_BUILD_TYPE')
+        if ci_type != 'host_unit_test':
+            return 0
+
+        shell_env = shell_environment.GetEnvironment()
+        # Use the tools lib to determine the correct values for the vars that interest us.
+        interesting_keys = ["ExtensionSdkDir", "INCLUDE", "LIB", "LIBPATH", "UniversalCRTSdkDir",
+                            "UCRTVersion", "WindowsLibPath", "WindowsSdkBinPath", "WindowsSdkDir", "WindowsSdkVerBinPath",
+                            "WindowsSDKVersion", "VCToolsInstallDir"]
+        vs_vars = locate_tools.QueryVcVariables(interesting_keys, "amd64")
+        for (k, v) in vs_vars.items():
+            if k.upper() == "PATH":
+                shell_env.append_path(v)
+            else:
+                shell_env.set_shell_var(k, v)
+
+        # Set up the reporting type for Cmocka.
+        shell_env.set_shell_var('CMOCKA_MESSAGE_OUTPUT', 'xml')
+        return 0
+
+    def do_post_build(self, thebuilder):
+        '''
+        After a build, will automatically locate and run all host-based unit tests. Logs any
+        failures with Warning severity and will return a count of the failures as the return code.
+
+        EXPECTS:
+        - Build Var 'CI_BUILD_TYPE' - If not set to 'host_unit_test', will not do anything.
+
+        UPDATES:
+        - Shell Var 'CMOCKA_XML_FILE'
+        '''
+        ci_type = thebuilder.env.GetValue('CI_BUILD_TYPE')
+        if ci_type != 'host_unit_test':
+            return 0
+
+        shell_env = shell_environment.GetEnvironment()
+        logging.log(edk2_logging.get_section_level(),
+                    "Run Host based Unit Tests")
+        path = thebuilder.env.GetValue("BUILD_OUTPUT_BASE")
+
+        failure_count = 0
+
+        for arch in thebuilder.env.GetValue("TARGET_ARCH").split():
+            logging.log(edk2_logging.get_subsection_level(),
+                        "Testing for architecture: " + arch)
+            cp = os.path.join(path, arch)
+
+            # If any old results XML files exist, clean them up.
+            for old_result in glob.iglob(os.path.join(cp, "*.result.xml")):
+                os.remove(old_result)
+
+            # Determine whether any tests exist.
+            testList = glob.glob(os.path.join(cp, "*Test*.exe"))
+            for test in testList:
+                # Configure output name.
+                shell_env.set_shell_var(
+                    'CMOCKA_XML_FILE', test + ".%g." + arch + ".result.xml")
+
+                # Run the test.
+                ret = RunCmd('"' + test + '"', "", workingdir=cp)
+                if(ret != 0):
+                    logging.error("UnitTest Execution Error: " +
+                                  os.path.basename(test))
+                else:
+                    logging.info("UnitTest Completed: " +
+                                 os.path.basename(test))
+                    file_match_pattern = test + ".*." + arch + ".result.xml"
+                    xml_results_list = glob.glob(file_match_pattern)
+                    for xml_result_file in xml_results_list:
+                        root = xml.etree.ElementTree.parse(
+                            xml_result_file).getroot()
+                        for suite in root:
+                            for case in suite:
+                                for result in case:
+                                    if result.tag == 'failure':
+                                        logging.warning(
+                                            "%s Test Failed" % os.path.basename(test))
+                                        logging.warning(
+                                            "  %s - %s" % (case.attrib['name'], result.text))
+                                        failure_count += 1
+
+        return failure_count

BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner_plug_in.yaml

@@ -0,0 +1,12 @@
+##
+# IUefiBuildPlugin used to run any unittests that
+# were built on this build.
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+{
+  "scope": "host-test-win",
+  "name": "Windows Host-Based Unit Test Runner",
+  "module": "HostBasedUnitTestRunner"
+}