tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

UnitTestFrameworkPkg: Apply uncrustify changes 

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3737

Apply uncrustify changes to .c/.h files in the UnitTestFrameworkPkg package

Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>
This commit is contained in:
Michael Kubacki 2021-12-05 14:54:19 -08:00 committed by mergify[bot]
parent e5efcf8be8
commit 7c0ad2c338
18 changed files with 368 additions and 309 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLibPosix.c
View File

@ -68,9 +68,9 @@ DebugPrint (
VOID VOID
EFIAPI EFIAPI
DebugVPrint ( DebugVPrint (
IN UINTN ErrorLevel, IN UINTN ErrorLevel,
IN CONST CHAR8 *Format, IN CONST CHAR8 *Format,
IN VA_LIST VaListMarker IN VA_LIST VaListMarker
) )
{ {
CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH]; CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
@ -99,9 +99,9 @@ DebugVPrint (
VOID VOID
EFIAPI EFIAPI
DebugBPrint ( DebugBPrint (
IN UINTN ErrorLevel, IN UINTN ErrorLevel,
IN CONST CHAR8 *Format, IN CONST CHAR8 *Format,
IN BASE_LIST BaseListMarker IN BASE_LIST BaseListMarker
) )
{ {
CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH]; CHAR8 Buffer[MAX_DEBUG_MESSAGE_LENGTH];
@ -144,9 +144,9 @@ DebugAssert (
// //
// Generate a Breakpoint, DeadLoop, or NOP based on PCD settings // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
// //
if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) { if ((PcdGet8 (PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
CpuBreakpoint (); CpuBreakpoint ();
} else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) { } else if ((PcdGet8 (PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
CpuDeadLoop (); CpuDeadLoop ();
} }
} }
@ -181,7 +181,7 @@ DebugClearMemory (
// //
// SetMem() checks for the the ASSERT() condition on Length and returns Buffer // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
// //
return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue)); return SetMem (Buffer, Length, PcdGet8 (PcdDebugClearMemoryValue));
} }
/** /**
@ -200,7 +200,7 @@ DebugAssertEnabled (
VOID VOID
) )
{ {
return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0); return (BOOLEAN)((PcdGet8 (PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
} }
/** /**
@ -219,7 +219,7 @@ DebugPrintEnabled (
VOID VOID
) )
{ {
return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0); return (BOOLEAN)((PcdGet8 (PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
} }
/** /**
@ -238,7 +238,7 @@ DebugCodeEnabled (
VOID VOID
) )
{ {
return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0); return (BOOLEAN)((PcdGet8 (PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
} }
/** /**
@ -257,7 +257,7 @@ DebugClearMemoryEnabled (
VOID VOID
) )
{ {
return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0); return (BOOLEAN)((PcdGet8 (PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
} }
/** /**
@ -272,8 +272,8 @@ DebugClearMemoryEnabled (
BOOLEAN BOOLEAN
EFIAPI EFIAPI
DebugPrintLevelEnabled ( DebugPrintLevelEnabled (
IN CONST UINTN ErrorLevel IN CONST UINTN ErrorLevel
) )
{ {
return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0); return (BOOLEAN)((ErrorLevel & PcdGet32 (PcdFixedDebugPrintErrorLevel)) != 0);
} }

39
UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c
View File

@ -26,11 +26,11 @@
/// aligned allocation. /// aligned allocation.
/// ///
typedef struct { typedef struct {
UINT32 Signature; UINT32 Signature;
VOID *AllocatedBufffer; VOID *AllocatedBufffer;
UINTN TotalPages; UINTN TotalPages;
VOID *AlignedBuffer; VOID *AlignedBuffer;
UINTN AlignedPages; UINTN AlignedPages;
} PAGE_HEAD; } PAGE_HEAD;
/** /**
@ -159,25 +159,27 @@ AllocateAlignedPages (
if (Alignment < SIZE_4KB) { if (Alignment < SIZE_4KB) {
Alignment = SIZE_4KB; Alignment = SIZE_4KB;
} }
AlignmentMask = Alignment - 1;
AlignmentMask = Alignment - 1;
// //
// We need reserve Alignment pages for PAGE_HEAD, as meta data. // We need reserve Alignment pages for PAGE_HEAD, as meta data.
// //
PageHead.Signature = PAGE_HEAD_PRIVATE_SIGNATURE; PageHead.Signature = PAGE_HEAD_PRIVATE_SIGNATURE;
PageHead.TotalPages = Pages + EFI_SIZE_TO_PAGES (Alignment) * 2; PageHead.TotalPages = Pages + EFI_SIZE_TO_PAGES (Alignment) * 2;
PageHead.AlignedPages = Pages; PageHead.AlignedPages = Pages;
PageHead.AllocatedBufffer = malloc (EFI_PAGES_TO_SIZE (PageHead.TotalPages)); PageHead.AllocatedBufffer = malloc (EFI_PAGES_TO_SIZE (PageHead.TotalPages));
if (PageHead.AllocatedBufffer == NULL) { if (PageHead.AllocatedBufffer == NULL) {
return NULL; return NULL;
} }
PageHead.AlignedBuffer = (VOID *)(((UINTN) PageHead.AllocatedBufffer + AlignmentMask) & ~AlignmentMask);
if ((UINTN)PageHead.AlignedBuffer - (UINTN)PageHead.AllocatedBufffer < sizeof(PAGE_HEAD)) { PageHead.AlignedBuffer = (VOID *)(((UINTN)PageHead.AllocatedBufffer + AlignmentMask) & ~AlignmentMask);
if ((UINTN)PageHead.AlignedBuffer - (UINTN)PageHead.AllocatedBufffer < sizeof (PAGE_HEAD)) {
PageHead.AlignedBuffer = (VOID *)((UINTN)PageHead.AlignedBuffer + Alignment); PageHead.AlignedBuffer = (VOID *)((UINTN)PageHead.AlignedBuffer + Alignment);
} }
PageHeadPtr = (VOID *)((UINTN)PageHead.AlignedBuffer - sizeof(PAGE_HEAD)); PageHeadPtr = (VOID *)((UINTN)PageHead.AlignedBuffer - sizeof (PAGE_HEAD));
memcpy (PageHeadPtr, &PageHead, sizeof(PAGE_HEAD)); memcpy (PageHeadPtr, &PageHead, sizeof (PAGE_HEAD));
return PageHead.AlignedBuffer; return PageHead.AlignedBuffer;
} }
@ -267,10 +269,11 @@ FreeAlignedPages (
// //
// NOTE: Partial free is not supported. Just keep it. // NOTE: Partial free is not supported. Just keep it.
// //
PageHeadPtr = (VOID *)((UINTN)Buffer - sizeof(PAGE_HEAD)); PageHeadPtr = (VOID *)((UINTN)Buffer - sizeof (PAGE_HEAD));
if (PageHeadPtr->Signature != PAGE_HEAD_PRIVATE_SIGNATURE) { if (PageHeadPtr->Signature != PAGE_HEAD_PRIVATE_SIGNATURE) {
return; return;
} }
if (PageHeadPtr->AlignedPages != Pages) { if (PageHeadPtr->AlignedPages != Pages) {
return; return;
} }
@ -366,6 +369,7 @@ AllocateZeroPool (
if (Buffer == NULL) { if (Buffer == NULL) {
return NULL; return NULL;
} }
memset (Buffer, 0, AllocationSize); memset (Buffer, 0, AllocationSize);
return Buffer; return Buffer;
} }
@ -444,6 +448,7 @@ AllocateCopyPool (
if (Memory == NULL) { if (Memory == NULL) {
return NULL; return NULL;
} }
memcpy (Memory, Buffer, AllocationSize); memcpy (Memory, Buffer, AllocationSize);
return Memory; return Memory;
} }
@ -534,12 +539,14 @@ ReallocatePool (
VOID *NewBuffer; VOID *NewBuffer;
NewBuffer = malloc (NewSize); NewBuffer = malloc (NewSize);
if (NewBuffer != NULL && OldBuffer != NULL) { if ((NewBuffer != NULL) && (OldBuffer != NULL)) {
memcpy (NewBuffer, OldBuffer, MIN (OldSize, NewSize)); memcpy (NewBuffer, OldBuffer, MIN (OldSize, NewSize));
} }
if (OldBuffer != NULL) { if (OldBuffer != NULL) {
FreePool(OldBuffer); FreePool (OldBuffer);
} }
return NewBuffer; return NewBuffer;
} }

2
UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c
View File

@ -18,7 +18,7 @@
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
SetBootNextDevice( SetBootNextDevice (
VOID VOID
) )
{ {

19
UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c
View File

@ -26,7 +26,7 @@
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
SetBootNextDevice ( SetBootNextDevice (
VOID VOID
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
@ -47,8 +47,8 @@ SetBootNextDevice (
Dp = NULL; Dp = NULL;
NewOptionValid = FALSE; NewOptionValid = FALSE;
UsbDp.Header.Length[0] = (UINT8)(sizeof(USB_CLASS_DEVICE_PATH) & 0xff); UsbDp.Header.Length[0] = (UINT8)(sizeof (USB_CLASS_DEVICE_PATH) & 0xff);
UsbDp.Header.Length[1] = (UINT8)(sizeof(USB_CLASS_DEVICE_PATH) >> 8); UsbDp.Header.Length[1] = (UINT8)(sizeof (USB_CLASS_DEVICE_PATH) >> 8);
UsbDp.Header.Type = MESSAGING_DEVICE_PATH; UsbDp.Header.Type = MESSAGING_DEVICE_PATH;
UsbDp.Header.SubType = MSG_USB_CLASS_DP; UsbDp.Header.SubType = MSG_USB_CLASS_DP;
UsbDp.VendorId = 0xFFFF; UsbDp.VendorId = 0xFFFF;
@ -66,20 +66,20 @@ SetBootNextDevice (
goto CLEANUP; goto CLEANUP;
} }
//@MRT --- Is this memory leak because we lose the old Dp memory // @MRT --- Is this memory leak because we lose the old Dp memory
Dp = AppendDevicePathNode ( Dp = AppendDevicePathNode (
DpEnd, DpEnd,
(EFI_DEVICE_PATH_PROTOCOL *)&UsbDp (EFI_DEVICE_PATH_PROTOCOL *)&UsbDp
); );
if (Dp == NULL) { if (Dp == NULL) {
DEBUG((DEBUG_ERROR, "%a: Unable to create device path. Dp is NULL.\n", __FUNCTION__)); DEBUG ((DEBUG_ERROR, "%a: Unable to create device path. Dp is NULL.\n", __FUNCTION__));
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
goto CLEANUP; goto CLEANUP;
} }
Status = EfiBootManagerInitializeLoadOption ( Status = EfiBootManagerInitializeLoadOption (
&NewOption, &NewOption,
(UINTN) BootNextValue, (UINTN)BootNextValue,
LoadOptionTypeBoot, LoadOptionTypeBoot,
Attributes, Attributes,
L"Generic USB Class Device", L"Generic USB Class Device",
@ -107,21 +107,24 @@ SetBootNextDevice (
L"BootNext", L"BootNext",
&gEfiGlobalVariableGuid, &gEfiGlobalVariableGuid,
(EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE), (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE),
sizeof(BootNextValue), sizeof (BootNextValue),
&(BootNextValue) &(BootNextValue)
); );
DEBUG((DEBUG_VERBOSE, "%a - Set BootNext Status (%r)\n", __FUNCTION__, Status)); DEBUG ((DEBUG_VERBOSE, "%a - Set BootNext Status (%r)\n", __FUNCTION__, Status));
CLEANUP: CLEANUP:
if (Dp != NULL) { if (Dp != NULL) {
FreePool (Dp); FreePool (Dp);
} }
if (DpEnd != NULL) { if (DpEnd != NULL) {
FreePool (DpEnd); FreePool (DpEnd);
} }
if (NewOptionValid) { if (NewOptionValid) {
EfiBootManagerFreeLoadOption (&NewOption); EfiBootManagerFreeLoadOption (&NewOption);
} }
return Status; return Status;
} }

6
UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLib.c
View File

@ -41,9 +41,9 @@ UnitTestDebugAssert (
UT_LOG_INFO ("Detected expected ASSERT: %a(%d): %a\n", FileName, LineNumber, Description); UT_LOG_INFO ("Detected expected ASSERT: %a(%d): %a\n", FileName, LineNumber, Description);
LongJump (gUnitTestExpectAssertFailureJumpBuffer, 1); LongJump (gUnitTestExpectAssertFailureJumpBuffer, 1);
} else { } else {
AsciiStrCpyS (Message, sizeof(Message), "Detected unexpected ASSERT("); AsciiStrCpyS (Message, sizeof (Message), "Detected unexpected ASSERT(");
AsciiStrCatS (Message, sizeof(Message), Description); AsciiStrCatS (Message, sizeof (Message), Description);
AsciiStrCatS (Message, sizeof(Message), ")"); AsciiStrCatS (Message, sizeof (Message), ")");
UnitTestAssertTrue (FALSE, "", LineNumber, FileName, Message); UnitTestAssertTrue (FALSE, "", LineNumber, FileName, Message);
} }
} }

18
UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c
View File

@ -26,7 +26,7 @@ AddUnitTestFailure (
// //
// Make sure that you're cooking with gas. // Make sure that you're cooking with gas.
// //
if (UnitTest == NULL || FailureMessage == NULL) { if ((UnitTest == NULL) || (FailureMessage == NULL)) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
@ -120,6 +120,7 @@ UnitTestAssertTrue (
Description Description
); );
} }
return Expression; return Expression;
} }
@ -166,6 +167,7 @@ UnitTestAssertFalse (
Description Description
); );
} }
return !Expression; return !Expression;
} }
@ -214,7 +216,8 @@ UnitTestAssertNotEfiError (
Status Status
); );
} }
return !EFI_ERROR( Status );
return !EFI_ERROR (Status);
} }
/** /**
@ -271,6 +274,7 @@ UnitTestAssertEqual (
ValueB ValueB
); );
} }
return (ValueA == ValueB); return (ValueA == ValueB);
} }
@ -312,7 +316,7 @@ UnitTestAssertMemEqual (
IN CONST CHAR8 *DescriptionB IN CONST CHAR8 *DescriptionB
) )
{ {
if (CompareMem(BufferA, BufferB, Length) != 0) { if (CompareMem (BufferA, BufferB, Length) != 0) {
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",
FileName, FileName,
@ -332,6 +336,7 @@ UnitTestAssertMemEqual (
); );
return FALSE; return FALSE;
} }
return TRUE; return TRUE;
} }
@ -389,6 +394,7 @@ UnitTestAssertNotEqual (
ValueB ValueB
); );
} }
return (ValueA != ValueB); return (ValueA != ValueB);
} }
@ -442,6 +448,7 @@ UnitTestAssertStatusEqual (
Expected Expected
); );
} }
return (Status == Expected); return (Status == Expected);
} }
@ -490,6 +497,7 @@ UnitTestAssertNotNull (
PointerName PointerName
); );
} }
return (Pointer != NULL); return (Pointer != NULL);
} }
@ -536,6 +544,7 @@ UnitTestExpectAssertFailure (
if (ResultStatus != NULL) { if (ResultStatus != NULL) {
*ResultStatus = UnitTestStatus; *ResultStatus = UnitTestStatus;
} }
if (UnitTestStatus == UNIT_TEST_PASSED) { if (UnitTestStatus == UNIT_TEST_PASSED) {
UT_LOG_INFO ( UT_LOG_INFO (
"[ASSERT PASS] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) detected expected assert\n", "[ASSERT PASS] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) detected expected assert\n",
@ -544,6 +553,7 @@ UnitTestExpectAssertFailure (
FunctionCall FunctionCall
); );
} }
if (UnitTestStatus == UNIT_TEST_SKIPPED) { if (UnitTestStatus == UNIT_TEST_SKIPPED) {
UT_LOG_WARNING ( UT_LOG_WARNING (
"[ASSERT WARN] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) disabled\n", "[ASSERT WARN] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) disabled\n",
@ -552,6 +562,7 @@ UnitTestExpectAssertFailure (
FunctionCall FunctionCall
); );
} }
if (UnitTestStatus == UNIT_TEST_ERROR_TEST_FAILED) { if (UnitTestStatus == UNIT_TEST_ERROR_TEST_FAILED) {
UT_LOG_ERROR ( UT_LOG_ERROR (
"[ASSERT FAIL] %a:%d: Function call (%a) did not ASSERT()!\n", "[ASSERT FAIL] %a:%d: Function call (%a) did not ASSERT()!\n",
@ -567,5 +578,6 @@ UnitTestExpectAssertFailure (
FunctionCall FunctionCall
); );
} }
return (UnitTestStatus != UNIT_TEST_ERROR_TEST_FAILED); return (UnitTestStatus != UNIT_TEST_ERROR_TEST_FAILED);
} }

24
UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c
View File

@ -48,7 +48,7 @@ UnitTestAssertTrue (
{ {
CHAR8 TempStr[MAX_STRING_SIZE]; CHAR8 TempStr[MAX_STRING_SIZE];
snprintf (TempStr, sizeof(TempStr), "UT_ASSERT_TRUE(%s:%x)", Description, Expression); snprintf (TempStr, sizeof (TempStr), "UT_ASSERT_TRUE(%s:%x)", Description, Expression);
_assert_true (Expression, TempStr, FileName, (INT32)LineNumber); _assert_true (Expression, TempStr, FileName, (INT32)LineNumber);
return Expression; return Expression;
@ -84,7 +84,7 @@ UnitTestAssertFalse (
{ {
CHAR8 TempStr[MAX_STRING_SIZE]; CHAR8 TempStr[MAX_STRING_SIZE];
snprintf (TempStr, sizeof(TempStr), "UT_ASSERT_FALSE(%s:%x)", Description, Expression); snprintf (TempStr, sizeof (TempStr), "UT_ASSERT_FALSE(%s:%x)", Description, Expression);
_assert_true (!Expression, TempStr, FileName, (INT32)LineNumber); _assert_true (!Expression, TempStr, FileName, (INT32)LineNumber);
return !Expression; return !Expression;
@ -120,7 +120,7 @@ UnitTestAssertNotEfiError (
{ {
CHAR8 TempStr[MAX_STRING_SIZE]; CHAR8 TempStr[MAX_STRING_SIZE];
snprintf (TempStr, sizeof(TempStr), "UT_ASSERT_NOT_EFI_ERROR(%s:%p)", Description, (void *)Status); snprintf (TempStr, sizeof (TempStr), "UT_ASSERT_NOT_EFI_ERROR(%s:%p)", Description, (void *)Status);
_assert_true (!EFI_ERROR (Status), TempStr, FileName, (INT32)LineNumber); _assert_true (!EFI_ERROR (Status), TempStr, FileName, (INT32)LineNumber);
return !EFI_ERROR (Status); return !EFI_ERROR (Status);
@ -161,7 +161,7 @@ UnitTestAssertEqual (
{ {
CHAR8 TempStr[MAX_STRING_SIZE]; CHAR8 TempStr[MAX_STRING_SIZE];
snprintf (TempStr, sizeof(TempStr), "UT_ASSERT_EQUAL(%s:%llx, %s:%llx)", DescriptionA, ValueA, DescriptionB, ValueB); snprintf (TempStr, sizeof (TempStr), "UT_ASSERT_EQUAL(%s:%llx, %s:%llx)", DescriptionA, ValueA, DescriptionB, ValueB);
_assert_true ((ValueA == ValueB), TempStr, FileName, (INT32)LineNumber); _assert_true ((ValueA == ValueB), TempStr, FileName, (INT32)LineNumber);
return (ValueA == ValueB); return (ValueA == ValueB);
@ -208,9 +208,9 @@ UnitTestAssertMemEqual (
CHAR8 TempStr[MAX_STRING_SIZE]; CHAR8 TempStr[MAX_STRING_SIZE];
BOOLEAN Result; BOOLEAN Result;
Result = (CompareMem(BufferA, BufferB, Length) == 0); Result = (CompareMem (BufferA, BufferB, Length) == 0);
snprintf (TempStr, sizeof(TempStr), "UT_ASSERT_MEM_EQUAL(%s:%p, %s:%p)", DescriptionA, BufferA, DescriptionB, BufferB); snprintf (TempStr, sizeof (TempStr), "UT_ASSERT_MEM_EQUAL(%s:%p, %s:%p)", DescriptionA, BufferA, DescriptionB, BufferB);
_assert_true (Result, TempStr, FileName, (INT32)LineNumber); _assert_true (Result, TempStr, FileName, (INT32)LineNumber);
return Result; return Result;
@ -251,7 +251,7 @@ UnitTestAssertNotEqual (
{ {
CHAR8 TempStr[MAX_STRING_SIZE]; CHAR8 TempStr[MAX_STRING_SIZE];
snprintf (TempStr, sizeof(TempStr), "UT_ASSERT_NOT_EQUAL(%s:%llx, %s:%llx)", DescriptionA, ValueA, DescriptionB, ValueB); snprintf (TempStr, sizeof (TempStr), "UT_ASSERT_NOT_EQUAL(%s:%llx, %s:%llx)", DescriptionA, ValueA, DescriptionB, ValueB);
_assert_true ((ValueA != ValueB), TempStr, FileName, (INT32)LineNumber); _assert_true ((ValueA != ValueB), TempStr, FileName, (INT32)LineNumber);
return (ValueA != ValueB); return (ValueA != ValueB);
@ -290,7 +290,7 @@ UnitTestAssertStatusEqual (
{ {
CHAR8 TempStr[MAX_STRING_SIZE]; CHAR8 TempStr[MAX_STRING_SIZE];
snprintf (TempStr, sizeof(TempStr), "UT_ASSERT_STATUS_EQUAL(%s:%p)", Description, (VOID *)Status); snprintf (TempStr, sizeof (TempStr), "UT_ASSERT_STATUS_EQUAL(%s:%p)", Description, (VOID *)Status);
_assert_true ((Status == Expected), TempStr, FileName, (INT32)LineNumber); _assert_true ((Status == Expected), TempStr, FileName, (INT32)LineNumber);
return (Status == Expected); return (Status == Expected);
@ -328,7 +328,7 @@ UnitTestAssertNotNull (
{ {
CHAR8 TempStr[MAX_STRING_SIZE]; CHAR8 TempStr[MAX_STRING_SIZE];
snprintf (TempStr, sizeof(TempStr), "UT_ASSERT_NOT_NULL(%s:%p)", PointerName, Pointer); snprintf (TempStr, sizeof (TempStr), "UT_ASSERT_NOT_NULL(%s:%p)", PointerName, Pointer);
_assert_true ((Pointer != NULL), TempStr, FileName, (INT32)LineNumber); _assert_true ((Pointer != NULL), TempStr, FileName, (INT32)LineNumber);
return (Pointer != NULL); return (Pointer != NULL);
@ -379,6 +379,7 @@ UnitTestExpectAssertFailure (
if (ResultStatus != NULL) { if (ResultStatus != NULL) {
*ResultStatus = UnitTestStatus; *ResultStatus = UnitTestStatus;
} }
if (UnitTestStatus == UNIT_TEST_PASSED) { if (UnitTestStatus == UNIT_TEST_PASSED) {
UT_LOG_INFO ( UT_LOG_INFO (
"[ASSERT PASS] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) detected expected assert\n", "[ASSERT PASS] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) detected expected assert\n",
@ -387,6 +388,7 @@ UnitTestExpectAssertFailure (
FunctionCall FunctionCall
); );
} }
if (UnitTestStatus == UNIT_TEST_SKIPPED) { if (UnitTestStatus == UNIT_TEST_SKIPPED) {
UT_LOG_WARNING ( UT_LOG_WARNING (
"[ASSERT WARN] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) disabled\n", "[ASSERT WARN] %a:%d: UT_EXPECT_ASSERT_FAILURE(%a) disabled\n",
@ -395,9 +397,11 @@ UnitTestExpectAssertFailure (
FunctionCall FunctionCall
); );
} }
if (UnitTestStatus == UNIT_TEST_ERROR_TEST_FAILED) { if (UnitTestStatus == UNIT_TEST_ERROR_TEST_FAILED) {
snprintf (TempStr, sizeof(TempStr), "UT_EXPECT_ASSERT_FAILURE(%s) did not trigger ASSERT()", FunctionCall); snprintf (TempStr, sizeof (TempStr), "UT_EXPECT_ASSERT_FAILURE(%s) did not trigger ASSERT()", FunctionCall);
_assert_true (FALSE, TempStr, FileName, (INT32)LineNumber); _assert_true (FALSE, TempStr, FileName, (INT32)LineNumber);
} }
return (UnitTestStatus != UNIT_TEST_ERROR_TEST_FAILED); return (UnitTestStatus != UNIT_TEST_ERROR_TEST_FAILED);
} }

17
UnitTestFrameworkPkg/Library/UnitTestLib/Log.c
View File

@ -19,8 +19,8 @@
#define UNIT_TEST_MAX_LOG_BUFFER SIZE_16KB #define UNIT_TEST_MAX_LOG_BUFFER SIZE_16KB
struct _UNIT_TEST_LOG_PREFIX_STRING { struct _UNIT_TEST_LOG_PREFIX_STRING {
UNIT_TEST_STATUS LogLevel; UNIT_TEST_STATUS LogLevel;
CHAR8 *String; CHAR8 *String;
}; };
struct _UNIT_TEST_LOG_PREFIX_STRING mLogPrefixStrings[] = { struct _UNIT_TEST_LOG_PREFIX_STRING mLogPrefixStrings[] = {
@ -35,7 +35,7 @@ struct _UNIT_TEST_LOG_PREFIX_STRING mLogPrefixStrings[] = {
// //
STATIC STATIC
CONST CHAR8* CONST CHAR8 *
GetStringForStatusLogPrefix ( GetStringForStatusLogPrefix (
IN UINTN LogLevel IN UINTN LogLevel
) )
@ -50,6 +50,7 @@ GetStringForStatusLogPrefix (
break; break;
} }
} }
return Result; return Result;
} }
@ -65,7 +66,7 @@ AddStringToUnitTestLog (
// //
// Make sure that you're cooking with gas. // Make sure that you're cooking with gas.
// //
if (UnitTest == NULL || String == NULL) { if ((UnitTest == NULL) || (String == NULL)) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
@ -86,7 +87,7 @@ AddStringToUnitTestLog (
String, String,
UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH
); );
if(EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Failed to add unit test log string. Status = %r\n", Status)); DEBUG ((DEBUG_ERROR, "Failed to add unit test log string. Status = %r\n", Status));
return Status; return Status;
} }
@ -129,14 +130,14 @@ UnitTestLogInit (
} }
// //
//check again to make sure allocate worked // check again to make sure allocate worked
// //
if(Test->Log == NULL) { if (Test->Log == NULL) {
DEBUG ((DEBUG_ERROR, "Failed to allocate memory for the log\n")); DEBUG ((DEBUG_ERROR, "Failed to allocate memory for the log\n"));
return; return;
} }
if((Buffer != NULL) && (BufferSize > 0) && (BufferSize <= UNIT_TEST_MAX_LOG_BUFFER)) { if ((Buffer != NULL) && (BufferSize > 0) && (BufferSize <= UNIT_TEST_MAX_LOG_BUFFER)) {
CopyMem (Test->Log, Buffer, BufferSize); CopyMem (Test->Log, Buffer, BufferSize);
} }
} }

22
UnitTestFrameworkPkg/Library/UnitTestLib/RunTests.c
View File

@ -54,8 +54,9 @@ RunTestSuite (
// Iterate all tests within the suite // Iterate all tests within the suite
// //
for (TestEntry = (UNIT_TEST_LIST_ENTRY *)GetFirstNode (&(Suite->TestCaseList)); for (TestEntry = (UNIT_TEST_LIST_ENTRY *)GetFirstNode (&(Suite->TestCaseList));
(LIST_ENTRY*)TestEntry != &(Suite->TestCaseList); (LIST_ENTRY *)TestEntry != &(Suite->TestCaseList);
TestEntry = (UNIT_TEST_LIST_ENTRY *)GetNextNode (&(Suite->TestCaseList), (LIST_ENTRY *)TestEntry)) { TestEntry = (UNIT_TEST_LIST_ENTRY *)GetNextNode (&(Suite->TestCaseList), (LIST_ENTRY *)TestEntry))
{
Test = &TestEntry->UT; Test = &TestEntry->UT;
ParentFramework->CurrentTest = Test; ParentFramework->CurrentTest = Test;
@ -67,7 +68,7 @@ RunTestSuite (
// First, check to see whether the test has already been run. // First, check to see whether the test has already been run.
// NOTE: This would generally only be the case if a saved state was detected and loaded. // NOTE: This would generally only be the case if a saved state was detected and loaded.
// //
if (Test->Result != UNIT_TEST_PENDING && Test->Result != UNIT_TEST_RUNNING) { if ((Test->Result != UNIT_TEST_PENDING) && (Test->Result != UNIT_TEST_RUNNING)) {
DEBUG ((DEBUG_VERBOSE, "Test was run on a previous pass. Skipping.\n")); DEBUG ((DEBUG_VERBOSE, "Test was run on a previous pass. Skipping.\n"));
ParentFramework->CurrentTest = NULL; ParentFramework->CurrentTest = NULL;
continue; continue;
@ -75,19 +76,19 @@ RunTestSuite (
// //
// Next, if we're still running, make sure that our test prerequisites are in place. // Next, if we're still running, make sure that our test prerequisites are in place.
if (Test->Result == UNIT_TEST_PENDING && Test->Prerequisite != NULL) { if ((Test->Result == UNIT_TEST_PENDING) && (Test->Prerequisite != NULL)) {
DEBUG ((DEBUG_VERBOSE, "PREREQ\n")); DEBUG ((DEBUG_VERBOSE, "PREREQ\n"));
if (SetJump (&gUnitTestJumpBuffer) == 0) { if (SetJump (&gUnitTestJumpBuffer) == 0) {
if (Test->Prerequisite (Test->Context) != UNIT_TEST_PASSED) { if (Test->Prerequisite (Test->Context) != UNIT_TEST_PASSED) {
DEBUG ((DEBUG_ERROR, "Prerequisite Not Met\n")); DEBUG ((DEBUG_ERROR, "Prerequisite Not Met\n"));
Test->Result = UNIT_TEST_ERROR_PREREQUISITE_NOT_MET; Test->Result = UNIT_TEST_ERROR_PREREQUISITE_NOT_MET;
ParentFramework->CurrentTest = NULL; ParentFramework->CurrentTest = NULL;
continue; continue;
} }
} else { } else {
DEBUG ((DEBUG_ERROR, "Prerequisite Not Met\n")); DEBUG ((DEBUG_ERROR, "Prerequisite Not Met\n"));
Test->Result = UNIT_TEST_ERROR_PREREQUISITE_NOT_MET; Test->Result = UNIT_TEST_ERROR_PREREQUISITE_NOT_MET;
ParentFramework->CurrentTest = NULL; ParentFramework->CurrentTest = NULL;
continue; continue;
} }
} }
@ -166,8 +167,9 @@ RunAllTestSuites (
// Iterate all suites // Iterate all suites
// //
for (Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetFirstNode (&Framework->TestSuiteList); for (Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetFirstNode (&Framework->TestSuiteList);
(LIST_ENTRY *)Suite != &Framework->TestSuiteList; (LIST_ENTRY *)Suite != &Framework->TestSuiteList;
Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetNextNode (&Framework->TestSuiteList, (LIST_ENTRY *)Suite)) { Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetNextNode (&Framework->TestSuiteList, (LIST_ENTRY *)Suite))
{
Status = RunTestSuite (&(Suite->UTS)); Status = RunTestSuite (&(Suite->UTS));
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Test Suite Failed with Error. %r\n", Status)); DEBUG ((DEBUG_ERROR, "Test Suite Failed with Error. %r\n", Status));

43
UnitTestFrameworkPkg/Library/UnitTestLib/RunTestsCmocka.c
View File

@ -38,7 +38,7 @@ UNIT_TEST_SUITE *mActiveUnitTestSuite = NULL;
void void
CmockaUnitTestFunctionRunner ( CmockaUnitTestFunctionRunner (
void **state void **state
) )
{ {
UNIT_TEST *UnitTest; UNIT_TEST *UnitTest;
@ -52,16 +52,16 @@ CmockaUnitTestFunctionRunner (
if (UnitTest->RunTest == NULL) { if (UnitTest->RunTest == NULL) {
UnitTest->Result = UNIT_TEST_SKIPPED; UnitTest->Result = UNIT_TEST_SKIPPED;
} else { } else {
UnitTest->Result = UNIT_TEST_RUNNING; UnitTest->Result = UNIT_TEST_RUNNING;
Framework->CurrentTest = UnitTest; Framework->CurrentTest = UnitTest;
UnitTest->Result = UnitTest->RunTest (UnitTest->Context); UnitTest->Result = UnitTest->RunTest (UnitTest->Context);
Framework->CurrentTest = NULL; Framework->CurrentTest = NULL;
} }
} }
int int
CmockaUnitTestSetupFunctionRunner ( CmockaUnitTestSetupFunctionRunner (
void **state void **state
) )
{ {
UNIT_TEST *UnitTest; UNIT_TEST *UnitTest;
@ -78,7 +78,7 @@ CmockaUnitTestSetupFunctionRunner (
} }
Framework->CurrentTest = UnitTest; Framework->CurrentTest = UnitTest;
Result = UnitTest->Prerequisite (UnitTest->Context); Result = UnitTest->Prerequisite (UnitTest->Context);
Framework->CurrentTest = NULL; Framework->CurrentTest = NULL;
// //
@ -89,7 +89,7 @@ CmockaUnitTestSetupFunctionRunner (
int int
CmockaUnitTestTeardownFunctionRunner ( CmockaUnitTestTeardownFunctionRunner (
void **state void **state
) )
{ {
UNIT_TEST *UnitTest; UNIT_TEST *UnitTest;
@ -112,10 +112,10 @@ CmockaUnitTestTeardownFunctionRunner (
// stdout and stderr in their xml format // stdout and stderr in their xml format
// //
if (UnitTest->Log != NULL) { if (UnitTest->Log != NULL) {
print_message("UnitTest: %s - %s\n", UnitTest->Name, UnitTest->Description); print_message ("UnitTest: %s - %s\n", UnitTest->Name, UnitTest->Description);
print_message("Log Output Start\n"); print_message ("Log Output Start\n");
print_message("%s", UnitTest->Log); print_message ("%s", UnitTest->Log);
print_message("Log Output End\n"); print_message ("Log Output End\n");
} }
// //
@ -126,12 +126,13 @@ CmockaUnitTestTeardownFunctionRunner (
int int
CmockaUnitTestSuiteSetupFunctionRunner ( CmockaUnitTestSuiteSetupFunctionRunner (
void **state void **state
) )
{ {
if (mActiveUnitTestSuite == NULL) { if (mActiveUnitTestSuite == NULL) {
return -1; return -1;
} }
if (mActiveUnitTestSuite->Setup == NULL) { if (mActiveUnitTestSuite->Setup == NULL) {
return 0; return 0;
} }
@ -145,12 +146,13 @@ CmockaUnitTestSuiteSetupFunctionRunner (
int int
CmockaUnitTestSuiteTeardownFunctionRunner ( CmockaUnitTestSuiteTeardownFunctionRunner (
void **state void **state
) )
{ {
if (mActiveUnitTestSuite == NULL) { if (mActiveUnitTestSuite == NULL) {
return -1; return -1;
} }
if (mActiveUnitTestSuite->Teardown == NULL) { if (mActiveUnitTestSuite->Teardown == NULL) {
return 0; return 0;
} }
@ -173,7 +175,7 @@ RunTestSuite (
struct CMUnitTest *Tests; struct CMUnitTest *Tests;
UINTN Index; UINTN Index;
TestEntry = NULL; TestEntry = NULL;
if (Suite == NULL) { if (Suite == NULL) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
@ -195,7 +197,8 @@ RunTestSuite (
Index = 0; Index = 0;
for (TestEntry = (UNIT_TEST_LIST_ENTRY *)GetFirstNode (&(Suite->TestCaseList)); for (TestEntry = (UNIT_TEST_LIST_ENTRY *)GetFirstNode (&(Suite->TestCaseList));
(LIST_ENTRY *)TestEntry != &(Suite->TestCaseList); (LIST_ENTRY *)TestEntry != &(Suite->TestCaseList);
TestEntry = (UNIT_TEST_LIST_ENTRY *)GetNextNode (&(Suite->TestCaseList), (LIST_ENTRY *)TestEntry)) { TestEntry = (UNIT_TEST_LIST_ENTRY *)GetNextNode (&(Suite->TestCaseList), (LIST_ENTRY *)TestEntry))
{
UnitTest = &TestEntry->UT; UnitTest = &TestEntry->UT;
Tests[Index].name = UnitTest->Description; Tests[Index].name = UnitTest->Description;
Tests[Index].test_func = CmockaUnitTestFunctionRunner; Tests[Index].test_func = CmockaUnitTestFunctionRunner;
@ -204,6 +207,7 @@ RunTestSuite (
Tests[Index].initial_state = UnitTest; Tests[Index].initial_state = UnitTest;
Index++; Index++;
} }
ASSERT (Index == Suite->NumTests); ASSERT (Index == Suite->NumTests);
// //
@ -254,17 +258,18 @@ RunAllTestSuites (
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
DEBUG((DEBUG_VERBOSE, "---------------------------------------------------------\n")); DEBUG ((DEBUG_VERBOSE, "---------------------------------------------------------\n"));
DEBUG((DEBUG_VERBOSE, "------------ RUNNING ALL TEST SUITES --------------\n")); DEBUG ((DEBUG_VERBOSE, "------------ RUNNING ALL TEST SUITES --------------\n"));
DEBUG((DEBUG_VERBOSE, "---------------------------------------------------------\n")); DEBUG ((DEBUG_VERBOSE, "---------------------------------------------------------\n"));
mFrameworkHandle = FrameworkHandle; mFrameworkHandle = FrameworkHandle;
// //
// Iterate all suites // Iterate all suites
// //
for (Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetFirstNode (&Framework->TestSuiteList); for (Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetFirstNode (&Framework->TestSuiteList);
(LIST_ENTRY *)Suite != &Framework->TestSuiteList; (LIST_ENTRY *)Suite != &Framework->TestSuiteList;
Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetNextNode (&Framework->TestSuiteList, (LIST_ENTRY *)Suite)) { Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetNextNode (&Framework->TestSuiteList, (LIST_ENTRY *)Suite))
{
Status = RunTestSuite (&(Suite->UTS)); Status = RunTestSuite (&(Suite->UTS));
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Test Suite Failed with Error. %r\n", Status)); DEBUG ((DEBUG_ERROR, "Test Suite Failed with Error. %r\n", Status));

131
UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
View File

@ -47,7 +47,7 @@ IsFrameworkShortNameValid (
} }
STATIC STATIC
CHAR8* CHAR8 *
AllocateAndCopyString ( AllocateAndCopyString (
IN CHAR8 *StringToCopy IN CHAR8 *StringToCopy
) )
@ -55,12 +55,13 @@ AllocateAndCopyString (
CHAR8 *NewString; CHAR8 *NewString;
UINTN NewStringLength; UINTN NewStringLength;
NewString = NULL; NewString = NULL;
NewStringLength = AsciiStrnLenS (StringToCopy, UNIT_TEST_MAX_STRING_LENGTH) + 1; NewStringLength = AsciiStrnLenS (StringToCopy, UNIT_TEST_MAX_STRING_LENGTH) + 1;
NewString = AllocatePool (NewStringLength * sizeof( CHAR8 )); NewString = AllocatePool (NewStringLength * sizeof (CHAR8));
if (NewString != NULL) { if (NewString != NULL) {
AsciiStrCpyS (NewString, NewStringLength, StringToCopy); AsciiStrCpyS (NewString, NewStringLength, StringToCopy);
} }
return NewString; return NewString;
} }
@ -74,10 +75,10 @@ SetFrameworkFingerprint (
UINT32 NewFingerprint; UINT32 NewFingerprint;
// For this one we'll just use the title and version as the unique fingerprint. // For this one we'll just use the title and version as the unique fingerprint.
NewFingerprint = CalculateCrc32( Framework->Title, (AsciiStrLen( Framework->Title ) * sizeof( CHAR8 )) ); NewFingerprint = CalculateCrc32 (Framework->Title, (AsciiStrLen (Framework->Title) * sizeof (CHAR8)));
NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32( Framework->VersionString, (AsciiStrLen( Framework->VersionString ) * sizeof( CHAR8 )) ); NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32 (Framework->VersionString, (AsciiStrLen (Framework->VersionString) * sizeof (CHAR8)));
CopyMem( Fingerprint, &NewFingerprint, UNIT_TEST_FINGERPRINT_SIZE ); CopyMem (Fingerprint, &NewFingerprint, UNIT_TEST_FINGERPRINT_SIZE);
return; return;
} }
@ -92,11 +93,11 @@ SetSuiteFingerprint (
UINT32 NewFingerprint; UINT32 NewFingerprint;
// For this one, we'll use the fingerprint from the framework, and the title of the suite. // For this one, we'll use the fingerprint from the framework, and the title of the suite.
NewFingerprint = CalculateCrc32( &Framework->Fingerprint[0], UNIT_TEST_FINGERPRINT_SIZE ); NewFingerprint = CalculateCrc32 (&Framework->Fingerprint[0], UNIT_TEST_FINGERPRINT_SIZE);
NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32( Suite->Title, (AsciiStrLen( Suite->Title ) * sizeof( CHAR8 )) ); NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32 (Suite->Title, (AsciiStrLen (Suite->Title) * sizeof (CHAR8)));
NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32( Suite->Name, (AsciiStrLen(Suite->Name) * sizeof(CHAR8)) ); NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32 (Suite->Name, (AsciiStrLen (Suite->Name) * sizeof (CHAR8)));
CopyMem( Fingerprint, &NewFingerprint, UNIT_TEST_FINGERPRINT_SIZE ); CopyMem (Fingerprint, &NewFingerprint, UNIT_TEST_FINGERPRINT_SIZE);
return; return;
} }
@ -111,11 +112,11 @@ SetTestFingerprint (
UINT32 NewFingerprint; UINT32 NewFingerprint;
// For this one, we'll use the fingerprint from the suite, and the description and classname of the test. // For this one, we'll use the fingerprint from the suite, and the description and classname of the test.
NewFingerprint = CalculateCrc32( &Suite->Fingerprint[0], UNIT_TEST_FINGERPRINT_SIZE ); NewFingerprint = CalculateCrc32 (&Suite->Fingerprint[0], UNIT_TEST_FINGERPRINT_SIZE);
NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32( Test->Description, (AsciiStrLen( Test->Description ) * sizeof( CHAR8 )) ); NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32 (Test->Description, (AsciiStrLen (Test->Description) * sizeof (CHAR8)));
NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32( Test->Name, (AsciiStrLen(Test->Name) * sizeof(CHAR8)) ); NewFingerprint = (NewFingerprint >> 8) ^ CalculateCrc32 (Test->Name, (AsciiStrLen (Test->Name) * sizeof (CHAR8)));
CopyMem( Fingerprint, &NewFingerprint, UNIT_TEST_FINGERPRINT_SIZE ); CopyMem (Fingerprint, &NewFingerprint, UNIT_TEST_FINGERPRINT_SIZE);
return; return;
} }
@ -126,7 +127,7 @@ CompareFingerprints (
IN UINT8 *FingerprintB IN UINT8 *FingerprintB
) )
{ {
return (CompareMem( FingerprintA, FingerprintB, UNIT_TEST_FINGERPRINT_SIZE ) == 0); return (CompareMem (FingerprintA, FingerprintB, UNIT_TEST_FINGERPRINT_SIZE) == 0);
} }
/** /**
@ -216,8 +217,9 @@ InitUnitTestFramework (
// //
// First, check all pointers and make sure nothing's broked. // First, check all pointers and make sure nothing's broked.
// //
if (FrameworkHandle == NULL || Title == NULL || if ((FrameworkHandle == NULL) || (Title == NULL) ||
ShortTitle == NULL || VersionString == NULL) { (ShortTitle == NULL) || (VersionString == NULL))
{
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
@ -246,12 +248,14 @@ InitUnitTestFramework (
NewFramework->Log = NULL; NewFramework->Log = NULL;
NewFramework->CurrentTest = NULL; NewFramework->CurrentTest = NULL;
NewFramework->SavedState = NULL; NewFramework->SavedState = NULL;
if (NewFramework->Title == NULL || if ((NewFramework->Title == NULL) ||
NewFramework->ShortTitle == NULL || (NewFramework->ShortTitle == NULL) ||
NewFramework->VersionString == NULL) { (NewFramework->VersionString == NULL))
{
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
goto Exit; goto Exit;
} }
InitializeListHead (&(NewFramework->TestSuiteList)); InitializeListHead (&(NewFramework->TestSuiteList));
// //
@ -263,12 +267,12 @@ InitUnitTestFramework (
// If there is a persisted context, load it now. // If there is a persisted context, load it now.
// //
if (DoesCacheExist (NewFrameworkHandle)) { if (DoesCacheExist (NewFrameworkHandle)) {
Status = LoadUnitTestCache (NewFrameworkHandle, (UNIT_TEST_SAVE_HEADER**)(&NewFramework->SavedState)); Status = LoadUnitTestCache (NewFrameworkHandle, (UNIT_TEST_SAVE_HEADER **)(&NewFramework->SavedState));
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
// //
// Don't actually report it as an error, but emit a warning. // Don't actually report it as an error, but emit a warning.
// //
DEBUG (( DEBUG_ERROR, "%a - Cache was detected, but failed to load.\n", __FUNCTION__ )); DEBUG ((DEBUG_ERROR, "%a - Cache was detected, but failed to load.\n", __FUNCTION__));
Status = EFI_SUCCESS; Status = EFI_SUCCESS;
} }
} }
@ -330,7 +334,7 @@ CreateUnitTestSuite (
UNIT_TEST_SUITE_LIST_ENTRY *NewSuiteEntry; UNIT_TEST_SUITE_LIST_ENTRY *NewSuiteEntry;
UNIT_TEST_FRAMEWORK *Framework; UNIT_TEST_FRAMEWORK *Framework;
Status = EFI_SUCCESS; Status = EFI_SUCCESS;
Framework = (UNIT_TEST_FRAMEWORK *)FrameworkHandle; Framework = (UNIT_TEST_FRAMEWORK *)FrameworkHandle;
// //
@ -351,12 +355,12 @@ CreateUnitTestSuite (
// //
// Copy the fields we think we need. // Copy the fields we think we need.
// //
NewSuiteEntry->UTS.NumTests = 0; NewSuiteEntry->UTS.NumTests = 0;
NewSuiteEntry->UTS.Title = AllocateAndCopyString (Title); NewSuiteEntry->UTS.Title = AllocateAndCopyString (Title);
NewSuiteEntry->UTS.Name = AllocateAndCopyString (Name); NewSuiteEntry->UTS.Name = AllocateAndCopyString (Name);
NewSuiteEntry->UTS.Setup = Setup; NewSuiteEntry->UTS.Setup = Setup;
NewSuiteEntry->UTS.Teardown = Teardown; NewSuiteEntry->UTS.Teardown = Teardown;
NewSuiteEntry->UTS.ParentFramework = FrameworkHandle; NewSuiteEntry->UTS.ParentFramework = FrameworkHandle;
InitializeListHead (&(NewSuiteEntry->Entry)); // List entry for sibling suites. InitializeListHead (&(NewSuiteEntry->Entry)); // List entry for sibling suites.
InitializeListHead (&(NewSuiteEntry->UTS.TestCaseList)); // List entry for child tests. InitializeListHead (&(NewSuiteEntry->UTS.TestCaseList)); // List entry for child tests.
if (NewSuiteEntry->UTS.Title == NULL) { if (NewSuiteEntry->UTS.Title == NULL) {
@ -372,13 +376,13 @@ CreateUnitTestSuite (
// //
// Create the suite fingerprint. // Create the suite fingerprint.
// //
SetSuiteFingerprint( &NewSuiteEntry->UTS.Fingerprint[0], Framework, &NewSuiteEntry->UTS ); SetSuiteFingerprint (&NewSuiteEntry->UTS.Fingerprint[0], Framework, &NewSuiteEntry->UTS);
Exit: Exit:
// //
// If everything is going well, add the new suite to the tail list for the framework. // If everything is going well, add the new suite to the tail list for the framework.
// //
if (!EFI_ERROR( Status )) { if (!EFI_ERROR (Status)) {
InsertTailList (&(Framework->TestSuiteList), (LIST_ENTRY *)NewSuiteEntry); InsertTailList (&(Framework->TestSuiteList), (LIST_ENTRY *)NewSuiteEntry);
*SuiteHandle = (UNIT_TEST_SUITE_HANDLE)(&NewSuiteEntry->UTS); *SuiteHandle = (UNIT_TEST_SUITE_HANDLE)(&NewSuiteEntry->UTS);
} else { } else {
@ -432,8 +436,8 @@ AddTestCase (
UNIT_TEST_FRAMEWORK *ParentFramework; UNIT_TEST_FRAMEWORK *ParentFramework;
UNIT_TEST_SUITE *Suite; UNIT_TEST_SUITE *Suite;
Status = EFI_SUCCESS; Status = EFI_SUCCESS;
Suite = (UNIT_TEST_SUITE *)SuiteHandle; Suite = (UNIT_TEST_SUITE *)SuiteHandle;
// //
// First, let's check to make sure that our parameters look good. // First, let's check to make sure that our parameters look good.
@ -445,7 +449,7 @@ AddTestCase (
ParentFramework = (UNIT_TEST_FRAMEWORK *)Suite->ParentFramework; ParentFramework = (UNIT_TEST_FRAMEWORK *)Suite->ParentFramework;
// //
// Create the new entry. // Create the new entry.
NewTestEntry = AllocateZeroPool (sizeof( UNIT_TEST_LIST_ENTRY )); NewTestEntry = AllocateZeroPool (sizeof (UNIT_TEST_LIST_ENTRY));
if (NewTestEntry == NULL) { if (NewTestEntry == NULL) {
return EFI_OUT_OF_RESOURCES; return EFI_OUT_OF_RESOURCES;
} }
@ -468,6 +472,7 @@ AddTestCase (
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
goto Exit; goto Exit;
} }
if (NewTestEntry->UT.Name == NULL) { if (NewTestEntry->UT.Name == NULL) {
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
goto Exit; goto Exit;
@ -492,7 +497,7 @@ Exit:
// If everything is going well, add the new suite to the tail list for the framework. // If everything is going well, add the new suite to the tail list for the framework.
// //
if (!EFI_ERROR (Status)) { if (!EFI_ERROR (Status)) {
InsertTailList (&(Suite->TestCaseList), (LIST_ENTRY*)NewTestEntry); InsertTailList (&(Suite->TestCaseList), (LIST_ENTRY *)NewTestEntry);
Suite->NumTests++; Suite->NumTests++;
} else { } else {
// //
@ -520,9 +525,10 @@ UpdateTestFromSave (
// //
// First, evaluate the inputs. // First, evaluate the inputs.
// //
if (Test == NULL || SavedState == NULL) { if ((Test == NULL) || (SavedState == NULL)) {
return; return;
} }
if (SavedState->TestCount == 0) { if (SavedState->TestCount == 0) {
return; return;
} }
@ -590,18 +596,19 @@ UpdateTestFromSave (
// at the beginning of the context structure. // at the beginning of the context structure.
// //
SavedContext = (UNIT_TEST_SAVE_CONTEXT *)FloatingPointer; SavedContext = (UNIT_TEST_SAVE_CONTEXT *)FloatingPointer;
if ((SavedContext->Size - sizeof (UNIT_TEST_SAVE_CONTEXT)) > 0 && if (((SavedContext->Size - sizeof (UNIT_TEST_SAVE_CONTEXT)) > 0) &&
CompareFingerprints (&Test->Fingerprint[0], &SavedContext->Fingerprint[0])) { CompareFingerprints (&Test->Fingerprint[0], &SavedContext->Fingerprint[0]))
{
// //
// Override the test context with the saved context. // Override the test context with the saved context.
// //
Test->Context = (VOID*)SavedContext->Data; Test->Context = (VOID *)SavedContext->Data;
} }
} }
} }
STATIC STATIC
UNIT_TEST_SAVE_HEADER* UNIT_TEST_SAVE_HEADER *
SerializeState ( SerializeState (
IN UNIT_TEST_FRAMEWORK_HANDLE FrameworkHandle, IN UNIT_TEST_FRAMEWORK_HANDLE FrameworkHandle,
IN UNIT_TEST_CONTEXT ContextToSave OPTIONAL, IN UNIT_TEST_CONTEXT ContextToSave OPTIONAL,
@ -628,9 +635,10 @@ SerializeState (
// //
// First, let's not make assumptions about the parameters. // First, let's not make assumptions about the parameters.
// //
if (Framework == NULL || if ((Framework == NULL) ||
(ContextToSave != NULL && ContextToSaveSize == 0) || ((ContextToSave != NULL) && (ContextToSaveSize == 0)) ||
ContextToSaveSize > MAX_UINT32) { (ContextToSaveSize > MAX_UINT32))
{
return NULL; return NULL;
} }
@ -658,11 +666,11 @@ SerializeState (
// //
// Account for the size of a test structure. // Account for the size of a test structure.
// //
TotalSize += sizeof( UNIT_TEST_SAVE_TEST ); TotalSize += sizeof (UNIT_TEST_SAVE_TEST);
// //
// If there's a log, make sure to account for the log size. // If there's a log, make sure to account for the log size.
// //
if (UnitTest->Log != NULL) { if (UnitTest->Log != NULL) {
// //
// The +1 is for the NULL character. Can't forget the NULL character. // The +1 is for the NULL character. Can't forget the NULL character.
// //
@ -670,18 +678,21 @@ SerializeState (
ASSERT (LogSize < MAX_UINT32); ASSERT (LogSize < MAX_UINT32);
TotalSize += (UINT32)LogSize; TotalSize += (UINT32)LogSize;
} }
// //
// Increment the test count. // Increment the test count.
// //
TestCount++; TestCount++;
} }
} }
// //
// If there are no tests, we're done here. // If there are no tests, we're done here.
// //
if (TestCount == 0) { if (TestCount == 0) {
return NULL; return NULL;
} }
// //
// Add room for the context, if there is one. // Add room for the context, if there is one.
// //
@ -700,8 +711,8 @@ SerializeState (
// //
// Alright, let's start setting up some data. // Alright, let's start setting up some data.
// //
Header->Version = UNIT_TEST_PERSISTENCE_LIB_VERSION; Header->Version = UNIT_TEST_PERSISTENCE_LIB_VERSION;
Header->SaveStateSize = TotalSize; Header->SaveStateSize = TotalSize;
CopyMem (&Header->Fingerprint[0], &Framework->Fingerprint[0], UNIT_TEST_FINGERPRINT_SIZE); CopyMem (&Header->Fingerprint[0], &Framework->Fingerprint[0], UNIT_TEST_FINGERPRINT_SIZE);
CopyMem (&Header->StartTime, &Framework->StartTime, sizeof (EFI_TIME)); CopyMem (&Header->StartTime, &Framework->StartTime, sizeof (EFI_TIME));
Header->TestCount = TestCount; Header->TestCount = TestCount;
@ -711,7 +722,7 @@ SerializeState (
// Start adding all of the test cases. // Start adding all of the test cases.
// Set the floating pointer to the start of the current test save buffer. // Set the floating pointer to the start of the current test save buffer.
// //
FloatingPointer = (UINT8*)Header + sizeof( UNIT_TEST_SAVE_HEADER ); FloatingPointer = (UINT8 *)Header + sizeof (UNIT_TEST_SAVE_HEADER);
// //
// Iterate all suites. // Iterate all suites.
// //
@ -722,8 +733,8 @@ SerializeState (
// //
TestListHead = &((UNIT_TEST_SUITE_LIST_ENTRY *)Suite)->UTS.TestCaseList; TestListHead = &((UNIT_TEST_SUITE_LIST_ENTRY *)Suite)->UTS.TestCaseList;
for (Test = GetFirstNode (TestListHead); Test != TestListHead; Test = GetNextNode (TestListHead, Test)) { for (Test = GetFirstNode (TestListHead); Test != TestListHead; Test = GetNextNode (TestListHead, Test)) {
TestSaveData = (UNIT_TEST_SAVE_TEST *)FloatingPointer; TestSaveData = (UNIT_TEST_SAVE_TEST *)FloatingPointer;
UnitTest = &((UNIT_TEST_LIST_ENTRY *)Test)->UT; UnitTest = &((UNIT_TEST_LIST_ENTRY *)Test)->UT;
// //
// Save the fingerprint. // Save the fingerprint.
@ -733,11 +744,10 @@ SerializeState (
// //
// Save the result. // Save the result.
// //
TestSaveData->Result = UnitTest->Result; TestSaveData->Result = UnitTest->Result;
TestSaveData->FailureType = UnitTest->FailureType; TestSaveData->FailureType = UnitTest->FailureType;
AsciiStrnCpyS (&TestSaveData->FailureMessage[0], UNIT_TEST_TESTFAILUREMSG_LENGTH, &UnitTest->FailureMessage[0], UNIT_TEST_TESTFAILUREMSG_LENGTH); AsciiStrnCpyS (&TestSaveData->FailureMessage[0], UNIT_TEST_TESTFAILUREMSG_LENGTH, &UnitTest->FailureMessage[0], UNIT_TEST_TESTFAILUREMSG_LENGTH);
// //
// If there is a log, save the log. // If there is a log, save the log.
// //
@ -762,9 +772,9 @@ SerializeState (
// //
// If there is a context to save, let's do that now. // If there is a context to save, let's do that now.
// //
if (ContextToSave != NULL && Framework->CurrentTest != NULL) { if ((ContextToSave != NULL) && (Framework->CurrentTest != NULL)) {
TestSaveContext = (UNIT_TEST_SAVE_CONTEXT*)FloatingPointer; TestSaveContext = (UNIT_TEST_SAVE_CONTEXT *)FloatingPointer;
TestSaveContext->Size = (UINT32)ContextToSaveSize + sizeof (UNIT_TEST_SAVE_CONTEXT); TestSaveContext->Size = (UINT32)ContextToSaveSize + sizeof (UNIT_TEST_SAVE_CONTEXT);
CopyMem (&TestSaveContext->Fingerprint[0], &Framework->CurrentTest->Fingerprint[0], UNIT_TEST_FINGERPRINT_SIZE); CopyMem (&TestSaveContext->Fingerprint[0], &Framework->CurrentTest->Fingerprint[0], UNIT_TEST_FINGERPRINT_SIZE);
CopyMem (((UINT8 *)TestSaveContext + sizeof (UNIT_TEST_SAVE_CONTEXT)), ContextToSave, ContextToSaveSize); CopyMem (((UINT8 *)TestSaveContext + sizeof (UNIT_TEST_SAVE_CONTEXT)), ContextToSave, ContextToSaveSize);
Header->HasSavedContext = TRUE; Header->HasSavedContext = TRUE;
@ -804,15 +814,15 @@ SerializeState (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
SaveFrameworkState ( SaveFrameworkState (
IN UNIT_TEST_CONTEXT ContextToSave OPTIONAL, IN UNIT_TEST_CONTEXT ContextToSave OPTIONAL,
IN UINTN ContextToSaveSize IN UINTN ContextToSaveSize
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
UNIT_TEST_FRAMEWORK_HANDLE FrameworkHandle; UNIT_TEST_FRAMEWORK_HANDLE FrameworkHandle;
UNIT_TEST_SAVE_HEADER *Header; UNIT_TEST_SAVE_HEADER *Header;
Header = NULL; Header = NULL;
FrameworkHandle = GetActiveFrameworkHandle (); FrameworkHandle = GetActiveFrameworkHandle ();
// //
@ -825,8 +835,9 @@ SaveFrameworkState (
// //
// First, let's not make assumptions about the parameters. // First, let's not make assumptions about the parameters.
// //
if ((ContextToSave != NULL && ContextToSaveSize == 0) || if (((ContextToSave != NULL) && (ContextToSaveSize == 0)) ||
ContextToSaveSize > MAX_UINT32) { (ContextToSaveSize > MAX_UINT32))
{
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }

33
UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFileSystem/UnitTestPersistenceLibSimpleFileSystem.c
View File

@ -29,7 +29,7 @@
**/ **/
STATIC STATIC
EFI_DEVICE_PATH_PROTOCOL* EFI_DEVICE_PATH_PROTOCOL *
GetCacheFileDevicePath ( GetCacheFileDevicePath (
IN UNIT_TEST_FRAMEWORK_HANDLE FrameworkHandle IN UNIT_TEST_FRAMEWORK_HANDLE FrameworkHandle
) )
@ -44,7 +44,7 @@ GetCacheFileDevicePath (
UINTN CacheFilePathLength; UINTN CacheFilePathLength;
EFI_DEVICE_PATH_PROTOCOL *CacheFileDevicePath; EFI_DEVICE_PATH_PROTOCOL *CacheFileDevicePath;
Framework = (UNIT_TEST_FRAMEWORK*)FrameworkHandle; Framework = (UNIT_TEST_FRAMEWORK *)FrameworkHandle;
AppPath = NULL; AppPath = NULL;
CacheFilePath = NULL; CacheFilePath = NULL;
TestName = NULL; TestName = NULL;
@ -56,7 +56,7 @@ GetCacheFileDevicePath (
Status = gBS->HandleProtocol ( Status = gBS->HandleProtocol (
gImageHandle, gImageHandle,
&gEfiLoadedImageProtocolGuid, &gEfiLoadedImageProtocolGuid,
(VOID**)&LoadedImage (VOID **)&LoadedImage
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_WARN, "%a - Failed to locate DevicePath for loaded image. %r\n", __FUNCTION__, Status)); DEBUG ((DEBUG_WARN, "%a - Failed to locate DevicePath for loaded image. %r\n", __FUNCTION__, Status));
@ -67,10 +67,11 @@ GetCacheFileDevicePath (
// Before we can start, change test name from ASCII to Unicode. // Before we can start, change test name from ASCII to Unicode.
// //
CacheFilePathLength = AsciiStrLen (Framework->ShortTitle) + 1; CacheFilePathLength = AsciiStrLen (Framework->ShortTitle) + 1;
TestName = AllocatePool (CacheFilePathLength * sizeof(CHAR16)); TestName = AllocatePool (CacheFilePathLength * sizeof (CHAR16));
if (!TestName) { if (!TestName) {
goto Exit; goto Exit;
} }
AsciiStrToUnicodeStrS (Framework->ShortTitle, TestName, CacheFilePathLength); AsciiStrToUnicodeStrS (Framework->ShortTitle, TestName, CacheFilePathLength);
// //
@ -82,7 +83,7 @@ GetCacheFileDevicePath (
// PathCleanUpDirectories (FileNameCopy); // PathCleanUpDirectories (FileNameCopy);
// if (PathRemoveLastItem (FileNameCopy)) { // if (PathRemoveLastItem (FileNameCopy)) {
// //
AppPath = ConvertDevicePathToText (LoadedImage->FilePath, TRUE, TRUE); // NOTE: This must be freed. AppPath = ConvertDevicePathToText (LoadedImage->FilePath, TRUE, TRUE); // NOTE: This must be freed.
DirectorySlashOffset = StrLen (AppPath); DirectorySlashOffset = StrLen (AppPath);
// //
// Make sure we didn't get any weird data. // Make sure we didn't get any weird data.
@ -99,6 +100,7 @@ GetCacheFileDevicePath (
if (AppPath[DirectorySlashOffset] == L'\\') { if (AppPath[DirectorySlashOffset] == L'\\') {
break; break;
} }
DirectorySlashOffset--; DirectorySlashOffset--;
} while (DirectorySlashOffset > 0); } while (DirectorySlashOffset > 0);
@ -115,11 +117,11 @@ GetCacheFileDevicePath (
// //
// Now we know some things, we're ready to produce our output string, I think. // Now we know some things, we're ready to produce our output string, I think.
// //
CacheFilePathLength = DirectorySlashOffset + 1; CacheFilePathLength = DirectorySlashOffset + 1;
CacheFilePathLength += StrLen (TestName); CacheFilePathLength += StrLen (TestName);
CacheFilePathLength += StrLen (CACHE_FILE_SUFFIX); CacheFilePathLength += StrLen (CACHE_FILE_SUFFIX);
CacheFilePathLength += 1; // Don't forget the NULL terminator. CacheFilePathLength += 1; // Don't forget the NULL terminator.
CacheFilePath = AllocateZeroPool (CacheFilePathLength * sizeof (CHAR16)); CacheFilePath = AllocateZeroPool (CacheFilePathLength * sizeof (CHAR16));
if (!CacheFilePath) { if (!CacheFilePath) {
goto Exit; goto Exit;
} }
@ -129,7 +131,7 @@ GetCacheFileDevicePath (
// //
StrnCpyS (CacheFilePath, CacheFilePathLength, AppPath, DirectorySlashOffset + 1); // Copy the path for the parent directory. StrnCpyS (CacheFilePath, CacheFilePathLength, AppPath, DirectorySlashOffset + 1); // Copy the path for the parent directory.
StrCatS (CacheFilePath, CacheFilePathLength, TestName); // Copy the base name for the test cache. StrCatS (CacheFilePath, CacheFilePathLength, TestName); // Copy the base name for the test cache.
StrCatS (CacheFilePath, CacheFilePathLength, CACHE_FILE_SUFFIX); // Copy the file suffix. StrCatS (CacheFilePath, CacheFilePathLength, CACHE_FILE_SUFFIX); // Copy the file suffix.
// //
// Finally, try to create the device path for the thing thing. // Finally, try to create the device path for the thing thing.
@ -143,9 +145,11 @@ Exit:
if (AppPath != NULL) { if (AppPath != NULL) {
FreePool (AppPath); FreePool (AppPath);
} }
if (CacheFilePath != NULL) { if (CacheFilePath != NULL) {
FreePool (CacheFilePath); FreePool (CacheFilePath);
} }
if (TestName != NULL) { if (TestName != NULL) {
FreePool (TestName); FreePool (TestName);
} }
@ -229,7 +233,7 @@ SaveUnitTestCache (
// //
// Check the inputs for sanity. // Check the inputs for sanity.
// //
if (FrameworkHandle == NULL || SaveData == NULL) { if ((FrameworkHandle == NULL) || (SaveData == NULL)) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
@ -240,7 +244,7 @@ SaveUnitTestCache (
FileDevicePath = GetCacheFileDevicePath (FrameworkHandle); FileDevicePath = GetCacheFileDevicePath (FrameworkHandle);
// //
//First lets open the file if it exists so we can delete it...This is the work around for truncation // First lets open the file if it exists so we can delete it...This is the work around for truncation
// //
Status = ShellOpenFileByDevicePath ( Status = ShellOpenFileByDevicePath (
&FileDevicePath, &FileDevicePath,
@ -284,7 +288,7 @@ SaveUnitTestCache (
SaveData SaveData
); );
if (EFI_ERROR (Status) || WriteCount != SaveData->SaveStateSize) { if (EFI_ERROR (Status) || (WriteCount != SaveData->SaveStateSize)) {
DEBUG ((DEBUG_ERROR, "%a - Writing to file failed! %r\n", __FUNCTION__, Status)); DEBUG ((DEBUG_ERROR, "%a - Writing to file failed! %r\n", __FUNCTION__, Status));
} else { } else {
DEBUG ((DEBUG_INFO, "%a - SUCCESS!\n", __FUNCTION__)); DEBUG ((DEBUG_INFO, "%a - SUCCESS!\n", __FUNCTION__));
@ -338,7 +342,7 @@ LoadUnitTestCache (
// //
// Check the inputs for sanity. // Check the inputs for sanity.
// //
if (FrameworkHandle == NULL || SaveData == NULL) { if ((FrameworkHandle == NULL) || (SaveData == NULL)) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
@ -377,7 +381,7 @@ LoadUnitTestCache (
// Now that we know the size, let's allocated a buffer to hold the contents. // Now that we know the size, let's allocated a buffer to hold the contents.
// //
FileSize = (UINTN)LargeFileSize; // You know what... if it's too large, this lib don't care. FileSize = (UINTN)LargeFileSize; // You know what... if it's too large, this lib don't care.
Buffer = AllocatePool (FileSize); Buffer = AllocatePool (FileSize);
if (Buffer == NULL) { if (Buffer == NULL) {
DEBUG ((DEBUG_ERROR, "%a - Failed to allocate a pool to hold the file contents! %r\n", __FUNCTION__, Status)); DEBUG ((DEBUG_ERROR, "%a - Failed to allocate a pool to hold the file contents! %r\n", __FUNCTION__, Status));
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
@ -399,6 +403,7 @@ Exit:
if (FileDevicePath != NULL) { if (FileDevicePath != NULL) {
FreePool (FileDevicePath); FreePool (FileDevicePath);
} }
if (IsFileOpened) { if (IsFileOpened) {
ShellCloseFile (&FileHandle); ShellCloseFile (&FileHandle);
} }
@ -406,7 +411,7 @@ Exit:
// //
// If we're returning an error, make sure // If we're returning an error, make sure
// the state is sane. // the state is sane.
if (EFI_ERROR (Status) && Buffer != NULL) { if (EFI_ERROR (Status) && (Buffer != NULL)) {
FreePool (Buffer); FreePool (Buffer);
Buffer = NULL; Buffer = NULL;
} }

115
UnitTestFrameworkPkg/Library/UnitTestResultReportLib/UnitTestResultReportLib.c
View File

@ -23,36 +23,36 @@ ReportOutput (
); );
struct _UNIT_TEST_STATUS_STRING { struct _UNIT_TEST_STATUS_STRING {
UNIT_TEST_STATUS Status; UNIT_TEST_STATUS Status;
CHAR8 *String; CHAR8 *String;
}; };
struct _UNIT_TEST_FAILURE_TYPE_STRING { struct _UNIT_TEST_FAILURE_TYPE_STRING {
FAILURE_TYPE Type; FAILURE_TYPE Type;
CHAR8 *String; CHAR8 *String;
}; };
struct _UNIT_TEST_STATUS_STRING mStatusStrings[] = { struct _UNIT_TEST_STATUS_STRING mStatusStrings[] = {
{ UNIT_TEST_PASSED, "PASSED"}, { UNIT_TEST_PASSED, "PASSED" },
{ UNIT_TEST_ERROR_PREREQUISITE_NOT_MET, "NOT RUN - PREREQUISITE FAILED"}, { UNIT_TEST_ERROR_PREREQUISITE_NOT_MET, "NOT RUN - PREREQUISITE FAILED" },
{ UNIT_TEST_ERROR_TEST_FAILED, "FAILED"}, { UNIT_TEST_ERROR_TEST_FAILED, "FAILED" },
{ UNIT_TEST_RUNNING, "RUNNING"}, { UNIT_TEST_RUNNING, "RUNNING" },
{ UNIT_TEST_PENDING, "PENDING"}, { UNIT_TEST_PENDING, "PENDING" },
{ 0, "**UNKNOWN**"} { 0, "**UNKNOWN**" }
}; };
struct _UNIT_TEST_FAILURE_TYPE_STRING mFailureTypeStrings[] = { struct _UNIT_TEST_FAILURE_TYPE_STRING mFailureTypeStrings[] = {
{ FAILURETYPE_NOFAILURE, "NO FAILURE"}, { FAILURETYPE_NOFAILURE, "NO FAILURE" },
{ FAILURETYPE_OTHER, "OTHER FAILURE"}, { FAILURETYPE_OTHER, "OTHER FAILURE" },
{ FAILURETYPE_ASSERTTRUE, "ASSERT_TRUE FAILURE"}, { FAILURETYPE_ASSERTTRUE, "ASSERT_TRUE FAILURE" },
{ FAILURETYPE_ASSERTFALSE, "ASSERT_FALSE FAILURE"}, { FAILURETYPE_ASSERTFALSE, "ASSERT_FALSE FAILURE" },
{ FAILURETYPE_ASSERTEQUAL, "ASSERT_EQUAL FAILURE"}, { FAILURETYPE_ASSERTEQUAL, "ASSERT_EQUAL FAILURE" },
{ FAILURETYPE_ASSERTNOTEQUAL, "ASSERT_NOTEQUAL FAILURE"}, { FAILURETYPE_ASSERTNOTEQUAL, "ASSERT_NOTEQUAL FAILURE" },
{ FAILURETYPE_ASSERTNOTEFIERROR, "ASSERT_NOTEFIERROR FAILURE"}, { FAILURETYPE_ASSERTNOTEFIERROR, "ASSERT_NOTEFIERROR FAILURE" },
{ FAILURETYPE_ASSERTSTATUSEQUAL, "ASSERT_STATUSEQUAL FAILURE"}, { FAILURETYPE_ASSERTSTATUSEQUAL, "ASSERT_STATUSEQUAL FAILURE" },
{ FAILURETYPE_ASSERTNOTNULL, "ASSERT_NOTNULL FAILURE"}, { FAILURETYPE_ASSERTNOTNULL, "ASSERT_NOTNULL FAILURE" },
{ FAILURETYPE_EXPECTASSERT, "EXPECT_ASSERT FAILURE"}, { FAILURETYPE_EXPECTASSERT, "EXPECT_ASSERT FAILURE" },
{ 0, "*UNKNOWN* Failure"} { 0, "*UNKNOWN* Failure" }
}; };
// //
@ -60,7 +60,7 @@ struct _UNIT_TEST_FAILURE_TYPE_STRING mFailureTypeStrings[] = {
// //
STATIC STATIC
CONST CHAR8* CONST CHAR8 *
GetStringForUnitTestStatus ( GetStringForUnitTestStatus (
IN UNIT_TEST_STATUS Status IN UNIT_TEST_STATUS Status
) )
@ -75,6 +75,7 @@ GetStringForUnitTestStatus (
return mStatusStrings[Index].String; return mStatusStrings[Index].String;
} }
} }
// //
// Return last entry if no match found. // Return last entry if no match found.
// //
@ -82,7 +83,7 @@ GetStringForUnitTestStatus (
} }
STATIC STATIC
CONST CHAR8* CONST CHAR8 *
GetStringForFailureType ( GetStringForFailureType (
IN FAILURE_TYPE Failure IN FAILURE_TYPE Failure
) )
@ -97,10 +98,11 @@ GetStringForFailureType (
return mFailureTypeStrings[Index].String; return mFailureTypeStrings[Index].String;
} }
} }
// //
// Return last entry if no match found. // Return last entry if no match found.
// //
DEBUG((DEBUG_INFO, "%a Failure Type does not have string defined 0x%X\n", __FUNCTION__, (UINT32)Failure)); DEBUG ((DEBUG_INFO, "%a Failure Type does not have string defined 0x%X\n", __FUNCTION__, (UINT32)Failure));
return mFailureTypeStrings[Index].String; return mFailureTypeStrings[Index].String;
} }
@ -128,7 +130,7 @@ OutputUnitTestFrameworkReport (
Passed = 0; Passed = 0;
Failed = 0; Failed = 0;
NotRun = 0; NotRun = 0;
Suite = NULL; Suite = NULL;
Framework = (UNIT_TEST_FRAMEWORK *)FrameworkHandle; Framework = (UNIT_TEST_FRAMEWORK *)FrameworkHandle;
if (Framework == NULL) { if (Framework == NULL) {
@ -139,16 +141,16 @@ OutputUnitTestFrameworkReport (
ReportPrint ("------------- UNIT TEST FRAMEWORK RESULTS ---------------\n"); ReportPrint ("------------- UNIT TEST FRAMEWORK RESULTS ---------------\n");
ReportPrint ("---------------------------------------------------------\n"); ReportPrint ("---------------------------------------------------------\n");
//print the version and time // print the version and time
// //
// Iterate all suites // Iterate all suites
// //
for (Suite = (UNIT_TEST_SUITE_LIST_ENTRY*)GetFirstNode(&Framework->TestSuiteList); for (Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetFirstNode (&Framework->TestSuiteList);
(LIST_ENTRY*)Suite != &Framework->TestSuiteList; (LIST_ENTRY *)Suite != &Framework->TestSuiteList;
Suite = (UNIT_TEST_SUITE_LIST_ENTRY*)GetNextNode(&Framework->TestSuiteList, (LIST_ENTRY*)Suite)) { Suite = (UNIT_TEST_SUITE_LIST_ENTRY *)GetNextNode (&Framework->TestSuiteList, (LIST_ENTRY *)Suite))
{
Test = NULL; Test = NULL;
SPassed = 0; SPassed = 0;
SFailed = 0; SFailed = 0;
SNotRun = 0; SNotRun = 0;
@ -161,10 +163,10 @@ OutputUnitTestFrameworkReport (
// //
// Iterate all tests within the suite // Iterate all tests within the suite
// //
for (Test = (UNIT_TEST_LIST_ENTRY*)GetFirstNode(&(Suite->UTS.TestCaseList)); for (Test = (UNIT_TEST_LIST_ENTRY *)GetFirstNode (&(Suite->UTS.TestCaseList));
(LIST_ENTRY*)Test != &(Suite->UTS.TestCaseList); (LIST_ENTRY *)Test != &(Suite->UTS.TestCaseList);
Test = (UNIT_TEST_LIST_ENTRY*)GetNextNode(&(Suite->UTS.TestCaseList), (LIST_ENTRY*)Test)) { Test = (UNIT_TEST_LIST_ENTRY *)GetNextNode (&(Suite->UTS.TestCaseList), (LIST_ENTRY *)Test))
{
ReportPrint ("*********************************************************\n"); ReportPrint ("*********************************************************\n");
ReportPrint (" CLASS NAME: %a\n", Test->UT.Name); ReportPrint (" CLASS NAME: %a\n", Test->UT.Name);
ReportPrint (" TEST: %a\n", Test->UT.Description); ReportPrint (" TEST: %a\n", Test->UT.Description);
@ -178,41 +180,42 @@ OutputUnitTestFrameworkReport (
} }
switch (Test->UT.Result) { switch (Test->UT.Result) {
case UNIT_TEST_PASSED: case UNIT_TEST_PASSED:
SPassed++; SPassed++;
break; break;
case UNIT_TEST_ERROR_TEST_FAILED: case UNIT_TEST_ERROR_TEST_FAILED:
SFailed++; SFailed++;
break; break;
case UNIT_TEST_PENDING: // Fall through... case UNIT_TEST_PENDING: // Fall through...
case UNIT_TEST_RUNNING: // Fall through... case UNIT_TEST_RUNNING: // Fall through...
case UNIT_TEST_ERROR_PREREQUISITE_NOT_MET: case UNIT_TEST_ERROR_PREREQUISITE_NOT_MET:
SNotRun++; SNotRun++;
break; break;
default: default:
break; break;
} }
ReportPrint ("**********************************************************\n"); ReportPrint ("**********************************************************\n");
} //End Test iteration } // End Test iteration
ReportPrint ("+++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n"); ReportPrint ("+++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n");
ReportPrint ("Suite Stats\n"); ReportPrint ("Suite Stats\n");
ReportPrint (" Passed: %d (%d%%)\n", SPassed, (SPassed * 100)/(SPassed+SFailed+SNotRun)); ReportPrint (" Passed: %d (%d%%)\n", SPassed, (SPassed * 100)/(SPassed+SFailed+SNotRun));
ReportPrint (" Failed: %d (%d%%)\n", SFailed, (SFailed * 100) / (SPassed + SFailed + SNotRun)); ReportPrint (" Failed: %d (%d%%)\n", SFailed, (SFailed * 100) / (SPassed + SFailed + SNotRun));
ReportPrint (" Not Run: %d (%d%%)\n", SNotRun, (SNotRun * 100) / (SPassed + SFailed + SNotRun)); ReportPrint (" Not Run: %d (%d%%)\n", SNotRun, (SNotRun * 100) / (SPassed + SFailed + SNotRun));
ReportPrint ("+++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n" ); ReportPrint ("+++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n");
Passed += SPassed; //add to global counters Passed += SPassed; // add to global counters
Failed += SFailed; //add to global counters Failed += SFailed; // add to global counters
NotRun += SNotRun; //add to global counters NotRun += SNotRun; // add to global counters
}//End Suite iteration }// End Suite iteration
ReportPrint ("=========================================================\n"); ReportPrint ("=========================================================\n");
ReportPrint ("Total Stats\n"); ReportPrint ("Total Stats\n");
ReportPrint (" Passed: %d (%d%%)\n", Passed, (Passed * 100) / (Passed + Failed + NotRun)); ReportPrint (" Passed: %d (%d%%)\n", Passed, (Passed * 100) / (Passed + Failed + NotRun));
ReportPrint (" Failed: %d (%d%%)\n", Failed, (Failed * 100) / (Passed + Failed + NotRun)); ReportPrint (" Failed: %d (%d%%)\n", Failed, (Failed * 100) / (Passed + Failed + NotRun));
ReportPrint (" Not Run: %d (%d%%)\n", NotRun, (NotRun * 100) / (Passed + Failed + NotRun)); ReportPrint (" Not Run: %d (%d%%)\n", NotRun, (NotRun * 100) / (Passed + Failed + NotRun));
ReportPrint ("=========================================================\n" ); ReportPrint ("=========================================================\n");
return EFI_SUCCESS; return EFI_SUCCESS;
} }

1
UnitTestFrameworkPkg/Library/UnitTestResultReportLib/UnitTestResultReportLibConOut.c
View File

@ -29,6 +29,7 @@ ReportPrint (
} else { } else {
gST->ConOut->OutputString (gST->ConOut, String); gST->ConOut->OutputString (gST->ConOut, String);
} }
VA_END (Marker); VA_END (Marker);
} }

1
UnitTestFrameworkPkg/Library/UnitTestResultReportLib/UnitTestResultReportLibDebugLib.c
View File

@ -28,6 +28,7 @@ ReportPrint (
} else { } else {
DEBUG ((DEBUG_INFO, String)); DEBUG ((DEBUG_INFO, String));
} }
VA_END (Marker); VA_END (Marker);
} }

2
UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestPersistenceLib.h
View File

@ -14,7 +14,7 @@
#include <UnitTestFrameworkTypes.h> #include <UnitTestFrameworkTypes.h>
#define UNIT_TEST_PERSISTENCE_LIB_VERSION 1 #define UNIT_TEST_PERSISTENCE_LIB_VERSION 1
/** /**
Determines whether a persistence cache already exists for Determines whether a persistence cache already exists for

122
UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h
View File

@ -15,14 +15,14 @@
/// ///
/// The maximum length of a string stored in the unit test framework /// The maximum length of a string stored in the unit test framework
/// ///
#define UNIT_TEST_MAX_STRING_LENGTH (120) #define UNIT_TEST_MAX_STRING_LENGTH (120)
/// ///
/// The size of a firngerprint used to save/resume execution of a unit test /// The size of a firngerprint used to save/resume execution of a unit test
/// framework. This is the size of a CRC32 value which is 32-bit value. /// framework. This is the size of a CRC32 value which is 32-bit value.
/// ///
/// ///
#define UNIT_TEST_FINGERPRINT_SIZE (sizeof (UINT32)) #define UNIT_TEST_FINGERPRINT_SIZE (sizeof (UINT32))
/// ///
/// The maximum length of a test failure message stored in the unit test /// The maximum length of a test failure message stored in the unit test
@ -35,55 +35,55 @@
/// test. /// test.
/// ///
typedef UINT32 FAILURE_TYPE; typedef UINT32 FAILURE_TYPE;
#define FAILURETYPE_NOFAILURE (0) #define FAILURETYPE_NOFAILURE (0)
#define FAILURETYPE_OTHER (1) #define FAILURETYPE_OTHER (1)
#define FAILURETYPE_ASSERTTRUE (2) #define FAILURETYPE_ASSERTTRUE (2)
#define FAILURETYPE_ASSERTFALSE (3) #define FAILURETYPE_ASSERTFALSE (3)
#define FAILURETYPE_ASSERTEQUAL (4) #define FAILURETYPE_ASSERTEQUAL (4)
#define FAILURETYPE_ASSERTNOTEQUAL (5) #define FAILURETYPE_ASSERTNOTEQUAL (5)
#define FAILURETYPE_ASSERTNOTEFIERROR (6) #define FAILURETYPE_ASSERTNOTEFIERROR (6)
#define FAILURETYPE_ASSERTSTATUSEQUAL (7) #define FAILURETYPE_ASSERTSTATUSEQUAL (7)
#define FAILURETYPE_ASSERTNOTNULL (8) #define FAILURETYPE_ASSERTNOTNULL (8)
#define FAILURETYPE_EXPECTASSERT (9) #define FAILURETYPE_EXPECTASSERT (9)
/// ///
/// Unit Test context structure tracked by the unit test framework. /// Unit Test context structure tracked by the unit test framework.
/// ///
typedef struct { typedef struct {
CHAR8 *Description; CHAR8 *Description;
CHAR8 *Name; //can't have spaces and should be short CHAR8 *Name; // can't have spaces and should be short
CHAR8 *Log; CHAR8 *Log;
FAILURE_TYPE FailureType; FAILURE_TYPE FailureType;
CHAR8 FailureMessage[UNIT_TEST_TESTFAILUREMSG_LENGTH]; CHAR8 FailureMessage[UNIT_TEST_TESTFAILUREMSG_LENGTH];
UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE];
UNIT_TEST_STATUS Result; UNIT_TEST_STATUS Result;
UNIT_TEST_FUNCTION RunTest; UNIT_TEST_FUNCTION RunTest;
UNIT_TEST_PREREQUISITE Prerequisite; UNIT_TEST_PREREQUISITE Prerequisite;
UNIT_TEST_CLEANUP CleanUp; UNIT_TEST_CLEANUP CleanUp;
UNIT_TEST_CONTEXT Context; UNIT_TEST_CONTEXT Context;
UNIT_TEST_SUITE_HANDLE ParentSuite; UNIT_TEST_SUITE_HANDLE ParentSuite;
} UNIT_TEST; } UNIT_TEST;
/// ///
/// Structure used to store the set of unit tests in a unit test suite as a list. /// Structure used to store the set of unit tests in a unit test suite as a list.
/// ///
typedef struct { typedef struct {
LIST_ENTRY Entry; LIST_ENTRY Entry;
UNIT_TEST UT; UNIT_TEST UT;
} UNIT_TEST_LIST_ENTRY; } UNIT_TEST_LIST_ENTRY;
/// ///
/// Unit Test Suite context structure tracked by the unit test framework. /// Unit Test Suite context structure tracked by the unit test framework.
/// ///
typedef struct { typedef struct {
UINTN NumTests; UINTN NumTests;
CHAR8 *Title; CHAR8 *Title;
CHAR8 *Name; CHAR8 *Name;
UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE];
UNIT_TEST_SUITE_SETUP Setup; UNIT_TEST_SUITE_SETUP Setup;
UNIT_TEST_SUITE_TEARDOWN Teardown; UNIT_TEST_SUITE_TEARDOWN Teardown;
LIST_ENTRY TestCaseList; // UNIT_TEST_LIST_ENTRY LIST_ENTRY TestCaseList; // UNIT_TEST_LIST_ENTRY
UNIT_TEST_FRAMEWORK_HANDLE ParentFramework; UNIT_TEST_FRAMEWORK_HANDLE ParentFramework;
} UNIT_TEST_SUITE; } UNIT_TEST_SUITE;
/// ///
@ -91,57 +91,57 @@ typedef struct {
/// as a list. /// as a list.
/// ///
typedef struct { typedef struct {
LIST_ENTRY Entry; LIST_ENTRY Entry;
UNIT_TEST_SUITE UTS; UNIT_TEST_SUITE UTS;
} UNIT_TEST_SUITE_LIST_ENTRY; } UNIT_TEST_SUITE_LIST_ENTRY;
/// ///
/// Unit Test Framework context structure tracked by the unit test framework. /// Unit Test Framework context structure tracked by the unit test framework.
/// ///
typedef struct { typedef struct {
CHAR8 *Title; CHAR8 *Title;
CHAR8 *ShortTitle; // This title should contain NO spaces or non-filename characters. Is used in reporting and serialization. CHAR8 *ShortTitle; // This title should contain NO spaces or non-filename characters. Is used in reporting and serialization.
CHAR8 *VersionString; CHAR8 *VersionString;
CHAR8 *Log; CHAR8 *Log;
UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE];
LIST_ENTRY TestSuiteList; // UNIT_TEST_SUITE_LIST_ENTRY LIST_ENTRY TestSuiteList; // UNIT_TEST_SUITE_LIST_ENTRY
EFI_TIME StartTime; EFI_TIME StartTime;
EFI_TIME EndTime; EFI_TIME EndTime;
UNIT_TEST *CurrentTest; UNIT_TEST *CurrentTest;
VOID *SavedState; // This is an instance of UNIT_TEST_SAVE_HEADER*, if present. VOID *SavedState; // This is an instance of UNIT_TEST_SAVE_HEADER*, if present.
} UNIT_TEST_FRAMEWORK; } UNIT_TEST_FRAMEWORK;
/// ///
/// Serialized version of a unit test /// Serialized version of a unit test
/// ///
typedef struct { typedef struct {
UINT32 Size; // Size of the UNIT_TEST_SAVE_TEST including Log[] UINT32 Size; // Size of the UNIT_TEST_SAVE_TEST including Log[]
UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; // Fingerprint of the test itself. UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; // Fingerprint of the test itself.
CHAR8 FailureMessage[UNIT_TEST_TESTFAILUREMSG_LENGTH]; CHAR8 FailureMessage[UNIT_TEST_TESTFAILUREMSG_LENGTH];
FAILURE_TYPE FailureType; FAILURE_TYPE FailureType;
UNIT_TEST_STATUS Result; UNIT_TEST_STATUS Result;
CHAR8 Log[]; CHAR8 Log[];
} UNIT_TEST_SAVE_TEST; } UNIT_TEST_SAVE_TEST;
/// ///
/// Serialized version of a unit test context /// Serialized version of a unit test context
/// ///
typedef struct { typedef struct {
UINT32 Size; // Size of the UNIT_TEST_SAVE_CONTEXT including Data[] UINT32 Size; // Size of the UNIT_TEST_SAVE_CONTEXT including Data[]
UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; // Fingerprint of the corresponding test. UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; // Fingerprint of the corresponding test.
UINT8 Data[]; // Actual data of the context. UINT8 Data[]; // Actual data of the context.
} UNIT_TEST_SAVE_CONTEXT; } UNIT_TEST_SAVE_CONTEXT;
/// ///
/// Serialized version of unit test framework /// Serialized version of unit test framework
/// ///
typedef struct { typedef struct {
UINT8 Version; UINT8 Version;
UINT32 SaveStateSize; // Size of the entire serialized buffer. UINT32 SaveStateSize; // Size of the entire serialized buffer.
UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; // Fingerprint of the framework that has been saved. UINT8 Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; // Fingerprint of the framework that has been saved.
EFI_TIME StartTime; EFI_TIME StartTime;
UINT32 TestCount; UINT32 TestCount;
BOOLEAN HasSavedContext; BOOLEAN HasSavedContext;
// UNIT_TEST_SAVE_TEST Tests[]; // Array of structures starts here. // UNIT_TEST_SAVE_TEST Tests[]; // Array of structures starts here.
// UNIT_TEST_SAVE_CONTEXT SavedContext[]; // Saved context for the currently running test. // UNIT_TEST_SAVE_CONTEXT SavedContext[]; // Saved context for the currently running test.
// CHAR8 Log[]; // NOTE: Not yet implemented!! // CHAR8 Log[]; // NOTE: Not yet implemented!!

52
UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c
View File

@ -664,14 +664,14 @@ UefiTestMain (
Framework = NULL; Framework = NULL;
DEBUG(( DEBUG_INFO, "%a v%a\n", UNIT_TEST_NAME, UNIT_TEST_VERSION )); DEBUG ((DEBUG_INFO, "%a v%a\n", UNIT_TEST_NAME, UNIT_TEST_VERSION));
// //
// Start setting up the test framework for running the tests. // Start setting up the test framework for running the tests.
// //
Status = InitUnitTestFramework (&Framework, UNIT_TEST_NAME, gEfiCallerBaseName, UNIT_TEST_VERSION); Status = InitUnitTestFramework (&Framework, UNIT_TEST_NAME, gEfiCallerBaseName, UNIT_TEST_VERSION);
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
DEBUG((DEBUG_ERROR, "Failed in InitUnitTestFramework. Status = %r\n", Status)); DEBUG ((DEBUG_ERROR, "Failed in InitUnitTestFramework. Status = %r\n", Status));
goto EXIT; goto EXIT;
} }
@ -684,6 +684,7 @@ UefiTestMain (
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
goto EXIT; goto EXIT;
} }
AddTestCase (SimpleMathTests, "Adding 1 to 1 should produce 2", "Addition", OnePlusOneShouldEqualTwo, NULL, NULL, NULL); AddTestCase (SimpleMathTests, "Adding 1 to 1 should produce 2", "Addition", OnePlusOneShouldEqualTwo, NULL, NULL, NULL);
// //
@ -695,6 +696,7 @@ UefiTestMain (
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
goto EXIT; goto EXIT;
} }
AddTestCase (GlobalVarTests, "You should be able to change a global BOOLEAN", "Boolean", GlobalBooleanShouldBeChangeable, NULL, NULL, NULL); AddTestCase (GlobalVarTests, "You should be able to change a global BOOLEAN", "Boolean", GlobalBooleanShouldBeChangeable, NULL, NULL, NULL);
AddTestCase (GlobalVarTests, "You should be able to change a global pointer", "Pointer", GlobalPointerShouldBeChangeable, MakeSureThatPointerIsNull, ClearThePointer, NULL); AddTestCase (GlobalVarTests, "You should be able to change a global pointer", "Pointer", GlobalPointerShouldBeChangeable, MakeSureThatPointerIsNull, ClearThePointer, NULL);
@ -707,19 +709,20 @@ UefiTestMain (
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
goto EXIT; goto EXIT;
} }
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_TRUE() macro", "MacroUtAssertTrue", MacroUtAssertTrue, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_FALSE() macro", "MacroUtAssertFalse", MacroUtAssertFalse, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_TRUE() macro", "MacroUtAssertTrue", MacroUtAssertTrue, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_EQUAL() macro", "MacroUtAssertEqual", MacroUtAssertEqual, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_FALSE() macro", "MacroUtAssertFalse", MacroUtAssertFalse, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_MEM_EQUAL() macro", "MacroUtAssertMemEqual", MacroUtAssertMemEqual, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_EQUAL() macro", "MacroUtAssertEqual", MacroUtAssertEqual, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_NOT_EQUAL() macro", "MacroUtAssertNotEqual", MacroUtAssertNotEqual, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_MEM_EQUAL() macro", "MacroUtAssertMemEqual", MacroUtAssertMemEqual, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_NOT_EFI_ERROR() macro", "MacroUtAssertNotEfiError", MacroUtAssertNotEfiError, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_NOT_EQUAL() macro", "MacroUtAssertNotEqual", MacroUtAssertNotEqual, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_STATUS_EQUAL() macro", "MacroUtAssertStatusEqual", MacroUtAssertStatusEqual, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_NOT_EFI_ERROR() macro", "MacroUtAssertNotEfiError", MacroUtAssertNotEfiError, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_NOT_NULL() macro", "MacroUtAssertNotNull", MacroUtAssertNotNull, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_STATUS_EQUAL() macro", "MacroUtAssertStatusEqual", MacroUtAssertStatusEqual, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_ASSERT_NOT_NULL() macro", "MacroUtAssertNotNull", MacroUtAssertNotNull, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_EXPECT_ASSERT_FAILURE() macro", "MacroUtExpectAssertFailure", MacroUtExpectAssertFailure, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_EXPECT_ASSERT_FAILURE() macro", "MacroUtExpectAssertFailure", MacroUtExpectAssertFailure, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_LOG_ERROR() macro", "MacroUtLogError", MacroUtLogError, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_LOG_ERROR() macro", "MacroUtLogError", MacroUtLogError, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_LOG_WARNING() macro", "MacroUtLogWarning", MacroUtLogWarning, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_LOG_WARNING() macro", "MacroUtLogWarning", MacroUtLogWarning, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_LOG_INFO() macro", "MacroUtLogInfo", MacroUtLogInfo, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_LOG_INFO() macro", "MacroUtLogInfo", MacroUtLogInfo, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsEnabled, "Test UT_LOG_VERBOSE() macro", "MacroUtLogVerbose", MacroUtLogVerbose, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsEnabled, "Test UT_LOG_VERBOSE() macro", "MacroUtLogVerbose", MacroUtLogVerbose, NULL, NULL, NULL);
// //
@ -731,19 +734,20 @@ UefiTestMain (
Status = EFI_OUT_OF_RESOURCES; Status = EFI_OUT_OF_RESOURCES;
goto EXIT; goto EXIT;
} }
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_TRUE() macro", "MacroUtAssertTrue", MacroUtAssertTrue, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_FALSE() macro", "MacroUtAssertFalse", MacroUtAssertFalse, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_TRUE() macro", "MacroUtAssertTrue", MacroUtAssertTrue, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_EQUAL() macro", "MacroUtAssertEqual", MacroUtAssertEqual, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_FALSE() macro", "MacroUtAssertFalse", MacroUtAssertFalse, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_MEM_EQUAL() macro", "MacroUtAssertMemEqual", MacroUtAssertMemEqual, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_EQUAL() macro", "MacroUtAssertEqual", MacroUtAssertEqual, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_NOT_EQUAL() macro", "MacroUtAssertNotEqual", MacroUtAssertNotEqual, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_MEM_EQUAL() macro", "MacroUtAssertMemEqual", MacroUtAssertMemEqual, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_NOT_EFI_ERROR() macro", "MacroUtAssertNotEfiError", MacroUtAssertNotEfiError, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_NOT_EQUAL() macro", "MacroUtAssertNotEqual", MacroUtAssertNotEqual, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_STATUS_EQUAL() macro", "MacroUtAssertStatusEqual", MacroUtAssertStatusEqual, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_NOT_EFI_ERROR() macro", "MacroUtAssertNotEfiError", MacroUtAssertNotEfiError, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_NOT_NULL() macro", "MacroUtAssertNotNull", MacroUtAssertNotNull, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_STATUS_EQUAL() macro", "MacroUtAssertStatusEqual", MacroUtAssertStatusEqual, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_ASSERT_NOT_NULL() macro", "MacroUtAssertNotNull", MacroUtAssertNotNull, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_EXPECT_ASSERT_FAILURE() macro", "MacroUtExpectAssertFailure", MacroUtExpectAssertFailure, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_EXPECT_ASSERT_FAILURE() macro", "MacroUtExpectAssertFailure", MacroUtExpectAssertFailure, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_LOG_ERROR() macro", "MacroUtLogError", MacroUtLogError, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_LOG_ERROR() macro", "MacroUtLogError", MacroUtLogError, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_LOG_WARNING() macro", "MacroUtLogWarning", MacroUtLogWarning, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_LOG_WARNING() macro", "MacroUtLogWarning", MacroUtLogWarning, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_LOG_INFO() macro", "MacroUtLogInfo", MacroUtLogInfo, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_LOG_INFO() macro", "MacroUtLogInfo", MacroUtLogInfo, NULL, NULL, NULL);
AddTestCase (MacroTestsAssertsDisabled, "Test UT_LOG_VERBOSE() macro", "MacroUtLogVerbose", MacroUtLogVerbose, NULL, NULL, NULL); AddTestCase (MacroTestsAssertsDisabled, "Test UT_LOG_VERBOSE() macro", "MacroUtLogVerbose", MacroUtLogVerbose, NULL, NULL, NULL);
// //
@ -791,8 +795,8 @@ DxeEntryPoint (
**/ **/
int int
main ( main (
int argc, int argc,
char *argv[] char *argv[]
) )
{ {
return UefiTestMain (); return UefiTestMain ();