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