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
  47 from osdf.models.api.placementRequest import PlacementAPI
  48
  49 ERROR_TEMPLATE = osdf.ERROR_TEMPLATE
  50
  51 app = Flask(__name__)
  52
  53
  54
  55 BAD_CLIENT_REQUEST_MESSAGE = 'Client sent an invalid request'
  56
  57 # An exception explicitly raised due to some business rule
  58 @app.errorhandler(BusinessException)
  59 def handle_business_exception(e):
  60     error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
  61     err_msg = ERROR_TEMPLATE.render(description=str(e))
  62     response = Response(err_msg, content_type='application/json; charset=utf-8')
  63     response.status_code = 400
  64     return response
  65
  66 # Returns a detailed synchronous message to the calling client when osdf fails due to a remote call to another system
  67 @app.errorhandler(RequestException)
  68 def handle_request_exception(e):
  69     error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
  70     err_msg = request_exception_to_json_body(e)
  71     response = Response(err_msg, content_type='application/json; charset=utf-8')
  72     response.status_code = 400
  73     return response
  74
  75 # Returns a detailed message to the calling client when the initial synchronous message is invalid
  76 @app.errorhandler(DataError)
  77 def handle_data_error(e):
  78     error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
  79
  80     body_dictionary = {
  81         "serviceException": {
  82             "text": BAD_CLIENT_REQUEST_MESSAGE,
  83             "exceptionMessage": str(e.messages),
  84             "errorType": "InvalidClientRequest"
  85         }
  86     }
  87
  88     body_as_json = json.dumps(body_dictionary)
  89     response = Response(body_as_json, content_type='application/json; charset=utf-8')
  90     response.status_code = 400
  91     return response
  92
  93
  94 @app.route("/osdf/api/v2/placement", methods=["POST"])
  95 @auth_basic.login_required
  96 def do_placement_opt():
  97     """Perform placement optimization after validating the request and fetching policies
  98     Make a call to the call-back URL with the output of the placement request.
  99     Note: Call to Conductor for placement optimization may have redirects, so account for them
 100     """
 101     request_json = request.get_json()
 102     req_id = request_json['requestInfo']['requestId']
 103     g.request_id = req_id
 104     audit_log.info(MH.received_request(request.url, request.remote_addr, json.dumps(request_json)))
 105
 106     PlacementAPI(request_json).validate()
 107
 108     # Currently policies are being used only during placement, so only fetch them if placement demands is not empty
 109     policies = {}
 110
 111     if 'placementDemand' in request_json['placementInfo']['demandInfo']:
 112         policies, prov_status = get_policies(request_json, "placement")
 113
 114     audit_log.info(MH.new_worker_thread(req_id, "[for placement]"))
 115     t = Thread(target=process_placement_opt, args=(request_json, policies, osdf_config, prov_status))
 116     t.start()
 117     audit_log.info(MH.accepted_valid_request(req_id, request))
 118     return osdf.operation.responses.osdf_response_for_request_accept(
 119         req_id=req_id, text="Accepted placement request. Response will be posted to callback URL")
 120
 121
 122 # Returned when unexpected coding errors occur during initial synchronous processing
 123 @app.errorhandler(500)
 124 def internal_failure(error):
 125     error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
 126     response = Response(internal_error_message, content_type='application/json; charset=utf-8')
 127     response.status_code = 500
 128     return response
 129
 130
 131 def getOptions(argv):
 132     program_version_string = '%%prog %s' % ("v1.0")
 133     program_longdesc = ""
 134     program_license = ""
 135
 136     parser = OptionParser(version=program_version_string, epilog=program_longdesc, description=program_license)
 137     parser.add_option("-l", "--local", dest="local", help="run locally", action="store_true", default=False)
 138     parser.add_option("-t", "--devtest", dest="devtest", help="run in dev/test environment", action="store_true", default=False)
 139     parser.add_option("-d", "--debughost", dest="debughost", help="IP Address of host running debug server", default='')
 140     parser.add_option("-p", "--debugport", dest="debugport", help="Port number of debug server", type=int, default=5678)
 141     (opts, args) = parser.parse_args(argv)
 142
 143     if (opts.debughost != ''):
 144         print('pydevd.settrace(%s, port=%s)' % (opts.debughost, opts.debugport))
 145         pydevd.settrace(opts.debughost, port=opts.debugport)
 146     return opts
 147
 148
 149 if __name__ == "__main__":
 150
 151     sys_conf = osdf_config['core']['osdf_system']
 152     ports = sys_conf['osdf_ports']
 153     internal_port, external_port = ports['internal'], ports['external']
 154     ssl_context = tuple(sys_conf['ssl_context'])
 155     local_host = "0.0.0.0"
 156
 157     common_app_opts = dict(host=local_host, threaded=True, use_reloader=False)
 158
 159     opts = getOptions(sys.argv)
 160     if (not opts.local and not opts.devtest):  # normal deployment
 161         app.run(port=internal_port, ssl_context=ssl_context, debug=False, **common_app_opts)
 162     else:
 163         port = internal_port if opts.local else external_port
 164         app.run(port=port, debug=True, **common_app_opts)