From nobody Sun Feb 8 21:33:22 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+94110+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+94110+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1663830552; cv=none; d=zohomail.com; s=zohoarc; b=YoTPOCDd+AEQ1m9kU+cYqzHo9qJ/dVSS1W1MgWneTvvfIa5UEsCUFk2YvzDOYKsE/IJ2pTAodtT6pOsXFnmBSRUhWCz3ace8x23/sDCbgGxCMpri9puEBqbU50HxT3YeRdTj41tXKUPvitVIOMVoXoKMZfh8p8PHJTryvBFzxmU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1663830552; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=p2whg2F/qdZ+2nPIP9LcXOdJjv7egDLnKlhrQfwzbVc=; b=V86260uFf+eKpfNFwLtjMXutZXkNeJWeMqmCr+jMQhCKc6eChRKWU+OLoxZKXr2nQ0wlNWm22MUSh6X8gOIxh22bNZV+go73lTHPXlFSZf1UTUtwdNR5ohaABgN7lY6v1qFM+ZlsjEkoIFDrVKFQPhoJk0Z1RDGrMYBdJHb6ycY= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+94110+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1663830552968822.546128196396; Thu, 22 Sep 2022 00:09:12 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id kHKVYY1788612xu2rwJfHZba; Thu, 22 Sep 2022 00:09:12 -0700 X-Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mx.groups.io with SMTP id smtpd.web11.4494.1663830549554291597 for ; Thu, 22 Sep 2022 00:09:12 -0700 X-IronPort-AV: E=McAfee;i="6500,9779,10477"; a="364198680" X-IronPort-AV: E=Sophos;i="5.93,335,1654585200"; d="scan'208";a="364198680" X-Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 22 Sep 2022 00:09:10 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.93,335,1654585200"; d="scan'208";a="621986204" X-Received: from gguo-desk.gar.corp.intel.com ([10.5.215.23]) by fmsmga007.fm.intel.com with ESMTP; 22 Sep 2022 00:09:10 -0700 From: "Guo, Gua" To: devel@edk2.groups.io Cc: Gua Guo , Bob Feng , Liming Gao , Bret Barkelew , Michael D Kinney , Sean Brogan Subject: [edk2-devel] [PATCH v3 2/2] BaseTools/Plugin: Add coverage support for Unit Test Date: Thu, 22 Sep 2022 15:09:05 +0800 Message-Id: <9bd869e8a7384e1e60680d18a3e2713cd2891f2f.1663830230.git.gua.guo@intel.com> In-Reply-To: References: MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,gua.guo@intel.com X-Gm-Message-State: IWP3p3bt05f20qWaxitb8ygSx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1663830552; bh=1l87ABUBF0EbP1o5nHaKTlfxhBNX33FiAFbITDir2aY=; h=Cc:Date:From:Reply-To:Subject:To; b=UWy+vTLlYgJgs3o8KYmWKa02yLmBdcixCq99vA9gy8w3q7CtcWZTwv1Ug3q5MVEAu8U D12dYIhMTWb7O0TBXowlHTyC4Wkjb+SzkJAlDSjFR87fbxYNWA8qnUWEWZv9dSCZoVEnv jRj5ihXfj7bvM71/OBq0h51tj8N5tvg0yQg= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1663830555221100010 Content-Type: text/plain; charset="utf-8" From: Gua Guo For GCC, use lcov to generate Unit Test code coverage report For VS2019, use OpenCppCoverage to generate code coverage report Cc: Bob Feng Cc: Liming Gao Cc: Bret Barkelew Cc: Michael D Kinney Cc: Sean Brogan Signed-off-by: Gua Guo --- .../HostBasedUnitTestRunner.py | 124 ++++++++++++++++++ 1 file changed, 124 insertions(+) diff --git a/BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunn= er.py b/BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner.py index c1eeaf2625..0b77576f3c 100644 --- a/BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner.py +++ b/BaseTools/Plugin/HostBasedUnitTestRunner/HostBasedUnitTestRunner.py @@ -112,4 +112,128 @@ class HostBasedUnitTestRunner(IUefiBuildPlugin): " %s - %s" % (case.attrib['na= me'], result.text)) failure_count +=3D 1 =20 + if thebuilder.env.GetValue("CODE_COVERAGE") =3D=3D "TRUE": + if thebuilder.env.GetValue("TOOL_CHAIN_TAG") =3D=3D "GCC5": + self.gen_code_coverage_gcc(thebuilder) + elif thebuilder.env.GetValue("TOOL_CHAIN_TAG") =3D=3D "VS2= 019": + self.gen_code_coverage_msvc(thebuilder) + else: + logging.info("Skipping code coverage. Only supported o= n GCC.") + return failure_count + + def gen_code_coverage_gcc(self, thebuilder): + logging.info("Generating UnitTest code coverage") + + buildOutputBase =3D thebuilder.env.GetValue("BUILD_OUTPUT_BASE") + workspace =3D thebuilder.env.GetValue("WORKSPACE") + + # Generate base code coverage for all source files + ret =3D RunCmd("lcov", f"--no-external --capture --initial --direc= tory {buildOutputBase} --output-file {buildOutputBase}/cov-base.info --rc l= cov_branch_coverage=3D1") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to build initial cove= rage data.") + return 1 + + # Coverage data for tested files only + ret =3D RunCmd("lcov", f"--capture --directory {buildOutputBase}/ = --output-file {buildOutputBase}/coverage-test.info --rc lcov_branch_coverag= e=3D1") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to build coverage dat= a for tested files.") + return 1 + + # Aggregate all coverage data + ret =3D RunCmd("lcov", f"--add-tracefile {buildOutputBase}/cov-bas= e.info --add-tracefile {buildOutputBase}/coverage-test.info --output-file {= buildOutputBase}/total-coverage.info --rc lcov_branch_coverage=3D1") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to aggregate coverage= data.") + return 1 + + # Generate coverage XML + ret =3D RunCmd("lcov_cobertura",f"{buildOutputBase}/total-coverage= .info -o {buildOutputBase}/compare.xml") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to generate coverage = XML.") + return 1 + + # Filter out auto-generated and test code + ret =3D RunCmd("lcov_cobertura",f"{buildOutputBase}/total-coverage= .info --excludes ^.*UnitTest\|^.*MU\|^.*Mock\|^.*DEBUG -o {buildOutputBase}= /coverage.xml") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed generate filtered cov= erage XML.") + return 1 + + # Generate all coverage file + testCoverageList =3D glob.glob (f"{workspace}/Build/**/total-cover= age.info", recursive=3DTrue) + + coverageFile =3D "" + for testCoverage in testCoverageList: + coverageFile +=3D " --add-tracefile " + testCoverage + ret =3D RunCmd("lcov", f"{coverageFile} --output-file {workspace}/= Build/all-coverage.info --rc lcov_branch_coverage=3D1") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed generate all coverage= file.") + return 1 + + # Generate and HTML file if requested.by each package + if thebuilder.env.GetValue("CC_HTML") =3D=3D "TRUE": + ret =3D RunCmd("pycobertura", f"show --format html --output {b= uildOutputBase}/coverage.html {buildOutputBase}/coverage.xml --source {work= space}") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to generate HTML = in single package..") + + # Generate and HTML file if requested.for all package + if os.path.isfile(f"{workspace}/Build/coverage.xml"): + os.remove(f"{workspace}/Build/coverage.xml") + ret =3D RunCmd("lcov_cobertura",f"{workspace}/Build/all-coverage.i= nfo --excludes ^.*UnitTest\|^.*MU\|^.*Mock\|^.*DEBUG -o {workspace}/Build/c= overage.xml") + + if thebuilder.env.GetValue("CC_HTML") =3D=3D "TRUE": + if os.path.isfile(f"{workspace}/Build/coverage.html"): + os.remove(f"{workspace}/Build/coverage.html") + ret =3D RunCmd("pycobertura", f"show --format html --output {w= orkspace}/Build/coverage.html {workspace}/Build/coverage.xml --source {work= space}") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to generate HTML.= ") + + return 0 + + + def gen_code_coverage_msvc(self, thebuilder): + logging.info("Generating UnitTest code coverage") + + + buildOutputBase =3D thebuilder.env.GetValue("BUILD_OUTPUT_BASE") + testList =3D glob.glob(os.path.join(buildOutputBase, "**","*Test*.= exe"), recursive=3DTrue) + workspace =3D thebuilder.env.GetValue("WORKSPACE") + + # Generate coverage file + coverageFile =3D "" + for testFile in testList: + ret =3D RunCmd("OpenCppCoverage", f"--source {workspace} --exp= ort_type binary:{testFile}.cov -- {testFile}") + coverageFile +=3D " --input_coverage=3D" + testFile + ".cov" + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to collect covera= ge data.") + return 1 + + # Generate and HTML file if requested.by each package + if thebuilder.env.GetValue("CC_HTML") =3D=3D "TRUE": + ret =3D RunCmd("OpenCppCoverage", f"--export_type cobertura:{b= uildOutputBase}/coverage.xml --working_dir=3D{workspace}/Build {coverageFil= e}") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to generate cober= tura format xml in single package.") + return 1 + + ret =3D RunCmd("pycobertura", f"show --format html --output {b= uildOutputBase}/cverage.html {buildOutputBase}/coverage.xml --source {works= pace}") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to generate HTML = in single package.") + return 1 + + # Generate total report HTML file for all package + testCoverageList =3D glob.glob(os.path.join(workspace, "Build", "*= *","*Test*.exe.cov"), recursive=3DTrue) + coverageFile =3D "" + for testCoverage in testCoverageList: + coverageFile +=3D " --input_coverage=3D" + testCoverage + + if thebuilder.env.GetValue("CC_HTML") =3D=3D "TRUE": + ret =3D RunCmd("OpenCppCoverage", f"--export_type cobertura:{w= orkspace}/Build/coverage.xml --working_dir=3D{workspace}/Build {coverageFil= e}") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to generate cober= tura format xml.") + return 1 + + ret =3D RunCmd("pycobertura", f"show --format html --output {w= orkspace}/Build/coverage.html {workspace}/Build/coverage.xml --source {work= space}") + if(ret !=3D 0): + logging.error("UnitTest Coverage: Failed to generate HTML.= ") + return 1 + + return 0 --=20 2.31.1.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#94110): https://edk2.groups.io/g/devel/message/94110 Mute This Topic: https://groups.io/mt/93843730/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-