Re: [PATCH v1 2/2] UefiCpuPkg/Test: develop UEFI App and dynamic cmd for MP services UT

["duntan" <dun.tan@intel.com>]

Reviewed-by: Dun Tan <dun.tan@intel.com>

-----Original Message-----
From: Lou, Yun <yun.lou@intel.com> 
Sent: Thursday, November 24, 2022 8:12 PM
To: devel@edk2.groups.io
Cc: Lou, Yun <yun.lou@intel.com>; Ni, Ray <ray.ni@intel.com>; Dong, Eric <eric.dong@intel.com>; Laszlo Ersek <lersek@redhat.com>; Kumar, Rahul R <rahul.r.kumar@intel.com>; Liu, Zhiguang <zhiguang.liu@intel.com>; Tan, Dun <dun.tan@intel.com>
Subject: [PATCH v1 2/2] UefiCpuPkg/Test: develop UEFI App and dynamic cmd for MP services UT

From: Jason Lou <yun.lou@intel.com>

The code changes develop UEFI application and dynamic command for EfiMpServiceProtocol unit tests based on current UnitTestFramework.

Signed-off-by: Jason Lou <yun.lou@intel.com>
Reviewed-by: Ray Ni <ray.ni@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Rahul Kumar <rahul1.kumar@intel.com>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Dun Tan <dun.tan@intel.com>
---
 UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolDynamicCmdUnitTest.c   | 129 ++++++++++++++++++++
 UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolDynamicCmdUnitTest.inf |  45 +++++++
 UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolShellUnitTest.inf      |  43 +++++++
 UefiCpuPkg/UefiCpuPkg.dsc                                                                    |   8 ++
 4 files changed, 225 insertions(+)

diff --git a/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolDynamicCmdUnitTest.c b/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolDynamicCmdUnitTest.c
new file mode 100644
index 0000000000..be65c3d678
--- /dev/null
+++ b/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProt
+++ ocolDynamicCmdUnitTest.c
@@ -0,0 +1,129 @@
+/** @file+  Produce "MpProtocolUnitTest" shell dynamic command.++  Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>++  SPDX-License-Identifier: BSD-2-Clause-Patent++**/++#include <Library/UefiBootServicesTableLib.h>+#include <Protocol/ShellDynamicCommand.h>+#include "EfiMpServicesUnitTestCommom.h"++CHAR16  *mMpProtocolUnitTestCommandHelp = L".TH MpProtocolUnitTest 0\r\n.SH NAME\r\nDisplay unit test results of EFI MP services protocol.\r\n";++EFI_STATUS+EFIAPI+EfiMpServiceProtocolUnitTest (+  VOID+  );++/**+  This is the shell command handler function pointer callback type.  This+  function handles the command when it is invoked in the shell.++  @param[in] This                   The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.+  @param[in] SystemTable            The pointer to the system table.+  @param[in] ShellParameters        The parameters associated with the command.+  @param[in] Shell                  The instance of the shell protocol used in the context+                                    of processing this command.++  @return EFI_SUCCESS               the operation was successful+  @return other                     the operation failed.+**/+SHELL_STATUS+EFIAPI+MpProtocolUnitTestCommandHandler (+  IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL  *This,+  IN EFI_SYSTEM_TABLE                    *SystemTable,+  IN EFI_SHELL_PARAMETERS_PROTOCOL       *ShellParameters,+  IN EFI_SHELL_PROTOCOL                  *Shell+  )+{+  return EfiMpServiceProtocolUnitTest ();+}++/**+  This is the command help handler function pointer callback type.  This+  function is responsible for displaying help information for the associated+  command.++  @param[in] This                   The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.+  @param[in] Language               The pointer to the language string to use.++  @return string                    Pool allocated help string, must be freed by caller+**/+CHAR16 *+EFIAPI+MpProtocolUnitTestCommandGetHelp (+  IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL  *This,+  IN CONST CHAR8                         *Language+  )+{+  return AllocateCopyPool (StrSize (mMpProtocolUnitTestCommandHelp), mMpProtocolUnitTestCommandHelp);+}++EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL  mMpProtocolUnitTestDynamicCommand = {+  L"MpProtocolUnitTest",+  MpProtocolUnitTestCommandHandler,+  MpProtocolUnitTestCommandGetHelp+};++/**+  Entry point of MpProtocolUnitTest Dynamic Command.++  Produce the DynamicCommand protocol to handle "MpProtocolUnitTest" command.++  @param ImageHandle            The image handle of the process.+  @param SystemTable            The EFI System Table pointer.++  @retval EFI_SUCCESS           Tftp command is executed successfully.+  @retval EFI_ABORTED           HII package was failed to initialize.+  @retval others                Other errors when executing MpProtocolUnitTest command.+**/+EFI_STATUS+EFIAPI+MpProtocolUnitTestCommandInitialize (+  IN EFI_HANDLE        ImageHandle,+  IN EFI_SYSTEM_TABLE  *SystemTable+  )+{+  EFI_STATUS  Status;++  Status = gBS->InstallProtocolInterface (+                  &ImageHandle,+                  &gEfiShellDynamicCommandProtocolGuid,+                  EFI_NATIVE_INTERFACE,+                  &mMpProtocolUnitTestDynamicCommand+                  );+  ASSERT_EFI_ERROR (Status);++  return Status;+}++/**+  Driver unload handler.++  @param ImageHandle            The image handle of the process.++  @retval EFI_SUCCESS           The image is unloaded.+  @retval Others                Failed to unload the image.+**/+EFI_STATUS+EFIAPI+MpProtocolUnitTestUnload (+  IN EFI_HANDLE  ImageHandle+  )+{+  EFI_STATUS  Status;++  Status = gBS->UninstallProtocolInterface (+                  ImageHandle,+                  &gEfiShellDynamicCommandProtocolGuid,+                  &mMpProtocolUnitTestDynamicCommand+                  );+  ASSERT_EFI_ERROR (Status);++  return Status;+}diff --git a/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolDynamicCmdUnitTest.inf b/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolDynamicCmdUnitTest.inf
new file mode 100644
index 0000000000..3fa287d1ae
--- /dev/null
+++ b/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProt
+++ ocolDynamicCmdUnitTest.inf
@@ -0,0 +1,45 @@
+## @file+# DXE driver that provides Shell 'MpProtocolUnitTest' dynamic command to test EfiMpServiceProtocol.+#+# Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>+# SPDX-License-Identifier: BSD-2-Clause-Patent+#+##++[Defines]+  INF_VERSION     = 0x00010005+  BASE_NAME       = EfiMpServiceProtocolDynamicCmdUnitTest+  FILE_GUID       = 8C4624B1-58CC-4DF6-9E6D-09B38D67DFA6+  MODULE_TYPE     = DXE_DRIVER+  VERSION_STRING  = 1.0+  ENTRY_POINT     = MpProtocolUnitTestCommandInitialize+  UNLOAD_IMAGE    = MpProtocolUnitTestUnload++[Sources]+  EfiMpServicesUnitTestCommom.c+  EfiMpServicesUnitTestCommom.h+  EfiMpServiceProtocolUnitTest.c+  EfiMpServiceProtocolDynamicCmdUnitTest.c++[Packages]+  MdePkg/MdePkg.dec+  MdeModulePkg/MdeModulePkg.dec+  UefiCpuPkg/UefiCpuPkg.dec++[LibraryClasses]+  BaseLib+  DebugLib+  BaseMemoryLib+  MemoryAllocationLib+  UefiDriverEntryPoint+  UefiBootServicesTableLib+  UefiLib+  UnitTestPersistenceLib+  UnitTestLib++[Protocols]+  gEfiMpServiceProtocolGuid           ## CONSUMES+  gEfiShellDynamicCommandProtocolGuid ## PRODUCES++[Depex]+  TRUEdiff --git a/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolShellUnitTest.inf b/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolShellUnitTest.inf
new file mode 100644
index 0000000000..34c1ea96a6
--- /dev/null
+++ b/UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProt
+++ ocolShellUnitTest.inf
@@ -0,0 +1,43 @@
+## @file+# UEFI application that tests EfiMpServiceProtocol in Shell.+#+# Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>+# SPDX-License-Identifier: BSD-2-Clause-Patent+#+##++[Defines]+  INF_VERSION     = 0x00010005+  BASE_NAME       = MpProtocolUnitTest+  FILE_GUID       = 4CEE6399-A22C-4FFD-B148-3A56B1DD83F1+  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]+  EfiMpServicesUnitTestCommom.c+  EfiMpServicesUnitTestCommom.h+  EfiMpServiceProtocolUnitTest.c++[Packages]+  MdePkg/MdePkg.dec+  UefiCpuPkg/UefiCpuPkg.dec++[LibraryClasses]+  BaseLib+  DebugLib+  BaseMemoryLib+  MemoryAllocationLib+  UefiApplicationEntryPoint+  UefiBootServicesTableLib+  UnitTestPersistenceLib+  UnitTestLib++[Protocols]+  gEfiMpServiceProtocolGuid           ## CONSUMESdiff --git a/UefiCpuPkg/UefiCpuPkg.dsc b/UefiCpuPkg/UefiCpuPkg.dsc
index 67b0ce46e4..f9a46089d2 100644
--- a/UefiCpuPkg/UefiCpuPkg.dsc
+++ b/UefiCpuPkg/UefiCpuPkg.dsc
@@ -183,6 +183,14 @@
   UefiCpuPkg/Library/CpuExceptionHandlerLib/UnitTest/PeiCpuExceptionHandlerLibUnitTest.inf   UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EdkiiPeiMpServices2PpiPeiUnitTest.inf   UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolDxeUnitTest.inf+  UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolDynamicCmdUnitTest.inf {+    <LibraryClasses>+      UnitTestResultReportLib|UnitTestFrameworkPkg/Library/UnitTestResultReportLib/UnitTestResultReportLibConOut.inf+  }+  UefiCpuPkg/Test/UnitTest/EfiMpServicesPpiProtocol/EfiMpServiceProtocolShellUnitTest.inf {+    <LibraryClasses>+      UnitTestResultReportLib|UnitTestFrameworkPkg/Library/UnitTestResultReportLib/UnitTestResultReportLibConOut.inf+  }  [Components.X64]   UefiCpuPkg/Library/CpuExceptionHandlerLib/UnitTest/DxeCpuExceptionHandlerLibUnitTest.inf-- 
2.28.0.windows.1