From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by mx.groups.io with SMTP id smtpd.web10.7390.1667532676726925714 for ; Thu, 03 Nov 2022 20:31:16 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="unable to parse pub key" header.i=@intel.com header.s=intel header.b=CSIGEMgu; spf=pass (domain: intel.com, ip: 192.55.52.151, mailfrom: michael.d.kinney@intel.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1667532676; x=1699068676; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=rK3k+ksoiSmDDvQcwHGJfM7R+zClqNefnBp5EdlXTAI=; b=CSIGEMgu42DXyoQT0HakaQOm0HR4DRpRh3r02RMdFgDYGUSFz8P6tscA VG/9NEbA3VWWbT6LcFUU2kd6r1IghGlXTeXyQkTFLQ44vfdu2acTD1y13 QHxbRQwCZ8nmzZjlBnz1h50zR1i4RPDwCHuz0p0GVW47PleDW+5RHWUrv UpGG1fuSQHwQyJZpZGNlUh3UHfwEH9hsbeHyUrrBEetFQyJ1sx6RABmUr krXI4g4fRkIgRLROfUQ8CHCbVbQ/plgxEVfF5lQP5chWmSdAWnpenQzX6 VBJ0ktNiD/3lzM3rWt1+2lTinlC9V7XxNf/ff8tb22Z6o6G+QcUHLS97j g==; X-IronPort-AV: E=McAfee;i="6500,9779,10520"; a="290258025" X-IronPort-AV: E=Sophos;i="5.96,136,1665471600"; d="scan'208";a="290258025" Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga107.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Nov 2022 20:31:04 -0700 X-IronPort-AV: E=McAfee;i="6500,9779,10520"; a="809917943" X-IronPort-AV: E=Sophos;i="5.96,136,1665471600"; d="scan'208";a="809917943" Received: from mdkinney-mobl2.amr.corp.intel.com ([10.209.2.81]) by orsmga005-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Nov 2022 20:31:03 -0700 From: "Michael D Kinney" To: devel@edk2.groups.io Cc: Liming Gao , Zhiguang Liu , Bob Feng , Yuwei Chen , Sean Brogan , Bret Barkelew Subject: [Patch 0/7] Add GoogleTest to UnitTestFrameworkPkg Date: Thu, 3 Nov 2022 20:30:49 -0700 Message-Id: <20221104033056.1259-1-michael.d.kinney@intel.com> X-Mailer: git-send-email 2.37.1.windows.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4134 PR: https://github.com/tianocore/edk2/pull/3566 Branch: https://github.com/mdkinney/edk2/tree/Bug_4134_AddGoogleTest Add GoogleTest support to UnitTestFrameworkPkg to provide an additional host-based unit test framework to developers. Code: https://github.com/google/googletest Docs: https://google.github.io/googletest GoogleTest is implemented in C++, but does support implementing unit tests for C code. This patch series makes a few updates for C++ compatibility and build issues related to multiple definitions of _ASSERT(). The GoogleTest git submodule is added to the UnitTestFrameworkPkg and .pytools/CISettings.py file along with an update to the host-based test runner plugin to set the GTEST_OUTPUT environment variable to specify the XML output file format and location. A port of the unit tests for the the MdePkg BaseSafeIntLib are included to provide an example that is in both the current unit test style and the GoogleTest style. Cc: Liming Gao Cc: Zhiguang Liu Cc: Bob Feng Cc: Liming Gao Cc: Yuwei Chen Cc: Sean Brogan Cc: Bret Barkelew Signed-off-by: Michael D Kinney Michael D Kinney (7): MdePkg/Include: Update Base.h to improve C++ compatibility MdePkg/Include/Library: Undefine _ASSERT() if already defined UnitTestFrameworkPkg: Add googletest submodule and GoogleTestLib UnitTestFrameworkPkg/Library/CmockaLib: Enable symbol files. .pytool: Add googletest submodule to CISettings.py BaseTools/Plugin/HostBaseUnitTestRunner: Enable gtest xml output MdePkg/Test: Add port of BaseSafeIntLib unit tests to GoogleTest .gitmodules | 3 + .pytool/CISettings.py | 2 + .../HostBasedUnitTestRunner.py | 7 +- MdePkg/Include/Base.h | 12 +- MdePkg/Include/Library/DebugLib.h | 3 + .../GoogleTestBaseSafeIntLib.inf | 37 + .../GoogleTestBaseSafeIntLib.uni | 13 + .../SafeIntLibUintnIntnUnitTests32.cpp | 425 +++ .../SafeIntLibUintnIntnUnitTests64.cpp | 429 ++++ .../BaseSafeIntLib/TestBaseSafeIntLib.cpp | 2274 +++++++++++++++++ MdePkg/Test/MdePkgHostTest.dsc | 1 + .../Include/Library/GoogleTestLib.h | 14 + .../Library/CmockaLib/CmockaLib.inf | 2 +- .../Library/GoogleTestLib/GoogleTestLib.inf | 36 + .../Library/GoogleTestLib/GoogleTestLib.uni | 14 + .../Library/GoogleTestLib/googletest | 1 + UnitTestFrameworkPkg/ReadMe.md | 235 +- .../SampleGoogleTest/SampleGoogleTest.cpp | 263 ++ .../SampleGoogleTest/SampleGoogleTestHost.inf | 35 + .../Test/UnitTestFrameworkPkgHostTest.dsc | 4 +- .../UnitTestFrameworkPkg.ci.yaml | 4 +- UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec | 8 + .../UnitTestFrameworkPkgHost.dsc.inc | 4 +- 23 files changed, 3790 insertions(+), 36 deletions(-) create mode 100644 MdePkg/Test/GoogleTest/Library/BaseSafeIntLib/GoogleTestBaseSafeIntLib.inf create mode 100644 MdePkg/Test/GoogleTest/Library/BaseSafeIntLib/GoogleTestBaseSafeIntLib.uni create mode 100644 MdePkg/Test/GoogleTest/Library/BaseSafeIntLib/SafeIntLibUintnIntnUnitTests32.cpp create mode 100644 MdePkg/Test/GoogleTest/Library/BaseSafeIntLib/SafeIntLibUintnIntnUnitTests64.cpp create mode 100644 MdePkg/Test/GoogleTest/Library/BaseSafeIntLib/TestBaseSafeIntLib.cpp create mode 100644 UnitTestFrameworkPkg/Include/Library/GoogleTestLib.h create mode 100644 UnitTestFrameworkPkg/Library/GoogleTestLib/GoogleTestLib.inf create mode 100644 UnitTestFrameworkPkg/Library/GoogleTestLib/GoogleTestLib.uni create mode 160000 UnitTestFrameworkPkg/Library/GoogleTestLib/googletest create mode 100644 UnitTestFrameworkPkg/Test/GoogleTest/Sample/SampleGoogleTest/SampleGoogleTest.cpp create mode 100644 UnitTestFrameworkPkg/Test/GoogleTest/Sample/SampleGoogleTest/SampleGoogleTestHost.inf -- 2.37.1.windows.1