1 # -------------------------------------------------------------------------
2 # Copyright (c) 2015-2017 AT&T Intellectual Property
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
16 # -------------------------------------------------------------------------
20 OSDF Manager Main Flask Application
26 from optparse import OptionParser
27 from threading import Thread # for scaling up, may need celery with RabbitMQ or redis
30 from flask import Flask, request, Response, g
31 from requests import RequestException
32 from schematics.exceptions import DataError
34 import osdf.adapters.aaf.sms as sms
35 import osdf.operation.responses
36 from osdf.adapters.policy.interface import get_policies
37 from osdf.config.base import osdf_config
38 from osdf.logging.osdf_logging import MH, audit_log, error_log, debug_log
39 from osdf.models.api.pciOptimizationRequest import PCIOptimizationAPI
40 from osdf.models.api.placementRequest import PlacementAPI
41 from osdf.operation.error_handling import request_exception_to_json_body, internal_error_message
42 from osdf.operation.exceptions import BusinessException
43 from osdf.operation.responses import osdf_response_for_request_accept as req_accept
44 from osdf.optimizers.pciopt.pci_opt_processor import process_pci_optimation
45 from osdf.optimizers.placementopt.conductor.remote_opt_processor import process_placement_opt
46 from osdf.optimizers.routeopt.simple_route_opt import RouteOpt
47 from osdf.utils import api_data_utils
48 from osdf.webapp.appcontroller import auth_basic
50 ERROR_TEMPLATE = osdf.ERROR_TEMPLATE
54 BAD_CLIENT_REQUEST_MESSAGE = 'Client sent an invalid request'
57 @app.errorhandler(BusinessException)
58 def handle_business_exception(e):
59 """An exception explicitly raised due to some business rule"""
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
67 @app.errorhandler(RequestException)
68 def handle_request_exception(e):
69 """Returns a detailed synchronous message to the calling client
70 when osdf fails due to a remote call to another system"""
71 error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
72 err_msg = request_exception_to_json_body(e)
73 response = Response(err_msg, content_type='application/json; charset=utf-8')
74 response.status_code = 400
78 @app.errorhandler(DataError)
79 def handle_data_error(e):
80 """Returns a detailed message to the calling client when the initial synchronous message is invalid"""
81 error_log.error("Synchronous error for request id {} {}".format(g.request_id, traceback.format_exc()))
85 "text": BAD_CLIENT_REQUEST_MESSAGE,
86 "exceptionMessage": str(e.errors),
87 "errorType": "InvalidClientRequest"
91 body_as_json = json.dumps(body_dictionary)
92 response = Response(body_as_json, content_type='application/json; charset=utf-8')
93 response.status_code = 400
97 @app.route("/api/oof/v1/healthcheck", methods=["GET"])
98 def do_osdf_health_check():
99 """Simple health check"""
100 audit_log.info("A health check request is processed!")
104 @app.route("/api/oof/v1/placement", methods=["POST"])
105 @auth_basic.login_required
106 def do_placement_opt():
107 return placement_rest_api()
110 @app.route("/api/oof/placement/v1", methods=["POST"])
111 @auth_basic.login_required
112 def do_placement_opt_common_versioning():
113 return placement_rest_api()
116 def placement_rest_api():
117 """Perform placement optimization after validating the request and fetching policies
118 Make a call to the call-back URL with the output of the placement request.
119 Note: Call to Conductor for placement optimization may have redirects, so account for them
121 request_json = request.get_json()
122 req_id = request_json['requestInfo']['requestId']
123 g.request_id = req_id
124 audit_log.info(MH.received_request(request.url, request.remote_addr, json.dumps(request_json)))
125 api_version_info = api_data_utils.retrieve_version_info(request, req_id)
126 PlacementAPI(request_json).validate()
127 policies = get_policies(request_json, "placement")
128 audit_log.info(MH.new_worker_thread(req_id, "[for placement]"))
129 t = Thread(target=process_placement_opt, args=(request_json, policies, osdf_config))
131 audit_log.info(MH.accepted_valid_request(req_id, request))
132 return req_accept(request_id=req_id,
133 transaction_id=request_json['requestInfo']['transactionId'],
134 version_info=api_version_info, request_status="accepted", status_message="")
137 @app.route("/api/oof/v1/route", methods=["POST"])
140 Perform the basic route calculations and returnn the vpn-bindings
142 request_json = request.get_json()
143 audit_log.info("Calculate Route request received!")
144 return RouteOpt().getRoute(request_json)
147 @app.route("/api/oof/v1/pci", methods=["POST"])
148 @app.route("/api/oof/pci/v1", methods=["POST"])
149 @auth_basic.login_required
150 def do_pci_optimization():
151 request_json = request.get_json()
152 req_id = request_json['requestInfo']['requestId']
153 g.request_id = req_id
154 audit_log.info(MH.received_request(request.url, request.remote_addr, json.dumps(request_json)))
155 PCIOptimizationAPI(request_json).validate()
156 # disable policy retrieval
157 # policies = get_policies(request_json, "pciopt")
158 audit_log.info(MH.new_worker_thread(req_id, "[for pciopt]"))
159 t = Thread(target=process_pci_optimation, args=(request_json, osdf_config, None))
161 audit_log.info(MH.accepted_valid_request(req_id, request))
162 return req_accept(request_id=req_id,
163 transaction_id=request_json['requestInfo']['transactionId'],
164 request_status="accepted", status_message="")
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
176 def get_options(argv):
177 program_version_string = '%%prog %s' % "v1.0"
178 program_longdesc = ""
181 parser = OptionParser(version=program_version_string, epilog=program_longdesc, description=program_license)
182 parser.add_option("-l", "--local", dest="local", help="run locally", action="store_true", default=False)
183 parser.add_option("-t", "--devtest", dest="devtest", help="run in dev/test environment", action="store_true",
185 parser.add_option("-d", "--debughost", dest="debughost", help="IP Address of host running debug server", default='')
186 parser.add_option("-p", "--debugport", dest="debugport", help="Port number of debug server", type=int, default=5678)
187 opts, args = parser.parse_args(argv)
190 debug_log.debug('pydevd.settrace({}, port={})'.format(opts.debughost, opts.debugport))
191 pydevd.settrace(opts.debughost, port=opts.debugport)
195 if __name__ == "__main__":
197 sys_conf = osdf_config['core']['osdf_system']
198 ports = sys_conf['osdf_ports']
199 internal_port, external_port = ports['internal'], ports['external']
201 local_host = sys_conf['osdf_ip_default']
202 common_app_opts = dict(host=local_host, threaded=True, use_reloader=False)
204 ssl_opts = sys_conf.get('ssl_context')
206 common_app_opts.update({'ssl_context': tuple(ssl_opts)})
208 opts = get_options(sys.argv)
209 # Load secrets from SMS
211 if not opts.local and not opts.devtest: # normal deployment
212 app.run(port=internal_port, debug=False, **common_app_opts)
214 port = internal_port if opts.local else external_port
215 app.run(port=port, debug=True, **common_app_opts)