PEL for Worker class

This commit adds code to log informational PEL in worker class, in case
of exceptions occurred during creating asset tag and initiating backup &
restore.

output:
'''
root@testhostname:~# peltool -i 0x5000ED96
{
"Private Header": {
    "Section Version":          "1",
    "Sub-section type":         "0",
    "Created by":               "bmc vpd",
    "Created at":               "01/10/2025 15:48:55",
    "Committed at":             "01/10/2025 15:48:55",
    "Creator Subsystem":        "BMC",
    "CSSVER":                   "",
    "Platform Log Id":          "0x5000ED96",
    "Entry Id":                 "0x5000ED96",
    "BMC Event Log Id":         "783"
},
"User Header": {
    "Section Version":          "1",
    "Sub-section type":         "0",
    "Log Committed by":         "bmc error logging",
    "Subsystem":                "CEC Hardware - VPD Interface",
    "Event Scope":              "Entire Platform",
    "Event Severity":           "Informational Event",
    "Event Type":               "Miscellaneous, Informational Only",
    "Action Flags": [
                                "Event not customer viewable",
                                "Report Externally"
    ],
    "Host Transmission":        "Not Sent",
    "HMC Transmission":         "Not Sent"
},
"Primary SRC": {
    "Section Version":          "1",
    "Sub-section type":         "1",
    "Created by":               "bmc vpd",
    "SRC Version":              "0x02",
    "SRC Format":               "0x55",
    "Virtual Progress SRC":     "False",
    "I5/OS Service Event Bit":  "False",
    "Hypervisor Dump Initiated":"False",
    "Backplane CCIN":           "2E2D",
    "Terminate FW Error":       "False",
    "Deconfigured":             "False",
    "Guarded":                  "False",
    "Error Details": {
        "Message":              "A VPD data exception occurred."
    },
    "Valid Word Count":         "0x09",
    "Reference Code":           "BD554001",
    "Hex Word 2":               "00000055",
    "Hex Word 3":               "2E2D0010",
    "Hex Word 4":               "00000000",
    "Hex Word 5":               "00000000",
    "Hex Word 6":               "00000000",
    "Hex Word 7":               "00000000",
    "Hex Word 8":               "00000000",
    "Hex Word 9":               "00000000"
},
"Extended User Header": {
    "Section Version":          "1",
    "Sub-section type":         "0",
    "Created by":               "bmc error logging",
    "Reporting Machine Type":   "9105-22A",
    "Reporting Serial Number":  "139F230",
    "FW Released Ver":          "",
    "FW SubSys Version":        "fw1110.00-3.37",
    "Common Ref Time":          "00/00/0000 00:00:00",
    "Symptom Id Len":           "20",
    "Symptom Id":               "BD554001_2E2D0010"
},
"Failing MTMS": {
    "Section Version":          "1",
    "Sub-section type":         "0",
    "Created by":               "bmc error logging",
    "Machine Type Model":       "9105-22A",
    "Serial Number":            "139F230"
},
"User Data 0": {
    "Section Version": "1",
    "Sub-section type": "1",
    "Created by": "bmc error logging",
    "BMCLoad": "0.51 0.80 0.80",
    "BMCState": "Ready",
    "BMCUptime": "0y 0d 0h 26m 28s",
    "BootState": "Unspecified",
    "ChassisState": "Off",
    "FW Version ID": "fw1110.00-3.37-85-g35b06323a2-dirty",
    "HostState": "Off",
    "System IM": "50001001"
},
"User Data 1": {
    "Section Version": "1",
    "Sub-section type": "1",
    "Created by": "bmc error logging",
    "DESCRIPTION": "Exception caught while backup and restore VPD keyword's.Test error",
    "FileName": "/usr/src/debug/openpower-fru-vpd/1.0+git/vpd-manager/src/worker.cpp",
    "FunctionName": "performBackupAndRestore",
    "InteranlRc": "0",
    "UserData1": "",
    "UserData2": ""
}
'''

Signed-off-by: RekhaAparna01 <[email protected]>

Author: RekhaAparna01

vpd-manager/include/worker.hpp

@@ -473,7 +473,10 @@ class Worker
      * @brief API to form asset tag string for the system.
      *
      * @param[in] i_parsedVpdMap - Parsed VPD map.
-     * @return - Formed asset tag string. Empty in case of any error.
+     *
+     * @throw std::runtime_error
+     *
+     * @return - Formed asset tag string.
      */
     std::string
         createAssetTagString(const types::VPDMapVariant& i_parsedVpdMap);

vpd-manager/src/worker.cpp

@@ -5,6 +5,7 @@
 #include "backup_restore.hpp"
 #include "configuration.hpp"
 #include "constants.hpp"
+#include "event_logger.hpp"
 #include "exceptions.hpp"
 #include "logger.hpp"
 #include "parser.hpp"
@@ -252,7 +253,7 @@ std::string Worker::getHWVersion(const types::IPZVpdMap& parsedVpd) const
 {
     if (parsedVpd.empty())
     {
-        throw std::runtime_error("Empty VPD map. Can't Extract IM value");
+        throw std::runtime_error("Empty VPD map. Can't Extract HW value");
     }
 
     const auto& itrToVINI = parsedVpd.find("VINI");
@@ -1150,43 +1151,33 @@ std::string
 {
     std::string l_assetTag;
 
-    try
+    // system VPD will be in IPZ format.
+    if (auto l_parsedVpdMap = std::get_if<types::IPZVpdMap>(&i_parsedVpdMap))
     {
-        // system VPD will be in IPZ format.
-        if (auto l_parsedVpdMap =
-                std::get_if<types::IPZVpdMap>(&i_parsedVpdMap))
+        auto l_itrToVsys = (*l_parsedVpdMap).find(constants::recVSYS);
+        if (l_itrToVsys != (*l_parsedVpdMap).end())
         {
-            auto l_itrToVsys = (*l_parsedVpdMap).find(constants::recVSYS);
-            if (l_itrToVsys != (*l_parsedVpdMap).end())
-            {
-                std::string l_tmKwdValue;
-                vpdSpecificUtility::getKwVal(l_itrToVsys->second,
-                                             constants::kwdTM, l_tmKwdValue);
+            std::string l_tmKwdValue;
+            vpdSpecificUtility::getKwVal(l_itrToVsys->second, constants::kwdTM,
+                                         l_tmKwdValue);
 
-                std::string l_seKwdValue;
-                vpdSpecificUtility::getKwVal(l_itrToVsys->second,
-                                             constants::kwdSE, l_seKwdValue);
+            std::string l_seKwdValue;
+            vpdSpecificUtility::getKwVal(l_itrToVsys->second, constants::kwdSE,
+                                         l_seKwdValue);
 
-                l_assetTag = std::string{"Server-"} + l_tmKwdValue +
-                             std::string{"-"} + l_seKwdValue;
-            }
-            else
-            {
-                throw std::runtime_error(
-                    "VSYS record not found in parsed VPD map to create Asset tag.");
-            }
+            l_assetTag = std::string{"Server-"} + l_tmKwdValue +
+                         std::string{"-"} + l_seKwdValue;
         }
         else
         {
             throw std::runtime_error(
-                "Invalid VPD type recieved to create Asset tag.");
+                "VSYS record not found in parsed VPD map to create Asset tag.");
         }
     }
-    catch (const std::exception& l_ex)
+    else
     {
-        // TODO:Log PEL with below description.
-        logging::logMessage("Asset tag can't be formed. Error = " +
-                            std::string(l_ex.what()));
+        throw std::runtime_error(
+            "Invalid VPD type recieved to create Asset tag.");
     }
 
     return l_assetTag;
@@ -1224,10 +1215,12 @@ void Worker::publishSystemVPD(const types::VPDMapVariant& parsedVpdMap)
         }
         catch (const std::exception& l_ex)
         {
-            // TODO Log PEL with below description
-            logging::logMessage(
+            EventLogger::createSyncPel(
+                types::ErrorType::InvalidVpdMessage,
+                types::SeverityType::Informational, __FILE__, __FUNCTION__, 0,
                 "Asset tag update failed with following error: " +
-                std::string(l_ex.what()));
+                    std::string(l_ex.what()),
+                std::nullopt, std::nullopt, std::nullopt, std::nullopt);
         }
 
         // Notify PIM
@@ -1557,6 +1550,8 @@ void Worker::performBackupAndRestore(types::VPDMapVariant& io_srcVpdMap)
             auto [l_srcVpdVariant,
                   l_dstVpdVariant] = l_backupAndRestoreObj.backupAndRestore();
 
+            throw std::runtime_error("Test error");
+
             // ToDo: Revisit is this check is required or not.
             if (auto l_srcVpdMap =
                     std::get_if<types::IPZVpdMap>(&l_srcVpdVariant);
@@ -1566,18 +1561,15 @@ void Worker::performBackupAndRestore(types::VPDMapVariant& io_srcVpdMap)
             }
         }
     }
-    catch (const std::exception& ex)
+    catch (const std::exception& l_ex)
     {
-        logging::logMessage(ex.what());
-        // ToDo: Uncomment when PEL implementation goes in.
-        /*std::string l_errorMsg(
-            "Exception caught while backup and restore VPD keyword's. Error: " +
-            std::string(ex.what()));
-        inventory::PelAdditionalData l_additionalData{};
-        l_additionalData.emplace("DESCRIPTION", l_errorMsg);
-        createPEL(l_additionalData,
-        PelSeverity::ERROR, errBackupAndRestore, nullptr);
-        */
+        EventLogger::createSyncPel(
+            types::ErrorType::InvalidVpdMessage,
+            types::SeverityType::Informational, __FILE__, __FUNCTION__, 0,
+            std::string(
+                "Exception caught while backup and restore VPD keyword's.") +
+                l_ex.what(),
+            std::nullopt, std::nullopt, std::nullopt, std::nullopt);
     }
 }
 
@@ -1643,9 +1635,7 @@ void Worker::deleteFruVpd(const std::string& i_dbusObjPath)
 
                 if (!dbusUtility::callPIM(std::move(l_objectMap)))
                 {
-                    throw std::runtime_error(
-                        "Can't process delete VPD for FRU [" + i_dbusObjPath +
-                        "] as unable to read present property");
+                    throw std::runtime_error("Call to PIM failed.");
                 }
 
                 if (jsonUtility::isActionRequired(m_parsedJson, l_fruPath,
@@ -1660,7 +1650,9 @@ void Worker::deleteFruVpd(const std::string& i_dbusObjPath)
         }
         else
         {
-            logging::logMessage("DBus read failed");
+            logging::logMessage("Can't process delete VPD for FRU [" +
+                                i_dbusObjPath +
+                                "] as unable to read present property");
             return;
         }