From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: devel@edk2.groups.io
Cc: Sean Brogan <sean.brogan@microsoft.com>,
Bret Barkelew <Bret.Barkelew@microsoft.com>,
Jiewen Yao <jiewen.yao@intel.com>
Subject: [Patch 11/15] UnitTestFrameworkPkg/UnitTestLib: Fix target mode log messages
Date: Sun, 14 Jun 2020 17:19:14 -0700 [thread overview]
Message-ID: <20200615001918.22164-12-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=2806
Update the log messages generated in target mode to use
FileName instead of FunctionName. FunctionName is an empty
string so the log messages generated do not provide enough
information to know the source of a unit test failure.
Using FileName combined with LineNumber provides the
right information to identify the location of a unit test
failure.
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>
---
.../Library/UnitTestLib/Assert.c | 64 +++++++++----------
1 file changed, 32 insertions(+), 32 deletions(-)
diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c b/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c
index c327ba88f1..8a131fab2b 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c
+++ b/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c
@@ -105,14 +105,14 @@ UnitTestAssertTrue (
if (!Expression) {
UnitTestLogFailure (
FAILURETYPE_ASSERTTRUE,
- "%a::%d Expression (%a) is not TRUE!\n",
- FunctionName,
+ "%a:%d: Expression (%a) is not TRUE!\n",
+ FileName,
LineNumber,
Description
);
UT_LOG_ERROR (
- "[ASSERT FAIL] %a::%d Expression (%a) is not TRUE!\n",
- FunctionName,
+ "[ASSERT FAIL] %a:%d: Expression (%a) is not TRUE!\n",
+ FileName,
LineNumber,
Description
);
@@ -151,14 +151,14 @@ UnitTestAssertFalse (
if (Expression) {
UnitTestLogFailure (
FAILURETYPE_ASSERTFALSE,
- "%a::%d Expression(%a) is not FALSE!\n",
- FunctionName,
+ "%a:%d: Expression(%a) is not FALSE!\n",
+ FileName,
LineNumber,
Description
);
UT_LOG_ERROR (
- "[ASSERT FAIL] %a::%d Expression (%a) is not FALSE!\n",
- FunctionName,
+ "[ASSERT FAIL] %a:%d: Expression (%a) is not FALSE!\n",
+ FileName,
LineNumber,
Description
);
@@ -197,15 +197,15 @@ UnitTestAssertNotEfiError (
if (EFI_ERROR (Status)) {
UnitTestLogFailure (
FAILURETYPE_ASSERTNOTEFIERROR,
- "%a::%d Status '%a' is EFI_ERROR (%r)!\n",
- FunctionName,
+ "%a:%d: Status '%a' is EFI_ERROR (%r)!\n",
+ FileName,
LineNumber,
Description,
Status
);
UT_LOG_ERROR (
- "[ASSERT FAIL] %a::%d Status '%a' is EFI_ERROR (%r)!\n",
- FunctionName,
+ "[ASSERT FAIL] %a:%d: Status '%a' is EFI_ERROR (%r)!\n",
+ FileName,
LineNumber,
Description,
Status
@@ -250,8 +250,8 @@ UnitTestAssertEqual (
if (ValueA != ValueB) {
UnitTestLogFailure (
FAILURETYPE_ASSERTEQUAL,
- "%a::%d Value %a != %a (%d != %d)!\n",
- FunctionName,
+ "%a:%d: Value %a != %a (%d != %d)!\n",
+ FileName,
LineNumber,
DescriptionA,
DescriptionB,
@@ -259,8 +259,8 @@ UnitTestAssertEqual (
ValueB
);
UT_LOG_ERROR (
- "[ASSERT FAIL] %a::%d Value %a != %a (%d != %d)!\n",
- FunctionName,
+ "[ASSERT FAIL] %a:%d: Value %a != %a (%d != %d)!\n",
+ FileName,
LineNumber,
DescriptionA,
DescriptionB,
@@ -312,16 +312,16 @@ UnitTestAssertMemEqual (
if (CompareMem(BufferA, BufferB, Length) != 0) {
UnitTestLogFailure (
FAILURETYPE_ASSERTEQUAL,
- "%a::%d Memory at %a != %a for length %d bytes!\n",
- FunctionName,
+ "%a:%d: Memory at %a != %a for length %d bytes!\n",
+ FileName,
LineNumber,
DescriptionA,
DescriptionB,
Length
);
UT_LOG_ERROR (
- "[ASSERT FAIL] %a::%d Value %a != %a for length %d bytes!\n",
- FunctionName,
+ "[ASSERT FAIL] %a:%d: Value %a != %a for length %d bytes!\n",
+ FileName,
LineNumber,
DescriptionA,
DescriptionB,
@@ -368,8 +368,8 @@ UnitTestAssertNotEqual (
if (ValueA == ValueB) {
UnitTestLogFailure (
FAILURETYPE_ASSERTNOTEQUAL,
- "%a::%d Value %a == %a (%d == %d)!\n",
- FunctionName,
+ "%a:%d: Value %a == %a (%d == %d)!\n",
+ FileName,
LineNumber,
DescriptionA,
DescriptionB,
@@ -377,8 +377,8 @@ UnitTestAssertNotEqual (
ValueB
);
UT_LOG_ERROR (
- "[ASSERT FAIL] %a::%d Value %a == %a (%d == %d)!\n",
- FunctionName,
+ "[ASSERT FAIL] %a:%d: Value %a == %a (%d == %d)!\n",
+ FileName,
LineNumber,
DescriptionA,
DescriptionB,
@@ -423,16 +423,16 @@ UnitTestAssertStatusEqual (
if (Status != Expected) {
UnitTestLogFailure (
FAILURETYPE_ASSERTSTATUSEQUAL,
- "%a::%d Status '%a' is %r, should be %r!\n",
- FunctionName,
+ "%a:%d: Status '%a' is %r, should be %r!\n",
+ FileName,
LineNumber,
Description,
Status,
Expected
);
UT_LOG_ERROR (
- "[ASSERT FAIL] %a::%d Status '%a' is %r, should be %r!\n",
- FunctionName,
+ "[ASSERT FAIL] %a:%d: Status '%a' is %r, should be %r!\n",
+ FileName,
LineNumber,
Description,
Status,
@@ -475,14 +475,14 @@ UnitTestAssertNotNull (
if (Pointer == NULL) {
UnitTestLogFailure (
FAILURETYPE_ASSERTNOTNULL,
- "%a::%d Pointer (%a) is NULL!\n",
- FunctionName,
+ "%a:%d: Pointer (%a) is NULL!\n",
+ FileName,
LineNumber,
PointerName
);
UT_LOG_ERROR (
- "[ASSERT FAIL] %a::%d Pointer (%a) is NULL!\n",
- FunctionName,
+ "[ASSERT FAIL] %a:%d: Pointer (%a) is NULL!\n",
+ FileName,
LineNumber,
PointerName
);
--
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 ` Michael D Kinney [this message]
2020-06-15 0:19 ` [Patch 12/15] UnitTestFrameworkPkg/UnitTestLib: Add checks for ASSERT() Michael D Kinney
2020-06-15 0:19 ` [Patch 13/15] MdePkg/Include: Hook DebugLib _ASSERT() for unit tests Michael D Kinney
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-12-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