From: Michael Kubacki <[email protected]>
Adds a new script and build plugin called DebugMacroCheck.
The script verifies that the number of print specifiers match the
number of arguments in DEBUG() calls.
Overview:
- Build plugin: BuildPlugin/DebugMacroCheckBuildPlugin.py
- Runs on any build target that is not NO-TARGET
- Standalone script: DebugMacroCheck.py
- Run `DebugMacroCheck.py --help` to see command line options
- Unit tests:
- Tests/test_DebugMacroCheck.py
- Can be run with:
`python -m unittest discover -s ./BaseTools/Plugin/DebugMacroCheck/tests -v`
- Also visible in VS Code Test Explorer
Note: I've disabled this in some packages due to past maintainer
preferences for CI checks. If the patch to disable the plugin
does not receive reviews, I will be forced to drop it from the
series which means the plugin will be enabled by default in those
packages.
Background:
The tool has been constantly run against edk2 derived code for about
a year now. During that time, its found over 20 issues in edk2, over
50 issues in various vendor code, and numerous other issues specific
to Project Mu.
See the following series for a batch of issues previously fixed in
edk2 discovered by the tool:
https://edk2.groups.io/g/devel/message/93104
I've received interest from vendors to place it in edk2 to
immediately find issues in the upstream and make it easier for edk2
consumers to directly acquire it. That led to this patch series.
This would run in edk2 as a build plugin. All issues in the edk2
codebase have been resolved so this would find new issues before
they are merged into the codebase.
The script is meant to be portable so it can be run as a build plugin
or dropped as a standalone script into other environments alongside
the unit tests.
Series Overview:
- Fixes outstanding issues in RedfishPkg
- Adds the `regex` PIP module to pip-requirements.txt
- Adds exceptions for debug macro usage in ArmVirtPkg,
DynamicTablesPkg, and SecurityPkg
- Disables the plugin in OvmfPkg per maintainer's previous
preferences
- Adds the plugin
The plugin (this series) is running with passing CI results as shown
in this PR:
https://github.com/tianocore/edk2/pull/4736
---
V2 changes:
- Move the plugin from .pytool/Plugin to BaseTools/Plugin since
it is a build plugin not a CI plugin and that's usually where
build plugins reside.
- Remove `mws` usage since it has been deprecated recently in
edk2-pytools.
Cc: Abner Chang <[email protected]>
Cc: Alexei Fedorov <[email protected]>
Cc: Ard Biesheuvel <[email protected]>
Cc: Bob Feng <[email protected]>
Cc: Gerd Hoffmann <[email protected]>
Cc: Igor Kulchytskyy <[email protected]>
Cc: Jian J Wang <[email protected]>
Cc: Jiewen Yao <[email protected]>
Cc: Jordan Justen <[email protected]>
Cc: Leif Lindholm <[email protected]>
Cc: Liming Gao <[email protected]>
Cc: Michael D Kinney <[email protected]>
Cc: Nickle Wang <[email protected]>
Cc: Pierre Gondois <[email protected]>
Cc: Rebecca Cran <[email protected]>
Cc: Sami Mujawar <[email protected]>
Cc: Sean Brogan <[email protected]>
Cc: Yuwei Chen <[email protected]>
Michael Kubacki (7):
RedfishPkg/PlatformHostInterfaceBmcUsbNicLib: Fix DEBUG macro args
pip-requirements.txt: Add regex
SecurityPkg.ci.yaml: Add debug macro exception
ArmVirtPkg.ci.yaml: Add debug macro exception
DynamicTablesPkg.ci.yaml: Add debug macro exception
OvmfPkg/PlatformCI: Disable DebugMacroCheck
BaseTools/Plugin: Add DebugMacroCheck
RedfishPkg/Library/PlatformHostInterfaceBmcUsbNicLib/PlatformHostInterfaceBmcUsbNicLib.c
| 8 +-
ArmVirtPkg/ArmVirtPkg.ci.yaml
| 8 +
BaseTools/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheckBuildPlugin.py
| 127 +++
BaseTools/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheck_plug_in.yaml
| 11 +
BaseTools/Plugin/DebugMacroCheck/DebugMacroCheck.py
| 859 ++++++++++++++++++++
BaseTools/Plugin/DebugMacroCheck/Readme.md
| 253 ++++++
BaseTools/Plugin/DebugMacroCheck/tests/DebugMacroDataSet.py
| 674 +++++++++++++++
BaseTools/Plugin/DebugMacroCheck/tests/MacroTest.py
| 131 +++
BaseTools/Plugin/DebugMacroCheck/tests/__init__.py
| 0
BaseTools/Plugin/DebugMacroCheck/tests/test_DebugMacroCheck.py
| 201 +++++
DynamicTablesPkg/DynamicTablesPkg.ci.yaml
| 8 +
OvmfPkg/PlatformCI/PlatformBuildLib.py
| 1 +
SecurityPkg/SecurityPkg.ci.yaml
| 9 +
pip-requirements.txt
| 2 +-
14 files changed, 2287 insertions(+), 5 deletions(-)
create mode 100644
BaseTools/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheckBuildPlugin.py
create mode 100644
BaseTools/Plugin/DebugMacroCheck/BuildPlugin/DebugMacroCheck_plug_in.yaml
create mode 100644 BaseTools/Plugin/DebugMacroCheck/DebugMacroCheck.py
create mode 100644 BaseTools/Plugin/DebugMacroCheck/Readme.md
create mode 100644 BaseTools/Plugin/DebugMacroCheck/tests/DebugMacroDataSet.py
create mode 100644 BaseTools/Plugin/DebugMacroCheck/tests/MacroTest.py
create mode 100644 BaseTools/Plugin/DebugMacroCheck/tests/__init__.py
create mode 100644
BaseTools/Plugin/DebugMacroCheck/tests/test_DebugMacroCheck.py
--
2.42.0.windows.2
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108600): https://edk2.groups.io/g/devel/message/108600
Mute This Topic: https://groups.io/mt/101341642/21656
Group Owner: [email protected]
Unsubscribe: https://edk2.groups.io/g/devel/unsub [[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
