Ensure timely termination of all flask servers
[osm/vim-emu.git] / src / emuvim / api / openstack / openstack_dummies / base_openstack_dummy.py
1 # Copyright (c) 2015 SONATA-NFV and Paderborn University
2 # ALL RIGHTS RESERVED.
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 # Neither the name of the SONATA-NFV, Paderborn University
17 # nor the names of its contributors may be used to endorse or promote
18 # products derived from this software without specific prior written
19 # permission.
20 #
21 # This work has been performed in the framework of the SONATA project,
22 # funded by the European Commission under Grant number 671517 through
23 # the Horizon 2020 and 5G-PPP programmes. The authors would like to
24 # acknowledge the contributions of their colleagues of the SONATA
25 # partner consortium (www.sonata-nfv.eu).
26 import logging
27
28 import threading
29 from flask import Flask, request
30 from flask_restful import Api, Resource
31 from gevent import monkey
32 from gevent.pywsgi import WSGIServer
33
34 monkey.patch_all()
35
36 LOG = logging.getLogger("api.openstack.base")
37
38
39 class BaseOpenstackDummy(Resource):
40 """
41 This class is the base class for all openstack entrypoints of son-emu.
42 """
43
44 def __init__(self, listenip, port):
45 self.ip = listenip
46 self.port = port
47 self.compute = None
48 self.manage = None
49 self.http_server = None
50 self.server_thread = None
51 self.playbook_file = '/tmp/son-emu-requests.log'
52 with open(self.playbook_file, 'w'):
53 pass
54
55 # setup Flask
56 self.app = Flask(__name__)
57 self.api = Api(self.app)
58
59 def start(self):
60 self.server_thread = threading.Thread(target=self._start_flask, args=())
61 self.server_thread.name = self.__class__.__name__
62 self.server_thread.start()
63
64 def stop(self):
65 if self.http_server:
66 LOG.info('Stopping %s' % self.__class__.__name__)
67 self.http_server.stop(timeout=1)
68
69 def _start_flask(self):
70 LOG.info("Starting %s endpoint @ http://%s:%d" % (
71 self.__class__.__name__, self.ip, self.port))
72 self.http_server = WSGIServer(
73 (self.ip, self.port),
74 self.app,
75 log=open("/dev/null", "w") # don't show http logs
76 )
77 self.http_server.serve_forever(stop_timeout=1)
78 LOG.info('Stopped %s' % self.__class__.__name__)
79
80 def dump_playbook(self):
81 with self.manage.lock:
82 with open(self.playbook_file, 'a') as logfile:
83 if len(request.data) > 0:
84 data = "# %s API\n" % str(
85 self.__class__).split('.')[-1].rstrip('\'>')
86 data += "curl -X {type} -H \"Content-type: application/json\" -d '{data}' {url}".format(type=request.method,
87 data=request.data,
88 url=request.url)
89 logfile.write(data + "\n")