UnitTestFrameworkPkg/UnitTestLib: Fix target mode log messages

REF: 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>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Bret Barkelew <Bret.Barkelew@microsoft.com>
This commit is contained in:
Michael D Kinney 2020-06-10 17:40:27 -07:00 committed by mergify[bot]
parent 77e42ca4df
commit 425df6923e

View File

@ -105,14 +105,14 @@ UnitTestAssertTrue (
if (!Expression) { if (!Expression) {
UnitTestLogFailure ( UnitTestLogFailure (
FAILURETYPE_ASSERTTRUE, FAILURETYPE_ASSERTTRUE,
"%a::%d Expression (%a) is not TRUE!\n", "%a:%d: Expression (%a) is not TRUE!\n",
FunctionName, FileName,
LineNumber, LineNumber,
Description Description
); );
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a::%d Expression (%a) is not TRUE!\n", "[ASSERT FAIL] %a:%d: Expression (%a) is not TRUE!\n",
FunctionName, FileName,
LineNumber, LineNumber,
Description Description
); );
@ -151,14 +151,14 @@ UnitTestAssertFalse (
if (Expression) { if (Expression) {
UnitTestLogFailure ( UnitTestLogFailure (
FAILURETYPE_ASSERTFALSE, FAILURETYPE_ASSERTFALSE,
"%a::%d Expression(%a) is not FALSE!\n", "%a:%d: Expression(%a) is not FALSE!\n",
FunctionName, FileName,
LineNumber, LineNumber,
Description Description
); );
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a::%d Expression (%a) is not FALSE!\n", "[ASSERT FAIL] %a:%d: Expression (%a) is not FALSE!\n",
FunctionName, FileName,
LineNumber, LineNumber,
Description Description
); );
@ -197,15 +197,15 @@ UnitTestAssertNotEfiError (
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
UnitTestLogFailure ( UnitTestLogFailure (
FAILURETYPE_ASSERTNOTEFIERROR, FAILURETYPE_ASSERTNOTEFIERROR,
"%a::%d Status '%a' is EFI_ERROR (%r)!\n", "%a:%d: Status '%a' is EFI_ERROR (%r)!\n",
FunctionName, FileName,
LineNumber, LineNumber,
Description, Description,
Status Status
); );
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a::%d Status '%a' is EFI_ERROR (%r)!\n", "[ASSERT FAIL] %a:%d: Status '%a' is EFI_ERROR (%r)!\n",
FunctionName, FileName,
LineNumber, LineNumber,
Description, Description,
Status Status
@ -250,8 +250,8 @@ UnitTestAssertEqual (
if (ValueA != ValueB) { if (ValueA != ValueB) {
UnitTestLogFailure ( UnitTestLogFailure (
FAILURETYPE_ASSERTEQUAL, FAILURETYPE_ASSERTEQUAL,
"%a::%d Value %a != %a (%d != %d)!\n", "%a:%d: Value %a != %a (%d != %d)!\n",
FunctionName, FileName,
LineNumber, LineNumber,
DescriptionA, DescriptionA,
DescriptionB, DescriptionB,
@ -259,8 +259,8 @@ UnitTestAssertEqual (
ValueB ValueB
); );
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a::%d Value %a != %a (%d != %d)!\n", "[ASSERT FAIL] %a:%d: Value %a != %a (%d != %d)!\n",
FunctionName, FileName,
LineNumber, LineNumber,
DescriptionA, DescriptionA,
DescriptionB, DescriptionB,
@ -312,16 +312,16 @@ UnitTestAssertMemEqual (
if (CompareMem(BufferA, BufferB, Length) != 0) { if (CompareMem(BufferA, BufferB, Length) != 0) {
UnitTestLogFailure ( UnitTestLogFailure (
FAILURETYPE_ASSERTEQUAL, FAILURETYPE_ASSERTEQUAL,
"%a::%d Memory at %a != %a for length %d bytes!\n", "%a:%d: Memory at %a != %a for length %d bytes!\n",
FunctionName, FileName,
LineNumber, LineNumber,
DescriptionA, DescriptionA,
DescriptionB, DescriptionB,
Length Length
); );
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a::%d Value %a != %a for length %d bytes!\n", "[ASSERT FAIL] %a:%d: Value %a != %a for length %d bytes!\n",
FunctionName, FileName,
LineNumber, LineNumber,
DescriptionA, DescriptionA,
DescriptionB, DescriptionB,
@ -368,8 +368,8 @@ UnitTestAssertNotEqual (
if (ValueA == ValueB) { if (ValueA == ValueB) {
UnitTestLogFailure ( UnitTestLogFailure (
FAILURETYPE_ASSERTNOTEQUAL, FAILURETYPE_ASSERTNOTEQUAL,
"%a::%d Value %a == %a (%d == %d)!\n", "%a:%d: Value %a == %a (%d == %d)!\n",
FunctionName, FileName,
LineNumber, LineNumber,
DescriptionA, DescriptionA,
DescriptionB, DescriptionB,
@ -377,8 +377,8 @@ UnitTestAssertNotEqual (
ValueB ValueB
); );
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a::%d Value %a == %a (%d == %d)!\n", "[ASSERT FAIL] %a:%d: Value %a == %a (%d == %d)!\n",
FunctionName, FileName,
LineNumber, LineNumber,
DescriptionA, DescriptionA,
DescriptionB, DescriptionB,
@ -423,16 +423,16 @@ UnitTestAssertStatusEqual (
if (Status != Expected) { if (Status != Expected) {
UnitTestLogFailure ( UnitTestLogFailure (
FAILURETYPE_ASSERTSTATUSEQUAL, FAILURETYPE_ASSERTSTATUSEQUAL,
"%a::%d Status '%a' is %r, should be %r!\n", "%a:%d: Status '%a' is %r, should be %r!\n",
FunctionName, FileName,
LineNumber, LineNumber,
Description, Description,
Status, Status,
Expected Expected
); );
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a::%d Status '%a' is %r, should be %r!\n", "[ASSERT FAIL] %a:%d: Status '%a' is %r, should be %r!\n",
FunctionName, FileName,
LineNumber, LineNumber,
Description, Description,
Status, Status,
@ -475,14 +475,14 @@ UnitTestAssertNotNull (
if (Pointer == NULL) { if (Pointer == NULL) {
UnitTestLogFailure ( UnitTestLogFailure (
FAILURETYPE_ASSERTNOTNULL, FAILURETYPE_ASSERTNOTNULL,
"%a::%d Pointer (%a) is NULL!\n", "%a:%d: Pointer (%a) is NULL!\n",
FunctionName, FileName,
LineNumber, LineNumber,
PointerName PointerName
); );
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a::%d Pointer (%a) is NULL!\n", "[ASSERT FAIL] %a:%d: Pointer (%a) is NULL!\n",
FunctionName, FileName,
LineNumber, LineNumber,
PointerName PointerName
); );