Remove the static Base Message Registry file
This change removes the static Base Message Registry file and
replaces it with a compile-time structure.
A script is used to pull the Base Message Registry file from
the DMTF and parse it into the .hpp structure.
Tested:
Verified that after running the script, I can get the same
Redfish data back from the existing endpoints without using
the static files.
Change-Id: Ide3c61ecff62801c06619d5c3edc2229c945d8e7
Signed-off-by: Jason M. Bills <jason.m.bills@linux.intel.com>
diff --git a/redfish-core/lib/message_registries.hpp b/redfish-core/lib/message_registries.hpp
new file mode 100644
index 0000000..f01caf9
--- /dev/null
+++ b/redfish-core/lib/message_registries.hpp
@@ -0,0 +1,189 @@
+/*
+// Copyright (c) 2019 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+#pragma once
+
+#include "node.hpp"
+#include "registries.hpp"
+#include "registries/base_message_registry.hpp"
+
+namespace redfish
+{
+
+class MessageRegistryFileCollection : public Node
+{
+ public:
+ template <typename CrowApp>
+ MessageRegistryFileCollection(CrowApp &app) :
+ Node(app, "/redfish/v1/Registries/")
+ {
+ entityPrivileges = {
+ {boost::beast::http::verb::get, {{"Login"}}},
+ {boost::beast::http::verb::head, {{"Login"}}},
+ {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::put, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
+ }
+
+ private:
+ /**
+ * Functions triggers appropriate requests on DBus
+ */
+ void doGet(crow::Response &res, const crow::Request &req,
+ const std::vector<std::string> ¶ms) override
+ {
+ std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
+ // Collections don't include the static data added by SubRoute because
+ // it has a duplicate entry for members
+ asyncResp->res.jsonValue["@odata.type"] =
+ "#MessageRegistryFileCollection.MessageRegistryFileCollection";
+ asyncResp->res.jsonValue["@odata.context"] =
+ "/redfish/v1/"
+ "$metadata#MessageRegistryFileCollection."
+ "MessageRegistryFileCollection";
+ asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Registries";
+ asyncResp->res.jsonValue["Name"] = "MessageRegistryFile Collection";
+ asyncResp->res.jsonValue["Description"] =
+ "Collection of MessageRegistryFiles";
+ nlohmann::json &messageRegistryFileArray =
+ asyncResp->res.jsonValue["Members"];
+ messageRegistryFileArray = nlohmann::json::array();
+ messageRegistryFileArray.push_back(
+ {{"@odata.id", "/redfish/v1/Registries/Base"}});
+ messageRegistryFileArray.push_back(
+ {{"@odata.id", "/redfish/v1/Registries/OpenBMC"}});
+ asyncResp->res.jsonValue["Members@odata.count"] =
+ messageRegistryFileArray.size();
+ }
+};
+
+class BaseMessageRegistryFile : public Node
+{
+ public:
+ template <typename CrowApp>
+ BaseMessageRegistryFile(CrowApp &app) :
+ Node(app, "/redfish/v1/Registries/Base/")
+ {
+ entityPrivileges = {
+ {boost::beast::http::verb::get, {{"Login"}}},
+ {boost::beast::http::verb::head, {{"Login"}}},
+ {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::put, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
+ }
+
+ private:
+ void doGet(crow::Response &res, const crow::Request &req,
+ const std::vector<std::string> ¶ms) override
+ {
+ std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
+
+ asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Registries/Base";
+ asyncResp->res.jsonValue["@odata.type"] =
+ "#MessageRegistryFile.v1_1_0.MessageRegistryFile";
+ asyncResp->res.jsonValue["@odata.context"] =
+ "/redfish/v1/$metadata#MessageRegistryFile.MessageRegistryFile";
+ asyncResp->res.jsonValue["Name"] = "Base Message Registry File";
+ asyncResp->res.jsonValue["Description"] =
+ "DMTF Base Message Registry File Location";
+ asyncResp->res.jsonValue["Id"] = "Base";
+ asyncResp->res.jsonValue["Registry"] = "Base.1.4";
+ nlohmann::json &messageRegistryLanguageArray =
+ asyncResp->res.jsonValue["Languages"];
+ messageRegistryLanguageArray = nlohmann::json::array();
+ messageRegistryLanguageArray.push_back({"en"});
+ asyncResp->res.jsonValue["Languages@odata.count"] =
+ messageRegistryLanguageArray.size();
+ nlohmann::json &messageRegistryLocationArray =
+ asyncResp->res.jsonValue["Location"];
+ messageRegistryLocationArray = nlohmann::json::array();
+ messageRegistryLocationArray.push_back(
+ {{"Language", "en"},
+ {"PublicationUri",
+ "https://redfish.dmtf.org/registries/Base.1.4.0.json"},
+ {"Uri", "/redfish/v1/Registries/Base/Base"}});
+ asyncResp->res.jsonValue["Location@odata.count"] =
+ messageRegistryLocationArray.size();
+ }
+};
+
+class BaseMessageRegistry : public Node
+{
+ public:
+ template <typename CrowApp>
+ BaseMessageRegistry(CrowApp &app) :
+ Node(app, "/redfish/v1/Registries/Base/Base/")
+ {
+ entityPrivileges = {
+ {boost::beast::http::verb::get, {{"Login"}}},
+ {boost::beast::http::verb::head, {{"Login"}}},
+ {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::put, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
+ {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
+ }
+
+ private:
+ void doGet(crow::Response &res, const crow::Request &req,
+ const std::vector<std::string> ¶ms) override
+ {
+ std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
+
+ asyncResp->res.jsonValue["@Redfish.Copyright"] =
+ "Copyright 2014-2018 DMTF. All rights reserved.";
+ asyncResp->res.jsonValue["@odata.type"] =
+ "#MessageRegistry.v1_0_0.MessageRegistry";
+ asyncResp->res.jsonValue["Id"] = "Base.1.4.0";
+ asyncResp->res.jsonValue["Name"] = "Base Message Registry";
+ asyncResp->res.jsonValue["Language"] = "en";
+ asyncResp->res.jsonValue["Description"] =
+ "This registry defines the base messages for Redfish";
+ asyncResp->res.jsonValue["RegistryPrefix"] = "Base";
+ asyncResp->res.jsonValue["RegistryVersion"] = "1.4.0";
+ asyncResp->res.jsonValue["OwningEntity"] = "DMTF";
+ nlohmann::json &messageArray = asyncResp->res.jsonValue["Messages"];
+ messageArray = nlohmann::json::array();
+
+ // Go through the Message Registry and populate each Message
+ for (const message_registries::MessageEntry &message :
+ message_registries::base::registry)
+ {
+ messageArray.push_back(
+ {{message.first,
+ {{"Description", message.second.description},
+ {"Message", message.second.message},
+ {"Severity", message.second.severity},
+ {"NumberOfArgs", message.second.numberOfArgs},
+ {"Resolution", message.second.resolution}}}});
+ if (message.second.numberOfArgs > 0)
+ {
+ nlohmann::json &messageParamArray =
+ messageArray.back()[message.first]["ParamTypes"];
+ for (const char *str : message.second.paramTypes)
+ {
+ if (str == nullptr)
+ {
+ break;
+ }
+ messageParamArray.push_back(str);
+ }
+ }
+ }
+ }
+};
+
+} // namespace redfish