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