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