[Patch 0/7] Add GoogleTest to UnitTestFrameworkPkg


Michael D Kinney
 

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 <gaoliming@...>
Cc: Zhiguang Liu <zhiguang.liu@...>
Cc: Bob Feng <bob.c.feng@...>
Cc: Liming Gao <gaoliming@...>
Cc: Yuwei Chen <yuwei.chen@...>
Cc: Sean Brogan <sean.brogan@...>
Cc: Bret Barkelew <Bret.Barkelew@...>
Signed-off-by: Michael D Kinney <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

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