Reviewed-by: Bret Barkelew <bret.barke...@microsoft.com>
- Bret ________________________________ From: devel@edk2.groups.io <devel@edk2.groups.io> on behalf of Liming Gao via groups.io <liming.gao=intel....@groups.io> Sent: Monday, July 13, 2020 11:54:53 PM To: devel@edk2.groups.io <devel@edk2.groups.io>; Kinney, Michael D <michael.d.kin...@intel.com> Subject: [EXTERNAL] Re: [edk2-devel] [Patch v3 00/16] UnitTestFrameworkPkg: Enhancements and bug fixes Mike: Thanks for your update. This patch set is good to me. Reviewed-by: Liming Gao <liming....@intel.com> Thanks Liming -----Original Message----- From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael D Kinney Sent: 2020年7月11日 10:09 To: devel@edk2.groups.io Subject: [edk2-devel] [Patch v3 00/16] UnitTestFrameworkPkg: Enhancements and bug fixes Changes in V3 ============== * Add UnitTestHostBaseLib class for the global variable that allows host based unit tests to hook and emulate some BaseLib services Changes in V2 ============== * Add UnitTestExpectAssertFailure() to UnitTestLib to simplify the macro UT_EXPECT_ASSERT_FAILURE() and provide better log messages. * Expand UnitTestFrameworkPkg sample unit tests to cover test cases for the new UT_EXPECT_ASSERT_FAILURE() macro and all other UnitTestLib macros. * Add failure type FAILURETYPE_EXPECTASSERT when the macro UT_EXPECT_ASSERT_FAILURE() does not detect an ASSERT(). * Move print of log messages to end of cleanup function to support log messages generated in a cleanup function. * Update running of target-based tests to use SetJump()/LongJump() around prereq, cleanup, and unit test functions to match the behavior of host based tests using cmocka. This also requires all UnitTestLib Assert functions to generate error log message first and then call UnitTestFailure() where the LongJump() is made to make sure all log messages are added before the LongJump(). REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2797&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=Cvs4rSfp%2FUl15lR331i0WOqsz0X0XGYc9nPu%2FFu5Ce0%3D&reserved=0 REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2798&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=gKBdHVSP%2F3QmwmX%2FAhCjQcIC6BMU%2F8yx6BM03VYaugo%3D&reserved=0 REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2799&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=eBVwmQgDnQLCOKhIybCJ8nn9CU43aO3shuTlUSxzC%2BM%3D&reserved=0 REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2800&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=7sFBxWZvhxXfiLAyCgaExGqAW%2F8yfIU0p2hlMLK4XUg%3D&reserved=0 REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2801&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=jYoltIH%2BvS43A1b5koMYdK0bnmPt8Pa4tz6QkbezYc4%3D&reserved=0 REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2803&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=Neyrn2INlcMtlJ%2BbS456GPRWVxb5ALL%2B9BcLMGqX69Q%3D&reserved=0 REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2804&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=hkyOv8qhQ3iC%2FwvqnayiBeot6AYwfRho%2FUmhfcVd0qo%3D&reserved=0 REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2805&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=TLvx%2FUylNXEyMOBlikWOfnQHnbqyR1JiCm9uIod859Q%3D&reserved=0 REF: https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugzilla.tianocore.org%2Fshow_bug.cgi%3Fid%3D2806&data=02%7C01%7CBret.Barkelew%40microsoft.com%7Cdb2bad178b6044d37e1208d827c2d38e%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637303065010616592&sdata=Wh7uoily48Be5EFItwd7o6whBtQZy82jh0cIDE%2FDrCY%3D&reserved=0 * Add Null base libraries for host based unit tests * Add host based test version of BaseLib with hooks for services that use privileged instructions. * Add new UT_EXPECT_ASSERT_FAILURE() macro to UnitTestLib class * Enable source level debug of unit tests * Increase stack size to 256KB for host based tests on Windows * Update BaseTools to support NULL libs for HOST_APPLICATION modules * Guarantee print log works even if unit test generates an exception * Use filename instead of function name in target mode logs Cc: Liming Gao liming....@intel.com Cc: Bob Feng bob.c.f...@intel.com Cc: Sean Brogan sean.bro...@microsoft.com Cc: Bret Barkelew bret.barke...@microsoft.com Cc: Jiewen Yao jiewen....@intel.com Signed-off-by: Michael D Kinney michael.d.kin...@intel.com Michael D Kinney (16): BaseTools/Python: Allow HOST_APPLICATION to use NULL libraries MdePkg/BaseCpuLibNull: Add Null version of CpuLib for host testing MdePkg/BaseCacheMaintenanceLibNull: Add Null instance for host testing MdePkg/BaseLib: Break out IA32/X64 GCC inline privileged functions MdePkg/Library/BaseLib: Add BaseLib instance for host based unit tests UnitTestFrameworkPkg: Use host libraries from MdePkg UnitTestFrameworkPkg: Enable source level debug for host tests UnitTestFrameworkPkg: Set host application stack size to 256KB UnitTestFrameworkPkg: Change target mode DebugLib mapping UnitTestFrameworkPkg/UnitTestLib: Move print log into cleanup UnitTestFrameworkPkg/UnitTestLib: Fix target mode log messages UnitTestFrameworkPkg/UnitTestLib: Add checks for ASSERT() MdePkg/Include: Hook DebugLib _ASSERT() for unit tests MdePkg/Include: Add UT_EXPECT_ASSERT_FAILURE() to UnitTestLib MdePkg/Library/BaseStackCheckLib: Fix PCD type in INF UnitTestFramewokPkg/SampleUnitTest: Use UT_EXPECT_ASSERT_FAILURE() .../Python/Workspace/WorkspaceCommon.py | 4 +- MdePkg/Include/Library/DebugLib.h | 28 +- MdePkg/Include/Library/UnitTestLib.h | 90 + .../BaseCacheMaintenanceLibNull.c | 225 ++ .../BaseCacheMaintenanceLibNull.inf | 29 + .../BaseCacheMaintenanceLibNull.uni | 12 + .../Library/BaseCpuLibNull/BaseCpuLibNull.c | 37 + .../Library/BaseCpuLibNull/BaseCpuLibNull.inf | 26 + .../Library/BaseCpuLibNull/BaseCpuLibNull.uni | 11 + MdePkg/Library/BaseLib/BaseLib.inf | 4 +- MdePkg/Library/BaseLib/Ia32/GccInline.c | 1181 +------ .../Ia32/{GccInline.c => GccInlinePriv.c} | 601 +--- MdePkg/Library/BaseLib/UnitTestHost.c | 140 + MdePkg/Library/BaseLib/UnitTestHost.h | 66 + .../Library/BaseLib/UnitTestHostBaseLib.inf | 217 ++ .../Library/BaseLib/UnitTestHostBaseLib.uni | 11 + MdePkg/Library/BaseLib/X64/GccInline.c | 1240 +------ .../X64/{GccInline.c => GccInlinePriv.c} | 572 +--- MdePkg/Library/BaseLib/X86UnitTestHost.c | 2977 +++++++++++++++++ .../BaseStackCheckLib/BaseStackCheckLib.inf | 2 +- MdePkg/MdePkg.dec | 8 +- MdePkg/MdePkg.dsc | 4 +- MdePkg/Test/MdePkgHostTest.dsc | 5 + .../Include/Library/UnitTestHostBaseLib.h | 582 ++++ .../UnitTestDebugAssertLib.c | 49 + .../UnitTestDebugAssertLib.inf | 31 + .../UnitTestDebugAssertLib.uni | 11 + .../Library/UnitTestLib/Assert.c | 217 +- .../Library/UnitTestLib/AssertCmocka.c | 68 + .../Library/UnitTestLib/RunTests.c | 23 +- .../Library/UnitTestLib/RunTestsCmocka.c | 33 +- .../UnitTestResultReportLib.c | 3 +- .../PrivateInclude/UnitTestFrameworkTypes.h | 1 + .../Sample/SampleUnitTest/SampleUnitTest.c | 510 +++ .../SampleUnitTest/SampleUnitTestDxe.inf | 3 + .../SampleUnitTest/SampleUnitTestHost.inf | 3 + .../SampleUnitTest/SampleUnitTestPei.inf | 3 + .../SampleUnitTest/SampleUnitTestSmm.inf | 3 + .../SampleUnitTestUefiShell.inf | 3 + .../Test/UnitTestFrameworkPkgHostTest.dsc | 5 +- UnitTestFrameworkPkg/UnitTestFrameworkPkg.dsc | 4 + .../UnitTestFrameworkPkgHost.dsc.inc | 11 +- .../UnitTestFrameworkPkgTarget.dsc.inc | 10 +- 43 files changed, 5374 insertions(+), 3689 deletions(-) create mode 100644 MdePkg/Library/BaseCacheMaintenanceLibNull/BaseCacheMaintenanceLibNull.c create mode 100644 MdePkg/Library/BaseCacheMaintenanceLibNull/BaseCacheMaintenanceLibNull.inf create mode 100644 MdePkg/Library/BaseCacheMaintenanceLibNull/BaseCacheMaintenanceLibNull.uni create mode 100644 MdePkg/Library/BaseCpuLibNull/BaseCpuLibNull.c create mode 100644 MdePkg/Library/BaseCpuLibNull/BaseCpuLibNull.inf create mode 100644 MdePkg/Library/BaseCpuLibNull/BaseCpuLibNull.uni copy MdePkg/Library/BaseLib/Ia32/{GccInline.c => GccInlinePriv.c} (62%) create mode 100644 MdePkg/Library/BaseLib/UnitTestHost.c create mode 100644 MdePkg/Library/BaseLib/UnitTestHost.h create mode 100644 MdePkg/Library/BaseLib/UnitTestHostBaseLib.inf create mode 100644 MdePkg/Library/BaseLib/UnitTestHostBaseLib.uni copy MdePkg/Library/BaseLib/X64/{GccInline.c => GccInlinePriv.c} (65%) create mode 100644 MdePkg/Library/BaseLib/X86UnitTestHost.c create mode 100644 MdePkg/Test/UnitTest/Include/Library/UnitTestHostBaseLib.h create mode 100644 UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLib.c create mode 100644 UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLib.inf create mode 100644 UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLib.uni -- 2.21.0.windows.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#62581): https://edk2.groups.io/g/devel/message/62581 Mute This Topic: https://groups.io/mt/75432213/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
