Implement vpd-tool dumpObject stub (ibm-openbmc#501)

This commit implements vpd-tool --dumpObject stub and some associated
utility methods and constants for the same.
This commit allows user to provide --dumpObject command line option to
vpd-tool.
Note: This commit does not include actual implementation of
--dumpObject.

Change-Id: I821777237a3080d390e2bba151cd685ef8994bf9
Signed-off-by: Souvik Roy <[email protected]>

Author: Souvik Roy

vpd-tool/include/tool_constants.hpp

@@ -20,5 +20,9 @@ constexpr auto ipzVpdInfPrefix = "com.ibm.ipzvpd.";
 constexpr auto vpdManagerService = "com.ibm.VPD.Manager";
 constexpr auto vpdManagerObjectPath = "/com/ibm/VPD/Manager";
 constexpr auto vpdManagerInfName = "com.ibm.VPD.Manager";
+constexpr auto inventoryItemInf = "xyz.openbmc_project.Inventory.Item";
+constexpr auto kwdVpdInf = "com.ibm.ipzvpd.VINI";
+constexpr auto locationCodeInf = "com.ibm.ipzvpd.Location";
+constexpr auto assetInf = "xyz.openbmc_project.Inventory.Decorator.Asset";
 } // namespace constants
 } // namespace vpd

vpd-tool/include/tool_json_utility.hpp

@@ -0,0 +1,62 @@
+#pragma once
+
+#include <nlohmann/json.hpp>
+
+#include <fstream>
+
+namespace vpd
+{
+namespace jsonUtility
+{
+
+/**
+ * @brief API to parse respective JSON.
+ *
+ * Exception is thrown in case of JSON parse error.
+ *
+ * @param[in] i_pathToJson - Path to JSON.
+ * @return Parsed JSON.
+ * @throw std::runtime_error
+ */
+inline nlohmann::json getParsedJson(const std::string& i_pathToJson)
+{
+    if (i_pathToJson.empty())
+    {
+        throw std::runtime_error("Path to JSON is missing");
+    }
+
+    try
+    {
+        if (!std::filesystem::exists(i_pathToJson) ||
+            std::filesystem::is_empty(i_pathToJson))
+        {
+            throw std::runtime_error("Incorrect File Path or empty file = " +
+                                     i_pathToJson);
+        }
+    }
+    catch (std::exception& l_ex)
+    {
+        throw std::runtime_error("Failed to check file path: " + i_pathToJson +
+                                 " Error: " + l_ex.what());
+    }
+
+    std::ifstream l_jsonFile(i_pathToJson);
+    if (!l_jsonFile)
+    {
+        throw std::runtime_error("Failed to access Json path = " +
+                                 i_pathToJson);
+    }
+
+    try
+    {
+        return nlohmann::json::parse(l_jsonFile);
+    }
+    catch (const nlohmann::json::parse_error& l_ex)
+    {
+        throw std::runtime_error("Failed to parse JSON file: " + i_pathToJson +
+                                 " Error: " + l_ex.what());
+    }
+}
+
+} // namespace jsonUtility
+} // namespace vpd

vpd-tool/include/tool_utils.hpp

@@ -75,6 +75,8 @@ inline types::DbusVariantType readDbusProperty(const std::string& i_serviceName,
  * @brief An API to print json data on stdout.
  *
  * @param[in] i_jsonData - JSON object.
+ *
+ * @throw std::runtime_error
  */
 inline void printJson(const nlohmann::json& i_jsonData)
 {

vpd-tool/include/vpd_tool.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+#include <nlohmann/json.hpp>
+
 #include <string>
 
 namespace vpd
@@ -17,6 +19,27 @@ namespace vpd
  */
 class VpdTool
 {
+  private:
+    /**
+     * @brief Get specific properties of a FRU in JSON format.
+     *
+     * For a given Object Path of a FRU, this API returns the following
+     * properties of the FRU in JSON format:
+     * - Present property, Pretty Name, Location Code, Sub Model
+     * - SN, PN, CC, FN, DR keywords under VINI record.
+     * - type and TYPE of the FRU
+     *
+     * @param[in] i_fruPath - DBus object path
+     *
+     * @return On success, returns the properties of the FRU in JSON format,
+     * otherwise returns an empty JSON object.
+     * Note: The caller of this API should
+     * check for empty JSON object
+     *
+     * @throw std::runtime_error
+     */
+    nlohmann::json getFruPropertiesJson(const std::string& i_fruPath) const;
+
   public:
     /**
      * @brief Read keyword value.
@@ -39,5 +62,20 @@ class VpdTool
                     const std::string& i_recordName,
                     const std::string& i_keywordName, const bool i_onHardware,
                     const std::string& i_fileToSave = {});
+
+    /**
+     * @brief Dump the given inventory object in JSON format to console.
+     *
+     * For a given Object Path of a FRU, this API dumps the following properties
+     * of the FRU in JSON format to console:
+     * - Present property, Pretty Name, Location Code, Sub Model
+     * - SN, PN, CC, FN, DR keywords under VINI record.
+     * - type and TYPE of the FRU
+     *
+     * @param[in] i_fruPath - DBus object path.
+     *
+     * @return On success returns 0, otherwise returns -1.
+     */
+    int dumpObject(const std::string& i_fruPath) const noexcept;
 };
 } // namespace vpd

vpd-tool/meson.build

@@ -13,7 +13,7 @@ sources = ['src/vpd_tool_main.cpp',
 
 vpd_tool_exe = executable('vpd-tool',
                           sources,
-                          include_directories : ['include/'],
+                          include_directories : ['include/','../'],
                           dependencies: dependency_list,
                           install: true
                         )

vpd-tool/src/vpd_tool.cpp

@@ -1,6 +1,9 @@
+#include "config.h"
+
 #include "vpd_tool.hpp"
 
 #include "tool_constants.hpp"
+#include "tool_json_utility.hpp"
 #include "tool_types.hpp"
 #include "tool_utils.hpp"
 
@@ -74,4 +77,36 @@ int VpdTool::readKeyword(const std::string& i_vpdPath,
     }
     return l_rc;
 }
+
+int VpdTool::dumpObject(const std::string& i_fruPath) const noexcept
+{
+    int l_rc{constants::FAILURE};
+    try
+    {
+        const nlohmann::json l_resultJson = getFruPropertiesJson(i_fruPath);
+        if (!l_resultJson.empty())
+        {
+            utils::printJson(l_resultJson);
+            l_rc = constants::SUCCESS;
+        }
+    }
+    catch (std::exception& l_ex)
+    {
+        std::cerr << "Dump Object failed for FRU: " << i_fruPath
+                  << " Error: " << l_ex.what() << std::endl;
+    }
+    return l_rc;
+}
+
+nlohmann::json VpdTool::getFruPropertiesJson(const std::string& i_fruPath) const
+{
+    nlohmann::json l_resultInJson = nlohmann::json::array({});
+    const nlohmann::json& l_sysCfgJsonObj =
+        vpd::jsonUtility::getParsedJson(INVENTORY_JSON_SYM_LINK);
+    // TODO: Implement getFruPropertiesJson
+    (void)i_fruPath;
+    (void)l_sysCfgJsonObj;
+    return l_resultInJson;
+}
+
 } // namespace vpd

vpd-tool/src/vpd_tool_main.cpp

@@ -1,4 +1,6 @@
 #include "tool_constants.hpp"
+#include "tool_json_utility.hpp"
+#include "tool_utils.hpp"
 #include "vpd_tool.hpp"
 
 #include <CLI/CLI.hpp>
@@ -8,7 +10,7 @@
 
 int main(int argc, char** argv)
 {
-    int l_rc = -1;
+    int l_rc = vpd::constants::FAILURE;
     CLI::App l_app{"VPD Command Line Tool"};
 
     std::string l_vpdPath{};
@@ -26,7 +28,10 @@ int main(int argc, char** argv)
         "        From hardware to console: "
         "vpd-tool -r -H -O <DBus Object Path> -R <Record Name> -K <Keyword Name>\n"
         "        From hardware to file: "
-        "vpd-tool -r -H -O <EEPROM Path> -R <Record Name> -K <Keyword Name> --file <File Path>");
+        "vpd-tool -r -H -O <EEPROM Path> -R <Record Name> -K <Keyword Name> --file <File Path>\n"
+        "Dump Object:\n"
+        "    From dbus to console: "
+        "vpd-tool -o -O <DBus Object Path>");
 
     auto l_objectOption = l_app.add_option("--object, -O", l_vpdPath,
                                            "File path");
@@ -46,6 +51,9 @@ int main(int argc, char** argv)
     auto l_hardwareFlag = l_app.add_flag("--Hardware, -H",
                                          "CAUTION: Developer only option.");
 
+    auto l_dumpObjFlag = l_app.add_flag("--dumpObject, -o", "Dump Object")
+                             ->needs(l_objectOption);
+
     // ToDo: Take offset value from user for hardware path.
 
     CLI11_PARSE(l_app, argc, argv);
@@ -100,6 +108,11 @@ int main(int argc, char** argv)
         l_rc = l_vpdToolObj.readKeyword(l_vpdPath, l_recordName, l_keywordName,
                                         l_isHardwareOperation, l_filePath);
     }
+    else if (!l_dumpObjFlag->empty())
+    {
+        vpd::VpdTool l_vpdToolObj;
+        l_rc = l_vpdToolObj.dumpObject(l_vpdPath);
+    }
     else
     {
         std::cout << l_app.help() << std::endl;