Merge pull request #599 from souvik1914581/sr_vpdToolDecoratorAsset

vpd-tool dumpObject: show Decorator.Asset properties

Author: jinuthomas

vpd-tool/include/tool_types.hpp

@@ -67,6 +67,9 @@ using TableInputData = std::vector<TableRowData>;
 // A table column name-size pair
 using TableColumnNameSizePair = std::pair<std::string, std::size_t>;
 
+/* Map<Property, Value>*/
+using PropertyMap = std::map<std::string, DbusVariantType>;
+
 enum UserOption
 {
     Exit,

vpd-tool/include/tool_utils.hpp

@@ -73,6 +73,56 @@ inline types::DbusVariantType readDbusProperty(const std::string& i_serviceName,
     return l_propertyValue;
 }
 
+/**
+ * @brief An API to get property map for an interface.
+ *
+ * This API returns a map of property and its value with respect to a particular
+ * interface.
+ *
+ * Note: It will be caller's responsibility to check for empty map returned and
+ * generate appropriate error.
+ *
+ * @param[in] i_service - Service name.
+ * @param[in] i_objectPath - object path.
+ * @param[in] i_interface - Interface, for the properties to be listed.
+ *
+ * @return - A map of property and value of an interface, if success.
+ *           if failed, empty map.
+ */
+inline types::PropertyMap
+    getPropertyMap(const std::string& i_service,
+                   const std::string& i_objectPath,
+                   const std::string& i_interface) noexcept
+{
+    types::PropertyMap l_propertyValueMap;
+    if (i_service.empty() || i_objectPath.empty() || i_interface.empty())
+    {
+        // TODO: Enable logging when verbose is enabled.
+        // std::cout << "Invalid parameters to get property map" << std::endl;
+        return l_propertyValueMap;
+    }
+
+    try
+    {
+        auto l_bus = sdbusplus::bus::new_default();
+        auto l_method =
+            l_bus.new_method_call(i_service.c_str(), i_objectPath.c_str(),
+                                  "org.freedesktop.DBus.Properties", "GetAll");
+        l_method.append(i_interface);
+        auto l_result = l_bus.call(l_method);
+        l_result.read(l_propertyValueMap);
+    }
+    catch (const sdbusplus::exception::SdBusError& l_ex)
+    {
+        // TODO: Enable logging when verbose is enabled.
+        // std::cerr << "Failed to get property map for service: [" << i_service
+        //           << "], object path: [" << i_objectPath
+        //           << "] Error : " << l_ex.what() << std::endl;
+    }
+
+    return l_propertyValueMap;
+}
+
 /**
  * @brief An API to print json data on stdout.
  *

vpd-tool/include/vpd_tool.hpp

@@ -38,7 +38,7 @@ class VpdTool
      * If FRU's "Present" property is false, this API returns an empty JSON.
      * Note: The caller of this API should handle empty JSON.
      *
-     * @throw json::exception
+     * @throw json::exception, std::out_of_range, std::bad_alloc
      */
     nlohmann::json getFruProperties(const std::string& i_objectPath) const;
 

vpd-tool/src/vpd_tool.cpp

@@ -115,8 +115,8 @@ int VpdTool::dumpObject(std::string i_fruPath) const noexcept
     catch (std::exception& l_ex)
     {
         // TODO: Enable logging when verbose is enabled.
-        // std::cerr << "Dump Object failed for FRU [" << i_fruPath
-        //           << "], Error: " << l_ex.what() << std::endl;
+        std::cerr << "Dump Object failed for FRU [" << i_fruPath
+                  << "], Error: " << l_ex.what() << std::endl;
     }
     return l_rc;
 }
@@ -131,9 +131,15 @@ nlohmann::json VpdTool::getFruProperties(const std::string& i_objectPath) const
 
     nlohmann::json l_fruJson = nlohmann::json::object_t({});
 
-    l_fruJson.emplace(i_objectPath, nlohmann::json::object_t({}));
+    // need to trim out the base inventory path in the FRU JSON.
+    const std::string l_displayObjectPath =
+        (i_objectPath.find(constants::baseInventoryPath) == std::string::npos)
+            ? i_objectPath
+            : i_objectPath.substr(strlen(constants::baseInventoryPath));
 
-    auto& l_fruObject = l_fruJson[i_objectPath];
+    l_fruJson.emplace(l_displayObjectPath, nlohmann::json::object_t({}));
+
+    auto& l_fruObject = l_fruJson[l_displayObjectPath];
 
     const auto l_prettyNameInJson = getInventoryPropertyJson<std::string>(
         i_objectPath, constants::inventoryItemInf, "PrettyName");
@@ -151,15 +157,6 @@ nlohmann::json VpdTool::getFruProperties(const std::string& i_objectPath) const
                            l_locationCodeInJson.cend());
     }
 
-    const auto l_subModelInJson = getInventoryPropertyJson<std::string>(
-        i_objectPath, constants::assetInf, "SubModel");
-
-    if (!l_subModelInJson.empty() &&
-        !l_subModelInJson.value("SubModel", "").empty())
-    {
-        l_fruObject.insert(l_subModelInJson.cbegin(), l_subModelInJson.cend());
-    }
-
     // Get the properties under VINI interface.
 
     nlohmann::json l_viniPropertiesInJson = nlohmann::json::object({});
@@ -184,6 +181,24 @@ nlohmann::json VpdTool::getFruProperties(const std::string& i_objectPath) const
         l_fruObject.insert(l_viniPropertiesInJson.cbegin(),
                            l_viniPropertiesInJson.cend());
     }
+    // if a FRU doesn't have VINI properties, we need to get the properties from
+    // Decorator.Asset interface
+    else
+    {
+        // Get properties under Decorator.Asset interface
+        const auto l_decoratorAssetPropertiesMap =
+            utils::getPropertyMap(constants::inventoryManagerService,
+                                  i_objectPath, constants::assetInf);
+
+        for (const auto& l_aProperty : l_decoratorAssetPropertiesMap)
+        {
+            if (const auto l_propertyValueStr =
+                    std::get_if<std::string>(&l_aProperty.second))
+            {
+                l_fruObject.emplace(l_aProperty.first, *l_propertyValueStr);
+            }
+        }
+    }
 
     const auto l_typePropertyJson = getFruTypeProperty(i_objectPath);
     if (!l_typePropertyJson.empty())
@@ -192,6 +207,9 @@ nlohmann::json VpdTool::getFruProperties(const std::string& i_objectPath) const
                            l_typePropertyJson.cend());
     }
 
+    // insert FRU "TYPE"
+    l_fruObject.emplace("TYPE", "FRU");
+
     return l_fruJson;
 }