From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by mx.groups.io with SMTP id smtpd.web10.9931.1597129329084339712 for ; Tue, 11 Aug 2020 00:02:09 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.88, mailfrom: shenglei.zhang@intel.com) IronPort-SDR: H+bzK7zFS0MzXMh2LCCw5lbHXbF58ERjTlQdypk9Q600rF+JHGM+Q/ry+QT28+3R1n/1cxiE8o v8efwQeGre6g== X-IronPort-AV: E=McAfee;i="6000,8403,9709"; a="171723327" X-IronPort-AV: E=Sophos;i="5.75,460,1589266800"; d="scan'208";a="171723327" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Aug 2020 00:02:07 -0700 IronPort-SDR: g7D54FNAFCyhQH46qzAYOWZQJl7bubR7fD/99/0p+OcHCmx/gkd7upDhuQgPc0Vo1Y52j3QSSq w3LKbo+m9aYA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.75,460,1589266800"; d="scan'208";a="277496904" Received: from shenglei-dev.ccr.corp.intel.com ([10.239.154.36]) by fmsmga008.fm.intel.com with ESMTP; 11 Aug 2020 00:02:06 -0700 From: "Zhang, Shenglei" To: devel@edk2.groups.io Cc: Bob Feng , Bret Barkelew , Michael D Kinney , Liming Gao , Sean Brogan Subject: [PATCH v9 00/16] Add a plugin to check Ecc issues for edk2 on open ci Date: Tue, 11 Aug 2020 15:01:48 +0800 Message-Id: <20200811070204.55160-1-shenglei.zhang@intel.com> X-Mailer: git-send-email 2.18.0.windows.1 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. Welcome everyone to create pull request to test the quality of this plugin. My forked tree: https://github.com/shenglei10/edk2 And I also created some test cases for ECC plugin. Below are test cases. https://github.com/shenglei10/edk2/tree/ECC Results can be view in below azure server. https://dev.azure.com/shengleizhang/shengleizhang/_build?definitionId=12&_a=summary Patches 1/16: It's a lib necessary for py3 to run Ecc on azure servers. 2/16: 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/16~16/16: 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 Cc: Bret Barkelew Cc: Michael D Kinney Cc: Liming Gao Cc: 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. 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. v6. The 1/16 patch is missed in v5 series. Now add it in v6. v7. Fix a bug that Ecc plugin can not be run correctly under Linux OS. v8. Enable error code config section to ignore certain kinds of issues, which are always false positive in partial Ecc scaning. All patches except 2/16 have been R-B and are not updated in v8 series. To avoid making noise in community, I only send cover letter and 2/16 patch. v9. Update 2/16, 3/16, 5/16 and 16/16. 1. Enable directory path for "IgnoreFiles" section in xxxPkg.yaml. So that users can skip a certain directory and don't need to fill in with file names. 2. Add submodule pathes in "IgnoreFiles" in MdeModulePkg.ci.yaml, CryptoPkg.ci.yaml and UnitTestFrameworkPkg.ci.yaml. Shenglei Zhang (16): pip-requirements.txt: Add Ecc required lib .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 | 302 ++++++++++++++++++ .pytool/Plugin/EccCheck/EccCheck_plug_in.yaml | 11 + .pytool/Plugin/EccCheck/Readme.md | 15 + ArmVirtPkg/ArmVirtPkg.ci.yaml | 11 + CryptoPkg/CryptoPkg.ci.yaml | 13 + EmulatorPkg/EmulatorPkg.ci.yaml | 11 + FatPkg/FatPkg.ci.yaml | 12 + FmpDevicePkg/FmpDevicePkg.ci.yaml | 12 + MdeModulePkg/MdeModulePkg.ci.yaml | 13 + MdePkg/MdePkg.ci.yaml | 11 + NetworkPkg/NetworkPkg.ci.yaml | 12 + OvmfPkg/OvmfPkg.ci.yaml | 11 + PcAtChipsetPkg/PcAtChipsetPkg.ci.yaml | 12 + SecurityPkg/SecurityPkg.ci.yaml | 12 + ShellPkg/ShellPkg.ci.yaml | 12 + UefiCpuPkg/UefiCpuPkg.ci.yaml | 12 + .../UnitTestFrameworkPkg.ci.yaml | 11 + pip-requirements.txt | 1 + 18 files changed, 494 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