4 # ==================================================================================
5 # Copyright (c) 2019-2020 Nokia
6 # Copyright (c) 2018-2020 AT&T Intellectual Property.
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
12 # http://www.apache.org/licenses/LICENSE-2.0
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
23 from mdclogpy import Logger
24 from ricsdl.exceptions import RejectedByBackend, NotConnected, BackendError
25 from a1 import a1rmr, exceptions, data
28 mdc_logger = Logger(name=__name__)
31 def _try_func_return(func):
33 generic caller that returns the apporp http response if exceptions are raised
37 except (ValidationError, exceptions.PolicyTypeAlreadyExists, exceptions.CantDeleteNonEmptyType):
39 except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound):
41 except (RejectedByBackend, NotConnected, BackendError):
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.
48 # mdc_logger.exception(exc) # waiting for https://jira.o-ran-sc.org/browse/RIC-39
51 # let other types of unexpected exceptions blow up and log
57 def get_healthcheck():
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
66 if a1rmr.healthcheck_rmr_thread():
68 return "rmr thread is unhealthy", 500
74 def get_all_policy_types():
76 Handles GET /a1-p/policytypes
78 return _try_func_return(data.get_type_list)
81 def create_policy_type(policy_type_id):
83 Handles PUT /a1-p/policytypes/policy_type_id
86 def put_type_handler():
87 data.store_policy_type(policy_type_id, body)
90 body = connexion.request.json
91 return _try_func_return(put_type_handler)
94 def get_policy_type(policy_type_id):
96 Handles GET /a1-p/policytypes/policy_type_id
98 return _try_func_return(lambda: data.get_policy_type(policy_type_id))
101 def delete_policy_type(policy_type_id):
103 Handles DELETE /a1-p/policytypes/policy_type_id
106 def delete_policy_type_handler():
107 data.delete_policy_type(policy_type_id)
110 return _try_func_return(delete_policy_type_handler)
116 def get_all_instances_for_type(policy_type_id):
118 Handles GET /a1-p/policytypes/policy_type_id/policies
120 return _try_func_return(lambda: data.get_instance_list(policy_type_id))
123 def get_policy_instance(policy_type_id, policy_instance_id):
125 Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id
127 return _try_func_return(lambda: data.get_policy_instance(policy_type_id, policy_instance_id))
130 def get_policy_instance_status(policy_type_id, policy_instance_id):
132 Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id/status
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)
140 return _try_func_return(lambda: data.get_policy_instance_status(policy_type_id, policy_instance_id))
143 def create_or_replace_policy_instance(policy_type_id, policy_instance_id):
145 Handles PUT /a1-p/policytypes/polidyid/policies/policy_instance_id
147 instance = connexion.request.json
149 def put_instance_handler():
151 Handles policy instance put
153 For now, policy_type_id is used as the message type
155 # validate the PUT against the schema
156 schema = data.get_policy_type(policy_type_id)["create_schema"]
157 validate(instance=instance, schema=schema)
160 data.store_policy_instance(policy_type_id, policy_instance_id, instance)
162 # queue rmr send (best effort)
163 a1rmr.queue_instance_send(("CREATE", policy_type_id, policy_instance_id, instance))
167 return _try_func_return(put_instance_handler)
170 def delete_policy_instance(policy_type_id, policy_instance_id):
172 Handles DELETE /a1-p/policytypes/polidyid/policies/policy_instance_id
175 def delete_instance_handler():
176 data.delete_policy_instance(policy_type_id, policy_instance_id)
178 # queue rmr send (best effort)
179 a1rmr.queue_instance_send(("DELETE", policy_type_id, policy_instance_id, ""))
183 return _try_func_return(delete_instance_handler)