.pytool: Update to newest pytools

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

# @file CharEncodingCheck.py\r
#\r
# Copyright (c) Microsoft Corporation.\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
##\r
\r
\r
import os\r
import logging\r
from edk2toolext.environment.plugintypes.ci_build_plugin import ICiBuildPlugin\r
from edk2toolext.environment.var_dict import VarDict\r
\r
##\r
# map\r
##\r
EcodingMap = {\r
    ".md": 'utf-8',\r
    ".dsc": 'utf-8',\r
    ".dec": 'utf-8',\r
    ".c": 'utf-8',\r
    ".h": 'utf-8',\r
    ".asm": 'utf-8',\r
    ".masm": 'utf-8',\r
    ".nasm": 'utf-8',\r
    ".s": 'utf-8',\r
    ".inf": 'utf-8',\r
    ".asl": 'utf-8',\r
    ".uni": 'utf-8',\r
    ".py": 'utf-8'\r
}\r
\r
\r
class CharEncodingCheck(ICiBuildPlugin):\r
    """\r
    A CiBuildPlugin that scans each file in the code tree and confirms the encoding is correct.\r
\r
    Configuration options:\r
    "CharEncodingCheck": {\r
        "IgnoreFiles": []\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 for valid file encoding for " + packagename, packagename + ".CharEncodingCheck")\r
\r
    ##\r
    # External function of plugin.  This function is used to perform the task of the ci_build_plugin 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
        files_tested = 0\r
\r
        abs_pkg_path = Edk2pathObj.GetAbsolutePathOnThisSystemFromEdk2RelativePath(packagename)\r
\r
        if abs_pkg_path is None:\r
            tc.SetSkipped()\r
            tc.LogStdError("No Package folder {0}".format(abs_pkg_path))\r
            return 0\r
\r
        for (ext, enc) in EcodingMap.items():\r
            files = self.WalkDirectoryForExtension([ext], abs_pkg_path)\r
            files = [Edk2pathObj.GetEdk2RelativePathFromAbsolutePath(x) for x in files]  # make edk2relative path so can process ignores\r
\r
            if "IgnoreFiles" in pkgconfig:\r
                for a in pkgconfig["IgnoreFiles"]:\r
                    a = a.replace(os.sep, "/")\r
                    try:\r
                        tc.LogStdOut("Ignoring File {0}".format(a))\r
                        files.remove(a)\r
                    except:\r
                        tc.LogStdError("CharEncodingCheck.IgnoreInf -> {0} not found in filesystem.  Invalid ignore file".format(a))\r
                        logging.info("CharEncodingCheck.IgnoreInf -> {0} not found in filesystem.  Invalid ignore file".format(a))\r
\r
            files = [Edk2pathObj.GetAbsolutePathOnThisSystemFromEdk2RelativePath(x) for x in files]\r
            for a in files:\r
                files_tested += 1\r
                if(self.TestEncodingOk(a, enc)):\r
                    logging.debug("File {0} Passed Encoding Check {1}".format(a, enc))\r
                else:\r
                    tc.LogStdError("Encoding Failure in {0}.  Not {1}".format(a, enc))\r
                    overall_status += 1\r
\r
        tc.LogStdOut("Tested Encoding on {0} files".format(files_tested))\r
        if overall_status != 0:\r
            tc.SetFailed("CharEncoding {0} Failed.  Errors {1}".format(packagename, overall_status), "CHAR_ENCODING_CHECK_FAILED")\r
        else:\r
            tc.SetSuccess()\r
        return overall_status\r
\r
    def TestEncodingOk(self, apath, encodingValue):\r
        try:\r
            with open(apath, "rb") as fobj:\r
                fobj.read().decode(encodingValue)\r
        except Exception as exp:\r
            logging.error("Encoding failure: file: {0} type: {1}".format(apath, encodingValue))\r
            logging.debug("EXCEPTION: while processing {1} - {0}".format(exp, apath))\r
            return False\r
\r
        return True\r