[edk2-devel] [Patch v3 00/12] Add gmock support for host-based unit testing

Michael D Kinney posted 12 patches 1 year ago
Failed in applying to current master (apply log)
.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   |   21 +-
.../Library/GoogleTestLib/GoogleTestLib.uni   |    3 -
.../Library/SubhookLib/SubhookLib.inf         |   31 +
.../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, 2022 insertions(+), 164 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
create mode 100644 UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.inf
create mode 100644 UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.uni
create mode 160000 UnitTestFrameworkPkg/Library/SubhookLib/subhook
[edk2-devel] [Patch v3 00/12] Add gmock support for host-based unit testing
Posted by Michael D Kinney 1 year ago
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 v3
==========
* Expand commit messages for HOST_APPLICATION only supports IA32/X64
* Update UnitTestFrameworkPkgHostTest.dsc to list libraries alphabetically
* Update GoogleTestLib.inf, SubhookLib.inf, and FunctionMockLib.inf to be 
  module type HOST_APLICATION and re-organize [BuildOptions] to make
  them easier to read.

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 <mikuback@linux.microsoft.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael Kubacki <mikuback@linux.microsoft.com>
Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Signed-off-by: Chris Johnson <chris.n.johnson@intel.com>

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   |   21 +-
 .../Library/GoogleTestLib/GoogleTestLib.uni   |    3 -
 .../Library/SubhookLib/SubhookLib.inf         |   31 +
 .../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, 2022 insertions(+), 164 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
 create mode 100644 UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.inf
 create mode 100644 UnitTestFrameworkPkg/Library/SubhookLib/SubhookLib.uni
 create mode 160000 UnitTestFrameworkPkg/Library/SubhookLib/subhook

-- 
2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#102724): https://edk2.groups.io/g/devel/message/102724
Mute This Topic: https://groups.io/mt/98134489/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/3901457/1787277/102458076/xyzzy [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-