Unit test for the firmware request sendAttributes

Added a unit test for the firmware request sendAttributes.  The unit
test exercises and verifies the correctness of the sendAttribute
firmware request method.

Did some massive cleanup of the testing framework/harness.  It was
becoming unwieldy and cumbersome to update.  I create methods for the
individual firmware request test instead of having the test reside in
over bloated method.

Added a section, in the README file, on how to test new interfaces
that are added for firmware request lineup.

Change-Id: I0ff7c0e48211b12d81be1f179ad3ee08e4d254af
RTC: 208343
Reviewed-on: http://rchgit01.rchland.ibm.com/gerrit1/78934
Tested-by: Jenkins Server <pfd-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP Build CI <op-jenkins+hostboot@us.ibm.com>
Tested-by: Jenkins OP HW <op-hw-jenkins+hostboot@us.ibm.com>
Tested-by: FSP CI Jenkins <fsp-CI-jenkins+hostboot@us.ibm.com>
Reviewed-by: Glenn Miles <milesg@ibm.com>
Reviewed-by: Christian R. Geddes <crgeddes@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

1 files changed, 28 insertions, 3 deletions

diff --git a/src/include/runtime/README.md b/src/include/runtime/README.md
index b26c51901..8a4e7298a 100755
--- a/src/include/runtime/README.md
+++ b/src/include/runtime/README.md
@@ -29,8 +29,9 @@ How to create an HBRT to FW request message interface
        TWO switch statements 'switch (l_req_fw_msg->io_type)'.  Look at others
        for examples.
 
-generic_hbrt_fsp_message.H::GenericFspMboxMessage_t
-    Firm Ware request:
+# generic_hbrt_fsp_message.H::GenericFspMboxMessage_t
+# How to create an HBRT Generic FSP Firmware request
+    Firmware request:
         1) The biggest part will be defining the interface.  Inspect the current
            interfaces (AttributeSetter_t, SingleScomOpHbrtFspData_t,
            TargetDeconfigHbrtFspData_t, etc) for inspiration.
@@ -56,7 +57,8 @@ generic_hbrt_fsp_message.H::GenericFspMboxMessage_t
                 ~/src/usr/fsiscom/runtime/rt_fsiscom.C::sendMultiScomReadToFsp
                 ~/src/usr/hwas/hwasPlatDeconfigGard.C::DeconfigGard::platPostDeconfigureTarget
 
-    Firm Ware notify:
+# How to create an HBRT Firmware Notify message
+    Firmware notify:
         1) The biggest part will be defining the interface.  Inspect the current
            interfaces (sbeRetryReqData_t, HbrtAttrSyncData_t, etc) for inspiration.
         2) Once an interface has been designed, add the structure to this file
@@ -79,3 +81,26 @@ generic_hbrt_fsp_message.H::GenericFspMboxMessage_t
            method ~/src/usr/util/runtime/rt_fwnotify.C::firmware_notify to
            call method created in step 4.
 
+# Integration testing the Firmware Request/Notify Message
+    This is not a true integration test but a verification that the data is
+    being sent, via the firmware request, in the format that the caller
+    intended.  Ensuring that the data is in the correct format and is correct
+    in of itself.
+
+    Add a test case to the file:
+         ~/src/usr/isteps/pm/runtime/test/firmwareRequestTest.H
+    This is where the message will being sent via the
+    hostInterfaces::firmware_request(...) method.  Here, is where you will
+    create a unique test case for your interface.  Follow the examples in
+    this file.  There are plenty of examples.
+
+    Add stub test code to the file/method:
+         ~/src/usr/testcore/rtloader/loader.H::rt_firmware_request(...)
+    This is where the message will be received and can be tested for
+    correctness. Follow the examples in this file.  There are plenty of
+    examples.
+
+
+
+
+