Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve log messages for DependencyCheck, UncrustifyCheck, and SpellCheck (#115) #215

Merged
merged 1 commit into from
Dec 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .pytool/Plugin/DependencyCheck/DependencyCheck.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ def RunBuildPlugin(self, packagename, Edk2pathObj, pkgconfig, environment, PLM,
if mod_specific_key in pkgconfig and p in pkgconfig[mod_specific_key]:
continue

logging.error("Dependency Check: Invalid Dependency INF: {0} depends on pkg {1}".format(file, p))
tc.LogStdError("Dependency Check: Invalid Dependency INF: {0} depends on pkg {1}".format(file, p))
logging.error(f"Dependency Check: {file} depends on pkg {p} but pkg is not listed in AcceptableDependencies")
tc.LogStdError(f"Dependency Check: {file} depends on pkg {p} but pkg is not listed in AcceptableDependencies")
overall_status += 1

# If XML object exists, add results
Expand Down
3 changes: 2 additions & 1 deletion .pytool/Plugin/SpellCheck/SpellCheck.py
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,14 @@ def RunBuildPlugin(self, packagename, Edk2pathObj, pkgconfig, environment, PLM,
# Helper - Log the syntax needed to add these words to dictionary
if len(EasyFix) > 0:
EasyFix = sorted(set(a.lower() for a in EasyFix))
logging.error(f'SpellCheck found {len(EasyFix)} failing words. See CI log for details.')
tc.LogStdOut("\n Easy fix:")
OneString = "If these are not errors add this to your ci.yaml file.\n"
OneString += '"SpellCheck": {\n "ExtendWords": ['
for a in EasyFix:
tc.LogStdOut(f'\n"{a}",')
OneString += f'\n "{a}",'
logging.info(OneString.rstrip(",") + '\n ]\n}')
logging.critical(OneString.rstrip(",") + '\n ]\n}')

# add result to test case
overall_status = len(Errors)
Expand Down
17 changes: 8 additions & 9 deletions .pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
Original file line number Diff line number Diff line change
Expand Up @@ -572,26 +572,27 @@ def _process_uncrustify_results(self) -> None:
self._formatted_file_error_count = len(formatted_files)

if self._formatted_file_error_count > 0:
logging.error(
logging.warning(f'Uncrustify found {self._formatted_file_error_count} files with formatting errors')
self._tc.LogStdError(f"Uncrustify found {self._formatted_file_error_count} files with formatting errors:\n")
logging.critical(
"Visit the following instructions to learn "
"how to find the detailed formatting errors in Azure "
"DevOps CI: "
"https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-Formatting#how-to-find-uncrustify-formatting-errors-in-continuous-integration-ci")
self._tc.LogStdError("Files with formatting errors:\n")


if self._output_file_diffs:
logging.info("Calculating file diffs. This might take a while...")

for formatted_file in formatted_files:
pre_formatted_file = formatted_file[:-
len(UncrustifyCheck.FORMATTED_FILE_EXTENSION)]
logging.error(pre_formatted_file)
pre_formatted_file = formatted_file[:-len(UncrustifyCheck.FORMATTED_FILE_EXTENSION)]

self._tc.LogStdError(f"Formatting errors in {os.path.relpath(pre_formatted_file, self._abs_package_path)}\n")
logging.info(f"Formatting errors in {os.path.relpath(pre_formatted_file, self._abs_package_path)}")

if (self._output_file_diffs or
self._file_template_contents is not None or
self._func_template_contents is not None):
self._tc.LogStdError(
f"Formatting errors in {os.path.relpath(pre_formatted_file, self._abs_package_path)}\n")

with open(formatted_file) as ff:
formatted_file_text = ff.read()
Expand All @@ -612,8 +613,6 @@ def _process_uncrustify_results(self) -> None:
self._tc.LogStdError(line)

self._tc.LogStdError('\n')
else:
self._tc.LogStdError(pre_formatted_file)

def _remove_tree(self, dir_path: str, ignore_errors: bool = False) -> None:
"""
Expand Down