summaryrefslogtreecommitdiff
path: root/test
diff options
context:
space:
mode:
authorClaire Weinan <cweinan@google.com>2022-07-14 05:40:19 +0300
committerClaire Weinan <cweinan@google.com>2023-01-14 01:58:36 +0300
commit0d9462115c53d478ed757ca4a3cccd0acf593781 (patch)
treebc880dc3b46bd2d72492c32e0d6e4d5624a70676 /test
parent51f65b0caa10aa785bd0050d31cf0c01ed17ac8e (diff)
downloadbmcweb-0d9462115c53d478ed757ca4a3cccd0acf593781.tar.xz
LogService: Use DeleteAll DBus method in clearDump
Update the clearDump() implementation to call the DeleteAll D-Bus method instead of iterating through D-Bus objects representing individual log entries and calling the Delete D-Bus method on each one. (It's more efficient for phosphor-debug-collector to iterate through entries in its DeleteAll method handler than for bmcweb to iterate through them.) It seems like clearDump() wasn't originally implemented using DeleteAll because dumps of various types were under the same D-Bus path namespace at the time and there wasn't a way to selectively clear dumps of only a specific type. The commit at [1] put different dump types under different path namespaces (enabling us to now use DeleteAll). Now clients should see a bit of performance improvement when running the ClearLog action on dump LogServices, due to the reduced number of D-Bus method calls needed to execute ClearLog. Also updated getDumpServiceInfo() to populate the ClearLog action for dump LogServices based on whether their dump manager object implements xyz.openbmc_project.Collection.DeleteAll. Tested: Cleared the fault log containing 100 entries. Ran with the time command several times before and after the change: ``` time curl -k -H "X-Auth-Token: $token" -X POST http://${bmc}/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog ``` Before the change, "real" time reported was ~1.2s. After the change, "real" time reported was ~0.4s. Forced creation of dump entries and then ran Redfish ClearLog action on each dump type: ``` curl -k -H "X-Auth-Token: $token" -X POST http://${bmc}/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog curl -k -H "X-Auth-Token: $token" -X POST http://${bmc}/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog curl -k -H "X-Auth-Token: $token" -X POST http://${bmc}/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog ``` Then verified that there were no dump LogService entries afterwards: ``` curl -k -H "X-Auth-Token: $token" -X GET http://${bmc}/redfish/v1/Managers/bmc/LogServices/Dump/Entries curl -k -H "X-Auth-Token: $token" -X GET http://${bmc}/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries curl -k -H "X-Auth-Token: $token" -X GET http://${bmc}/redfish/v1/Systems/system/LogServices/Dump/Entries ``` Also verified that the corresponding D-Bus objects were gone from the D-Bus tree after running ClearLog on each dump type: Before ClearLog: busctl tree xyz.openbmc_project.Dump.Manager `-/xyz `-/xyz/openbmc_project `-/xyz/openbmc_project/dump |-/xyz/openbmc_project/dump/bmc | `-/xyz/openbmc_project/dump/bmc/entry | `-/xyz/openbmc_project/dump/bmc/entry/101 |-/xyz/openbmc_project/dump/faultlog | `-/xyz/openbmc_project/dump/faultlog/entry | |-/xyz/openbmc_project/dump/faultlog/entry/11 | |-/xyz/openbmc_project/dump/faultlog/entry/12 | |-/xyz/openbmc_project/dump/faultlog/entry/13 | |-/xyz/openbmc_project/dump/faultlog/entry/14 | |-/xyz/openbmc_project/dump/faultlog/entry/15 | |-/xyz/openbmc_project/dump/faultlog/entry/16 | |-/xyz/openbmc_project/dump/faultlog/entry/17 | |-/xyz/openbmc_project/dump/faultlog/entry/18 | |-/xyz/openbmc_project/dump/faultlog/entry/19 | `-/xyz/openbmc_project/dump/faultlog/entry/20 |-/xyz/openbmc_project/dump/internal | `-/xyz/openbmc_project/dump/internal/manager `-/xyz/openbmc_project/dump/system `-/xyz/openbmc_project/dump/system/entry |-/xyz/openbmc_project/dump/system/entry/3 `-/xyz/openbmc_project/dump/system/entry/4 After ClearLog: busctl tree xyz.openbmc_project.Dump.Manager `-/xyz `-/xyz/openbmc_project `-/xyz/openbmc_project/dump |-/xyz/openbmc_project/dump/bmc |-/xyz/openbmc_project/dump/faultlog |-/xyz/openbmc_project/dump/internal | `-/xyz/openbmc_project/dump/internal/manager `-/xyz/openbmc_project/dump/system Confirmed that ClearLog action is listed for the following LogServices: /redfish/v1/Managers/bmc/LogServices/Dump /redfish/v1/Managers/bmc/LogServices/FaultLog /redfish/v1/Systems/system/LogServices/Dump Then ran "systemctl stop xyz.openbmc_project.Dump.Manager" (which removes dump manager objects including their xyz.openbmc_project.Collection.DeleteAll interface) and saw that the ClearLog action was no longer listed. Also locally built a version of phosphor-debug-collecor with the interface xyz.openbmc_project.Collection.DeleteAll removed from dump managers and ran it and saw that the ClearLog action wasn't listed. Redfish Service Validator passed on the following URIs (with service xyz.openbmc_project.Dump.Manager running): /redfish/v1/Managers/bmc/LogServices/Dump /redfish/v1/Managers/bmc/LogServices/FaultLog /redfish/v1/Systems/system/LogServices/Dump Note: Most dump LogService unit tests were removed in this patchset since this patchset adds a D-Bus call to getDumpServiceInfo(), and we haven't decided how to mock D-Bus calls for unit testing yet. [1] https://github.com/openbmc/phosphor-debug-collector/commit/fef66a951fe6fe283515480b2c493dfdc2275a95 Signed-off-by: Claire Weinan <cweinan@google.com> Change-Id: Ic5f8f9e3528f521887766d8710bd77f969d8236a
Diffstat (limited to 'test')
-rw-r--r--test/redfish-core/lib/log_services_dump_test.cpp91
1 files changed, 0 insertions, 91 deletions
diff --git a/test/redfish-core/lib/log_services_dump_test.cpp b/test/redfish-core/lib/log_services_dump_test.cpp
index 525830929e..2a6333b6b2 100644
--- a/test/redfish-core/lib/log_services_dump_test.cpp
+++ b/test/redfish-core/lib/log_services_dump_test.cpp
@@ -14,97 +14,6 @@ namespace redfish
namespace
{
-void assertLogServicesDumpServiceGet(crow::Response& res)
-{
- nlohmann::json& json = res.jsonValue;
- EXPECT_EQ(json["@odata.type"], "#LogService.v1_2_0.LogService");
- EXPECT_EQ(json["Name"], "Dump LogService");
-}
-
-void assertLogServicesBMCDumpServiceGet(crow::Response& res)
-{
- assertLogServicesDumpServiceGet(res);
-
- nlohmann::json& json = res.jsonValue;
- EXPECT_EQ(json["@odata.id"], "/redfish/v1/Managers/bmc/LogServices/Dump");
- EXPECT_EQ(
- json["Actions"]["#LogService.ClearLog"]["target"],
- "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog");
- EXPECT_EQ(
- json["Actions"]["#LogService.CollectDiagnosticData"]["target"],
- "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData");
- EXPECT_EQ(json["Description"], "BMC Dump LogService");
- EXPECT_EQ(json["Entries"]["@odata.id"],
- "/redfish/v1/Managers/bmc/LogServices/Dump/Entries");
- EXPECT_EQ(json["Id"], "Dump");
- EXPECT_EQ(json["OverWritePolicy"], "WrapsWhenFull");
-}
-
-void assertLogServicesFaultLogDumpServiceGet(crow::Response& res)
-{
- assertLogServicesDumpServiceGet(res);
-
- nlohmann::json& json = res.jsonValue;
- EXPECT_EQ(json["@odata.id"],
- "/redfish/v1/Managers/bmc/LogServices/FaultLog");
- EXPECT_EQ(
- json["Actions"]["#LogService.ClearLog"]["target"],
- "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog");
- EXPECT_EQ(json["Actions"]["#LogService.CollectDiagnosticData"]["target"],
- nlohmann::detail::value_t::null);
- EXPECT_EQ(json["Description"], "FaultLog Dump LogService");
- EXPECT_EQ(json["Entries"]["@odata.id"],
- "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries");
- EXPECT_EQ(json["Id"], "FaultLog");
- EXPECT_EQ(json["OverWritePolicy"], "Unknown");
-}
-
-void assertLogServicesSystemDumpServiceGet(crow::Response& res)
-{
- assertLogServicesDumpServiceGet(res);
-
- nlohmann::json& json = res.jsonValue;
- EXPECT_EQ(json["@odata.id"], "/redfish/v1/Systems/system/LogServices/Dump");
- EXPECT_EQ(
- json["Actions"]["#LogService.ClearLog"]["target"],
- "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog");
- EXPECT_EQ(
- json["Actions"]["#LogService.CollectDiagnosticData"]["target"],
- "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData");
- EXPECT_EQ(json["Description"], "System Dump LogService");
- EXPECT_EQ(json["Entries"]["@odata.id"],
- "/redfish/v1/Systems/system/LogServices/Dump/Entries");
- EXPECT_EQ(json["Id"], "Dump");
- EXPECT_EQ(json["OverWritePolicy"], "WrapsWhenFull");
-}
-
-TEST(LogServicesDumpServiceTest,
- LogServicesBMCDumpServiceStaticAttributesAreExpected)
-{
- auto shareAsyncResp = std::make_shared<bmcweb::AsyncResp>();
- shareAsyncResp->res.setCompleteRequestHandler(
- assertLogServicesBMCDumpServiceGet);
- getDumpServiceInfo(shareAsyncResp, "BMC");
-}
-
-TEST(LogServicesDumpServiceTest,
- LogServicesFaultLogDumpServiceStaticAttributesAreExpected)
-{
- auto shareAsyncResp = std::make_shared<bmcweb::AsyncResp>();
- shareAsyncResp->res.setCompleteRequestHandler(
- assertLogServicesFaultLogDumpServiceGet);
- getDumpServiceInfo(shareAsyncResp, "FaultLog");
-}
-
-TEST(LogServicesDumpServiceTest,
- LogServicesSystemDumpServiceStaticAttributesAreExpected)
-{
- auto shareAsyncResp = std::make_shared<bmcweb::AsyncResp>();
- shareAsyncResp->res.setCompleteRequestHandler(
- assertLogServicesSystemDumpServiceGet);
- getDumpServiceInfo(shareAsyncResp, "System");
-}
-
TEST(LogServicesDumpServiceTest, LogServicesInvalidDumpServiceGetReturnsError)
{
auto shareAsyncResp = std::make_shared<bmcweb::AsyncResp>();