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

MdePkg/Test: Add SafeIntLib and BaseLib Base64 unit tests 

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

* Add unit tests for SafeIntLib class
* Add unit tests for BaseLib Base64 conversion APIs.
* Add Test/MdePkgHostTest.dsc -to build host based unit
  tests
* Update MdePkg.dsc to build target based tests for
  SafeIntLib and BaseLib
* Update MdePkg.ci.yaml to build and run host based
  tests for SafeIntLib and BaseLib

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Acked-by: Hao A Wu <hao.a.wu@intel.com>
Reviewed-by: Bret Barkelew <Bret.Barkelew@microsoft.com>
This commit is contained in:
Michael D Kinney 2020-01-22 10:15:11 -08:00 committed by mergify[bot]
parent 3e61b953b7
commit e50c2bb383
16 changed files with 5034 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
MdePkg/MdePkg.ci.yaml
View File

@ -10,8 +10,13 @@
"DscPath": "MdePkg.dsc"
},
## options defined ci/Plugin/HostUnitTestCompilerPlugin
"HostUnitTestCompilerPlugin": {
"DscPath": "Test/MdePkgHostTest.dsc"
},
## options defined ci/Plugin/CharEncodingCheck
"CharEncodingCheck": {
"CharEncodingCheck": {
"IgnoreFiles": []
},
@ -21,7 +26,9 @@
"MdePkg/MdePkg.dec"
],
# For host based unit tests
"AcceptableDependencies-HOST_APPLICATION":[],
"AcceptableDependencies-HOST_APPLICATION":[
"UnitTestFrameworkPkg/UnitTestFrameworkPkg.dec"
],
# For UEFI shell based apps
"AcceptableDependencies-UEFI_APPLICATION":[],
"IgnoreInf": []
@ -29,10 +36,16 @@
## options defined ci/Plugin/DscCompleteCheck
"DscCompleteCheck": {
"IgnoreInf": [],
"IgnoreInf": [""],
"DscPath": "MdePkg.dsc"
},
## options defined ci/Plugin/HostUnitTestDscCompleteCheck
"HostUnitTestDscCompleteCheck": {
"IgnoreInf": [""],
"DscPath": "Test/MdePkgHostTest.dsc"
},
## options defined ci/Plugin/GuidCheck
"GuidCheck": {
"IgnoreGuidName": [

18
MdePkg/MdePkg.dsc
View File

@ -18,6 +18,8 @@
BUILD_TARGETS = DEBUG|RELEASE|NOOPT
SKUID_IDENTIFIER = DEFAULT
!include UnitTestFrameworkPkg/UnitTestFrameworkPkgTarget.dsc.inc
[PcdsFeatureFlag]
gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport|TRUE
@ -26,6 +28,9 @@
gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel|0x80000000
gEfiMdePkgTokenSpaceGuid.PcdPciExpressBaseAddress|0xE0000000
[LibraryClasses]
SafeIntLib|MdePkg/Library/BaseSafeIntLib/BaseSafeIntLib.inf
[Components]
MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.inf
MdePkg/Library/BaseCacheMaintenanceLib/BaseCacheMaintenanceLib.inf
@ -115,6 +120,19 @@
MdePkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.inf
MdePkg/Library/StandaloneMmServicesTableLib/StandaloneMmServicesTableLib.inf
#
# Add UEFI Target Based Unit Tests
#
MdePkg/Test/UnitTest/Library/BaseLib/BaseLibUnitTestsUefi.inf
#
# Build PEIM, DXE_DRIVER, SMM_DRIVER, UEFI Shell components that test SafeIntLib
#
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibPei.inf
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibDxe.inf
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibSmm.inf
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibUefiShell.inf
[Components.IA32, Components.X64]
MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf
MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsicSev.inf

30
MdePkg/Test/MdePkgHostTest.dsc Normal file
View File

@ -0,0 +1,30 @@
## @file
# MdePkg DSC file used to build host-based unit tests.
#
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# Copyright (C) Microsoft Corporation.
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
##
[Defines]
PLATFORM_NAME = MdePkgHostTest
PLATFORM_GUID = 50652B4C-88CB-4481-96E8-37F2D0034440
PLATFORM_VERSION = 0.1
DSC_SPECIFICATION = 0x00010005
OUTPUT_DIRECTORY = Build/MdePkg/HostTest
SUPPORTED_ARCHITECTURES = IA32|X64
BUILD_TARGETS = NOOPT
SKUID_IDENTIFIER = DEFAULT
!include UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc
[LibraryClasses]
SafeIntLib|MdePkg/Library/BaseSafeIntLib/BaseSafeIntLib.inf
[Components]
#
# Build HOST_APPLICATION that tests the SafeIntLib
#
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibHost.inf
MdePkg/Test/UnitTest/Library/BaseLib/BaseLibUnitTestsHost.inf

404
MdePkg/Test/UnitTest/Library/BaseLib/Base64UnitTest.c Normal file
View File

@ -0,0 +1,404 @@
/** @file
Unit tests of Base64 conversion APIs in BaseLib.
Copyright (C) Microsoft Corporation.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UnitTestLib.h>
#define UNIT_TEST_APP_NAME "BaseLib Unit Test Application"
#define UNIT_TEST_APP_VERSION "1.0"
/**
RFC 4648 https://tools.ietf.org/html/rfc4648 test vectors
BASE64("") = ""
BASE64("f") = "Zg=="
BASE64("fo") = "Zm8="
BASE64("foo") = "Zm9v"
BASE64("foob") = "Zm9vYg=="
BASE64("fooba") = "Zm9vYmE="
BASE64("foobar") = "Zm9vYmFy"
The test vectors are using ascii strings for the binary data
*/
typedef struct {
CHAR8 *TestInput;
CHAR8 *TestOutput;
EFI_STATUS ExpectedStatus;
VOID *BufferToFree;
UINTN ExpectedSize;
} BASIC_TEST_CONTEXT;
#define B64_TEST_1 ""
#define BIN_TEST_1 ""
#define B64_TEST_2 "Zg=="
#define BIN_TEST_2 "f"
#define B64_TEST_3 "Zm8="
#define BIN_TEST_3 "fo"
#define B64_TEST_4 "Zm9v"
#define BIN_TEST_4 "foo"
#define B64_TEST_5 "Zm9vYg=="
#define BIN_TEST_5 "foob"
#define B64_TEST_6 "Zm9vYmE="
#define BIN_TEST_6 "fooba"
#define B64_TEST_7 "Zm9vYmFy"
#define BIN_TEST_7 "foobar"
// Adds all white space - also ends the last quantum with only spaces afterwards
#define B64_TEST_8_IN " \t\v Zm9\r\nvYmFy \f "
#define BIN_TEST_8 "foobar"
// Not a quantum multiple of 4
#define B64_ERROR_1 "Zm9vymFy="
// Invalid characters in the string
#define B64_ERROR_2 "Zm$vymFy"
// Too many '=' characters
#define B64_ERROR_3 "Z==="
// Poorly placed '='
#define B64_ERROR_4 "Zm=vYmFy"
#define MAX_TEST_STRING_SIZE (200)
// ------------------------------------------------ Input----------Output-----------Result-------Free--Expected Output Size
static BASIC_TEST_CONTEXT mBasicEncodeTest1 = {BIN_TEST_1, B64_TEST_1, EFI_SUCCESS, NULL, sizeof(B64_TEST_1)};
static BASIC_TEST_CONTEXT mBasicEncodeTest2 = {BIN_TEST_2, B64_TEST_2, EFI_SUCCESS, NULL, sizeof(B64_TEST_2)};
static BASIC_TEST_CONTEXT mBasicEncodeTest3 = {BIN_TEST_3, B64_TEST_3, EFI_SUCCESS, NULL, sizeof(B64_TEST_3)};
static BASIC_TEST_CONTEXT mBasicEncodeTest4 = {BIN_TEST_4, B64_TEST_4, EFI_SUCCESS, NULL, sizeof(B64_TEST_4)};
static BASIC_TEST_CONTEXT mBasicEncodeTest5 = {BIN_TEST_5, B64_TEST_5, EFI_SUCCESS, NULL, sizeof(B64_TEST_5)};
static BASIC_TEST_CONTEXT mBasicEncodeTest6 = {BIN_TEST_6, B64_TEST_6, EFI_SUCCESS, NULL, sizeof(B64_TEST_6)};
static BASIC_TEST_CONTEXT mBasicEncodeTest7 = {BIN_TEST_7, B64_TEST_7, EFI_SUCCESS, NULL, sizeof(B64_TEST_7)};
static BASIC_TEST_CONTEXT mBasicEncodeError1 = {BIN_TEST_7, B64_TEST_1, EFI_BUFFER_TOO_SMALL, NULL, sizeof(B64_TEST_7)};
static BASIC_TEST_CONTEXT mBasicDecodeTest1 = {B64_TEST_1, BIN_TEST_1, EFI_SUCCESS, NULL, sizeof(BIN_TEST_1)-1};
static BASIC_TEST_CONTEXT mBasicDecodeTest2 = {B64_TEST_2, BIN_TEST_2, EFI_SUCCESS, NULL, sizeof(BIN_TEST_2)-1};
static BASIC_TEST_CONTEXT mBasicDecodeTest3 = {B64_TEST_3, BIN_TEST_3, EFI_SUCCESS, NULL, sizeof(BIN_TEST_3)-1};
static BASIC_TEST_CONTEXT mBasicDecodeTest4 = {B64_TEST_4, BIN_TEST_4, EFI_SUCCESS, NULL, sizeof(BIN_TEST_4)-1};
static BASIC_TEST_CONTEXT mBasicDecodeTest5 = {B64_TEST_5, BIN_TEST_5, EFI_SUCCESS, NULL, sizeof(BIN_TEST_5)-1};
static BASIC_TEST_CONTEXT mBasicDecodeTest6 = {B64_TEST_6, BIN_TEST_6, EFI_SUCCESS, NULL, sizeof(BIN_TEST_6)-1};
static BASIC_TEST_CONTEXT mBasicDecodeTest7 = {B64_TEST_7, BIN_TEST_7, EFI_SUCCESS, NULL, sizeof(BIN_TEST_7)-1};
static BASIC_TEST_CONTEXT mBasicDecodeTest8 = {B64_TEST_8_IN, BIN_TEST_8, EFI_SUCCESS, NULL, sizeof(BIN_TEST_8)-1};
static BASIC_TEST_CONTEXT mBasicDecodeError1 = {B64_ERROR_1, B64_ERROR_1, EFI_INVALID_PARAMETER, NULL, 0};
static BASIC_TEST_CONTEXT mBasicDecodeError2 = {B64_ERROR_2, B64_ERROR_2, EFI_INVALID_PARAMETER, NULL, 0};
static BASIC_TEST_CONTEXT mBasicDecodeError3 = {B64_ERROR_3, B64_ERROR_3, EFI_INVALID_PARAMETER, NULL, 0};
static BASIC_TEST_CONTEXT mBasicDecodeError4 = {B64_ERROR_4, B64_ERROR_4, EFI_INVALID_PARAMETER, NULL, 0};
static BASIC_TEST_CONTEXT mBasicDecodeError5 = {B64_TEST_7, BIN_TEST_1, EFI_BUFFER_TOO_SMALL, NULL, sizeof(BIN_TEST_7)-1};
/**
Simple clean up method to make sure tests clean up even if interrupted and fail
in the middle.
**/
STATIC
VOID
EFIAPI
CleanUpB64TestContext (
IN UNIT_TEST_CONTEXT Context
)
{
BASIC_TEST_CONTEXT *Btc;
Btc = (BASIC_TEST_CONTEXT *)Context;
if (Btc != NULL) {
//free string if set
if (Btc->BufferToFree != NULL) {
FreePool (Btc->BufferToFree);
Btc->BufferToFree = NULL;
}
}
}
/**
Unit test for Base64 encode APIs of BaseLib.
@param[in] Context [Optional] An optional parameter that enables:
1) test-case reuse with varied parameters and
2) test-case re-entry for Target tests that need a
reboot. This parameter is a VOID* and it is the
responsibility of the test author to ensure that the
contents are well understood by all test cases that may
consume it.
@retval UNIT_TEST_PASSED The Unit test has completed and the test
case was successful.
@retval UNIT_TEST_ERROR_TEST_FAILED A test case assertion has failed.
**/
STATIC
UNIT_TEST_STATUS
EFIAPI
RfcEncodeTest (
IN UNIT_TEST_CONTEXT Context
)
{
BASIC_TEST_CONTEXT *Btc;
CHAR8 *b64String;
CHAR8 *binString;
UINTN b64StringSize;
EFI_STATUS Status;
UINT8 *BinData;
UINTN BinSize;
CHAR8 *b64WorkString;
UINTN ReturnSize;
INTN CompareStatus;
UINTN indx;
Btc = (BASIC_TEST_CONTEXT *) Context;
binString = Btc->TestInput;
b64String = Btc->TestOutput;
//
// Only testing the the translate functionality, so preallocate the proper
// string buffer.
//
b64StringSize = AsciiStrnSizeS(b64String, MAX_TEST_STRING_SIZE);
BinSize = AsciiStrnLenS(binString, MAX_TEST_STRING_SIZE);
BinData = (UINT8 *) binString;
b64WorkString = (CHAR8 *) AllocatePool(b64StringSize);
UT_ASSERT_NOT_NULL(b64WorkString);
Btc->BufferToFree = b64WorkString;
ReturnSize = b64StringSize;
Status = Base64Encode(BinData, BinSize, b64WorkString, &ReturnSize);
UT_ASSERT_STATUS_EQUAL(Status, Btc->ExpectedStatus);
UT_ASSERT_EQUAL(ReturnSize, Btc->ExpectedSize);
if (!EFI_ERROR (Btc->ExpectedStatus)) {
if (ReturnSize != 0) {
CompareStatus = AsciiStrnCmp (b64String, b64WorkString, ReturnSize);
if (CompareStatus != 0) {
UT_LOG_ERROR ("b64 string compare error - size=%d\n", ReturnSize);
for (indx = 0; indx < ReturnSize; indx++) {
UT_LOG_ERROR (" %2.2x", 0xff & b64String[indx]);
}
UT_LOG_ERROR ("\n b64 work string:\n");
for (indx = 0; indx < ReturnSize; indx++) {
UT_LOG_ERROR (" %2.2x", 0xff & b64WorkString[indx]);
}
UT_LOG_ERROR ("\n");
}
UT_ASSERT_EQUAL (CompareStatus, 0);
}
}
Btc->BufferToFree = NULL;
FreePool (b64WorkString);
return UNIT_TEST_PASSED;
}
/**
Unit test for Base64 decode APIs of BaseLib.
@param[in] Context [Optional] An optional parameter that enables:
1) test-case reuse with varied parameters and
2) test-case re-entry for Target tests that need a
reboot. This parameter is a VOID* and it is the
responsibility of the test author to ensure that the
contents are well understood by all test cases that may
consume it.
@retval UNIT_TEST_PASSED The Unit test has completed and the test
case was successful.
@retval UNIT_TEST_ERROR_TEST_FAILED A test case assertion has failed.
**/
STATIC
UNIT_TEST_STATUS
EFIAPI
RfcDecodeTest(
IN UNIT_TEST_CONTEXT Context
)
{
BASIC_TEST_CONTEXT *Btc;
CHAR8 *b64String;
CHAR8 *binString;
EFI_STATUS Status;
UINTN b64StringLen;
UINTN ReturnSize;
UINT8 *BinData;
UINTN BinSize;
INTN CompareStatus;
UINTN indx;
Btc = (BASIC_TEST_CONTEXT *)Context;
b64String = Btc->TestInput;
binString = Btc->TestOutput;
//
// Only testing the the translate functionality
//
b64StringLen = AsciiStrnLenS (b64String, MAX_TEST_STRING_SIZE);
BinSize = AsciiStrnLenS (binString, MAX_TEST_STRING_SIZE);
BinData = AllocatePool (BinSize);
Btc->BufferToFree = BinData;
ReturnSize = BinSize;
Status = Base64Decode (b64String, b64StringLen, BinData, &ReturnSize);
UT_ASSERT_STATUS_EQUAL (Status, Btc->ExpectedStatus);
// If an error is not expected, check the results
if (EFI_ERROR (Btc->ExpectedStatus)) {
if (Btc->ExpectedStatus == EFI_BUFFER_TOO_SMALL) {
UT_ASSERT_EQUAL (ReturnSize, Btc->ExpectedSize);
}
} else {
UT_ASSERT_EQUAL (ReturnSize, Btc->ExpectedSize);
if (ReturnSize != 0) {
CompareStatus = CompareMem (binString, BinData, ReturnSize);
if (CompareStatus != 0) {
UT_LOG_ERROR ("bin string compare error - size=%d\n", ReturnSize);
for (indx = 0; indx < ReturnSize; indx++) {
UT_LOG_ERROR (" %2.2x", 0xff & binString[indx]);
}
UT_LOG_ERROR ("\nBinData:\n");
for (indx = 0; indx < ReturnSize; indx++) {
UT_LOG_ERROR (" %2.2x", 0xff & BinData[indx]);
}
UT_LOG_ERROR ("\n");
}
UT_ASSERT_EQUAL (CompareStatus, 0);
}
}
Btc->BufferToFree = NULL;
FreePool (BinData);
return UNIT_TEST_PASSED;
}
/**
Initialze the unit test framework, suite, and unit tests for the
Base64 conversion APIs of BaseLib and run the unit tests.
@retval EFI_SUCCESS All test cases were dispatched.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to
initialize the unit tests.
**/
STATIC
EFI_STATUS
EFIAPI
UnitTestingEntry (
VOID
)
{
EFI_STATUS Status;
UNIT_TEST_FRAMEWORK_HANDLE Fw;
UNIT_TEST_SUITE_HANDLE b64EncodeTests;
UNIT_TEST_SUITE_HANDLE b64DecodeTests;
Fw = NULL;
DEBUG ((DEBUG_INFO, "%a v%a\n", UNIT_TEST_APP_NAME, UNIT_TEST_APP_VERSION));
//
// Start setting up the test framework for running the tests.
//
Status = InitUnitTestFramework (&Fw, UNIT_TEST_APP_NAME, gEfiCallerBaseName, UNIT_TEST_APP_VERSION);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Failed in InitUnitTestFramework. Status = %r\n", Status));
goto EXIT;
}
//
// Populate the B64 Encode Unit Test Suite.
//
Status = CreateUnitTestSuite (&b64EncodeTests, Fw, "b64 Encode binary to Ascii string", "BaseLib.b64Encode", NULL, NULL);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Failed in CreateUnitTestSuite for b64EncodeTests\n"));
Status = EFI_OUT_OF_RESOURCES;
goto EXIT;
}
// --------------Suite-----------Description--------------Class Name----------Function--------Pre---Post-------------------Context-----------
AddTestCase (b64EncodeTests, "RFC 4686 Test Vector - Empty", "Test1", RfcEncodeTest, NULL, CleanUpB64TestContext, &mBasicEncodeTest1);
AddTestCase (b64EncodeTests, "RFC 4686 Test Vector - f", "Test2", RfcEncodeTest, NULL, CleanUpB64TestContext, &mBasicEncodeTest2);
AddTestCase (b64EncodeTests, "RFC 4686 Test Vector - fo", "Test3", RfcEncodeTest, NULL, CleanUpB64TestContext, &mBasicEncodeTest3);
AddTestCase (b64EncodeTests, "RFC 4686 Test Vector - foo", "Test4", RfcEncodeTest, NULL, CleanUpB64TestContext, &mBasicEncodeTest4);
AddTestCase (b64EncodeTests, "RFC 4686 Test Vector - foob", "Test5", RfcEncodeTest, NULL, CleanUpB64TestContext, &mBasicEncodeTest5);
AddTestCase (b64EncodeTests, "RFC 4686 Test Vector - fooba", "Test6", RfcEncodeTest, NULL, CleanUpB64TestContext, &mBasicEncodeTest6);
AddTestCase (b64EncodeTests, "RFC 4686 Test Vector - foobar", "Test7", RfcEncodeTest, NULL, CleanUpB64TestContext, &mBasicEncodeTest7);
AddTestCase (b64EncodeTests, "Too small of output buffer", "Error1", RfcEncodeTest, NULL, CleanUpB64TestContext, &mBasicEncodeError1);
//
// Populate the B64 Decode Unit Test Suite.
//
Status = CreateUnitTestSuite (&b64DecodeTests, Fw, "b64 Decode Ascii string to binary", "BaseLib.b64Decode", NULL, NULL);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "Failed in CreateUnitTestSuite for b64Decode Tests\n"));
Status = EFI_OUT_OF_RESOURCES;
goto EXIT;
}
AddTestCase (b64DecodeTests, "RFC 4686 Test Vector - Empty", "Test1", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeTest1);
AddTestCase (b64DecodeTests, "RFC 4686 Test Vector - f", "Test2", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeTest2);
AddTestCase (b64DecodeTests, "RFC 4686 Test Vector - fo", "Test3", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeTest3);
AddTestCase (b64DecodeTests, "RFC 4686 Test Vector - foo", "Test4", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeTest4);
AddTestCase (b64DecodeTests, "RFC 4686 Test Vector - foob", "Test5", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeTest5);
AddTestCase (b64DecodeTests, "RFC 4686 Test Vector - fooba", "Test6", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeTest6);
AddTestCase (b64DecodeTests, "RFC 4686 Test Vector - foobar", "Test7", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeTest7);
AddTestCase (b64DecodeTests, "Ignore Whitespace test", "Test8", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeTest8);
AddTestCase (b64DecodeTests, "Not a quantum multiple of 4", "Error1", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeError1);
AddTestCase (b64DecodeTests, "Invalid characters in the string", "Error2", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeError2);
AddTestCase (b64DecodeTests, "Too many padding characters", "Error3", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeError3);
AddTestCase (b64DecodeTests, "Incorrectly placed padding character", "Error4", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeError4);
AddTestCase (b64DecodeTests, "Too small of output buffer", "Error5", RfcDecodeTest, NULL, CleanUpB64TestContext, &mBasicDecodeError5);
//
// Execute the tests.
//
Status = RunAllTestSuites (Fw);
EXIT:
if (Fw) {
FreeUnitTestFramework (Fw);
}
return Status;
}
/**
Standard UEFI entry point for target based unit test execution from UEFI Shell.
**/
EFI_STATUS
EFIAPI
BaseLibUnitTestAppEntry (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
return UnitTestingEntry ();
}
/**
Standard POSIX C entry point for host based unit test execution.
**/
int
main (
int argc,
char *argv[]
)
{
return UnitTestingEntry ();
}

32
MdePkg/Test/UnitTest/Library/BaseLib/BaseLibUnitTestsHost.inf Normal file
View File

@ -0,0 +1,32 @@
## @file
# Unit tests of Base64 conversion APIs in BaseLib that are run from host
# environment.
#
# Copyright (C) Microsoft Corporation.
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010006
BASE_NAME = BaseLibUnitTestsHost
FILE_GUID = 1d005f4c-4dfa-41b5-ab0c-be91fe121459
MODULE_TYPE = HOST_APPLICATION
VERSION_STRING = 1.0
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
Base64UnitTest.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
BaseLib
BaseMemoryLib
DebugLib
UnitTestLib

33
MdePkg/Test/UnitTest/Library/BaseLib/BaseLibUnitTestsUefi.inf Normal file
View File

@ -0,0 +1,33 @@
## @file
# Unit tests of Base64 conversion APIs in BaseLib that are run from UEFI Shell.
#
# Copyright (C) Microsoft Corporation.
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010006
BASE_NAME = BaseLibUnitTestsUefi
FILE_GUID = df5a6fed-8786-4a9d-9d02-eab39497b4a1
MODULE_TYPE = UEFI_APPLICATION
VERSION_STRING = 1.0
ENTRY_POINT = BaseLibUnitTestAppEntry
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
Base64UnitTest.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
BaseLib
BaseMemoryLib
UefiApplicationEntryPoint
DebugLib
UnitTestLib

540
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/SafeIntLibUintnIntnUnitTests32.c Normal file
View File

@ -0,0 +1,540 @@
/** @file
IA32-specific functions for unit-testing INTN and UINTN functions in
SafeIntLib.
Copyright (c) Microsoft Corporation.<BR>
Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "TestBaseSafeIntLib.h"
UNIT_TEST_STATUS
EFIAPI
TestSafeInt32ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT32 Operand;
UINTN Result;
//
// If Operand is non-negative, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeInt32ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (-1537977259);
Status = SafeInt32ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint32ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT32 Operand;
INTN Result;
//
// If Operand is <= MAX_INTN, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeUint32ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xabababab);
Status = SafeUint32ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToInt32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Operand;
INT32 Result;
//
// INTN is same as INT32 in IA32, so this is just a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeIntnToInt32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToUint32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Operand;
UINT32 Result;
//
// If Operand is non-negative, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeIntnToUint32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (-1537977259);
Status = SafeIntnToUint32(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToUint32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
UINT32 Result;
//
// UINTN is same as UINT32 in IA32, so this is just a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeUintnToUint32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
INTN Result;
//
// If Operand is <= MAX_INTN, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeUintnToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xabababab);
Status = SafeUintnToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToInt64 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
INT64 Result;
//
// UINTN is same as UINT32 in IA32, and UINT32 is a subset of
// INT64, so this is just a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeUintnToInt64(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT64 Operand;
INTN Result;
//
// If Operand is between MIN_INTN and MAX_INTN2 inclusive, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
Operand = (-1537977259);
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-1537977259), Result);
//
// Otherwise should result in an error status
//
Operand = (0x5babababefefefef);
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Operand = (-6605562033422200815);
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT64 Operand;
UINTN Result;
//
// If Operand is between 0 and MAX_UINTN inclusive, then it's a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeInt64ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0x5babababefefefef);
Status = SafeInt64ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Operand = (-6605562033422200815);
Status = SafeInt64ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT64 Operand;
INTN Result;
//
// If Operand is <= MAX_INTN, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeUint64ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xababababefefefef);
Status = SafeUint64ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT64 Operand;
UINTN Result;
//
// If Operand is <= MAX_UINTN, then it's a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeUint64ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xababababefefefef);
Status = SafeUint64ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnAdd (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Augend;
UINTN Addend;
UINTN Result;
//
// If the result of addition doesn't overflow MAX_UINTN, then it's addition
//
Augend = 0x3a3a3a3a;
Addend = 0x3a3a3a3a;
Result = 0;
Status = SafeUintnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x74747474, Result);
//
// Otherwise should result in an error status
//
Augend = 0xabababab;
Addend = 0xbcbcbcbc;
Status = SafeUintnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnAdd (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Augend;
INTN Addend;
INTN Result;
//
// If the result of addition doesn't overflow MAX_INTN
// and doesn't underflow MIN_INTN, then it's addition
//
Augend = 0x3a3a3a3a;
Addend = 0x3a3a3a3a;
Result = 0;
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x74747474, Result);
Augend = (-976894522);
Addend = (-976894522);
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-1953789044), Result);
//
// Otherwise should result in an error status
//
Augend = 0x5a5a5a5a;
Addend = 0x5a5a5a5a;
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Augend = (-1515870810);
Addend = (-1515870810);
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnSub (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Minuend;
UINTN Subtrahend;
UINTN Result;
//
// If Minuend >= Subtrahend, then it's subtraction
//
Minuend = 0x5a5a5a5a;
Subtrahend = 0x3b3b3b3b;
Result = 0;
Status = SafeUintnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x1f1f1f1f, Result);
//
// Otherwise should result in an error status
//
Minuend = 0x5a5a5a5a;
Subtrahend = 0x6d6d6d6d;
Status = SafeUintnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnSub (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Minuend;
INTN Subtrahend;
INTN Result;
//
// If the result of subtractions doesn't overflow MAX_INTN or
// underflow MIN_INTN, then it's subtraction
//
Minuend = 0x5a5a5a5a;
Subtrahend = 0x3a3a3a3a;
Result = 0;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x20202020, Result);
Minuend = 0x3a3a3a3a;
Subtrahend = 0x5a5a5a5a;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-538976288), Result);
//
// Otherwise should result in an error status
//
Minuend = (-2054847098);
Subtrahend = 2054847098;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Minuend = (2054847098);
Subtrahend = (-2054847098);
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnMult (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Multiplicand;
UINTN Multiplier;
UINTN Result;
//
// If the result of multiplication doesn't overflow MAX_UINTN, it will succeed
//
Multiplicand = 0xa122a;
Multiplier = 0xd23;
Result = 0;
Status = SafeUintnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x844c9dbe, Result);
//
// Otherwise should result in an error status
//
Multiplicand = 0xa122a;
Multiplier = 0xed23;
Status = SafeUintnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnMult (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Multiplicand;
INTN Multiplier;
INTN Result;
//
// If the result of multiplication doesn't overflow MAX_INTN and doesn't
// underflow MIN_UINTN, it will succeed
//
Multiplicand = 0x123456;
Multiplier = 0x678;
Result = 0;
Status = SafeIntnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x75c28c50, Result);
//
// Otherwise should result in an error status
//
Multiplicand = 0x123456;
Multiplier = 0xabc;
Status = SafeIntnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}

544
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/SafeIntLibUintnIntnUnitTests64.c Normal file
View File

@ -0,0 +1,544 @@
/** @file
x64-specific functions for unit-testing INTN and UINTN functions in
SafeIntLib.
Copyright (c) Microsoft Corporation.<BR>
Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "TestBaseSafeIntLib.h"
UNIT_TEST_STATUS
EFIAPI
TestSafeInt32ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT32 Operand;
UINTN Result;
//
// If Operand is non-negative, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeInt32ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
//
// Otherwise should result in an error status
//
Operand = (-1537977259);
Status = SafeInt32ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint32ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT32 Operand;
INTN Result;
//
// For x64, INTN is same as INT64 which is a superset of INT32
// This is just a cast then, and it'll never fail
//
//
// If Operand is non-negative, then it's a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeUint32ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToInt32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Operand;
INT32 Result;
//
// If Operand is between MIN_INT32 and MAX_INT32 inclusive, then it's a cast
//
Operand = 0x5bababab;
Result = 0;
Status = SafeIntnToInt32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5bababab, Result);
Operand = (-1537977259);
Status = SafeIntnToInt32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-1537977259), Result);
//
// Otherwise should result in an error status
//
Operand = (0x5babababefefefef);
Status = SafeIntnToInt32(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Operand = (-6605562033422200815);
Status = SafeIntnToInt32(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToUint32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Operand;
UINT32 Result;
//
// If Operand is between 0 and MAX_UINT32 inclusive, then it's a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeIntnToUint32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0x5babababefefefef);
Status = SafeIntnToUint32(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Operand = (-6605562033422200815);
Status = SafeIntnToUint32(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToUint32 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
UINT32 Result;
//
// If Operand is <= MAX_UINT32, then it's a cast
//
Operand = 0xabababab;
Result = 0;
Status = SafeUintnToUint32(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xabababab, Result);
//
// Otherwise should result in an error status
//
Operand = (0xababababefefefef);
Status = SafeUintnToUint32(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
INTN Result;
//
// If Operand is <= MAX_INTN (0x7fff_ffff_ffff_ffff), then it's a cast
//
Operand = 0x5babababefefefef;
Result = 0;
Status = SafeUintnToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5babababefefefef, Result);
//
// Otherwise should result in an error status
//
Operand = (0xababababefefefef);
Status = SafeUintnToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToInt64 (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Operand;
INT64 Result;
//
// If Operand is <= MAX_INT64, then it's a cast
//
Operand = 0x5babababefefefef;
Result = 0;
Status = SafeUintnToInt64(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5babababefefefef, Result);
//
// Otherwise should result in an error status
//
Operand = (0xababababefefefef);
Status = SafeUintnToInt64(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT64 Operand;
INTN Result;
//
// INTN is same as INT64 in x64, so this is just a cast
//
Operand = 0x5babababefefefef;
Result = 0;
Status = SafeInt64ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5babababefefefef, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INT64 Operand;
UINTN Result;
//
// If Operand is non-negative, then it's a cast
//
Operand = 0x5babababefefefef;
Result = 0;
Status = SafeInt64ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5babababefefefef, Result);
//
// Otherwise should result in an error status
//
Operand = (-6605562033422200815);
Status = SafeInt64ToUintn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToIntn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT64 Operand;
INTN Result;
//
// If Operand is <= MAX_INTN (0x7fff_ffff_ffff_ffff), then it's a cast
//
Operand = 0x5babababefefefef;
Result = 0;
Status = SafeUint64ToIntn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x5babababefefefef, Result);
//
// Otherwise should result in an error status
//
Operand = (0xababababefefefef);
Status = SafeUint64ToIntn(Operand, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToUintn (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINT64 Operand;
UINTN Result;
//
// UINTN is same as UINT64 in x64, so this is just a cast
//
Operand = 0xababababefefefef;
Result = 0;
Status = SafeUint64ToUintn(Operand, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0xababababefefefef, Result);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnAdd (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Augend;
UINTN Addend;
UINTN Result;
//
// If the result of addition doesn't overflow MAX_UINTN, then it's addition
//
Augend = 0x3a3a3a3a12121212;
Addend = 0x3a3a3a3a12121212;
Result = 0;
Status = SafeUintnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x7474747424242424, Result);
//
// Otherwise should result in an error status
//
Augend = 0xababababefefefef;
Addend = 0xbcbcbcbcdededede;
Status = SafeUintnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnAdd (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Augend;
INTN Addend;
INTN Result;
//
// If the result of addition doesn't overflow MAX_INTN
// and doesn't underflow MIN_INTN, then it's addition
//
Augend = 0x3a3a3a3a3a3a3a3a;
Addend = 0x3a3a3a3a3a3a3a3a;
Result = 0;
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x7474747474747474, Result);
Augend = (-4195730024608447034);
Addend = (-4195730024608447034);
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-8391460049216894068), Result);
//
// Otherwise should result in an error status
//
Augend = 0x5a5a5a5a5a5a5a5a;
Addend = 0x5a5a5a5a5a5a5a5a;
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Augend = (-6510615555426900570);
Addend = (-6510615555426900570);
Status = SafeIntnAdd(Augend, Addend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnSub (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Minuend;
UINTN Subtrahend;
UINTN Result;
//
// If Minuend >= Subtrahend, then it's subtraction
//
Minuend = 0x5a5a5a5a5a5a5a5a;
Subtrahend = 0x3b3b3b3b3b3b3b3b;
Result = 0;
Status = SafeUintnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x1f1f1f1f1f1f1f1f, Result);
//
// Otherwise should result in an error status
//
Minuend = 0x5a5a5a5a5a5a5a5a;
Subtrahend = 0x6d6d6d6d6d6d6d6d;
Status = SafeUintnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnSub (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Minuend;
INTN Subtrahend;
INTN Result;
//
// If the result of subtractions doesn't overflow MAX_INTN or
// underflow MIN_INTN, then it's subtraction
//
Minuend = 0x5a5a5a5a5a5a5a5a;
Subtrahend = 0x3a3a3a3a3a3a3a3a;
Result = 0;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x2020202020202020, Result);
Minuend = 0x3a3a3a3a3a3a3a3a;
Subtrahend = 0x5a5a5a5a5a5a5a5a;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL((-2314885530818453536), Result);
//
// Otherwise should result in an error status
//
Minuend = (-8825501086245354106);
Subtrahend = 8825501086245354106;
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
Minuend = (8825501086245354106);
Subtrahend = (-8825501086245354106);
Status = SafeIntnSub(Minuend, Subtrahend, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnMult (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
UINTN Multiplicand;
UINTN Multiplier;
UINTN Result;
//
// If the result of multiplication doesn't overflow MAX_UINTN, it will succeed
//
Multiplicand = 0x123456789a;
Multiplier = 0x1234567;
Result = 0;
Status = SafeUintnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x14b66db9745a07f6, Result);
//
// Otherwise should result in an error status
//
Multiplicand = 0x123456789a;
Multiplier = 0x12345678;
Status = SafeUintnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnMult (
IN UNIT_TEST_CONTEXT Context
)
{
EFI_STATUS Status;
INTN Multiplicand;
INTN Multiplier;
INTN Result;
//
// If the result of multiplication doesn't overflow MAX_INTN and doesn't
// underflow MIN_UINTN, it will succeed
//
Multiplicand = 0x123456789;
Multiplier = 0x6789abcd;
Result = 0;
Status = SafeIntnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_NOT_EFI_ERROR(Status);
UT_ASSERT_EQUAL(0x75cd9045220d6bb5, Result);
//
// Otherwise should result in an error status
//
Multiplicand = 0x123456789;
Multiplier = 0xa789abcd;
Status = SafeIntnMult(Multiplicand, Multiplier, &Result);
UT_ASSERT_EQUAL(RETURN_BUFFER_TOO_SMALL, Status);
return UNIT_TEST_PASSED;
}

3064
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLib.c Normal file
View File

File diff suppressed because it is too large Load Diff

123
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLib.h Normal file
View File

@ -0,0 +1,123 @@
/** @file
UEFI OS based application for unit testing the SafeIntLib.
Copyright (c) Microsoft Corporation.<BR>
Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _TEST_BASE_SAFE_INT_LIB_H_
#define _TEST_BASE_SAFE_INT_LIB_H_
#include <PiPei.h>
#include <Uefi.h>
#include <Library/UefiLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UnitTestLib.h>
#include <Library/SafeIntLib.h>
UNIT_TEST_STATUS
EFIAPI
TestSafeInt32ToUintn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUint32ToIntn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToInt32(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnToUint32(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToUint32(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToIntn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnToInt64(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToIntn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeInt64ToUintn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToIntn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUint64ToUintn(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnAdd(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnAdd(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnSub(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnSub(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeUintnMult(
IN UNIT_TEST_CONTEXT Context
);
UNIT_TEST_STATUS
EFIAPI
TestSafeIntnMult(
IN UNIT_TEST_CONTEXT Context
);
#endif

13
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLib.uni Normal file
View File

@ -0,0 +1,13 @@
// /** @file
// Application that Unit Tests the SafeIntLib
//
// Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>
//
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
// **/
#string STR_MODULE_ABSTRACT #language en-US "Application that Unit Tests the SafeIntLib"
#string STR_MODULE_DESCRIPTION #language en-US "Application that Unit Tests the SafeIntLib."

45
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibDxe.inf Normal file
View File

@ -0,0 +1,45 @@
## @file
# DXE Driver that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibDxe
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 9729DB60-FB9D-4625-9EE1-93B21EC246B8
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
ENTRY_POINT = DxeEntryPoint
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
UefiDriverEntryPoint
BaseLib
DebugLib
SafeIntLib
UnitTestLib
[Depex]
TRUE

40
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibHost.inf Normal file
View File

@ -0,0 +1,40 @@
## @file
# Host OS based Application that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibHost
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 95487689-9E30-41AD-B773-3650C94BCBE2
MODULE_TYPE = HOST_APPLICATION
VERSION_STRING = 1.0
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
BaseLib
DebugLib
SafeIntLib
UnitTestLib

45
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibPei.inf Normal file
View File

@ -0,0 +1,45 @@
## @file
# PEIM that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibPei
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 7D910602-ED53-45E6-826E-8266705B9734
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
ENTRY_POINT = PeiEntryPoint
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
PeimEntryPoint
BaseLib
DebugLib
SafeIntLib
UnitTestLib
[Depex]
TRUE

45
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibSmm.inf Normal file
View File

@ -0,0 +1,45 @@
## @file
# SMM Driver that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibSmm
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 2F2A1907-B1B4-4E33-8B83-62A60AB4F0D4
MODULE_TYPE = DXE_SMM_DRIVER
VERSION_STRING = 1.0
ENTRY_POINT = DxeEntryPoint
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
UefiDriverEntryPoint
BaseLib
DebugLib
SafeIntLib
UnitTestLib
[Depex]
TRUE

42
MdePkg/Test/UnitTest/Library/BaseSafeIntLib/TestBaseSafeIntLibUefiShell.inf Normal file
View File

@ -0,0 +1,42 @@
## @file
# UEFI Shell based Application that Unit Tests the SafeIntLib
#
# Copyright (c) Microsoft Corporation.<BR>
# Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
# SPDX-License-Identifier: BSD-2-Clause-Patent
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TestBaseSafeIntLibUefiShell
MODULE_UNI_FILE = TestBaseSafeIntLib.uni
FILE_GUID = 1F91B73E-5B6A-4317-80E8-E7C36A3C7AF4
MODULE_TYPE = UEFI_APPLICATION
VERSION_STRING = 1.0
ENTRY_POINT = DxeEntryPoint
#
# The following information is for reference only and not required by the build tools.
#
# VALID_ARCHITECTURES = IA32 X64
#
[Sources]
TestBaseSafeIntLib.c
TestBaseSafeIntLib.h
[Sources.Ia32, Sources.ARM]
SafeIntLibUintnIntnUnitTests32.c
[Sources.X64, Sources.AARCH64]
SafeIntLibUintnIntnUnitTests64.c
[Packages]
MdePkg/MdePkg.dec
[LibraryClasses]
UefiApplicationEntryPoint
BaseLib
DebugLib
SafeIntLib
UnitTestLib