.pytool: Update to newest pytools

[mirror_edk2.git] / .pytool / Plugin / LibraryClassCheck / LibraryClassCheck.py

# @file LibraryClassCheck.py\r
#\r
# Copyright (c) Microsoft Corporation.\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
##\r
import logging\r
import os\r
from edk2toolext.environment.plugintypes.ci_build_plugin import ICiBuildPlugin\r
from edk2toollib.uefi.edk2.parsers.dec_parser import DecParser\r
from edk2toollib.uefi.edk2.parsers.inf_parser import InfParser\r
from edk2toolext.environment.var_dict import VarDict\r
\r
\r
class LibraryClassCheck(ICiBuildPlugin):\r
    """\r
    A CiBuildPlugin that scans the code tree and library classes for undeclared\r
    files\r
\r
    Configuration options:\r
    "LibraryClassCheck": {\r
        IgnoreHeaderFile: [],  # Ignore a file found on disk\r
        IgnoreLibraryClass: [] # Ignore a declaration found in dec file\r
    }\r
    """\r
\r
    def GetTestName(self, packagename: str, environment: VarDict) -> tuple:\r
        """ Provide the testcase name and classname for use in reporting\r
            testclassname: a descriptive string for the testcase can include whitespace\r
            classname: should be patterned <packagename>.<plugin>.<optionally any unique condition>\r
\r
            Args:\r
              packagename: string containing name of package to build\r
              environment: The VarDict for the test to run in\r
            Returns:\r
                a tuple containing the testcase name and the classname\r
                (testcasename, classname)\r
        """\r
        return ("Check library class declarations in " + packagename, packagename + ".LibraryClassCheck")\r
\r
    def __GetPkgDec(self, rootpath):\r
        try:\r
            allEntries = os.listdir(rootpath)\r
            for entry in allEntries:\r
                if entry.lower().endswith(".dec"):\r
                    return(os.path.join(rootpath, entry))\r
        except Exception:\r
            logging.error("Unable to find DEC for package:{0}".format(rootpath))\r
\r
        return None\r
\r
    ##\r
    # External function of plugin.  This function is used to perform the task of the MuBuild Plugin\r
    #\r
    #   - package is the edk2 path to package.  This means workspace/packagepath relative.\r
    #   - edk2path object configured with workspace and packages path\r
    #   - PkgConfig Object (dict) for the pkg\r
    #   - EnvConfig Object\r
    #   - Plugin Manager Instance\r
    #   - Plugin Helper Obj Instance\r
    #   - Junit Logger\r
    #   - output_stream the StringIO output stream from this plugin via logging\r
    def RunBuildPlugin(self, packagename, Edk2pathObj, pkgconfig, environment, PLM, PLMHelper, tc, output_stream=None):\r
        overall_status = 0\r
        LibraryClassIgnore = []\r
\r
        abs_pkg_path = Edk2pathObj.GetAbsolutePathOnThisSystemFromEdk2RelativePath(packagename)\r
        abs_dec_path = self.__GetPkgDec(abs_pkg_path)\r
        wsr_dec_path = Edk2pathObj.GetEdk2RelativePathFromAbsolutePath(abs_dec_path)\r
\r
        if abs_dec_path is None or wsr_dec_path == "" or not os.path.isfile(abs_dec_path):\r
            tc.SetSkipped()\r
            tc.LogStdError("No DEC file {0} in package {1}".format(abs_dec_path, abs_pkg_path))\r
            return -1\r
\r
        # Get all include folders\r
        dec = DecParser()\r
        dec.SetBaseAbsPath(Edk2pathObj.WorkspacePath).SetPackagePaths(Edk2pathObj.PackagePathList)\r
        dec.ParseFile(wsr_dec_path)\r
\r
        AllHeaderFiles = []\r
\r
        for includepath in dec.IncludePaths:\r
            ## Get all header files in the library folder\r
            AbsLibraryIncludePath = os.path.join(abs_pkg_path, includepath, "Library")\r
            if(not os.path.isdir(AbsLibraryIncludePath)):\r
                continue\r
\r
            hfiles = self.WalkDirectoryForExtension([".h"], AbsLibraryIncludePath)\r
            hfiles = [os.path.relpath(x,abs_pkg_path) for x in hfiles]  # make package root relative path\r
            hfiles = [x.replace("\\", "/") for x in hfiles]  # make package relative path\r
\r
            AllHeaderFiles.extend(hfiles)\r
\r
        if len(AllHeaderFiles) == 0:\r
            tc.SetSkipped()\r
            tc.LogStdError(f"No Library include folder in any Include path")\r
            return -1\r
\r
        # Remove ignored paths\r
        if "IgnoreHeaderFile" in pkgconfig:\r
            for a in pkgconfig["IgnoreHeaderFile"]:\r
                try:\r
                    tc.LogStdOut("Ignoring Library Header File {0}".format(a))\r
                    AllHeaderFiles.remove(a)\r
                except:\r
                    tc.LogStdError("LibraryClassCheck.IgnoreHeaderFile -> {0} not found.  Invalid Header File".format(a))\r
                    logging.info("LibraryClassCheck.IgnoreHeaderFile -> {0} not found.  Invalid Header File".format(a))\r
\r
        if "IgnoreLibraryClass" in pkgconfig:\r
            LibraryClassIgnore = pkgconfig["IgnoreLibraryClass"]\r
\r
\r
        ## Attempt to find library classes\r
        for lcd in dec.LibraryClasses:\r
            ## Check for correct file path separator\r
            if "\\" in lcd.path:\r
                tc.LogStdError("LibraryClassCheck.DecFilePathSeparator -> {0} invalid.".format(lcd.path))\r
                logging.error("LibraryClassCheck.DecFilePathSeparator -> {0} invalid.".format(lcd.path))\r
                overall_status += 1\r
                continue\r
\r
            if lcd.name in LibraryClassIgnore:\r
                tc.LogStdOut("Ignoring Library Class Name {0}".format(lcd.name))\r
                LibraryClassIgnore.remove(lcd.name)\r
                continue\r
\r
            logging.debug(f"Looking for Library Class {lcd.path}")\r
            try:\r
                AllHeaderFiles.remove(lcd.path)\r
\r
            except ValueError:\r
                tc.LogStdError(f"Library {lcd.name} with path {lcd.path} not found in package filesystem")\r
                logging.error(f"Library {lcd.name} with path {lcd.path} not found in package filesystem")\r
                overall_status += 1\r
\r
        ## any remaining AllHeaderFiles are not described in DEC\r
        for h in AllHeaderFiles:\r
            tc.LogStdError(f"Library Header File {h} not declared in package DEC {wsr_dec_path}")\r
            logging.error(f"Library Header File {h} not declared in package DEC {wsr_dec_path}")\r
            overall_status += 1\r
\r
        ## Warn about any invalid library class names in the ignore list\r
        for r in LibraryClassIgnore:\r
            tc.LogStdError("LibraryClassCheck.IgnoreLibraryClass -> {0} not found.  Library Class not found".format(r))\r
            logging.info("LibraryClassCheck.IgnoreLibraryClass -> {0} not found.  Library Class not found".format(r))\r
\r
\r
        # If XML object exists, add result\r
        if overall_status != 0:\r
            tc.SetFailed("LibraryClassCheck {0} Failed.  Errors {1}".format(wsr_dec_path, overall_status), "CHECK_FAILED")\r
        else:\r
            tc.SetSuccess()\r
        return overall_status\r