#include <PiPei.h>
#include <Uefi.h>
#include <Library/UefiLib.h>
#include <Library/DebugLib.h>
#include <Library/UnitTestLib.h>
#include <Library/PrintLib.h>

Macros
#define	UNIT_TEST_NAME "Sample Unit Test Generate Exception"

#define	UNIT_TEST_VERSION "0.1"

Functions
VOID EFIAPI	TestSuiteEnableAsserts (VOID)

VOID EFIAPI	TestSuiteDisableAsserts (VOID)

UINTN	DivideWithNoParameterChecking (UINTN Dividend, UINTN Divisor)

UNIT_TEST_STATUS EFIAPI	GenerateUnexpectedException (IN UNIT_TEST_CONTEXT Context)

EFI_STATUS EFIAPI	UefiTestMain (VOID)

EFI_STATUS EFIAPI	PeiEntryPoint (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

EFI_STATUS EFIAPI	DxeEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

int	main (int argc, char *argv[])

Detailed Description

This is a sample to demonstrate the usage of the Unit Test Library that supports the PEI, DXE, SMM, UEFI Shell, and host execution environments. This test case generates an exception. For some host-based environments, this is a fatal condition that terminates the unit tests and no additional test cases are executed. On other environments, this condition may be report a unit test failure and continue with additional unit tests.

Copyright (c) 2024, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SampleUnitTestGenerateException.c.

Macro Definition Documentation

◆ UNIT_TEST_NAME

#define UNIT_TEST_NAME "Sample Unit Test Generate Exception"

Definition at line 20 of file SampleUnitTestGenerateException.c.

◆ UNIT_TEST_VERSION

#define UNIT_TEST_VERSION "0.1"

Definition at line 21 of file SampleUnitTestGenerateException.c.

Function Documentation

◆ DivideWithNoParameterChecking()

UINTN DivideWithNoParameterChecking	(	UINTN	Dividend,
		UINTN	Divisor
	)

Definition at line 54 of file SampleUnitTestGenerateException.c.

◆ DxeEntryPoint()

EFI_STATUS EFIAPI DxeEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Standard UEFI entry point for target based unit test execution from DXE, SMM, UEFI Shell.

Definition at line 186 of file SampleUnitTestGenerateException.c.

◆ GenerateUnexpectedException()

UNIT_TEST_STATUS EFIAPI GenerateUnexpectedException ( IN UNIT_TEST_CONTEXT Context )

Sample unit test the triggers an unexpected exception

Parameters

[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.

Return values