From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: devel@edk2.groups.io
Cc: Liming Gao <liming.gao@intel.com>,
Sean Brogan <sean.brogan@microsoft.com>,
Bret Barkelew <Bret.Barkelew@microsoft.com>,
Jiewen Yao <jiewen.yao@intel.com>
Subject: [Patch 13/15] MdePkg/Include: Hook DebugLib _ASSERT() for unit tests
Date: Sun, 14 Jun 2020 17:19:16 -0700 [thread overview]
Message-ID: <20200615001918.22164-14-michael.d.kinney@intel.com> (raw)
In-Reply-To: <20200615001918.22164-1-michael.d.kinney@intel.com>
https://bugzilla.tianocore.org/show_bug.cgi?id=2801
Update DebugLib.h _ASSERT() macro to check if unit testing
is enabled and call UnitTestDebugAssert() instead of
DebugAssert() so the an ASSERT() condition that is triggered
by a function under test can be handled by the Unit Test
Framework.
If EDKII_UNIT_TEST_FRAMEWORK_ENABLED is not defined, then
the existing DebugLib behavior is preserved.
Cc: Liming Gao <liming.gao@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
---
MdePkg/Include/Library/DebugLib.h | 28 +++++++++++++++++++++++++++-
1 file changed, 27 insertions(+), 1 deletion(-)
diff --git a/MdePkg/Include/Library/DebugLib.h b/MdePkg/Include/Library/DebugLib.h
index baab34bf05..4cacd4b8e2 100644
--- a/MdePkg/Include/Library/DebugLib.h
+++ b/MdePkg/Include/Library/DebugLib.h
@@ -289,12 +289,38 @@ DebugPrintLevelEnabled (
@param Expression Boolean expression that evaluated to FALSE
**/
+#if defined (EDKII_UNIT_TEST_FRAMEWORK_ENABLED)
+/**
+ Unit test library replacement for DebugAssert() in DebugLib.
+
+ If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
+ If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
+
+ @param FileName The pointer to the name of the source file that generated the assert condition.
+ @param LineNumber The line number in the source file that generated the assert condition
+ @param Description The pointer to the description of the assert condition.
+
+**/
+VOID
+EFIAPI
+UnitTestDebugAssert (
+ IN CONST CHAR8 *FileName,
+ IN UINTN LineNumber,
+ IN CONST CHAR8 *Description
+ );
+
+#if defined(__clang__) && defined(__FILE_NAME__)
+#define _ASSERT(Expression) UnitTestDebugAssert (__FILE_NAME__, __LINE__, #Expression)
+#else
+#define _ASSERT(Expression) UnitTestDebugAssert (__FILE__, __LINE__, #Expression)
+#endif
+#else
#if defined(__clang__) && defined(__FILE_NAME__)
#define _ASSERT(Expression) DebugAssert (__FILE_NAME__, __LINE__, #Expression)
#else
#define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)
#endif
-
+#endif
/**
Internal worker macro that calls DebugPrint().
--
2.21.0.windows.1
next prev parent reply other threads:[~2020-06-15 0:19 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-15 0:19 [Patch 00/15] UnitTestFrameworkPkg: Enhancements and bug fixes Michael D Kinney
2020-06-15 0:19 ` [Patch 01/15] BaseTools/Python: Allow HOST_APPLICATION to use NULL libraries Michael D Kinney
2020-06-15 6:22 ` [edk2-devel] " Yuwei Chen
2020-06-15 0:19 ` [Patch 02/15] MdePkg/BaseCpuLibNull: Add Null version of CpuLib for host testing Michael D Kinney
2020-07-09 14:03 ` Liming Gao
2020-06-15 0:19 ` [Patch 03/15] MdePkg/BaseCacheMaintenanceLibNull: Add Null instance " Michael D Kinney
2020-07-09 14:03 ` Liming Gao
2020-06-15 0:19 ` [Patch 04/15] MdePkg/BaseLib: Break out IA32/X64 GCC inline privileged functions Michael D Kinney
2020-07-09 14:07 ` Liming Gao
2020-07-09 17:00 ` Michael D Kinney
2020-07-10 8:06 ` Liming Gao
2020-07-10 16:24 ` Michael D Kinney
2020-06-15 0:19 ` [Patch 05/15] MdePkg/Library/BaseLib: Add BaseLib instance for host based unit tests Michael D Kinney
2020-06-15 0:19 ` [Patch 06/15] UnitTestFrameworkPkg: Use host libraries from MdePkg Michael D Kinney
2020-06-15 0:19 ` [Patch 07/15] UnitTestFrameworkPkg: Enable source level debug for host tests Michael D Kinney
2020-06-15 0:19 ` [Patch 08/15] UnitTestFrameworkPkg: Set host application stack size to 256KB Michael D Kinney
2020-06-15 0:19 ` [Patch 09/15] UnitTestFrameworkPkg: Change target mode DebugLib mapping Michael D Kinney
2020-06-15 0:19 ` [Patch 10/15] UnitTestFrameworkPkg/UnitTestLib: Move print log into cleanup Michael D Kinney
2020-06-15 0:19 ` [Patch 11/15] UnitTestFrameworkPkg/UnitTestLib: Fix target mode log messages Michael D Kinney
2020-06-15 0:19 ` [Patch 12/15] UnitTestFrameworkPkg/UnitTestLib: Add checks for ASSERT() Michael D Kinney
2020-06-15 0:19 ` Michael D Kinney [this message]
2020-06-15 0:19 ` [Patch 14/15] MdePkg/Include: Add UT_EXPECT_ASSERT_FAILURE() to UnitTestLib Michael D Kinney
2020-06-15 0:19 ` [Patch 15/15] UnitTestFramewokPkg/SampleUnitTest: Use UT_EXPECT_ASSERT_FAILURE() 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=20200615001918.22164-14-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