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