util: Add pretty name for resources (#918)

deepakala-k · wltu · SunnySrivastava1984 · deepakala-k · commit 115e43ef84f4 · 2025-04-01T07:36:14.000Z
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 following commits: Logging invalid service name for debug Util api to fetch pretty name for assemblies Dimm: Look at Pretty Name (#973) (#1111) 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. In case prettyName is blank for that FRU, then last part of the object path will be used to populate assembly name. Signed-off-by: Willy Tu <wltu@google.com> Co-authored-by: Willy Tu <wltu@google.com> Co-authored-by: Sunny Srivastava <sunnsr25@in.ibm.com> Co-authored-by: Gunnar Mills <gmills@us.ibm.com>
diff --git a/redfish-core/include/utils/name_utils.hpp b/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
diff --git a/redfish-core/lib/assembly.hpp b/redfish-core/lib/assembly.hpp
@@ -21,6 +21,7 @@
 #include <nlohmann/json.hpp>
 #include <sdbusplus/asio/property.hpp>
 #include <sdbusplus/unpack_properties.hpp>
+#include <utils/name_utils.hpp>
 
 #include <algorithm>
 #include <array>
@@ -232,6 +233,11 @@ inline void getAssemblyProperties(
                     return;
                 }
 
+                nlohmann::json::json_pointer ptr(
+                    "/Assemblies/" + std::to_string(assemblyIndex) + "/Name");
+
+                name_util::getPrettyName(asyncResp, assembly, object, ptr);
+
                 for (const auto& [serviceName, interfaceList] : object)
                 {
                     for (const auto& interface : interfaceList)
diff --git a/redfish-core/lib/chassis.hpp b/redfish-core/lib/chassis.hpp
@@ -22,6 +22,7 @@
 #include "utils/collection.hpp"
 #include "utils/dbus_utils.hpp"
 #include "utils/json_utils.hpp"
+#include "utils/name_utils.hpp"
 
 #include <boost/beast/http/field.hpp>
 #include <boost/beast/http/verb.hpp>
@@ -478,7 +479,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);
diff --git a/redfish-core/lib/fan.hpp b/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,
diff --git a/redfish-core/lib/memory.hpp b/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")
diff --git a/redfish-core/lib/processor.hpp b/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>
 
@@ -813,6 +815,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;
                 }
             }
diff --git a/redfish-core/lib/storage.hpp b/redfish-core/lib/storage.hpp
@@ -21,10 +21,12 @@
 #include "utils/chassis_utils.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>
 
@@ -661,10 +663,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)
