UnitTestFrameworkPkg: Change OPTIONAL keyword usage style

[mirror_edk2.git] / UnitTestFrameworkPkg / Library / UnitTestLib / Log.c

/**\r
  Implemnet UnitTestLib log services\r
\r
  Copyright (c) Microsoft Corporation.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include <PiDxe.h>\r
#include <UnitTestFrameworkTypes.h>\r
#include <Library/UnitTestLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/PcdLib.h>\r
\r
#define UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH  (512)\r
#define UNIT_TEST_MAX_LOG_BUFFER                SIZE_16KB\r
\r
struct _UNIT_TEST_LOG_PREFIX_STRING {\r
  UNIT_TEST_STATUS  LogLevel;\r
  CHAR8             *String;\r
};\r
\r
struct _UNIT_TEST_LOG_PREFIX_STRING  mLogPrefixStrings[] = {\r
  { UNIT_TEST_LOG_LEVEL_ERROR,   "[ERROR]       " },\r
  { UNIT_TEST_LOG_LEVEL_WARN,    "[WARNING]     " },\r
  { UNIT_TEST_LOG_LEVEL_INFO,    "[INFO]        " },\r
  { UNIT_TEST_LOG_LEVEL_VERBOSE, "[VERBOSE]     " }\r
};\r
\r
//\r
// Unit-Test Log helper functions\r
//\r
\r
STATIC\r
CONST CHAR8*\r
GetStringForStatusLogPrefix (\r
  IN UINTN  LogLevel\r
  )\r
{\r
  UINTN  Index;\r
  CHAR8  *Result;\r
\r
  Result = NULL;\r
  for (Index = 0; Index < ARRAY_SIZE (mLogPrefixStrings); Index++) {\r
    if (mLogPrefixStrings[Index].LogLevel == LogLevel) {\r
      Result = mLogPrefixStrings[Index].String;\r
      break;\r
    }\r
  }\r
  return Result;\r
}\r
\r
STATIC\r
EFI_STATUS\r
AddStringToUnitTestLog (\r
  IN OUT UNIT_TEST    *UnitTest,\r
  IN     CONST CHAR8  *String\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Make sure that you're cooking with gas.\r
  //\r
  if (UnitTest == NULL || String == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  // If this is the first log for the test allocate log space\r
  if (UnitTest->Log == NULL) {\r
    UnitTestLogInit (UnitTest, NULL, 0);\r
  }\r
\r
  if (UnitTest->Log == NULL) {\r
    DEBUG ((DEBUG_ERROR, "Failed to allocate space for unit test log\n"));\r
    ASSERT (UnitTest->Log != NULL);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = AsciiStrnCatS (\r
             UnitTest->Log,\r
             UNIT_TEST_MAX_LOG_BUFFER / sizeof (CHAR8),\r
             String,\r
             UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH\r
             );\r
  if(EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "Failed to add unit test log string.  Status = %r\n", Status));\r
    return Status;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function is responsible for initializing the log buffer for a single test. It can\r
  be used internally, but may also be consumed by the test framework to add pre-existing\r
  data to a log before it's used.\r
\r
  @param[in,out]  TestHandle    A handle to the test being initialized.\r
  @param[in]      Buffer        [Optional] A pointer to pre-existing log data that should\r
                                be used to initialize the log. Should include a NULL terminator.\r
  @param[in]      BufferSize    [Optional] The size of the pre-existing log data.\r
\r
**/\r
VOID\r
EFIAPI\r
UnitTestLogInit (\r
  IN OUT UNIT_TEST  *Test,\r
  IN     UINT8      *Buffer      OPTIONAL,\r
  IN     UINTN      BufferSize   OPTIONAL\r
  )\r
{\r
  //\r
  // Make sure that you're cooking with gas.\r
  //\r
  if (Test == NULL) {\r
    DEBUG ((DEBUG_ERROR, "%a called with invalid Test parameter\n", __FUNCTION__));\r
    return;\r
  }\r
\r
  //\r
  // If this is the first log for the test allocate log space\r
  //\r
  if (Test->Log == NULL) {\r
    Test->Log = AllocateZeroPool (UNIT_TEST_MAX_LOG_BUFFER);\r
  }\r
\r
  //\r
  //check again to make sure allocate worked\r
  //\r
  if(Test->Log == NULL) {\r
    DEBUG ((DEBUG_ERROR, "Failed to allocate memory for the log\n"));\r
    return;\r
  }\r
\r
  if((Buffer != NULL) && (BufferSize > 0) && (BufferSize <= UNIT_TEST_MAX_LOG_BUFFER)) {\r
    CopyMem (Test->Log, Buffer, BufferSize);\r
  }\r
}\r
\r
/**\r
  Test logging function that records a messages in the test framework log.\r
  Record is associated with the currently executing test case.\r
\r
  @param[in]  ErrorLevel  The error level of the unit test log message.\r
  @param[in]  Format      Formatting string following the format defined in the\r
                          MdePkg/Include/Library/PrintLib.h.\r
  @param[in]  ...         Print args.\r
**/\r
VOID\r
EFIAPI\r
UnitTestLog (\r
  IN  UINTN        ErrorLevel,\r
  IN  CONST CHAR8  *Format,\r
  ...\r
  )\r
{\r
  UNIT_TEST_FRAMEWORK_HANDLE  FrameworkHandle;\r
  CHAR8                       NewFormatString[UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH];\r
  CHAR8                       LogString[UNIT_TEST_MAX_SINGLE_LOG_STRING_LENGTH];\r
  CONST CHAR8                 *LogTypePrefix;\r
  VA_LIST                     Marker;\r
\r
  FrameworkHandle = GetActiveFrameworkHandle ();\r
\r
  LogTypePrefix = NULL;\r
\r
  //\r
  // Make sure that this unit test log level is enabled.\r
  //\r
  if ((ErrorLevel & (UINTN)PcdGet32 (PcdUnitTestLogLevel)) == 0) {\r
    return;\r
  }\r
\r
  //\r
  // If we need to define a new format string...\r
  // well... get to it.\r
  //\r
  LogTypePrefix = GetStringForStatusLogPrefix (ErrorLevel);\r
  if (LogTypePrefix != NULL) {\r
    AsciiSPrint (NewFormatString, sizeof (NewFormatString), "%a%a", LogTypePrefix, Format);\r
  } else {\r
    AsciiStrCpyS (NewFormatString, sizeof (NewFormatString), Format);\r
  }\r
\r
  //\r
  // Convert the message to an ASCII String\r
  //\r
  VA_START (Marker, Format);\r
  AsciiVSPrint (LogString, sizeof (LogString), NewFormatString, Marker);\r
  VA_END (Marker);\r
\r
  //\r
  // Finally, add the string to the log.\r
  //\r
  AddStringToUnitTestLog (((UNIT_TEST_FRAMEWORK *)FrameworkHandle)->CurrentTest, LogString);\r
}\r