public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: devel@edk2.groups.io
Cc: Michael Kubacki <mikuback@linux.microsoft.com>,
	Nate DeSimone <nathaniel.l.desimone@intel.com>,
	Jian J Wang <jian.j.wang@intel.com>,
	Liming Gao <gaoliming@byosoft.com.cn>,
	Zhiguang Liu <zhiguang.liu@intel.com>,
	Jiewen Yao <jiewen.yao@intel.com>,
	Sean Brogan <sean.brogan@microsoft.com>,
	Andrew Fish <afish@apple.com>,
	Leif Lindholm <quic_llindhol@quicinc.com>,
	Chris Johnson <chris.n.johnson@intel.com>
Subject: [Patch 00/12] Add gmock support for host-based unit testing
Date: Sat, 25 Mar 2023 11:45:28 -0700	[thread overview]
Message-ID: <20230325184541.596-1-michael.d.kinney@intel.com> (raw)

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

* 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      |  57 +
 .../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       | 156 +++
 .../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                | 999 +++++++++++++++++-
 .../Test/UnitTestFrameworkPkgHostTest.dsc     |   2 +
 .../UnitTestFrameworkPkg.ci.yaml              |   7 +-
 UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec |   4 +
 .../UnitTestFrameworkPkgHost.dsc.inc          |   2 +
 47 files changed, 1960 insertions(+), 160 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

-- 
2.39.1.windows.1


             reply	other threads:[~2023-03-25 18:45 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-25 18:45 Michael D Kinney [this message]
2023-03-25 18:45 ` [Patch 01/12] UnitTestFrameworkPkg: Add subhook submodule required for gmock Michael D Kinney
2023-03-25 18:45 ` [Patch 02/12] .pytool/CISettings.py: Add subhook submodule Michael D Kinney
2023-03-25 18:45 ` [Patch 03/12] UnitTestFrameworkPkg: Add gmock support to GoogleTestLib Michael D Kinney
2023-03-25 18:45 ` [Patch 04/12] UnitTestFrameworkPkg/ReadMe.md: Add gmock documentation Michael D Kinney
2023-03-28 18:23   ` Johnson, Chris N
2023-03-25 18:45 ` [Patch 05/12] MdePkg: Add gmock examples Michael D Kinney
2023-03-25 18:45 ` [Patch 06/12] MdeModulePkg/Library/UefiSortLib: Add GoogleTestLib example Michael D Kinney
2023-03-25 18:45 ` [Patch 07/12] SecurityPkg: Add gmock example Michael D Kinney
2023-03-26  2:51   ` Yao, Jiewen
2023-03-25 18:45 ` [Patch 08/12] SecurityPkg/Library/SecureBootVariableLib: Fix VS20xx 4122 errors Michael D Kinney
2023-03-26  2:50   ` Yao, Jiewen
2023-03-25 18:45 ` [Patch 09/12] SecurityPkg/Library/SecureBootVariableLib: HOST_APPLICATION IA32/X64 only Michael D Kinney
2023-03-26  2:50   ` Yao, Jiewen
2023-03-25 18:45 ` [Patch 10/12] MdePkg/Library/BaseLib: " Michael D Kinney
2023-03-25 18:45 ` [Patch 11/12] MdeModulePkg: " Michael D Kinney
2023-03-25 18:45 ` [Patch 12/12] PrmPkg/Library: " Michael D Kinney

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230325184541.596-1-michael.d.kinney@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox