From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182]) by mx.groups.io with SMTP id smtpd.web10.141755.1680726822797203813 for ; Wed, 05 Apr 2023 13:33:42 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@linux.microsoft.com header.s=default header.b=BoiExUJZ; spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: osde@linux.microsoft.com) Received: from [10.137.194.171] (unknown [131.107.159.171]) by linux.microsoft.com (Postfix) with ESMTPSA id 42A1C210DEE4; Wed, 5 Apr 2023 13:33:42 -0700 (PDT) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 42A1C210DEE4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1680726822; bh=mbi7qCWAn1E+vOPJBxv1bTrYIxyDM7Ocp4R2piINuUo=; h=Date:Subject:To:Cc:References:From:In-Reply-To:From; b=BoiExUJZVyD4Ejn/E8PzcbzlTCV/z6IkclyHPyONDnfY4Lg1GHCXg9JjFrnyZks+C OOX188KBoRQj57TtU1fgShP+Tk+XAjJ/up/ZN3J2koMDG8dbHL4UqpZsoWIMdoI53E mw3BxCgUs5/7bhHkHGi2ZF6ACPcZce5KAWgIGHVc= Message-ID: Date: Wed, 5 Apr 2023 13:33:41 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.9.1 Subject: Re: [edk2-devel] [Patch v2 00/12] Add gmock support for host-based unit testing To: devel@edk2.groups.io, michael.d.kinney@intel.com Cc: Michael Kubacki , Nate DeSimone , Jian J Wang , Liming Gao , Zhiguang Liu , Jiewen Yao , Sean Brogan , Andrew Fish , Leif Lindholm , Chris Johnson References: <20230404182220.688-1-michael.d.kinney@intel.com> From: "Oliver Smith-Denny" In-Reply-To: <20230404182220.688-1-michael.d.kinney@intel.com> Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit Thanks for sending this out, looks to be a pretty clean unit testing interface. We are testing this now with some of our unit tests and will update with any feedback. In the meantime, for the patchset: Reviewed-by: Oliver Smith-Denny On 4/4/2023 11:22 AM, Michael D Kinney wrote: > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4389 > > PR: https://github.com/tianocore/edk2/pull/4180 > Branch: https://github.com/mdkinney/edk2/tree/Bug_4389_UnitTestFrameworkPkg_AddGoogleMockSupport > > New in v2 > ========== > * SecurityPkg: Add unit test descriptions to SecureBootVariableLibGoogleTest > * MdeModulePkg: Add unit test descriptions to UefiSortLibGoogleTest > * UnitTestFrameworkPkg: Update ReadMe.md based on review findings > * Fix FunctionMockLib example of the MockUefiLib declaration to align with > the design code. > * Fix FunctionMockLib Mocks header file location paths in the tables. > * Fix FunctionMockLib Mocks example (and description) of the MockUefiLib > declaration to align with the design code. > * Fix FunctionMockLib Mocks example (and description) of the MockUefiLib > INF file to align with the design file. > * Fix typos in new Code Coverage section. > > V1 > === > * Add subhook submodule that is required to hook internal functions > when using gmock. > * Add gmock support to GoogleTestLib > * Add FunctionMockLib library class and library instance > * Add GoogleTest extension to GoogleTestLib.h for CHAR16 type > * Add GoogleTest extension to GoogleTestLib.h for buffer types > * Add gmock documentation > * Add gmock examples > * Fix VS20xx 4122 errors in SecurityPkg unit test > * HOST_APPLICATION only supports IA32/X64 > > Cc: Michael Kubacki > Cc: Nate DeSimone > Cc: Jian J Wang > Cc: Liming Gao > Cc: Zhiguang Liu > Cc: Jiewen Yao > Cc: Michael D Kinney > Cc: Sean Brogan > Cc: Michael Kubacki > Cc: Andrew Fish > Cc: Leif Lindholm > Signed-off-by: Chris Johnson > > Chris Johnson (7): > UnitTestFrameworkPkg: Add subhook submodule required for gmock > .pytool/CISettings.py: Add subhook submodule > UnitTestFrameworkPkg: Add gmock support to GoogleTestLib > UnitTestFrameworkPkg/ReadMe.md: Add gmock documentation > MdePkg: Add gmock examples > MdeModulePkg/Library/UefiSortLib: Add GoogleTestLib example > SecurityPkg: Add gmock example > > Michael D Kinney (5): > SecurityPkg/Library/SecureBootVariableLib: Fix VS20xx 4122 errors > SecurityPkg/Library/SecureBootVariableLib: HOST_APPLICATION IA32/X64 > only > MdePkg/Library/BaseLib: HOST_APPLICATION IA32/X64 only > MdeModulePkg: HOST_APPLICATION IA32/X64 only > PrmPkg/Library: HOST_APPLICATION IA32/X64 only > > .gitmodules | 3 + > .pytool/CISettings.py | 2 + > .../MockUefiRuntimeServicesTableLib.inf | 6 +- > .../GoogleTest/UefiSortLibGoogleTest.cpp | 61 + > .../GoogleTest/UefiSortLibGoogleTest.inf | 31 + > MdeModulePkg/Test/MdeModulePkgHostTest.dsc | 6 + > .../VariableLockRequestToLockUnitTest.inf | 2 +- > .../Library/BaseLib/UnitTestHostBaseLib.inf | 2 +- > MdePkg/MdePkg.dec | 1 + > MdePkg/Test/MdePkgHostTest.dsc | 2 + > .../Include/GoogleTest/Library/MockUefiLib.h | 39 + > .../Library/MockUefiRuntimeServicesTableLib.h | 42 + > .../GoogleTest/MockUefiLib/MockUefiLib.cpp | 12 + > .../GoogleTest/MockUefiLib/MockUefiLib.inf | 33 + > .../MockUefiRuntimeServicesTableLib.cpp | 40 + > .../MockUefiRuntimeServicesTableLib.inf | 33 + > .../DxePrmContextBufferLibUnitTestHost.inf | 2 +- > .../DxePrmModuleDiscoveryLibUnitTestHost.inf | 2 +- > ReadMe.rst | 1 + > .../SecureBootVariableLibGoogleTest.cpp | 174 +++ > .../SecureBootVariableLibGoogleTest.inf | 32 + > .../UnitTest/MockPlatformPKProtectionLib.inf | 6 +- > .../UnitTest/MockUefiLib.inf | 6 +- > .../MockUefiRuntimeServicesTableLib.inf | 6 +- > .../UnitTest/SecureBootVariableLibUnitTest.c | 172 ++- > SecurityPkg/SecurityPkg.dec | 1 + > .../Library/MockPlatformPKProtectionLib.h | 28 + > .../MockPlatformPKProtectionLib.cpp | 11 + > .../MockPlatformPKProtectionLib.inf | 34 + > SecurityPkg/Test/SecurityPkgHostTest.dsc | 8 + > .../Include/Library/FunctionMockLib.h | 131 +++ > .../Include/Library/GoogleTestLib.h | 96 ++ > .../Include/Library/SubhookLib.h | 15 + > .../Library/CmockaLib/CmockaLib.inf | 2 +- > .../Library/FunctionMockLib/FunctionMockLib.c | 7 + > .../FunctionMockLib/FunctionMockLib.inf | 31 + > .../FunctionMockLib/FunctionMockLib.uni | 11 + > .../Library/GoogleTestLib/GoogleTestLib.inf | 6 +- > .../Library/GoogleTestLib/GoogleTestLib.uni | 3 - > .../SubhookLib.inf} | 16 +- > .../Library/SubhookLib/SubhookLib.uni | 11 + > .../Library/SubhookLib/subhook | 1 + > UnitTestFrameworkPkg/ReadMe.md | 1013 ++++++++++++++++- > .../Test/UnitTestFrameworkPkgHostTest.dsc | 2 + > .../UnitTestFrameworkPkg.ci.yaml | 7 +- > UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec | 4 + > .../UnitTestFrameworkPkgHost.dsc.inc | 2 + > 47 files changed, 1994 insertions(+), 162 deletions(-) > create mode 100644 MdeModulePkg/Library/UefiSortLib/GoogleTest/UefiSortLibGoogleTest.cpp > create mode 100644 MdeModulePkg/Library/UefiSortLib/GoogleTest/UefiSortLibGoogleTest.inf > create mode 100644 MdePkg/Test/Mock/Include/GoogleTest/Library/MockUefiLib.h > create mode 100644 MdePkg/Test/Mock/Include/GoogleTest/Library/MockUefiRuntimeServicesTableLib.h > create mode 100644 MdePkg/Test/Mock/Library/GoogleTest/MockUefiLib/MockUefiLib.cpp > create mode 100644 MdePkg/Test/Mock/Library/GoogleTest/MockUefiLib/MockUefiLib.inf > create mode 100644 MdePkg/Test/Mock/Library/GoogleTest/MockUefiRuntimeServicesTableLib/MockUefiRuntimeServicesTableLib.cpp > create mode 100644 MdePkg/Test/Mock/Library/GoogleTest/MockUefiRuntimeServicesTableLib/MockUefiRuntimeServicesTableLib.inf > create mode 100644 SecurityPkg/Library/SecureBootVariableLib/GoogleTest/SecureBootVariableLibGoogleTest.cpp > create mode 100644 SecurityPkg/Library/SecureBootVariableLib/GoogleTest/SecureBootVariableLibGoogleTest.inf > create mode 100644 SecurityPkg/Test/Mock/Include/GoogleTest/Library/MockPlatformPKProtectionLib.h > create mode 100644 SecurityPkg/Test/Mock/Library/GoogleTest/MockPlatformPKProtectionLib/MockPlatformPKProtectionLib.cpp > create mode 100644 SecurityPkg/Test/Mock/Library/GoogleTest/MockPlatformPKProtectionLib/MockPlatformPKProtectionLib.inf > create mode 100644 UnitTestFrameworkPkg/Include/Library/FunctionMockLib.h > create mode 100644 UnitTestFrameworkPkg/Include/Library/SubhookLib.h > create mode 100644 UnitTestFrameworkPkg/Library/FunctionMockLib/FunctionMockLib.c > create mode 100644 UnitTestFrameworkPkg/Library/FunctionMockLib/FunctionMockLib.inf > create mode 100644 UnitTestFrameworkPkg/Library/FunctionMockLib/FunctionMockLib.uni > copy UnitTestFrameworkPkg/Library/{GoogleTestLib/GoogleTestLib.inf => SubhookLib/SubhookLib.inf} (53%) > create mode 100644 UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.uni > create mode 160000 UnitTestFrameworkPkg/Library/SubhookLib/subhook >