set error code for getAllPathsToUpdateKeyword API
This commit updates getAllPathsToUpdateKeyword API to set error code in
case of error. This helps caller of API to take action based on the
error code returned from the API.
Change-Id: Id28885aee47adccb19ecdc6522a0061778ac0479
Signed-off-by: Rekha Aparna <vrekhaaparna@ibm.com>
diff --git a/vpd-manager/include/error_codes.hpp b/vpd-manager/include/error_codes.hpp
index 60a1492..648215e 100644
--- a/vpd-manager/include/error_codes.hpp
+++ b/vpd-manager/include/error_codes.hpp
@@ -20,6 +20,9 @@
JSON_PARSE_ERROR,
JSON_MISSING_GPIO_INFO,
JSON_MISSING_SERVICE_NAME,
+ REDUNDANT_PATH_NOT_FOUND,
+ ERROR_GETTING_REDUNDANT_PATH,
+ NO_EEPROM_PATH,
// Generic errors.
INVALID_INPUT_PARAMETER,
@@ -45,6 +48,10 @@
{error_code::JSON_MISSING_GPIO_INFO, "JSON missing required GPIO info."},
{error_code::JSON_MISSING_SERVICE_NAME,
"JSON missing the service name for the FRU"},
+ {error_code::REDUNDANT_PATH_NOT_FOUND, "No redundant path for the FRU."},
+ {error_code::ERROR_GETTING_REDUNDANT_PATH,
+ "Error while trying to get redundant path for the FRU"},
+ {error_code::NO_EEPROM_PATH, "EEPROM path not found."},
{error_code::DEVICE_NOT_PRESENT,
"Presence pin read successfully but device was absent."},
{error_code::DEVICE_PRESENCE_UNKNOWN, "Exception on presence line GPIO."},
diff --git a/vpd-manager/include/utility/json_utility.hpp b/vpd-manager/include/utility/json_utility.hpp
index 358fda1..8de6f7c 100644
--- a/vpd-manager/include/utility/json_utility.hpp
+++ b/vpd-manager/include/utility/json_utility.hpp
@@ -832,76 +832,91 @@
*
* @param[in] i_sysCfgJsonObj - System config JSON object.
* @param[in,out] io_vpdPath - Inventory object path or FRU EEPROM path.
+ * @param[out] o_errCode - To set error code in case of error.
*
* @return On success returns tuple of EEPROM path, inventory path & redundant
* path, on failure returns tuple with given input path alone.
*/
inline std::tuple<std::string, std::string, std::string>
getAllPathsToUpdateKeyword(const nlohmann::json& i_sysCfgJsonObj,
- std::string io_vpdPath)
+ std::string io_vpdPath, uint16_t& o_errCode)
{
types::Path l_inventoryObjPath;
types::Path l_redundantFruPath;
- try
+ o_errCode = 0;
+
+ if (i_sysCfgJsonObj.empty() || io_vpdPath.empty())
{
- uint16_t l_errCode = 0;
+ o_errCode = error_code::INVALID_INPUT_PARAMETER;
+ return std::make_tuple(io_vpdPath, l_inventoryObjPath,
+ l_redundantFruPath);
+ }
- if (!i_sysCfgJsonObj.empty())
+ // Get hardware path from system config JSON.
+ const types::Path l_fruPath =
+ jsonUtility::getFruPathFromJson(i_sysCfgJsonObj, io_vpdPath, o_errCode);
+
+ if (!l_fruPath.empty())
+ {
+ io_vpdPath = l_fruPath;
+
+ // Get inventory object path from system config JSON
+ l_inventoryObjPath = jsonUtility::getInventoryObjPathFromJson(
+ i_sysCfgJsonObj, l_fruPath, o_errCode);
+
+ if (l_inventoryObjPath.empty())
{
- // Get hardware path from system config JSON.
- const types::Path l_fruPath = jsonUtility::getFruPathFromJson(
- i_sysCfgJsonObj, io_vpdPath, l_errCode);
-
- if (!l_fruPath.empty())
+ if (o_errCode)
{
- io_vpdPath = l_fruPath;
-
- // Get inventory object path from system config JSON
- l_inventoryObjPath = jsonUtility::getInventoryObjPathFromJson(
- i_sysCfgJsonObj, l_fruPath, l_errCode);
-
- if (l_errCode)
- {
- logging::logMessage(
- "Failed to get inventory path from JSON for [" +
- io_vpdPath + "], error : " +
- vpdSpecificUtility::getErrCodeMsg(l_errCode));
-
- return std::make_tuple(io_vpdPath, l_inventoryObjPath,
- l_redundantFruPath);
- }
-
- // Get redundant hardware path if present in system config JSON
- l_redundantFruPath =
- jsonUtility::getRedundantEepromPathFromJson(
- i_sysCfgJsonObj, l_fruPath, l_errCode);
-
- if (l_errCode)
- {
- logging::logMessage(
- "Failed to get redundant EEPROM path for FRU [" +
- l_fruPath + "], error : " +
- vpdSpecificUtility::getErrCodeMsg(l_errCode));
-
- return std::make_tuple(io_vpdPath, l_inventoryObjPath,
- l_redundantFruPath);
- }
+ logging::logMessage(
+ "Failed to get inventory path from JSON for [" +
+ io_vpdPath + "], error : " +
+ vpdSpecificUtility::getErrCodeMsg(o_errCode));
+ }
+ else
+ {
+ o_errCode = error_code::FRU_PATH_NOT_FOUND;
}
- logging::logMessage(
- "Failed to get FRU path from JSON for [" + io_vpdPath +
- "], error : " + vpdSpecificUtility::getErrCodeMsg(l_errCode));
+ return std::make_tuple(io_vpdPath, l_inventoryObjPath,
+ l_redundantFruPath);
+ }
+
+ // Get redundant hardware path if present in system config JSON
+ l_redundantFruPath = jsonUtility::getRedundantEepromPathFromJson(
+ i_sysCfgJsonObj, l_fruPath, o_errCode);
+
+ if (l_redundantFruPath.empty())
+ {
+ if (o_errCode)
+ {
+ logging::logMessage(
+ "Failed to get redundant EEPROM path for FRU [" +
+ l_fruPath + "], error : " +
+ vpdSpecificUtility::getErrCodeMsg(o_errCode));
+
+ o_errCode = error_code::ERROR_GETTING_REDUNDANT_PATH;
+ }
+ else
+ {
+ o_errCode = error_code::REDUNDANT_PATH_NOT_FOUND;
+ }
return std::make_tuple(io_vpdPath, l_inventoryObjPath,
l_redundantFruPath);
}
}
- catch (const std::exception& l_exception)
+ else if (o_errCode)
{
logging::logMessage(
- "Failed to get all paths to update keyword value, error " +
- std::string(l_exception.what()));
+ "Failed to get FRU path from JSON for [" + io_vpdPath +
+ "], error : " + vpdSpecificUtility::getErrCodeMsg(o_errCode));
}
+ else
+ {
+ o_errCode = error_code::NO_EEPROM_PATH;
+ }
+
return std::make_tuple(io_vpdPath, l_inventoryObjPath, l_redundantFruPath);
}