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