From f12894f8bd7fc26ffa16e5a89072e6c19095f866 Mon Sep 17 00:00:00 2001 From: "Jason M. Bills" Date: Tue, 9 Oct 2018 12:45:45 -0700 Subject: Improve the Redfish error reporting interface Makes the Redfish error reporting interface automatically handle setting the http status and JSON content in the response object. When using an AsyncResp object, this allows for simply calling the Redfish error and returning. Change-Id: Icfdce2de763225f070e8dd61e591f296703f46bb Signed-off-by: Jason M. Bills --- redfish-core/src/utils/json_utils.cpp | 482 +--------------------------------- 1 file changed, 1 insertion(+), 481 deletions(-) (limited to 'redfish-core/src/utils/json_utils.cpp') diff --git a/redfish-core/src/utils/json_utils.cpp b/redfish-core/src/utils/json_utils.cpp index e141317..a47b4d8 100644 --- a/redfish-core/src/utils/json_utils.cpp +++ b/redfish-core/src/utils/json_utils.cpp @@ -21,484 +21,6 @@ namespace redfish namespace json_util { -Result getString(const char* fieldName, const nlohmann::json& json, - const std::string*& output) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - return Result::NOT_EXIST; - } - - output = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (output == nullptr) - { - return Result::WRONG_TYPE; - } - - return Result::SUCCESS; -} - -Result getObject(const char* fieldName, const nlohmann::json& json, - nlohmann::json* output) -{ - // Verify input pointer - if (output == nullptr) - { - return Result::NULL_POINTER; - } - - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - return Result::NOT_EXIST; - } - - // Verify type - if (!fieldIt->is_object()) - { - return Result::WRONG_TYPE; - } - - // Extract value - *output = *fieldIt; - - return Result::SUCCESS; -} - -Result getArray(const char* fieldName, const nlohmann::json& json, - nlohmann::json* output) -{ - // Verify input pointer - if (output == nullptr) - { - return Result::NULL_POINTER; - } - - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - return Result::NOT_EXIST; - } - - // Verify type - if (!fieldIt->is_array()) - { - return Result::WRONG_TYPE; - } - - // Extract value - *output = *fieldIt; - - return Result::SUCCESS; -} - -Result getInt(const char* fieldName, const nlohmann::json& json, - int64_t& output) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - return Result::NOT_EXIST; - } - - const int64_t* retVal = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (retVal == nullptr) - { - return Result::WRONG_TYPE; - } - - // Extract value - output = *retVal; - - return Result::SUCCESS; -} - -Result getUnsigned(const char* fieldName, const nlohmann::json& json, - uint64_t& output) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - return Result::NOT_EXIST; - } - - const uint64_t* retVal = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (retVal == nullptr) - { - return Result::WRONG_TYPE; - } - - // Extract value - output = *retVal; - - return Result::SUCCESS; -} - -Result getBool(const char* fieldName, const nlohmann::json& json, bool& output) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - return Result::NOT_EXIST; - } - - const bool* retVal = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (retVal == nullptr) - { - return Result::WRONG_TYPE; - } - - // Extract value - output = *retVal; - - return Result::SUCCESS; -} - -Result getDouble(const char* fieldName, const nlohmann::json& json, - double& output) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - return Result::NOT_EXIST; - } - - const double* retVal = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (retVal == nullptr) - { - return Result::WRONG_TYPE; - } - - // Extract value - output = *retVal; - - return Result::SUCCESS; -} - -Result getString(const char* fieldName, const nlohmann::json& json, - const std::string*& output, uint8_t msgCfgMap, - nlohmann::json& msgJson, const std::string&& fieldPath) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - if (msgCfgMap & static_cast(MessageSetting::MISSING)) - { - messages::addMessageToJson( - msgJson, messages::propertyMissing(fieldName), fieldPath); - } - - return Result::NOT_EXIST; - } - - output = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (output == nullptr) - { - if (msgCfgMap & static_cast(MessageSetting::TYPE_ERROR)) - { - messages::addMessageToJson( - msgJson, - messages::propertyValueTypeError(fieldIt->dump(), fieldName), - fieldPath); - } - - return Result::WRONG_TYPE; - } - - return Result::SUCCESS; -} - -Result getObject(const char* fieldName, const nlohmann::json& json, - nlohmann::json* output, uint8_t msgCfgMap, - nlohmann::json& msgJson, const std::string&& fieldPath) -{ - // Verify input pointer - if (output == nullptr) - { - return Result::NULL_POINTER; - } - - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - if (msgCfgMap & static_cast(MessageSetting::MISSING)) - { - messages::addMessageToJson( - msgJson, messages::propertyMissing(fieldName), fieldPath); - } - - return Result::NOT_EXIST; - } - - // Verify type - if (!fieldIt->is_object()) - { - if (msgCfgMap & static_cast(MessageSetting::TYPE_ERROR)) - { - messages::addMessageToJson( - msgJson, - messages::propertyValueTypeError(fieldIt->dump(), fieldName), - fieldPath); - } - - return Result::WRONG_TYPE; - } - - // Extract value - *output = *fieldIt; - - return Result::SUCCESS; -} - -Result getArray(const char* fieldName, const nlohmann::json& json, - nlohmann::json* output, uint8_t msgCfgMap, - nlohmann::json& msgJson, const std::string&& fieldPath) -{ - // Verify input pointer - if (output == nullptr) - { - return Result::NULL_POINTER; - } - - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - if (msgCfgMap & static_cast(MessageSetting::MISSING)) - { - messages::addMessageToJson( - msgJson, messages::propertyMissing(fieldName), fieldPath); - } - - return Result::NOT_EXIST; - } - - // Verify type - if (!fieldIt->is_array()) - { - if (msgCfgMap & static_cast(MessageSetting::TYPE_ERROR)) - { - messages::addMessageToJson( - msgJson, - messages::propertyValueTypeError(fieldIt->dump(), fieldName), - fieldPath); - } - - return Result::WRONG_TYPE; - } - - // Extract value - *output = *fieldIt; - - return Result::SUCCESS; -} - -Result getInt(const char* fieldName, const nlohmann::json& json, - int64_t& output, uint8_t msgCfgMap, nlohmann::json& msgJson, - const std::string&& fieldPath) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - if (msgCfgMap & static_cast(MessageSetting::MISSING)) - { - messages::addMessageToJson( - msgJson, messages::propertyMissing(fieldName), fieldPath); - } - - return Result::NOT_EXIST; - } - - const int64_t* retVal = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (retVal == nullptr) - { - if (msgCfgMap & static_cast(MessageSetting::TYPE_ERROR)) - { - messages::addMessageToJson( - msgJson, - messages::propertyValueTypeError(fieldIt->dump(), fieldName), - fieldPath); - } - - return Result::WRONG_TYPE; - } - - // Extract value - output = *retVal; - - return Result::SUCCESS; -} - -Result getUnsigned(const char* fieldName, const nlohmann::json& json, - uint64_t& output, uint8_t msgCfgMap, nlohmann::json& msgJson, - const std::string&& fieldPath) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - if (msgCfgMap & static_cast(MessageSetting::MISSING)) - { - messages::addMessageToJson( - msgJson, messages::propertyMissing(fieldName), fieldPath); - } - - return Result::NOT_EXIST; - } - - const uint64_t* retVal = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (retVal == nullptr) - { - if (msgCfgMap & static_cast(MessageSetting::TYPE_ERROR)) - { - messages::addMessageToJson( - msgJson, - messages::propertyValueTypeError(fieldIt->dump(), fieldName), - fieldPath); - } - - return Result::WRONG_TYPE; - } - - // Extract value - output = *retVal; - - return Result::SUCCESS; -} - -Result getBool(const char* fieldName, const nlohmann::json& json, bool& output, - uint8_t msgCfgMap, nlohmann::json& msgJson, - const std::string&& fieldPath) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - if (msgCfgMap & static_cast(MessageSetting::MISSING)) - { - messages::addMessageToJson( - msgJson, messages::propertyMissing(fieldName), fieldPath); - } - - return Result::NOT_EXIST; - } - - const bool* retVal = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (retVal == nullptr) - { - if (msgCfgMap & static_cast(MessageSetting::TYPE_ERROR)) - { - messages::addMessageToJson( - msgJson, - messages::propertyValueTypeError(fieldIt->dump(), fieldName), - fieldPath); - } - - return Result::WRONG_TYPE; - } - - // Extract value - output = *retVal; - - return Result::SUCCESS; -} - -Result getDouble(const char* fieldName, const nlohmann::json& json, - double& output, uint8_t msgCfgMap, nlohmann::json& msgJson, - const std::string&& fieldPath) -{ - // Find field - auto fieldIt = json.find(fieldName); - - // Verify existence - if (fieldIt == json.end()) - { - if (msgCfgMap & static_cast(MessageSetting::MISSING)) - { - messages::addMessageToJson( - msgJson, messages::propertyMissing(fieldName), fieldPath); - } - - return Result::NOT_EXIST; - } - - const double* retVal = fieldIt->get_ptr(); - - // Verify type - we know that it exists, so nullptr means wrong type - if (retVal == nullptr) - { - if (msgCfgMap & static_cast(MessageSetting::TYPE_ERROR)) - { - messages::addMessageToJson( - msgJson, - messages::propertyValueTypeError(fieldIt->dump(), fieldName), - fieldPath); - } - - return Result::WRONG_TYPE; - } - - // Extract value - output = *retVal; - - return Result::SUCCESS; -} - bool processJsonFromRequest(crow::Response& res, const crow::Request& req, nlohmann::json& reqJson) { @@ -506,10 +28,8 @@ bool processJsonFromRequest(crow::Response& res, const crow::Request& req, if (reqJson.is_discarded()) { - messages::addMessageToErrorJson(res.jsonValue, - messages::malformedJSON()); + messages::malformedJSON(res); - res.result(boost::beast::http::status::bad_request); res.end(); return false; -- cgit v1.2.3