[PATCH v3 00/17] Add a pipline to check Ecc issues for edk2 on open ci


Zhang, Shenglei
 

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2606
As planed we will enable Ecc check for edk2 on open ci. And they are
ready now, but these are V3 series. So I expect that contributors in
edk2 community can try using this script when reviewing. And I appreciate
receiving feedback and comments if someone find errors or false positive
issues.

I created a pipline of EccCheck for my forked edk2.
https://dev.azure.com/shengleizhang/shengleizhang/_build?definitionId=10&_a=summary

The patch series are big, so the commits are also pushed into my forked tree.
https://github.com/shenglei10/edk2/commits/ECC

Patches
1/17: EccCheck.py is a tool to report Ecc issues for commits. It can be run
on azure servers for open ci, or locally. Its usage is like
PatchCheck.py.
2/17: It's a lib necessary for py3 to run Ecc on azure servers. For local
use, we need to type command
"py -3 -m pip install antlr4-python3-runtime==4.7.1" first.
3/17: Windows-EccCheck.yml is a yaml file to configure the newly added
pipline. Azure uses this to create a pipline.
4/17~17/17: We consider some cases that will report out Ecc issues but they won't
be fixed, like submodule and industry standard related things. So we
add two configuration fields "Exception" and "IgnoreFiles" for people
to use. These patches add configuration in yaml files for Ecc check.

Cc: Bob Feng <bob.c.feng@...>
Cc: Bret Barkelew <Bret.Barkelew@...>
Cc: Michael D Kinney <michael.d.kinney@...>
Cc: Liming Gao <liming.gao@...>
Cc: Sean Brogan <sean.brogan@...>

v2: Update 1/17, fix the bug that the script can't hanlde multiple commits.

v3: Update 1/17, set the only workalbe workspace is edk2 root directory.
Update 2/17, designate the version of antlr4 is 4.7.1.
Add 4/17~17/17.

Shenglei Zhang (17):
BaseTools/Scripts: Add EccCheck.py
pip-requirements.txt: Add Ecc required lib
.azurepiplines: Add a pipline to check ECC issues for commits
MdeModulePkg/MdeModulePkg.ci.yaml: Add configuration for Ecc check
ArmVirtPkg/ArmVirtPkg.ci.yaml: Add configuration for Ecc check
CryptoPkg/CryptoPkg.ci.yaml: Add configuration for Ecc check
EmulatorPkg/EmulatorPkg.ci.yaml: Add configuration for Ecc check
FatPkg/FatPkg.ci.yaml: Add configuration for Ecc check
FmpDevicePkg/FmpDevicePkg.ci.yaml: Add configuration for Ecc check
MdePkg/MdePkg.ci.yaml: Add configuration for Ecc check
NetworkPkg/NetworkPkg.ci.yaml: Add configuration for Ecc check
OvmfPkg/OvmfPkg.ci.yaml: Add configuration for Ecc check
PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml: Add configuration for Ecc check
SecurityPkg/SecurityPkg.ci.yaml: Add configuration for Ecc check
ShellPkg/ShellPkg.ci.yaml: Add configuration for Ecc check
UefiCpuPkg/UefiCpuPkg.ci.yaml: Add configuration for Ecc check
UnitTestFrameworkPkg: Add configuration for Ecc check in yaml file

.azurepipelines/Windows-EccCheck.yml | 38 ++
ArmVirtPkg/ArmVirtPkg.ci.yaml | 10 +
BaseTools/Scripts/EccCheck.py | 437 ++++++++++++++++++
CryptoPkg/CryptoPkg.ci.yaml | 10 +
EmulatorPkg/EmulatorPkg.ci.yaml | 10 +
FatPkg/FatPkg.ci.yaml | 10 +
FmpDevicePkg/FmpDevicePkg.ci.yaml | 10 +
MdeModulePkg/MdeModulePkg.ci.yaml | 10 +
MdePkg/MdePkg.ci.yaml | 10 +
NetworkPkg/NetworkPkg.ci.yaml | 10 +
OvmfPkg/OvmfPkg.ci.yaml | 10 +
PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml | 10 +
SecurityPkg/SecurityPkg.ci.yaml | 10 +
ShellPkg/ShellPkg.ci.yaml | 10 +
UefiCpuPkg/UefiCpuPkg.ci.yaml | 10 +
.../UnitTestFrameworkPkg.ci.yaml | 10 +
pip-requirements.txt | 1 +
17 files changed, 616 insertions(+)
create mode 100644 .azurepipelines/Windows-EccCheck.yml
create mode 100644 BaseTools/Scripts/EccCheck.py

--
2.18.0.windows.1

Join devel@edk2.groups.io to automatically receive all group messages.