From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182]) by mx.groups.io with SMTP id smtpd.web08.5049.1648850351552106771 for ; Fri, 01 Apr 2022 14:59:11 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@linux.microsoft.com header.s=default header.b=Zs1Ct3R/; spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: mikuback@linux.microsoft.com) Received: from localhost.localdomain (unknown [47.202.59.224]) by linux.microsoft.com (Postfix) with ESMTPSA id 3046820DEEC8; Fri, 1 Apr 2022 14:59:10 -0700 (PDT) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 3046820DEEC8 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1648850351; bh=ncdYHtNxNwuuNe72B4x0igmv0/nXh9frUh0lFoybqKk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Zs1Ct3R/AaLrZtNiUyn2W9bnfaE40O8JOPS+YohBVANdOHWWjzNlVOaY67GIjPzdr A7vbAF9mVvGoYXaHOtTBP5kOxQ1s7ZfnFhUH0nHyyx2GMDGF+wLNuvG/J9QnOT9Mf0 rPgxP8Cn9cBlPB5EaAP/rmSuU3hJXm8RLVJUuaFs= From: "Michael Kubacki" To: devel@edk2.groups.io Cc: Michael D Kinney , Liming Gao , Sean Brogan , Bret Barkelew , Jiewen Yao Subject: [PATCH v3 2/4] .pytool/Plugin/UncrustifyCheck: Add ignore file support Date: Fri, 1 Apr 2022 17:58:30 -0400 Message-Id: <20220401215832.2523-3-mikuback@linux.microsoft.com> X-Mailer: git-send-email 2.28.0.windows.1 In-Reply-To: <20220401215832.2523-1-mikuback@linux.microsoft.com> References: <20220401215832.2523-1-mikuback@linux.microsoft.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Michael Kubacki REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3D3880 Currently UncrustifyCheck.py provides the following exclusion options: 1. Override the type of files UncrustifyCheck operates against by default (.c and .h files). Using the "IgnoreStandardPaths" configuration option. 2. By default, UncrustifyCheck skips files in git submodules and ignored by git (the "SkipGitExclusions" configuration option can override this behavior). The goal of UncrustifyCheck is to provide consistent formatting across the codebase. In some rare circumstances, maintainers might need to exclude a specific file (or file pattern) within their package. For example, a small set of auto-generated files from another repository. This change adds a new configuration option that can be specified in a package CI YAML file to describe a list of files within the package that should be ignored by UncrustifyCheck. The configuration option is called "IgnoreFiles" and it uses similar syntax to git ignore to ignore a list of files. Cc: Michael D Kinney Cc: Liming Gao Cc: Sean Brogan Cc: Bret Barkelew Signed-off-by: Michael Kubacki Reviewed-by: Jiewen Yao Reviewed-by: Sean Brogan --- .pytool/Plugin/UncrustifyCheck/Readme.md | 7 +++++ .pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py | 33 +++++++++++++++++= +++ 2 files changed, 40 insertions(+) diff --git a/.pytool/Plugin/UncrustifyCheck/Readme.md b/.pytool/Plugin/Un= crustifyCheck/Readme.md index 0c46fd241a7a..efe7a573e4fa 100644 --- a/.pytool/Plugin/UncrustifyCheck/Readme.md +++ b/.pytool/Plugin/UncrustifyCheck/Readme.md @@ -41,6 +41,7 @@ The plugin can be configured with a few optional config= uration options. "AdditionalIncludePaths": [], # Additional paths to check formatti= ng (wildcards supported). "AuditOnly": False, # Don't fail the build if there are = errors. Just log them. "ConfigFilePath": "", # Custom path to an Uncrustify confi= g file. + "IgnoreFiles": [], # A list of file patterns to ignore. "IgnoreStandardPaths": [], # Standard Plugin defined paths that= should be ignored. "OutputFileDiffs": True, # Output chunks of formatting diffs = in the test case log. # This can significantly slow down t= he plugin on very large packages. @@ -67,6 +68,12 @@ the test as skipped. This allows visibility into the f= ailures without breaking t =20 When specified in the config file, this is a package relative path to th= e Uncrustify configuration file. =20 +### `IgnoreFiles` + +This option supports .gitignore file and folder matching strings includi= ng wildcards. + +The files specified by this configuration option will not be processed b= y Uncrustify. + ### `IgnoreStandardPaths` =20 This plugin by default will check the below standard paths. A package co= nfiguration file can specify any of these paths diff --git a/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py b/.pytool/= Plugin/UncrustifyCheck/UncrustifyCheck.py index 6920580646de..f0455afeec24 100644 --- a/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py +++ b/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py @@ -13,11 +13,13 @@ import os import pathlib import shutil import timeit +from collections.abc import Callable from edk2toolext.environment import version_aggregator from edk2toolext.environment.plugin_manager import PluginManager from edk2toolext.environment.plugintypes.ci_build_plugin import ICiBuild= Plugin from edk2toolext.environment.plugintypes.uefi_helper_plugin import Helpe= rFunctions from edk2toolext.environment.var_dict import VarDict +from edk2toollib.gitignore_parser import parse_gitignore_lines from edk2toollib.log.junit_report_format import JunitReportTestCase from edk2toollib.uefi.edk2.path_utilities import Edk2Path from edk2toollib.utility_functions import RunCmd @@ -273,6 +275,24 @@ class UncrustifyCheck(ICiBuildPlugin): f"-c {self._app_config_file} -F {self._app_input_file_path} = --if-changed --suffix {UncrustifyCheck.FORMATTED_FILE_EXTENSION}", outstr= eam=3Doutput) self._app_output =3D output.getvalue().strip().splitlines() =20 + def _get_files_ignored_in_config(self) -> Callable[[str], bool]: + """" + Returns a function that returns true if a given file string path= is ignored in the plugin configuration file and false otherwise. + """ + ignored_files =3D [] + if "IgnoreFiles" in self._package_config: + ignored_files =3D self._package_config["IgnoreFiles"] + + # Pass "Package configuration file" as the source file path sinc= e + # the actual configuration file name is unknown to this plugin a= nd + # this provides a generic description of the file that provided + # the ignore file content. + # + # This information is only used for reporting (not used here) an= d + # the ignore lines are being passed directly as they are given t= o + # this plugin. + return parse_gitignore_lines(ignored_files, "Package configurati= on file", self._abs_workspace_path) + def _get_git_ignored_paths(self) -> List[str]: """" Returns a list of file absolute path strings to all files ignore= d in this git repository. @@ -465,6 +485,19 @@ class UncrustifyCheck(ICiBuildPlugin): self._abs_file_paths_to_format.extend( [str(path.resolve()) for path in pathlib.Path(self._abs_= package_path).rglob(path)]) =20 + # Remove files ignore in the plugin configuration file + plugin_ignored_files =3D list(filter(self._get_files_ignored_in_= config(), self._abs_file_paths_to_format)) + + if plugin_ignored_files: + logging.info( + f"{self._package_name} file count before plugin ignore f= ile exclusion: {len(self._abs_file_paths_to_format)}") + for path in plugin_ignored_files: + if path in self._abs_file_paths_to_format: + logging.info(f" File ignored in plugin config file:= {path}") + self._abs_file_paths_to_format.remove(path) + logging.info( + f"{self._package_name} file count after plugin ignore fi= le exclusion: {len(self._abs_file_paths_to_format)}") + if not "SkipGitExclusions" in self._package_config or not self._= package_config["SkipGitExclusions"]: # Remove files ignored by git logging.info( --=20 2.28.0.windows.1