a1/controller.py

   1 """
   2 Main a1 controller
   3 """
   4 # ==================================================================================
   5 #       Copyright (c) 2019-2020 Nokia
   6 #       Copyright (c) 2018-2020 AT&T Intellectual Property.
   7 #
   8 #   Licensed under the Apache License, Version 2.0 (the "License");
   9 #   you may not use this file except in compliance with the License.
  10 #   You may obtain a copy of the License at
  11 #
  12 #          http://www.apache.org/licenses/LICENSE-2.0
  13 #
  14 #   Unless required by applicable law or agreed to in writing, software
  15 #   distributed under the License is distributed on an "AS IS" BASIS,
  16 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 #   See the License for the specific language governing permissions and
  18 #   limitations under the License.
  19 # ==================================================================================
  20 from jsonschema import validate
  21 from jsonschema.exceptions import ValidationError
  22 import connexion
  23 from mdclogpy import Logger
  24 from ricsdl.exceptions import RejectedByBackend, NotConnected, BackendError
  25 from a1 import a1rmr, exceptions, data
  26
  27
  28 mdc_logger = Logger(name=__name__)
  29
  30
  31 def _try_func_return(func):
  32     """
  33     generic caller that returns the apporp http response if exceptions are raised
  34     """
  35     try:
  36         return func()
  37     except (ValidationError, exceptions.PolicyTypeAlreadyExists, exceptions.CantDeleteNonEmptyType):
  38         return "", 400
  39     except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound):
  40         return "", 404
  41     except (RejectedByBackend, NotConnected, BackendError):
  42         """
  43         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"
  44         and which are "never going to work". There is some discussion that RejectedByBackend is in the latter category, suggesting it should map to 400,
  45         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
  46         For now, we log, and 503, and investigate the logs later to improve the handling/reporting.
  47         """
  48         # mdc_logger.exception(exc)  # waiting for https://jira.o-ran-sc.org/browse/RIC-39
  49         return "", 503
  50
  51     # let other types of unexpected exceptions blow up and log
  52
  53
  54 # Healthcheck
  55
  56
  57 def get_healthcheck():
  58     """
  59     Handles healthcheck GET
  60     Currently, this checks:
  61     1. whether the a1 webserver is up (if it isn't, this won't even be called, so even entering this function confirms it is)
  62     2. checks whether the rmr thread is running and has completed a loop recently
  63     TODO: make "seconds" to pass in a configurable parameter?
  64     """
  65     if a1rmr.healthcheck_rmr_thread():
  66         return "", 200
  67     return "rmr thread is unhealthy", 500
  68
  69
  70 # Policy types
  71
  72
  73 def get_all_policy_types():
  74     """
  75     Handles GET /a1-p/policytypes
  76     """
  77     return _try_func_return(data.get_type_list)
  78
  79
  80 def create_policy_type(policy_type_id):
  81     """
  82     Handles PUT /a1-p/policytypes/policy_type_id
  83     """
  84
  85     def put_type_handler():
  86         data.store_policy_type(policy_type_id, body)
  87         return "", 201
  88
  89     body = connexion.request.json
  90     return _try_func_return(put_type_handler)
  91
  92
  93 def get_policy_type(policy_type_id):
  94     """
  95     Handles GET /a1-p/policytypes/policy_type_id
  96     """
  97     return _try_func_return(lambda: data.get_policy_type(policy_type_id))
  98
  99
 100 def delete_policy_type(policy_type_id):
 101     """
 102     Handles DELETE /a1-p/policytypes/policy_type_id
 103     """
 104
 105     def delete_policy_type_handler():
 106         data.delete_policy_type(policy_type_id)
 107         return "", 204
 108
 109     return _try_func_return(delete_policy_type_handler)
 110
 111
 112 # Policy instances
 113
 114
 115 def get_all_instances_for_type(policy_type_id):
 116     """
 117     Handles GET /a1-p/policytypes/policy_type_id/policies
 118     """
 119     return _try_func_return(lambda: data.get_instance_list(policy_type_id))
 120
 121
 122 def get_policy_instance(policy_type_id, policy_instance_id):
 123     """
 124     Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id
 125     """
 126     return _try_func_return(lambda: data.get_policy_instance(policy_type_id, policy_instance_id))
 127
 128
 129 def get_policy_instance_status(policy_type_id, policy_instance_id):
 130     """
 131     Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id/status
 132
 133     Return the aggregated status. The order of rules is as follows:
 134         1. If a1 has received at least one status, and *all* received statuses are "DELETED", we blow away the instance and return a 404
 135         2. if a1 has received at least one status and at least one is OK, we return "IN EFFECT"
 136         3. "NOT IN EFFECT" otherwise (no statuses, or none are OK but not all are deleted)
 137     """
 138
 139     return _try_func_return(lambda: data.get_policy_instance_status(policy_type_id, policy_instance_id))
 140
 141
 142 def create_or_replace_policy_instance(policy_type_id, policy_instance_id):
 143     """
 144     Handles PUT /a1-p/policytypes/polidyid/policies/policy_instance_id
 145     """
 146     instance = connexion.request.json
 147
 148     def put_instance_handler():
 149         """
 150         Handles policy instance put
 151
 152         For now, policy_type_id is used as the message type
 153         """
 154         #  validate the PUT against the schema
 155         schema = data.get_policy_type(policy_type_id)["create_schema"]
 156         validate(instance=instance, schema=schema)
 157
 158         # store the instance
 159         data.store_policy_instance(policy_type_id, policy_instance_id, instance)
 160
 161         # queue rmr send (best effort)
 162         a1rmr.queue_instance_send(("CREATE", policy_type_id, policy_instance_id, instance))
 163
 164         return "", 202
 165
 166     return _try_func_return(put_instance_handler)
 167
 168
 169 def delete_policy_instance(policy_type_id, policy_instance_id):
 170     """
 171     Handles DELETE /a1-p/policytypes/polidyid/policies/policy_instance_id
 172     """
 173
 174     def delete_instance_handler():
 175         """
 176         here we send out the DELETEs but we don't delete the instance until a GET is called where we check the statuses
 177         We also set the status as deleted which would be reflected in a GET to ../status (before the DELETE completes)
 178         """
 179         data.delete_policy_instance(policy_type_id, policy_instance_id)
 180
 181         # queue rmr send (best effort)
 182         a1rmr.queue_instance_send(("DELETE", policy_type_id, policy_instance_id, ""))
 183
 184         return "", 202
 185
 186     return _try_func_return(delete_instance_handler)