Storing metadata for Policy Instance.
[ric-plt/a1.git] / a1 / controller.py
1 # ==================================================================================
2 #       Copyright (c) 2019-2020 Nokia
3 #       Copyright (c) 2018-2020 AT&T Intellectual Property.
4 #
5 #   Licensed under the Apache License, Version 2.0 (the "License");
6 #   you may not use this file except in compliance with the License.
7 #   You may obtain a copy of the License at
8 #
9 #          http://www.apache.org/licenses/LICENSE-2.0
10 #
11 #   Unless required by applicable law or agreed to in writing, software
12 #   distributed under the License is distributed on an "AS IS" BASIS,
13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 #   See the License for the specific language governing permissions and
15 #   limitations under the License.
16 # ==================================================================================
17 """
18 Main a1 controller
19 """
20 from jsonschema import validate
21 from jsonschema.exceptions import ValidationError
22 import connexion
23 from prometheus_client import Counter
24 from mdclogpy import Logger
25 from ricsdl.exceptions import RejectedByBackend, NotConnected, BackendError
26 from a1 import a1rmr, exceptions, data
27
28
29 mdc_logger = Logger(name=__name__)
30 mdc_logger.mdclog_format_init(configmap_monitor=True)
31
32 a1_counters = Counter('A1Policy', 'Policy type and instance counters', ['counter'])
33
34
35 def _log_build_http_resp(exception, http_resp_code):
36     """
37     helper method that logs the exception and returns a tuple of (str, int) as a http response
38     """
39     msg = repr(exception)
40     mdc_logger.warning("Request failed, returning {0}: {1}".format(http_resp_code, msg))
41     return msg, http_resp_code
42
43
44 def _try_func_return(func):
45     """
46     helper method that runs the function and returns a detailed http response if an exception is raised.
47     """
48     try:
49         return func()
50     except (ValidationError, exceptions.PolicyTypeAlreadyExists, exceptions.PolicyTypeIdMismatch, exceptions.CantDeleteNonEmptyType) as exc:
51         return _log_build_http_resp(exc, 400)
52     except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound) as exc:
53         return _log_build_http_resp(exc, 404)
54     except (RejectedByBackend, NotConnected, BackendError) as exc:
55         """
56         These are SDL errors. At the time of development here, we do not have a good understanding
57         which of these errors are "try again later it may work" and which are "never going to work".
58         There is some discussion that RejectedByBackend is in the latter category, suggesting it
59         should map to 400, but until we understand the root cause of these errors, it's confusing
60         to clients to give them a 400 (a "your fault" code) because they won't know how to fix.
61         For now, we log, and 503, and investigate the logs later to improve the handling/reporting.
62         """
63         # mdc_logger.exception(exc)  # waiting for https://jira.o-ran-sc.org/browse/RIC-39
64         return _log_build_http_resp(exc, 503)
65     # let other types of unexpected exceptions blow up and log
66
67
68 # Healthcheck
69
70
71 def get_healthcheck():
72     """
73     Handles healthcheck GET
74     Currently, this checks:
75     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)
76     2. checks whether the rmr thread is running and has completed a loop recently
77     3. checks that our SDL connection is healthy
78     """
79     if not a1rmr.healthcheck_rmr_thread():
80         mdc_logger.error("A1 is not healthy due to the rmr thread")
81         return "rmr thread is unhealthy", 500
82     if not data.SDL.healthcheck():
83         mdc_logger.error("A1 is not healthy because it does not have a connection to SDL")
84         return "sdl connection is unhealthy", 500
85     return "", 200
86
87
88 # Policy types
89
90
91 def get_all_policy_types():
92     """
93     Handles GET /a1-p/policytypes
94     """
95     return _try_func_return(data.get_type_list)
96
97
98 def create_policy_type(policy_type_id):
99     """
100     Handles PUT /a1-p/policytypes/policy_type_id
101     """
102     a1_counters.labels(counter='CreatePolicyTypeReqs').inc()
103
104     def put_type_handler():
105         data.store_policy_type(policy_type_id, body)
106         mdc_logger.debug("Policy type {} created.".format(policy_type_id))
107         return "", 201
108
109     body = connexion.request.json
110     return _try_func_return(put_type_handler)
111
112
113 def get_policy_type(policy_type_id):
114     """
115     Handles GET /a1-p/policytypes/policy_type_id
116     """
117     return _try_func_return(lambda: data.get_policy_type(policy_type_id))
118
119
120 def delete_policy_type(policy_type_id):
121     """
122     Handles DELETE /a1-p/policytypes/policy_type_id
123     """
124     a1_counters.labels(counter='DeletePolicyTypeReqs').inc()
125
126     def delete_policy_type_handler():
127         data.delete_policy_type(policy_type_id)
128         mdc_logger.debug("Policy type {} deleted.".format(policy_type_id))
129         return "", 204
130
131     return _try_func_return(delete_policy_type_handler)
132
133
134 # Policy instances
135
136
137 def get_all_instances_for_type(policy_type_id):
138     """
139     Handles GET /a1-p/policytypes/policy_type_id/policies
140     """
141     return _try_func_return(lambda: data.get_instance_list(policy_type_id))
142
143
144 def get_policy_instance(policy_type_id, policy_instance_id):
145     """
146     Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id
147     """
148     return _try_func_return(lambda: data.get_policy_instance(policy_type_id, policy_instance_id))
149
150
151 def get_policy_instance_status(policy_type_id, policy_instance_id):
152     """
153     Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id/status
154
155     Return the aggregated status. The order of rules is as follows:
156         1. If a1 has received at least one status, and *all* received statuses are "DELETED", we blow away the instance and return a 404
157         2. if a1 has received at least one status and at least one is OK, we return "IN EFFECT"
158         3. "NOT IN EFFECT" otherwise (no statuses, or none are OK but not all are deleted)
159     """
160     return _try_func_return(lambda: data.get_policy_instance_status(policy_type_id, policy_instance_id))
161
162
163 def create_or_replace_policy_instance(policy_type_id, policy_instance_id):
164     """
165     Handles PUT /a1-p/policytypes/polidyid/policies/policy_instance_id
166     """
167     a1_counters.labels(counter='CreatePolicyInstanceReqs').inc()
168     instance = connexion.request.json
169
170     def put_instance_handler():
171         """
172         Handles policy instance put
173
174         For now, policy_type_id is used as the message type
175         """
176         #  validate the PUT against the schema
177         schema = data.get_policy_type(policy_type_id)["create_schema"]
178         validate(instance=instance, schema=schema)
179
180         # store the instance
181         operation = data.store_policy_instance(policy_type_id, policy_instance_id, instance)
182
183         # queue rmr send (best effort)
184         a1rmr.queue_instance_send((operation, policy_type_id, policy_instance_id, instance))
185
186         return "", 202
187
188     return _try_func_return(put_instance_handler)
189
190
191 def delete_policy_instance(policy_type_id, policy_instance_id):
192     """
193     Handles DELETE /a1-p/policytypes/polidyid/policies/policy_instance_id
194     """
195     a1_counters.labels(counter='DeletePolicyInstanceReqs').inc()
196
197     def delete_instance_handler():
198         data.delete_policy_instance(policy_type_id, policy_instance_id)
199
200         # queue rmr send (best effort)
201         a1rmr.queue_instance_send(("DELETE", policy_type_id, policy_instance_id, ""))
202
203         return "", 202
204
205     return _try_func_return(delete_instance_handler)
206
207
208 # data delivery
209
210
211 def data_delivery():
212     """
213     Handle data delivery /data-delivery
214     """
215
216     def data_delivery_handler():
217         mdc_logger.debug("data: {}".format(connexion.request.json))
218         ei_job_result_json = connexion.request.json
219         mdc_logger.debug("jobid: {}".format(ei_job_result_json.get("job")))
220         a1rmr.queue_ei_job_result((ei_job_result_json.get("job"), ei_job_result_json))
221         return "", 200
222
223     return _try_func_return(data_delivery_handler)