util: Add pretty name for resources (#918)

Created a helper function to fetch pretty name and added for some
resources.

- Chassis
- FirmwareInventory
- Storage
- StorageController
- System
- Processor

Implementation Details:
The helper function makes a call to ObjectMapper to get the services
that support the object path with the interfaces we want. It expects
only one service is exporting the object path.

Then it will try to get the `PrettyName` property. If it is found and is
valid, it will set the `Name` to the value. If not, it will use the
default value that is set before the function call.

This will affect all systems and replace the Name with the PrettyName if
it exist within the resource's object path.

Tested:
Passed Redfish Validator

The output names release the existing `Name` property only if the
PrettyName property exists. If not, it will use the default value.

Output with PrettyName
```
$ curl  -u root:0penBmc -X GET http://${bmc}/redfish/v1/Chassis/chassis0
{
  "@odata.id": "/redfish/v1/Chassis/chassis0",
  "@odata.type": "#Chassis.v1_14_0.Chassis",
  "ChassisType": "RackMount",
  "Id": "chassis0",
  "Links": {
    "ComputerSystems": [
      {
        "@odata.id": "/redfish/v1/Systems/system"
      }
    ],
    "ManagedBy": [
      {
        "@odata.id": "/redfish/v1/Managers/bmc"
      }
    ]
  },
  "Name": "Test Chassis",
  ...
}
```

Without PrettyName
```
$ curl  -u root:0penBmc -X GET http://${bmc}/redfish/v1/Chassis/chassis0
{
  "@odata.id": "/redfish/v1/Chassis/chassis0",
  "@odata.type": "#Chassis.v1_14_0.Chassis",
  "ChassisType": "RackMount",
  "Id": "chassis0",
  "Links": {
    "ComputerSystems": [
      {
        "@odata.id": "/redfish/v1/Systems/system"
      }
    ],
    "ManagedBy": [
      {
        "@odata.id": "/redfish/v1/Managers/bmc"
      }
    ]
  },
  "Name": "chassis0",
  ...
}
```

Squashed other commit to use pretty name for dimm and fan into this
commit for easier maintanence

Squashed another commit: "Logging  invalid service name for debug"

The method getPrettyName() may be called more than one time.
This will generate journal logging messages for the required Service name
if there are unexpected service names.

Signed-off-by: Willy Tu <[email protected]>
Co-authored-by: Willy Tu <[email protected]>

Author: deepakala-k

redfish-core/include/utils/name_utils.hpp

@@ -0,0 +1,74 @@
+
+#pragma once
+#include "dbus_utility.hpp"
+#include "error_messages.hpp"
+#include "logging.hpp"
+
+#include <async_resp.hpp>
+#include <boost/system/error_code.hpp>
+
+#include <memory>
+#include <string>
+
+namespace redfish
+{
+namespace name_util
+{
+
+/**
+ * @brief Populate the collection "Members" from a GetSubTreePaths search of
+ *        inventory
+ *
+ * @param[i,o] asyncResp  Async response object
+ * @param[i]   path       D-bus object path to find the pretty name
+ * @param[i]   services   List of services to exporting the D-bus object path
+ * @param[i]   namePath   Json pointer to the name field to update.
+ *
+ * @return void
+ */
+inline void getPrettyName(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+                          const std::string& path,
+                          const dbus::utility::MapperServiceMap& services,
+                          const nlohmann::json::json_pointer& namePath)
+{
+    BMCWEB_LOG_DEBUG("Get PrettyName for: {}", path);
+
+    // Ensure we only got one service back
+    if (services.size() != 1)
+    {
+        BMCWEB_LOG_ERROR("Invalid Service Size {}", services.size());
+        for (const auto& service : services)
+        {
+            BMCWEB_LOG_ERROR("Invalid Service Name: {}", service.first);
+        }
+        if (asyncResp)
+        {
+            messages::internalError(asyncResp->res);
+        }
+        return;
+    }
+
+    dbus::utility::getProperty<std::string>(
+        services[0].first, path, "xyz.openbmc_project.Inventory.Item", 
+        "PrettyName", [asyncResp, path, namePath]
+        (const boost::system::error_code& ec,
+                                    const std::string& prettyName) {
+            if (ec)
+            {
+                BMCWEB_LOG_DEBUG("DBUS response error : {}", ec.value());
+                return;
+            }
+
+            if (prettyName.empty())
+            {
+                return;
+            }
+
+            BMCWEB_LOG_DEBUG("Pretty Name: {}", prettyName);
+
+            asyncResp->res.jsonValue[namePath] = prettyName;
+        });
+}
+
+} // namespace name_util
+} // namespace redfish

redfish-core/lib/chassis.hpp

@@ -21,6 +21,7 @@
 #include "utils/collection.hpp"
 #include "utils/dbus_utils.hpp"
 #include "utils/json_utils.hpp"
+#include "utils/name_utils.hpp"
 
 #include <asm-generic/errno.h>
 
@@ -583,7 +584,9 @@ inline void handleChassisGetSubTree(
         asyncResp->res.jsonValue["@odata.type"] = "#Chassis.v1_22_0.Chassis";
         asyncResp->res.jsonValue["@odata.id"] =
             boost::urls::format("/redfish/v1/Chassis/{}", chassisId);
-        asyncResp->res.jsonValue["Name"] = "Chassis Collection";
+        name_util::getPrettyName(asyncResp, path, connectionNames,
+                                 "/Name"_json_pointer);
+        asyncResp->res.jsonValue["ChassisType"] = "RackMount";
         asyncResp->res.jsonValue["Actions"]["#Chassis.Reset"]["target"] =
             boost::urls::format("/redfish/v1/Chassis/{}/Actions/Chassis.Reset",
                                 chassisId);

redfish-core/lib/fan.hpp

@@ -14,6 +14,7 @@
 #include "registries/privilege_registry.hpp"
 #include "utils/chassis_utils.hpp"
 #include "utils/json_utils.hpp"
+#include "utils/name_utils.hpp"
 
 #include <asm-generic/errno.h>
 
@@ -235,7 +236,6 @@ inline void addFanCommonProperties(crow::Response& resp,
     resp.addHeader(boost::beast::http::field::link,
                    "</redfish/v1/JsonSchemas/Fan/Fan.json>; rel=describedby");
     resp.jsonValue["@odata.type"] = "#Fan.v1_3_0.Fan";
-    resp.jsonValue["Name"] = "Fan";
     resp.jsonValue["Id"] = fanId;
     resp.jsonValue["@odata.id"] = boost::urls::format(
         "/redfish/v1/Chassis/{}/ThermalSubsystem/Fans/{}", chassisId, fanId);
@@ -387,6 +387,9 @@ inline void afterGetValidFanPath(
     getFanAsset(asyncResp, fanPath, service);
     getFanLocation(asyncResp, fanPath, service);
     getLocationIndicatorActive(asyncResp, fanPath);
+    const dbus::utility::MapperServiceMap& serviceMatch = {{service, {""}}};
+    name_util::getPrettyName(asyncResp, fanPath, serviceMatch,
+                             "/Name"_json_pointer);
 }
 
 inline void doFanGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,

redfish-core/lib/memory.hpp

@@ -29,6 +29,7 @@
 #include <nlohmann/json.hpp>
 #include <sdbusplus/message/native_types.hpp>
 #include <sdbusplus/unpack_properties.hpp>
+#include <utils/name_utils.hpp>
 
 #include <array>
 #include <cstddef>
@@ -408,7 +409,6 @@ inline void assembleDimmProperties(
     const nlohmann::json::json_pointer& jsonPtr)
 {
     asyncResp->res.jsonValue[jsonPtr]["Id"] = dimmId;
-    asyncResp->res.jsonValue[jsonPtr]["Name"] = "DIMM Slot";
     asyncResp->res.jsonValue[jsonPtr]["Status"]["State"] =
         resource::State::Enabled;
     asyncResp->res.jsonValue[jsonPtr]["Status"]["Health"] =
@@ -754,6 +754,8 @@ inline void afterGetDimmData(
                                          objectPath);
                     dimmInterface = true;
                     found = true;
+                    name_util::getPrettyName(asyncResp, objectPath, serviceMap,
+                                             "/Name"_json_pointer);
                 }
                 else if (interface ==
                          "xyz.openbmc_project.Association.Definitions")

redfish-core/lib/processor.hpp

@@ -20,11 +20,13 @@
 #include "utils/dbus_utils.hpp"
 #include "utils/hex_utils.hpp"
 #include "utils/json_utils.hpp"
+#include "utils/name_utils.hpp"
 
 #include <boost/beast/http/field.hpp>
 #include <boost/beast/http/verb.hpp>
 #include <boost/system/error_code.hpp>
 #include <boost/url/format.hpp>
+#include <nlohmann/json.hpp>
 #include <sdbusplus/message/native_types.hpp>
 #include <sdbusplus/unpack_properties.hpp>
 
@@ -765,6 +767,8 @@ inline void handleProcessorSubtree(
                     // process must be on the same object path.
 
                     callback(objectPath, serviceMap);
+                    name_util::getPrettyName(asyncResp, objectPath, serviceMap,
+                                             "/Name"_json_pointer);
                     return;
                 }
             }

redfish-core/lib/storage.hpp

@@ -20,10 +20,12 @@
 #include "registries/privilege_registry.hpp"
 #include "utils/collection.hpp"
 #include "utils/dbus_utils.hpp"
+#include "utils/name_utils.hpp"
 
 #include <boost/beast/http/verb.hpp>
 #include <boost/system/error_code.hpp>
 #include <boost/url/format.hpp>
+#include <nlohmann/json.hpp>
 #include <sdbusplus/message/native_types.hpp>
 #include <sdbusplus/unpack_properties.hpp>
 
@@ -660,10 +662,10 @@ inline void afterGetSubtreeSystemsStorageDrive(
     const dbus::utility::MapperServiceMap& connectionNames = drive->second;
 
     asyncResp->res.jsonValue["@odata.type"] = "#Drive.v1_7_0.Drive";
-    asyncResp->res.jsonValue["@odata.id"] =
-        boost::urls::format("/redfish/v1/Systems/{}/Storage/1/Drives/{}",
-                            BMCWEB_REDFISH_SYSTEM_URI_NAME, driveId);
-    asyncResp->res.jsonValue["Name"] = driveId;
+    asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
+        "/redfish/v1/Systems/system/Storage/1/Drives/{}", driveId);
+    name_util::getPrettyName(asyncResp, path, drive->second,
+                             "/Name"_json_pointer);
     asyncResp->res.jsonValue["Id"] = driveId;
 
     if (connectionNames.size() != 1)