a1/controller.py

   1 """
   2 Main a1 controller
   3 """
   4 # ==================================================================================
   5 #       Copyright (c) 2019 Nokia
   6 #       Copyright (c) 2018-2019 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 import json
  21 from flask import Response
  22 from jsonschema import validate
  23 from jsonschema.exceptions import ValidationError
  24 import connexion
  25 from a1 import get_module_logger
  26 from a1 import a1rmr, exceptions, data
  27
  28
  29 logger = get_module_logger(__name__)
  30
  31
  32 def _try_func_return(func):
  33     """
  34     generic caller that returns the apporp http response if exceptions are raised
  35     """
  36     try:
  37         return func()
  38     except (ValidationError, exceptions.PolicyTypeAlreadyExists, exceptions.CantDeleteNonEmptyType):
  39         return "", 400
  40     except (exceptions.PolicyTypeNotFound, exceptions.PolicyInstanceNotFound):
  41         return "", 404
  42     except BaseException as exc:
  43         # catch all, should never happen...
  44         logger.exception(exc)
  45         return Response(status=500)
  46
  47
  48 def _gen_body_to_handler(operation, policy_type_id, policy_instance_id, payload=None):
  49     """
  50     used to create the payloads that get sent to downstream policy handlers
  51     """
  52     return {
  53         "operation": operation,
  54         "policy_type_id": policy_type_id,
  55         "policy_instance_id": policy_instance_id,
  56         "payload": payload,
  57     }
  58
  59
  60 # Healthcheck
  61
  62
  63 def get_healthcheck():
  64     """
  65     Handles healthcheck GET
  66     Currently, this checks:
  67     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)
  68     2. checks whether the rmr thread is running and has completed a loop recently
  69     TODO: make "seconds" to pass in a configurable parameter?
  70     """
  71     if a1rmr.healthcheck_rmr_thread():
  72         return "", 200
  73     return "rmr thread is unhealthy", 500
  74
  75
  76 # Policy types
  77
  78
  79 def get_all_policy_types():
  80     """
  81     Handles GET /a1-p/policytypes
  82     """
  83     return _try_func_return(data.get_type_list)
  84
  85
  86 def create_policy_type(policy_type_id):
  87     """
  88     Handles PUT /a1-p/policytypes/policy_type_id
  89     """
  90
  91     def put_type_handler():
  92         data.store_policy_type(policy_type_id, body)
  93         return "", 201
  94
  95     body = connexion.request.json
  96     return _try_func_return(put_type_handler)
  97
  98
  99 def get_policy_type(policy_type_id):
 100     """
 101     Handles GET /a1-p/policytypes/policy_type_id
 102     """
 103     return _try_func_return(lambda: data.get_policy_type(policy_type_id))
 104
 105
 106 def delete_policy_type(policy_type_id):
 107     """
 108     Handles DELETE /a1-p/policytypes/policy_type_id
 109     """
 110
 111     def delete_policy_type_handler():
 112         data.delete_policy_type(policy_type_id)
 113         return "", 204
 114
 115     return _try_func_return(delete_policy_type_handler)
 116
 117
 118 # Policy instances
 119
 120
 121 def get_all_instances_for_type(policy_type_id):
 122     """
 123     Handles GET /a1-p/policytypes/policy_type_id/policies
 124     """
 125     return _try_func_return(lambda: data.get_instance_list(policy_type_id))
 126
 127
 128 def get_policy_instance(policy_type_id, policy_instance_id):
 129     """
 130     Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id
 131     """
 132     return _try_func_return(lambda: data.get_policy_instance(policy_type_id, policy_instance_id))
 133
 134
 135 def get_policy_instance_status(policy_type_id, policy_instance_id):
 136     """
 137     Handles GET /a1-p/policytypes/polidyid/policies/policy_instance_id/status
 138
 139     Return the aggregated status. The order of rules is as follows:
 140         1. If a1 has received at least one status, and *all* received statuses are "DELETED", we blow away the instance and return a 404
 141         2. if a1 has received at least one status and at least one is OK, we return "IN EFFECT"
 142         3. "NOT IN EFFECT" otherwise (no statuses, or none are OK but not all are deleted)
 143     """
 144
 145     return _try_func_return(lambda: data.get_policy_instance_status(policy_type_id, policy_instance_id))
 146
 147
 148 def create_or_replace_policy_instance(policy_type_id, policy_instance_id):
 149     """
 150     Handles PUT /a1-p/policytypes/polidyid/policies/policy_instance_id
 151     """
 152     instance = connexion.request.json
 153
 154     def put_instance_handler():
 155         """
 156         Handles policy instance put
 157
 158         For now, policy_type_id is used as the message type
 159         """
 160         #  validate the PUT against the schema
 161         schema = data.get_policy_type(policy_type_id)["create_schema"]
 162         validate(instance=instance, schema=schema)
 163
 164         # store the instance
 165         data.store_policy_instance(policy_type_id, policy_instance_id, instance)
 166
 167         # send rmr (best effort)
 168         body = _gen_body_to_handler("CREATE", policy_type_id, policy_instance_id, payload=instance)
 169         a1rmr.queue_work({"payload": json.dumps(body), "msg type": policy_type_id})
 170
 171         return "", 202
 172
 173     return _try_func_return(put_instance_handler)
 174
 175
 176 def delete_policy_instance(policy_type_id, policy_instance_id):
 177     """
 178     Handles DELETE /a1-p/policytypes/polidyid/policies/policy_instance_id
 179     """
 180
 181     def delete_instance_handler():
 182         """
 183         here we send out the DELETEs but we don't delete the instance until a GET is called where we check the statuses
 184         We also set the status as deleted which would be reflected in a GET to ../status (before the DELETE completes)
 185         """
 186         data.delete_policy_instance(policy_type_id, policy_instance_id)
 187
 188         # send rmr (best effort)
 189         body = _gen_body_to_handler("DELETE", policy_type_id, policy_instance_id)
 190         a1rmr.queue_work({"payload": json.dumps(body), "msg type": policy_type_id})
 191
 192         return "", 202
 193
 194     return _try_func_return(delete_instance_handler)