Add pretty name for fabric adapters (#869)

The commit implement changes to make use of util function to
populate name for fabric adapters.

Validator was executed and no new error was found.

Test output:
curl -k -H "X-Auth-Token: $bmc_token" -X GET "https://${BMC_IP}/redfish/v1/Systems/system/FabricAdapters/motherboard-pcieslot8-pcie_card8"
{
  "@odata.id": "/redfish/v1/Systems/system/FabricAdapters/motherboard-pcieslot8-pcie_card8",
  "@odata.type": "#FabricAdapter.v1_4_0.FabricAdapter",
  "Id": "motherboard-pcieslot8-pcie_card8",
  "Links": {
    "PCIeDevices": [
      {
        "@odata.id": "/redfish/v1/Systems/system/PCIeDevices/chassis_motherboard_pcieslot8_pcie_card8"
      }
    ],
    "[email protected]": 1
  },
  "Location": {
    "PartLocation": {
      "ServiceLabel": "U780C.ND0.RCH0011-P0-C8"
    }
  },
  "Model": "",
  "Name": "PCIe4 x16 or PCIe5 x8 adapter",
  "PartNumber": "",
  "Ports": {
    "@odata.id": "/redfish/v1/Systems/system/FabricAdapters/motherboard-pcieslot8-pcie_card8/Ports"
  },
  "SerialNumber": "",
  "Status": {
    "Health": "OK",
    "State": "Absent"
  }
}

Signed-off-by: Sunny Srivastava <[email protected]>
Co-authored-by: Sunny Srivastava <[email protected]>

Author: 2 people

redfish-core/lib/fabric_adapters.hpp

@@ -351,6 +351,7 @@ inline void doAdapterGet(
 
 inline void afterGetValidFabricAdapterPath(
     const std::string& adapterId,
+    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
     std::function<void(
         const boost::system::error_code&, const std::string& fabricAdapterPath,
         const std::string& serviceName,
@@ -376,6 +377,9 @@ inline void afterGetValidFabricAdapterPath(
             fabricAdapterPath = adapterPath;
             serviceName = serviceMap.begin()->first;
             interfaces = serviceMap.begin()->second;
+
+            nlohmann::json::json_pointer ptr("/Name");
+            name_util::getPrettyName(asyncResp, adapterPath, serviceMap, ptr);
             break;
         }
     }
@@ -384,6 +388,7 @@ inline void afterGetValidFabricAdapterPath(
 
 inline void getValidFabricAdapterPath(
     const std::string& adapterId,
+    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
     std::function<void(
         const boost::system::error_code& ec,
         const std::string& fabricAdapterPath, const std::string& serviceName,
@@ -393,7 +398,8 @@ inline void getValidFabricAdapterPath(
         "xyz.openbmc_project.Inventory.Item.FabricAdapter"};
     dbus::utility::getSubTree("/xyz/openbmc_project/inventory", 0, interfaces,
                               std::bind_front(afterGetValidFabricAdapterPath,
-                                              adapterId, std::move(callback)));
+                                              adapterId, asyncResp,
+                                              std::move(callback)));
 }
 
 inline void afterHandleFabricAdapterGet(
@@ -448,9 +454,10 @@ inline void handleFabricAdapterGet(
                                    systemName);
         return;
     }
-    getValidFabricAdapterPath(
-        adapterId, std::bind_front(afterHandleFabricAdapterGet, asyncResp,
-                                   systemName, adapterId));
+    getValidFabricAdapterPath(adapterId, asyncResp,
+                              std::bind_front(afterHandleFabricAdapterGet,
+                                              asyncResp, systemName,
+                                              adapterId));
 }
 
 inline void afterHandleFabricAdapterPatch(
@@ -519,9 +526,10 @@ inline void handleFabricAdapterPatch(
         return;
     }
 
-    getValidFabricAdapterPath(
-        adapterId, std::bind_front(afterHandleFabricAdapterPatch, asyncResp,
-                                   adapterId, locationIndicatorActive));
+    getValidFabricAdapterPath(adapterId, asyncResp,
+                              std::bind_front(afterHandleFabricAdapterPatch,
+                                              asyncResp, adapterId,
+                                              locationIndicatorActive));
 }
 
 inline void handleFabricAdapterCollectionGet(
@@ -646,7 +654,7 @@ inline void handleFabricAdapterHead(
         return;
     }
     getValidFabricAdapterPath(
-        adapterId,
+        adapterId, asyncResp,
         std::bind_front(afterHandleFabricAdapterHead, asyncResp, adapterId));
 }
 

redfish-core/lib/fabric_ports.hpp

@@ -16,6 +16,7 @@
 #include "logging.hpp"
 #include "query.hpp"
 #include "registries/privilege_registry.hpp"
+#include <utils/name_utils.hpp>
 #include "utils/json_utils.hpp"
 
 #include <asm-generic/errno.h>
@@ -156,7 +157,12 @@ inline void getFabricPortProperties(
         boost::urls::format("/redfish/v1/Systems/{}/FabricAdapters/{}/Ports/{}",
                             systemName, adapterId, portId);
     asyncResp->res.jsonValue["Id"] = portId;
-    asyncResp->res.jsonValue["Name"] = "Fabric Port";
+
+    //Pretty name expects a services map
+    const dbus::utility::MapperServiceMap& serviceMap = {{serviceName, {""}}};
+    nlohmann::json::json_pointer ptr("/Name");
+    name_util::getPrettyName(asyncResp, portPath, serviceMap, ptr);
+
     asyncResp->res.jsonValue["Status"]["State"] = resource::State::Enabled;
     asyncResp->res.jsonValue["Status"]["Health"] = resource::Health::OK;