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     TODO: I've requested that SDL provide a "I'm connected to the backend" healthcheck that can be integrated here
  65     """
  66     if a1rmr.healthcheck_rmr_thread():
  67         return "", 200
  68     return "rmr thread is unhealthy", 500
  69
  70
  71 # Policy types
  72
  73
  74 def get_all_policy_types():
  75     """
  76     Handles GET /a1-p/policytypes
  77     """
  78     return _try_func_return(data.get_type_list)
  79
  80
  81 def create_policy_type(policy_type_id):
  82     """
  83     Handles PUT /a1-p/policytypes/policy_type_id
  84     """
  85
  86     def put_type_handler():
  87         data.store_policy_type(policy_type_id, body)
  88         return "", 201
  89
  90     body = connexion.request.json
  91     return _try_func_return(put_type_handler)
  92
  93
  94 def get_policy_type(policy_type_id):
  95     """
  96     Handles GET /a1-p/policytypes/policy_type_id
  97     """
  98     return _try_func_return(lambda: data.get_policy_type(policy_type_id))
  99
 100
 101 def delete_policy_type(policy_type_id):
 102     """
 103     Handles DELETE /a1-p/policytypes/policy_type_id
 104     """
 105
 106     def delete_policy_type_handler():
 107         data.delete_policy_type(policy_type_id)
 108         return "", 204
 109
 110     return _try_func_return(delete_policy_type_handler)
 111
 112
 113 # Policy instances
 114
 115
 116 def get_all_instances_for_type(policy_type_id):
 117     """
 118     Handles GET /a1-p/policytypes/policy_type_id/policies
 119     """
 120     return _try_func_return(lambda: data.get_instance_list(policy_type_id))
 121
 122
 123 def get_policy_instance(policy_type_id, policy_instance_id):
 124     """
 125     Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id
 126     """
 127     return _try_func_return(lambda: data.get_policy_instance(policy_type_id, policy_instance_id))
 128
 129
 130 def get_policy_instance_status(policy_type_id, policy_instance_id):
 131     """
 132     Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id/status
 133
 134     Return the aggregated status. The order of rules is as follows:
 135         1. If a1 has received at least one status, and *all* received statuses are "DELETED", we blow away the instance and return a 404
 136         2. if a1 has received at least one status and at least one is OK, we return "IN EFFECT"
 137         3. "NOT IN EFFECT" otherwise (no statuses, or none are OK but not all are deleted)
 138     """
 139
 140     return _try_func_return(lambda: data.get_policy_instance_status(policy_type_id, policy_instance_id))
 141
 142
 143 def create_or_replace_policy_instance(policy_type_id, policy_instance_id):
 144     """
 145     Handles PUT /a1-p/policytypes/polidyid/policies/policy_instance_id
 146     """
 147     instance = connexion.request.json
 148
 149     def put_instance_handler():
 150         """
 151         Handles policy instance put
 152
 153         For now, policy_type_id is used as the message type
 154         """
 155         #  validate the PUT against the schema
 156         schema = data.get_policy_type(policy_type_id)["create_schema"]
 157         validate(instance=instance, schema=schema)
 158
 159         # store the instance
 160         data.store_policy_instance(policy_type_id, policy_instance_id, instance)
 161
 162         # queue rmr send (best effort)
 163         a1rmr.queue_instance_send(("CREATE", policy_type_id, policy_instance_id, instance))
 164
 165         return "", 202
 166
 167     return _try_func_return(put_instance_handler)
 168
 169
 170 def delete_policy_instance(policy_type_id, policy_instance_id):
 171     """
 172     Handles DELETE /a1-p/policytypes/polidyid/policies/policy_instance_id
 173     """
 174
 175     def delete_instance_handler():
 176         data.delete_policy_instance(policy_type_id, policy_instance_id)
 177
 178         # queue rmr send (best effort)
 179         a1rmr.queue_instance_send(("DELETE", policy_type_id, policy_instance_id, ""))
 180
 181         return "", 202
 182
 183     return _try_func_return(delete_instance_handler)