+"""
+Main a1 controller
+"""
# ==================================================================================
# Copyright (c) 2019 Nokia
# Copyright (c) 2018-2019 AT&T Intellectual Property.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==================================================================================
-from flask import Response
-import connexion
import json
+from flask import Response
+from jsonschema import validate
from jsonschema.exceptions import ValidationError
+import connexion
from a1 import get_module_logger
-from a1 import a1rmr, exceptions, utils
+from a1 import a1rmr, exceptions, data
logger = get_module_logger(__name__)
-def _get_policy_definition(policyname):
- # Currently we read the manifest on each call, which would seem to allow updating A1 in place. Revisit this?
- manifest = utils.get_ric_manifest()
- for m in manifest["controls"]:
- if m["name"] == policyname:
- return m
- raise exceptions.PolicyNotFound()
-
-
-def _get_needed_policy_info(policyname):
- """
- Get the needed info for a policy
- """
- m = _get_policy_definition(policyname)
- return (
- utils.rmr_string_to_int(m["message_receives_rmr_type"]),
- m["message_receives_payload_schema"] if "message_receives_payload_schema" in m else None,
- utils.rmr_string_to_int(m["message_sends_rmr_type"]),
- )
-
-
-def _get_needed_policy_fetch_info(policyname):
- """
- Get the needed info for fetching a policy state
- """
- m = _get_policy_definition(policyname)
- req_k = "control_state_request_rmr_type"
- ack_k = "control_state_request_reply_rmr_type"
- return (
- utils.rmr_string_to_int(m[req_k]) if req_k in m else None,
- utils.rmr_string_to_int(m[ack_k]) if ack_k in m else None,
- )
-
-
def _try_func_return(func):
"""
generic caller that returns the apporp http response if exceptions are raised
"""
try:
return func()
- except ValidationError as exc:
+ except (ValidationError, exceptions.PolicyTypeAlreadyExists) as exc:
logger.exception(exc)
return "", 400
- except exceptions.PolicyNotFound as exc:
+ except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound) as exc:
logger.exception(exc)
return "", 404
- except exceptions.MissingManifest as exc:
- logger.exception(exc)
- return "A1 was unable to find the required RIC manifest. report this!", 500
- except exceptions.MissingRmrString as exc:
- logger.exception(exc)
- return "A1 does not have a mapping for the desired rmr string. report this!", 500
- except exceptions.MessageSendFailure as exc:
- logger.exception(exc)
- return "A1 was unable to send a needed message to a downstream subscriber", 504
- except exceptions.ExpectedAckNotReceived as exc:
- logger.exception(exc)
- return "A1 was expecting an ACK back but it didn't receive one or didn't recieve the expected ACK", 504
except BaseException as exc:
# catch all, should never happen...
logger.exception(exc)
return Response(status=500)
-def _put_handler(policyname, data):
+def _gen_body_to_handler(operation, policy_type_id, policy_instance_id, payload=None):
"""
- Handles policy put
+ used to create the payloads that get sent to downstream policy handlers
"""
+ return {
+ "operation": operation,
+ "policy_type_id": policy_type_id,
+ "policy_instance_id": policy_instance_id,
+ "payload": payload,
+ }
- mtype_send, schema, mtype_return = _get_needed_policy_info(policyname)
- # validate the PUT against the schema, or if there is no shema, make sure the pUT is empty
- if schema:
- utils.validate_json(data, schema)
- elif data != {}:
- return "BODY SUPPLIED BUT POLICY HAS NO EXPECTED BODY", 400
+# Healthcheck
- # send rmr, wait for ACK
- return_payload = a1rmr.send_ack_retry(json.dumps(data), message_type=mtype_send, expected_ack_message_type=mtype_return)
- # right now it is assumed that xapps respond with JSON payloads
- # it is further assumed that they include a field "status" and that the value "SUCCESS" indicates a good policy change
- try:
- rpj = json.loads(return_payload)
- return (rpj, 200) if rpj["status"] == "SUCCESS" else ({"reason": "BAD STATUS", "return_payload": rpj}, 502)
- except json.decoder.JSONDecodeError:
- return {"reason": "NOT JSON", "return_payload": return_payload}, 502
- except KeyError:
- return {"reason": "NO STATUS", "return_payload": rpj}, 502
+def get_healthcheck():
+ """
+ Handles healthcheck GET
+ Currently, this basically checks the server is alive.a1rmr
+ """
+ return "", 200
+
+
+# Policy types
-def _get_handler(policyname):
+def get_all_policy_types():
"""
- Handles policy GET
+ Handles GET /a1-p/policytypes
"""
- mtype_send, mtype_return = _get_needed_policy_fetch_info(policyname)
+ return _try_func_return(data.get_type_list)
- if not (mtype_send and mtype_return):
- return "POLICY DOES NOT SUPPORT FETCHING", 400
- # send rmr, wait for ACK
- return_payload = a1rmr.send_ack_retry("", message_type=mtype_send, expected_ack_message_type=mtype_return)
+def create_policy_type(policy_type_id):
+ """
+ Handles PUT /a1-p/policytypes/policy_type_id
+ """
- # right now it is assumed that xapps respond with JSON payloads
- try:
- return (json.loads(return_payload), 200)
- except json.decoder.JSONDecodeError:
- return {"reason": "NOT JSON", "return_payload": return_payload}, 502
+ def put_type_handler():
+ data.store_policy_type(policy_type_id, body)
+ return "", 201
+
+ body = connexion.request.json
+ return _try_func_return(put_type_handler)
+
+
+def get_policy_type(policy_type_id):
+ """
+ Handles GET /a1-p/policytypes/policy_type_id
+ """
+ return _try_func_return(lambda: data.get_policy_type(policy_type_id))
-# Public
+def delete_policy_type(policy_type_id):
+ """
+ Handles DELETE /a1-p/policytypes/policy_type_id
+ """
+ logger.error(policy_type_id)
+ return "", 501
+
+# Policy instances
-def put_handler(policyname):
+
+def get_all_instances_for_type(policy_type_id):
"""
- Handles policy replacement
+ Handles GET /a1-p/policytypes/policy_type_id/policies
"""
- data = connexion.request.json
- return _try_func_return(lambda: _put_handler(policyname, data))
+ def get_all_instance_handler():
+ # try to clean up instances for this type
+ for policy_instance_id in data.get_instance_list(policy_type_id):
+ data.delete_policy_instance_if_applicable(policy_type_id, policy_instance_id)
+
+ # re-fetch this list as it may have changed
+ return data.get_instance_list(policy_type_id), 200
-def get_handler(policyname):
+ return _try_func_return(get_all_instance_handler)
+
+
+def get_policy_instance(policy_type_id, policy_instance_id):
"""
- Handles policy GET
+ Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id
"""
- return _try_func_return(lambda: _get_handler(policyname))
+ def get_instance_handler():
+ # delete if applicable (will raise if not applicable to begin with)
+ data.delete_policy_instance_if_applicable(policy_type_id, policy_instance_id)
+
+ # raise 404 now that we may have deleted, or get the instance otherwise
+ return data.get_policy_instance(policy_type_id, policy_instance_id), 200
+
+ return _try_func_return(get_instance_handler)
-def healthcheck_handler():
+
+def get_policy_instance_status(policy_type_id, policy_instance_id):
"""
- Handles healthcheck GET
- Currently, this basically checks the server is alive.a1rmr
+ Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id/status
+
+ Return the aggregated status. The order of rules is as follows:
+ 1. If a1 has received at least one status, and *all* received statuses are "DELETED", we blow away the instance and return a 404
+ 2. if a1 has received at least one status and at least one is OK, we return "IN EFFECT"
+ 3. "NOT IN EFFECT" otherwise (no statuses, or none are OK but not all are deleted)
"""
- return "", 200
+
+ def get_status_handler():
+ # delete if applicable (will raise if not applicable to begin with)
+ data.delete_policy_instance_if_applicable(policy_type_id, policy_instance_id)
+
+ vector = data.get_policy_instance_statuses(policy_type_id, policy_instance_id)
+ for i in vector:
+ if i == "OK":
+ return "IN EFFECT", 200
+ return "NOT IN EFFECT", 200
+
+ return _try_func_return(get_status_handler)
+
+
+def create_or_replace_policy_instance(policy_type_id, policy_instance_id):
+ """
+ Handles PUT /a1-p/policytypes/polidyid/policies/policy_instance_id
+ """
+ instance = connexion.request.json
+
+ def put_instance_handler():
+ """
+ Handles policy instance put
+
+ For now, policy_type_id is used as the message type
+ """
+ # validate the PUT against the schema
+ schema = data.get_policy_type(policy_type_id)["create_schema"]
+ validate(instance=instance, schema=schema)
+
+ # store the instance
+ data.store_policy_instance(policy_type_id, policy_instance_id, instance)
+
+ # send rmr (best effort)
+ body = _gen_body_to_handler("CREATE", policy_type_id, policy_instance_id, payload=instance)
+ a1rmr.send(json.dumps(body), message_type=policy_type_id)
+
+ return "", 202
+
+ return _try_func_return(put_instance_handler)
+
+
+def delete_policy_instance(policy_type_id, policy_instance_id):
+ """
+ Handles DELETE /a1-p/policytypes/polidyid/policies/policy_instance_id
+ """
+
+ def delete_instance_handler():
+ """
+ here we send out the DELETEs but we don't delete the instance until a GET is called where we check the statuses
+ """
+ # send rmr (best effort)
+ body = _gen_body_to_handler("DELETE", policy_type_id, policy_instance_id)
+ a1rmr.send(json.dumps(body), message_type=policy_type_id)
+
+ return "", 202
+
+ return _try_func_return(delete_instance_handler)
Code Review / ric-plt / a1.git / blobdiff