Revise custom exceptions to require a message

[ric-plt/a1.git] / a1 / controller.py

diff --git a/a1/controller.py b/a1/controller.py
index 4210266..289cf9a 100644 (file)
--- a/a1/controller.py
+++ b/a1/controller.py
@@ -1,6 +1,3 @@
-"""
-Main a1 controller
-"""
 # ==================================================================================
 #       Copyright (c) 2019-2020 Nokia
 #       Copyright (c) 2018-2020 AT&T Intellectual Property.
@@ -17,6 +14,9 @@ Main a1 controller
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 # ==================================================================================
+"""
+Main a1 controller
+"""
 from jsonschema import validate
 from jsonschema.exceptions import ValidationError
 import connexion
@@ -28,26 +28,36 @@ from a1 import a1rmr, exceptions, data
 mdc_logger = Logger(name=__name__)
 
 
+def _log_build_http_resp(exception, http_resp_code):
+    """
+    helper method that logs the exception and returns a tuple of (str, int) as a http response
+    """
+    msg = repr(exception)
+    mdc_logger.warning("Request failed, returning {0}: {1}".format(http_resp_code, msg))
+    return msg, http_resp_code
+
+
 def _try_func_return(func):
     """
-    generic caller that returns the apporp http response if exceptions are raised
+    helper method that runs the function and returns a detailed http response if an exception is raised.
     """
     try:
         return func()
-    except (ValidationError, exceptions.PolicyTypeAlreadyExists, exceptions.CantDeleteNonEmptyType):
-        return "", 400
-    except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound):
-        return "", 404
-    except (RejectedByBackend, NotConnected, BackendError):
+    except (ValidationError, exceptions.PolicyTypeAlreadyExists, exceptions.PolicyTypeIdMismatch, exceptions.CantDeleteNonEmptyType) as exc:
+        return _log_build_http_resp(exc, 400)
+    except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound) as exc:
+        return _log_build_http_resp(exc, 404)
+    except (RejectedByBackend, NotConnected, BackendError) as exc:
         """
-        These are SDL errors. At the time of development here, we do not have a good understanding which of these errors are "try again later it may work"
-        and which are "never going to work". There is some discussion that RejectedByBackend is in the latter category, suggesting it should map to 400,
-        but until we understand the root cause of these errors, it's confusing to clients to give them a 400 (a "your fault" code) because they won't know how to fix
+        These are SDL errors. At the time of development here, we do not have a good understanding
+        which of these errors are "try again later it may work" and which are "never going to work".
+        There is some discussion that RejectedByBackend is in the latter category, suggesting it
+        should map to 400, but until we understand the root cause of these errors, it's confusing
+        to clients to give them a 400 (a "your fault" code) because they won't know how to fix.
         For now, we log, and 503, and investigate the logs later to improve the handling/reporting.
         """
         # mdc_logger.exception(exc)  # waiting for https://jira.o-ran-sc.org/browse/RIC-39
-        return "", 503
-
+        return _log_build_http_resp(exc, 503)
     # let other types of unexpected exceptions blow up and log
 
 
@@ -63,8 +73,10 @@ def get_healthcheck():
     3. checks that our SDL connection is healthy
     """
     if not a1rmr.healthcheck_rmr_thread():
+        mdc_logger.debug("A1 is not healthy due to the rmr thread")
         return "rmr thread is unhealthy", 500
     if not data.SDL.healthcheck():
+        mdc_logger.debug("A1 is not healthy because it does not have a connection to SDL")
         return "sdl connection is unhealthy", 500
     return "", 200
 
@@ -86,6 +98,7 @@ def create_policy_type(policy_type_id):
 
     def put_type_handler():
         data.store_policy_type(policy_type_id, body)
+        mdc_logger.debug("Policy type {} created.".format(policy_type_id))
         return "", 201
 
     body = connexion.request.json
@@ -106,6 +119,7 @@ def delete_policy_type(policy_type_id):
 
     def delete_policy_type_handler():
         data.delete_policy_type(policy_type_id)
+        mdc_logger.debug("Policy type {} deleted.".format(policy_type_id))
         return "", 204
 
     return _try_func_return(delete_policy_type_handler)