From: "Zhang, Shenglei" <shenglei.zhang@intel.com>
To: devel@edk2.groups.io
Cc: Bob Feng <bob.c.feng@intel.com>,
Bret Barkelew <Bret.Barkelew@microsoft.com>,
Michael D Kinney <michael.d.kinney@intel.com>,
Liming Gao <liming.gao@intel.com>,
Sean Brogan <sean.brogan@microsoft.com>
Subject: [PATCH v5 00/15] Add a plugin to check Ecc issues for edk2 on open ci
Date: Tue, 30 Jun 2020 20:00:00 +0800 [thread overview]
Message-ID: <20200630120015.15456-1-shenglei.zhang@intel.com> (raw)
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. 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=12&_a=summary
And I also created some test cases for ECC plugin. Results can be view
in the above pipline. Below are test cases.
https://github.com/shenglei10/edk2/tree/ECC
Patches
1/15: 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.
2/15: EccCheck.py is a plugin to report Ecc issues for commits. It can be run
on azure servers for open ci, or a local virtual environment.
3/15~15/15: 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@intel.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
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.
v4. Update 1/17, remove the function EdksetupRebuild(), instead add
function SetupEnvironment(). Update variables' format and type hints
to pass flake8 and mypy.
v5. Conver the former method to plugin solution, to align with
other check points on open ci.
Shenglei Zhang (15):
.pytool/Plugin: Add a plugin EccCheck
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
.pytool/Plugin/EccCheck/EccCheck.py | 268 ++++++++++++++++++
.pytool/Plugin/EccCheck/EccCheck_plug_in.yaml | 11 +
.pytool/Plugin/EccCheck/Readme.md | 15 +
ArmVirtPkg/ArmVirtPkg.ci.yaml | 11 +
CryptoPkg/CryptoPkg.ci.yaml | 11 +
EmulatorPkg/EmulatorPkg.ci.yaml | 11 +
FatPkg/FatPkg.ci.yaml | 11 +
FmpDevicePkg/FmpDevicePkg.ci.yaml | 11 +
MdeModulePkg/MdeModulePkg.ci.yaml | 11 +
MdePkg/MdePkg.ci.yaml | 11 +
NetworkPkg/NetworkPkg.ci.yaml | 11 +
OvmfPkg/OvmfPkg.ci.yaml | 11 +
PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml | 11 +
SecurityPkg/SecurityPkg.ci.yaml | 11 +
ShellPkg/ShellPkg.ci.yaml | 11 +
UefiCpuPkg/UefiCpuPkg.ci.yaml | 11 +
.../UnitTestFrameworkPkg.ci.yaml | 10 +
17 files changed, 447 insertions(+)
create mode 100644 .pytool/Plugin/EccCheck/EccCheck.py
create mode 100644 .pytool/Plugin/EccCheck/EccCheck_plug_in.yaml
create mode 100644 .pytool/Plugin/EccCheck/Readme.md
--
2.18.0.windows.1
next reply other threads:[~2020-06-30 12:00 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-30 12:00 Zhang, Shenglei [this message]
2020-06-30 12:00 ` [PATCH v5 01/15] .pytool/Plugin: Add a plugin EccCheck Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 02/15] MdeModulePkg/MdeModulePkg.ci.yaml: Add configuration for Ecc check Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 03/15] ArmVirtPkg/ArmVirtPkg.ci.yaml: " Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 04/15] CryptoPkg/CryptoPkg.ci.yaml: " Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 05/15] EmulatorPkg/EmulatorPkg.ci.yaml: " Zhang, Shenglei
2020-07-01 1:03 ` Ni, Ray
2020-06-30 12:00 ` [PATCH v5 06/15] FatPkg/FatPkg.ci.yaml: " Zhang, Shenglei
2020-07-01 1:03 ` Ni, Ray
2020-06-30 12:00 ` [PATCH v5 07/15] FmpDevicePkg/FmpDevicePkg.ci.yaml: " Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 08/15] MdePkg/MdePkg.ci.yaml: " Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 09/15] NetworkPkg/NetworkPkg.ci.yaml: " Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 10/15] OvmfPkg/OvmfPkg.ci.yaml: " Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 11/15] PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml: " Zhang, Shenglei
2020-07-01 1:03 ` Ni, Ray
2020-06-30 12:00 ` [PATCH v5 12/15] SecurityPkg/SecurityPkg.ci.yaml: " Zhang, Shenglei
2020-06-30 12:00 ` [PATCH v5 13/15] ShellPkg/ShellPkg.ci.yaml: " Zhang, Shenglei
2020-07-01 1:03 ` Ni, Ray
2020-06-30 12:00 ` [PATCH v5 14/15] UefiCpuPkg/UefiCpuPkg.ci.yaml: " Zhang, Shenglei
2020-07-01 1:03 ` Ni, Ray
2020-06-30 12:00 ` [PATCH v5 15/15] UnitTestFrameworkPkg: Add configuration for Ecc check in yaml file Zhang, Shenglei
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200630120015.15456-1-shenglei.zhang@intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox