UnitTestFrameworkTypes.h

Go to the documentation of this file.

 
#ifndef __UNIT_TEST_TYPES_H__
#define __UNIT_TEST_TYPES_H__
 
#include <Library/UnitTestLib.h>
 
#define UNIT_TEST_MAX_STRING_LENGTH  (512)
 
#define UNIT_TEST_FINGERPRINT_SIZE  (sizeof (UINT32))
 
typedef UINT32 FAILURE_TYPE;
#define FAILURETYPE_NOFAILURE          (0)
#define FAILURETYPE_OTHER              (1)
#define FAILURETYPE_ASSERTTRUE         (2)
#define FAILURETYPE_ASSERTFALSE        (3)
#define FAILURETYPE_ASSERTEQUAL        (4)
#define FAILURETYPE_ASSERTNOTEQUAL     (5)
#define FAILURETYPE_ASSERTNOTEFIERROR  (6)
#define FAILURETYPE_ASSERTSTATUSEQUAL  (7)
#define FAILURETYPE_ASSERTNOTNULL      (8)
#define FAILURETYPE_EXPECTASSERT       (9)
 
typedef struct {
  CHAR8                     *Description;
  CHAR8                     *Name; // can't have spaces and should be short
  CHAR8                     *Log;
  FAILURE_TYPE              FailureType;
  CHAR8                     FailureMessage[UNIT_TEST_MAX_STRING_LENGTH];
  UINT8                     Fingerprint[UNIT_TEST_FINGERPRINT_SIZE];
  UNIT_TEST_STATUS          Result;
  UNIT_TEST_FUNCTION        RunTest;
  UNIT_TEST_PREREQUISITE    Prerequisite;
  UNIT_TEST_CLEANUP         CleanUp;
  UNIT_TEST_CONTEXT         Context;
  UNIT_TEST_SUITE_HANDLE    ParentSuite;
} UNIT_TEST;
 
typedef struct {
  LIST_ENTRY    Entry;
  UNIT_TEST     UT;
} UNIT_TEST_LIST_ENTRY;
 
typedef struct {
  UINTN                         NumTests;
  CHAR8                         *Title;
  CHAR8                         *Name;
  UINT8                         Fingerprint[UNIT_TEST_FINGERPRINT_SIZE];
  UNIT_TEST_SUITE_SETUP         Setup;
  UNIT_TEST_SUITE_TEARDOWN      Teardown;
  LIST_ENTRY                    TestCaseList;   // UNIT_TEST_LIST_ENTRY
  UNIT_TEST_FRAMEWORK_HANDLE    ParentFramework;
} UNIT_TEST_SUITE;
 
typedef struct {
  LIST_ENTRY         Entry;
  UNIT_TEST_SUITE    UTS;
} UNIT_TEST_SUITE_LIST_ENTRY;
 
typedef struct {
  CHAR8         *Title;
  CHAR8         *ShortTitle;    // This title should contain NO spaces or non-filename characters. Is used in reporting and serialization.
  CHAR8         *VersionString;
  CHAR8         *Log;
  UINT8         Fingerprint[UNIT_TEST_FINGERPRINT_SIZE];
  LIST_ENTRY    TestSuiteList;  // UNIT_TEST_SUITE_LIST_ENTRY
  EFI_TIME      StartTime;
  EFI_TIME      EndTime;
  UNIT_TEST     *CurrentTest;
  VOID          *SavedState;    // This is an instance of UNIT_TEST_SAVE_HEADER*, if present.
} UNIT_TEST_FRAMEWORK;
 
typedef struct {
  UINT32              Size;                                       // Size of the UNIT_TEST_SAVE_TEST including Log[]
  UINT8               Fingerprint[UNIT_TEST_FINGERPRINT_SIZE];    // Fingerprint of the test itself.
  CHAR8               FailureMessage[UNIT_TEST_MAX_STRING_LENGTH];
  FAILURE_TYPE        FailureType;
  UNIT_TEST_STATUS    Result;
  CHAR8               Log[];
} UNIT_TEST_SAVE_TEST;
 
typedef struct {
  UINT32    Size;                                    // Size of the UNIT_TEST_SAVE_CONTEXT including Data[]
  UINT8     Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; // Fingerprint of the corresponding test.
  UINT8     Data[];                                  // Actual data of the context.
} UNIT_TEST_SAVE_CONTEXT;
 
typedef struct {
  UINT8       Version;
  UINT32      SaveStateSize;                           // Size of the entire serialized buffer.
  UINT8       Fingerprint[UNIT_TEST_FINGERPRINT_SIZE]; // Fingerprint of the framework that has been saved.
  EFI_TIME    StartTime;
  UINT32      TestCount;
  BOOLEAN     HasSavedContext;
  // UNIT_TEST_SAVE_TEST    Tests[];         // Array of structures starts here.
  // UNIT_TEST_SAVE_CONTEXT SavedContext[];  // Saved context for the currently running test.
  // CHAR8                  Log[];           // NOTE: Not yet implemented!!
} UNIT_TEST_SAVE_HEADER;
 
VOID
EFIAPI
UnitTestLogInit (
  IN OUT UNIT_TEST  *Test,
  IN UINT8          *Buffer     OPTIONAL,
  IN UINTN          BufferSize  OPTIONAL
  );
 
UNIT_TEST_FRAMEWORK_HANDLE
GetActiveFrameworkHandle (
  VOID
  );
 
#endif