a1/controller.py

   1 # ==================================================================================
   2 #       Copyright (c) 2019 Nokia
   3 #       Copyright (c) 2018-2019 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 from flask import Response
  18 import connexion
  19 import json
  20 from jsonschema.exceptions import ValidationError
  21 from a1 import get_module_logger
  22 from a1 import a1rmr, exceptions, utils
  23
  24
  25 logger = get_module_logger(__name__)
  26
  27
  28 def _get_needed_policy_info(policyname):
  29     """
  30     Get the needed info for a policy
  31     """
  32     # Currently we read the manifest on each call, which would seem to allow updating A1 in place. Revisit this?
  33     manifest = utils.get_ric_manifest()
  34     for m in manifest["controls"]:
  35         if m["name"] == policyname:
  36             schema = m["message_receives_payload_schema"] if "message_receives_payload_schema" in m else None
  37             return (
  38                 utils.rmr_string_to_int(m["message_receives_rmr_type"]),
  39                 schema,
  40                 utils.rmr_string_to_int(m["message_sends_rmr_type"]),
  41             )
  42     raise exceptions.PolicyNotFound()
  43
  44
  45 def _try_func_return(func):
  46     """
  47     generic caller that returns the apporp http response if exceptions are raised
  48     """
  49     try:
  50         return func()
  51     except ValidationError as exc:
  52         logger.exception(exc)
  53         return "", 400
  54     except exceptions.PolicyNotFound as exc:
  55         logger.exception(exc)
  56         return "", 404
  57     except exceptions.MissingManifest as exc:
  58         logger.exception(exc)
  59         return "A1 was unable to find the required RIC manifest. report this!", 500
  60     except exceptions.MissingRmrString as exc:
  61         logger.exception(exc)
  62         return "A1 does not have a mapping for the desired rmr string. report this!", 500
  63     except exceptions.MessageSendFailure as exc:
  64         logger.exception(exc)
  65         return "A1 was unable to send a needed message to a downstream subscriber", 504
  66     except exceptions.ExpectedAckNotReceived as exc:
  67         logger.exception(exc)
  68         return "A1 was expecting an ACK back but it didn't receive one or didn't recieve the expected ACK", 504
  69     except BaseException as exc:
  70         # catch all, should never happen...
  71         logger.exception(exc)
  72         return Response(status=500)
  73
  74
  75 def _put_handler(policyname, data):
  76     """
  77     Handles policy put
  78     """
  79
  80     mtype_send, schema, mtype_return = _get_needed_policy_info(policyname)
  81
  82     # validate the PUT against the schema, or if there is no shema, make sure the pUT is empty
  83     if schema:
  84         utils.validate_json(data, schema)
  85     elif data != {}:
  86         return "BODY SUPPLIED BUT POLICY HAS NO EXPECTED BODY", 400
  87
  88     # send rmr, wait for ACK
  89     return_payload = a1rmr.send_ack_retry(json.dumps(data), message_type=mtype_send, expected_ack_message_type=mtype_return)
  90
  91     # right now it is assumed that xapps respond with JSON payloads
  92     # it is further assumed that they include a field "status" and that the value "SUCCESS" indicates a good policy change
  93     try:
  94         rpj = json.loads(return_payload)
  95         return (rpj, 200) if rpj["status"] == "SUCCESS" else ({"reason": "BAD STATUS", "return_payload": rpj}, 502)
  96     except json.decoder.JSONDecodeError:
  97         return {"reason": "NOT JSON", "return_payload": return_payload}, 502
  98     except KeyError:
  99         return {"reason": "NO STATUS", "return_payload": rpj}, 502
 100
 101
 102 # Public
 103
 104
 105 def put_handler(policyname):
 106     """
 107     Handles policy replacement
 108     """
 109     data = connexion.request.json
 110     return _try_func_return(lambda: _put_handler(policyname, data))
 111
 112
 113 def get_handler(policyname):
 114     """
 115     Handles policy GET
 116     """
 117     return "", 501