Skip to content

WIP: Bmcshell acf-task tracker apis. #1303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 1120
Choose a base branch
from
Open

WIP: Bmcshell acf-task tracker apis. #1303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions redfish-core/lib/acf_service.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
#pragma once
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

License statement?

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright OpenBMC Authors


#include "privileges.hpp"
#include "registries/privilege_registry.hpp"
#include "utils/dbus_utils.hpp"
#include "utils/json_utils.hpp"

#include <app.hpp>
#include <boost/beast/http/status.hpp>
#include <nlohmann/json.hpp>

#include <string>

namespace redfish
{
static void handleAcfScriptsGet(
App& /*unused*/, const crow::Request& /*unused*/,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
{
BMCWEB_LOG_DEBUG("Handling GET request for ACF scripts");
crow::connections::systemBus->async_method_call(
[asyncResp](const boost::system::error_code& ec,
const std::vector<std::string>& msg) {
if (ec)
{
messages::internalError(asyncResp->res);
return;
}
nlohmann::json& response = asyncResp->res.jsonValue;
response["@odata.context"] =
"/redfish/v1/$metadata#AccountService.AcfScripts";
response["@odata.type"] = "#AccountService.AcfScripts";
response["Name"] = "ACF Scripts";
response["Id"] = "AcfScripts";
response["Description"] =
"ACF Scripts currently active on the system";
nlohmann::json scripts;
std::transform(
msg.begin(), msg.end(), std::back_inserter(scripts),
[](const std::string& script) {
nlohmann::json scriptJson;
scriptJson["Id"] = script; // Use the script ID
scriptJson["Actions"] = {
{"#AccountService.AcfScripts.Cancel",
{{"target",
std::format(
"/redfish/v1/AccountService/acf/{}/cancel",
script)}}}};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this can be explicitly specified (refer to https://github.com/openbmc/bmcweb/blob/master/COMMON_ERRORS.md#13-complete-replacement-of-the-response-object), and also use boost:urls::format()

              scriptJson["Actions"]["#AccountService.AcfScripts.Cancel"]["target"] =
                           boost::urls::format(
                               "/redfish/v1/AccountService/acf/{}/cancel",  script);

return scriptJson;
});
response["Members"] = scripts;
response["OdataCount"] = scripts.size();
response["@odata.id"] = "/redfish/v1/AccountService/acf/scripts";
},
"xyz.openbmc_project.acfshell", "/xyz/openbmc_project/acfshell",
"xyz.openbmc_project.TacfShell", "active");
}
static void handleAcfScriptCancel(
App& /*unused*/, const crow::Request& /*unused*/,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& scriptId)
{
BMCWEB_LOG_DEBUG("Handling GET request for ACF scripts");
crow::connections::systemBus->async_method_call(
[asyncResp](const boost::system::error_code& ec, bool success) {
if (ec)
{
messages::internalError(asyncResp->res);
return;
}
asyncResp->res.jsonValue["status"] = success;
},
"xyz.openbmc_project.acfshell", "/xyz/openbmc_project/acfshell",
"xyz.openbmc_project.TacfShell", "cancel", scriptId);
}
inline void requestRoutesAcfService(App& app)
{
BMCWEB_ROUTE(app, "/redfish/v1/AccountService/acf/scripts/")
.privileges(redfish::privileges::getAccountService)
.methods(boost::beast::http::verb::get)(
std::bind_front(handleAcfScriptsGet, std::ref(app)));

BMCWEB_ROUTE(app, "/redfish/v1/AccountService/acf/<str>/cancel/")
.privileges(redfish::privileges::postManagerAccountCollection)
.methods(boost::beast::http::verb::post)(
std::bind_front(handleAcfScriptCancel, std::ref(app)));
}

} // namespace redfish
4 changes: 2 additions & 2 deletions src/webserver_run.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

#include "bmcweb_config.h"

#include "acf_service.hpp"
#include "app.hpp"
#include "dbus_monitor.hpp"
#include "dbus_singleton.hpp"
Expand Down Expand Up @@ -36,7 +37,6 @@
#include <memory>
#include <string>
#include <string_view>

static void setLogLevel(const std::string& logLevel)
{
const std::basic_string_view<char>* iter =
Expand Down Expand Up @@ -136,7 +136,7 @@ int run()
{
crow::google_api::requestRoutes(app);
}

redfish::requestRoutesAcfService(app);
crow::login_routes::requestRoutes(app);

if constexpr (!BMCWEB_INSECURE_DISABLE_SSL)
Expand Down