osdfapp.py

   1 # -------------------------------------------------------------------------
   2 #   Copyright (c) 2015-2017 AT&T Intellectual Property
   3 #
   4 #   Licensed under the Apache License, Version 2.0 (the "License");
   5 #   you may not use this file except in compliance with the License.
   6 #   You may obtain a copy of the License at
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #   Unless required by applicable law or agreed to in writing, software
  11 #   distributed under the License is distributed on an "AS IS" BASIS,
  12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #   See the License for the specific language governing permissions and
  14 #   limitations under the License.
  15 #
  16 # -------------------------------------------------------------------------
  17 #
  18
  19 """
  20 OSDF Manager Main Flask Application
  21 """
  22
  23 import json
  24 import ssl
  25 import sys
  26 import traceback
  27 from optparse import OptionParser
  28 from threading import Thread  # for scaling up, may need celery with RabbitMQ or redis
  29
  30 import pydevd
  31 from flask import Flask, request, Response, g
  32 from requests import RequestException
  33 from schematics.exceptions import DataError
  34
  35 import osdf.adapters.aaf.sms as sms
  36 import osdf.operation.responses
  37 from osdf.adapters.policy.interface import get_policies
  38 from osdf.adapters.policy.interface import upload_policy_models
  39 from osdf.config.base import osdf_config
  40 from osdf.logging.osdf_logging import MH, audit_log, error_log, debug_log
  41 from osdf.models.api.pciOptimizationRequest import PCIOptimizationAPI
  42 from osdf.models.api.placementRequest import PlacementAPI
  43 from osdf.operation.error_handling import request_exception_to_json_body, internal_error_message
  44 from osdf.operation.exceptions import BusinessException
  45 from osdf.operation.responses import osdf_response_for_request_accept as req_accept
  46 from osdf.optimizers.pciopt.pci_opt_processor import process_pci_optimation
  47 from osdf.optimizers.placementopt.conductor.remote_opt_processor import process_placement_opt
  48 from osdf.optimizers.routeopt.simple_route_opt import RouteOpt
  49 from osdf.utils import api_data_utils
  50 from osdf.webapp.appcontroller import auth_basic
  51
  52 ERROR_TEMPLATE = osdf.ERROR_TEMPLATE
  53
  54 app = Flask(__name__)
  55
  56 BAD_CLIENT_REQUEST_MESSAGE = 'Client sent an invalid request'
  57
  58
  59 @app.errorhandler(BusinessException)
  60 def handle_business_exception(e):
  61     """An exception explicitly raised due to some business rule"""
  62     error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
  63     err_msg = ERROR_TEMPLATE.render(description=str(e))
  64     response = Response(err_msg, content_type='application/json; charset=utf-8')
  65     response.status_code = 400
  66     return response
  67
  68
  69 @app.errorhandler(RequestException)
  70 def handle_request_exception(e):
  71     """Returns a detailed synchronous message to the calling client
  72     when osdf fails due to a remote call to another system"""
  73     error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
  74     err_msg = request_exception_to_json_body(e)
  75     response = Response(err_msg, content_type='application/json; charset=utf-8')
  76     response.status_code = 400
  77     return response
  78
  79
  80 @app.errorhandler(DataError)
  81 def handle_data_error(e):
  82     """Returns a detailed message to the calling client when the initial synchronous message is invalid"""
  83     error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
  84
  85     body_dictionary = {
  86         "serviceException": {
  87             "text": BAD_CLIENT_REQUEST_MESSAGE,
  88             "exceptionMessage": str(e.errors),
  89             "errorType": "InvalidClientRequest"
  90         }
  91     }
  92
  93     body_as_json = json.dumps(body_dictionary)
  94     response = Response(body_as_json, content_type='application/json; charset=utf-8')
  95     response.status_code = 400
  96     return response
  97
  98
  99 @app.route("/api/oof/v1/healthcheck", methods=["GET"])
 100 def do_osdf_health_check():
 101     """Simple health check"""
 102     audit_log.info("A health check request is processed!")
 103     return "OK"
 104
 105
 106 @app.route("/api/oof/loadmodels/v1", methods=["GET"])
 107 def do_osdf_load_policies():
 108     audit_log.info("Uploading policy models")
 109     """Upload policy models"""
 110     response = upload_policy_models()
 111     audit_log.info(response)
 112     return "OK"
 113
 114
 115 @app.route("/api/oof/v1/placement", methods=["POST"])
 116 @auth_basic.login_required
 117 def do_placement_opt():
 118     return placement_rest_api()
 119
 120
 121 @app.route("/api/oof/placement/v1", methods=["POST"])
 122 @auth_basic.login_required
 123 def do_placement_opt_common_versioning():
 124     return placement_rest_api()
 125
 126
 127 def placement_rest_api():
 128     """Perform placement optimization after validating the request and fetching policies
 129     Make a call to the call-back URL with the output of the placement request.
 130     Note: Call to Conductor for placement optimization may have redirects, so account for them
 131     """
 132     request_json = request.get_json()
 133     req_id = request_json['requestInfo']['requestId']
 134     g.request_id = req_id
 135     audit_log.info(MH.received_request(request.url, request.remote_addr, json.dumps(request_json)))
 136     api_version_info = api_data_utils.retrieve_version_info(request, req_id)
 137     PlacementAPI(request_json).validate()
 138     policies = get_policies(request_json, "placement")
 139     audit_log.info(MH.new_worker_thread(req_id, "[for placement]"))
 140     t = Thread(target=process_placement_opt, args=(request_json, policies, osdf_config))
 141     t.start()
 142     audit_log.info(MH.accepted_valid_request(req_id, request))
 143     return req_accept(request_id=req_id,
 144                       transaction_id=request_json['requestInfo']['transactionId'],
 145                       version_info=api_version_info, request_status="accepted", status_message="")
 146
 147
 148 @app.route("/api/oof/v1/route", methods=["POST"])
 149 def do_route_calc():
 150     """
 151     Perform the basic route calculations and returnn the vpn-bindings
 152     """
 153     request_json = request.get_json()
 154     audit_log.info("Calculate Route request received!")
 155     return RouteOpt().getRoute(request_json)
 156
 157
 158 @app.route("/api/oof/v1/pci", methods=["POST"])
 159 @app.route("/api/oof/pci/v1", methods=["POST"])
 160 @auth_basic.login_required
 161 def do_pci_optimization():
 162     request_json = request.get_json()
 163     req_id = request_json['requestInfo']['requestId']
 164     g.request_id = req_id
 165     audit_log.info(MH.received_request(request.url, request.remote_addr, json.dumps(request_json)))
 166     PCIOptimizationAPI(request_json).validate()
 167     # disable policy retrieval
 168     # policies = get_policies(request_json, "pciopt")
 169     audit_log.info(MH.new_worker_thread(req_id, "[for pciopt]"))
 170     t = Thread(target=process_pci_optimation, args=(request_json, osdf_config, None))
 171     t.start()
 172     audit_log.info(MH.accepted_valid_request(req_id, request))
 173     return req_accept(request_id=req_id,
 174                       transaction_id=request_json['requestInfo']['transactionId'],
 175                       request_status="accepted", status_message="")
 176
 177
 178 @app.errorhandler(500)
 179 def internal_failure(error):
 180     """Returned when unexpected coding errors occur during initial synchronous processing"""
 181     error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
 182     response = Response(internal_error_message, content_type='application/json; charset=utf-8')
 183     response.status_code = 500
 184     return response
 185
 186
 187 def get_options(argv):
 188     program_version_string = '%%prog %s' % "v1.0"
 189     program_longdesc = ""
 190     program_license = ""
 191
 192     parser = OptionParser(version=program_version_string, epilog=program_longdesc, description=program_license)
 193     parser.add_option("-l", "--local", dest="local", help="run locally", action="store_true", default=False)
 194     parser.add_option("-t", "--devtest", dest="devtest", help="run in dev/test environment", action="store_true",
 195                       default=False)
 196     parser.add_option("-d", "--debughost", dest="debughost", help="IP Address of host running debug server", default='')
 197     parser.add_option("-p", "--debugport", dest="debugport", help="Port number of debug server", type=int, default=5678)
 198     opts, args = parser.parse_args(argv)
 199
 200     if opts.debughost:
 201         debug_log.debug('pydevd.settrace({}, port={})'.format(opts.debughost, opts.debugport))
 202         pydevd.settrace(opts.debughost, port=opts.debugport)
 203     return opts
 204
 205
 206 def build_ssl_context():
 207     ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
 208     ssl_context.set_ciphers('ECDHE-RSA-AES128-SHA256:EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH')
 209     ssl_context.load_cert_chain(sys_conf['ssl_context'][0], sys_conf['ssl_context'][1])
 210     return ssl_context
 211
 212
 213 if __name__ == "__main__":
 214
 215     sys_conf = osdf_config['core']['osdf_system']
 216     ports = sys_conf['osdf_ports']
 217     internal_port, external_port = ports['internal'], ports['external']
 218
 219     local_host = sys_conf['osdf_ip_default']
 220     common_app_opts = dict(host=local_host, threaded=True, use_reloader=False)
 221
 222     ssl_opts = sys_conf.get('ssl_context')
 223     if ssl_opts:
 224         common_app_opts.update({'ssl_context': build_ssl_context()})
 225
 226     opts = get_options(sys.argv)
 227     # Load secrets from SMS
 228     sms.load_secrets()
 229     if not opts.local and not opts.devtest:  # normal deployment
 230         app.run(port=internal_port, debug=False, **common_app_opts)
 231     else:
 232         port = internal_port if opts.local else external_port
 233         app.run(port=port, debug=True, **common_app_opts)