-
Notifications
You must be signed in to change notification settings - Fork 583
/
app.py
336 lines (286 loc) · 13.2 KB
/
app.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
from argparse import ArgumentParser
import concurrent.futures
import configparser
import logging
from logging import config
import multiprocessing
import os
import tabpy_server
from tabpy_server import __version__
from tabpy_server.app.ConfigParameters import ConfigParameters
from tabpy_server.app.SettingsParameters import SettingsParameters
from tabpy_server.app.util import parse_pwd_file
from tabpy_server.management.state import TabPyState
from tabpy_server.management.util import _get_state_from_file
from tabpy_server.psws.callbacks import (init_model_evaluator, init_ps_server)
from tabpy_server.psws.python_service import (PythonService,
PythonServiceHandler)
from tabpy_server.handlers import (EndpointHandler, EndpointsHandler,
EvaluationPlaneHandler, QueryPlaneHandler,
ServiceInfoHandler, StatusHandler,
UploadDestinationHandler)
from tornado_json.constants import TORNADO_MAJOR
import tornado
logger = logging.getLogger(__name__)
class TabPyApp:
'''
TabPy application class for keeping context like settings, state, etc.
'''
settings = {}
subdirectory = ""
tabpy_state = None
python_service = None
credentials = {}
def __init__(self, config_file=None):
if config_file is None:
cli_args = self._parse_cli_arguments()
if cli_args.config is not None:
config_file = cli_args.config
else:
config_file = os.path.join(os.path.dirname(__file__),
os.path.pardir, 'common',
'default.conf')
if os.path.isfile(config_file):
try:
logging.config.fileConfig(
config_file, disable_existing_loggers=False)
except KeyError:
logging.basicConfig(level=logging.DEBUG)
self._parse_config(config_file)
def run(self):
application = self._create_tornado_web_app()
init_model_evaluator(
self.settings,
self.tabpy_state,
self.python_service)
protocol = self.settings[SettingsParameters.TransferProtocol]
if protocol == 'http':
application.listen(self.settings[SettingsParameters.Port])
elif protocol == 'https':
application.listen(self.settings[SettingsParameters.Port],
ssl_options={
'certfile': self.settings[SettingsParameters.CertificateFile],
'keyfile': self.settings[SettingsParameters.KeyFile]
})
else:
msg = f'Unsupported transfer protocol {protocol}.'
logger.critical(msg)
raise RuntimeError(msg)
logger.info('Web service listening on port {}'.format(
str(self.settings[SettingsParameters.Port])))
tornado.ioloop.IOLoop.instance().start()
def _create_tornado_web_app(self):
logger.info('Initializing TabPy...')
tornado.ioloop.IOLoop.instance().run_sync(
lambda: init_ps_server(self.settings, self.tabpy_state))
logger.info('Done initializing TabPy.')
executor = concurrent.futures.ThreadPoolExecutor(
max_workers=multiprocessing.cpu_count())
# initialize Tornado application
application = tornado.web.Application([
# skip MainHandler to use StaticFileHandler .* page requests and
# default to index.html
# (r"/", MainHandler),
(self.subdirectory + r'/query/([^/]+)', QueryPlaneHandler,
dict(app=self)),
(self.subdirectory + r'/status', StatusHandler,
dict(app=self)),
(self.subdirectory + r'/info', ServiceInfoHandler,
dict(app=self)),
(self.subdirectory + r'/endpoints', EndpointsHandler,
dict(app=self)),
(self.subdirectory + r'/endpoints/([^/]+)?', EndpointHandler,
dict(app=self)),
(self.subdirectory + r'/evaluate', EvaluationPlaneHandler,
dict(executor=executor,
app=self)),
(self.subdirectory +
r'/configurations/endpoint_upload_destination',
UploadDestinationHandler,
dict(app=self)),
(self.subdirectory + r'/(.*)', tornado.web.StaticFileHandler,
dict(path=self.settings[SettingsParameters.StaticPath],
default_filename="index.html")),
], debug=False, **self.settings)
return application
@staticmethod
def _parse_cli_arguments():
'''
Parse command line arguments. Expected arguments:
* --config: string
'''
parser = ArgumentParser(description='Run TabPy Server.')
parser.add_argument('--config', help='Path to a config file.')
return parser.parse_args()
def _parse_config(self, config_file):
"""Provide consistent mechanism for pulling in configuration.
Attempt to retain backward compatibility for
existing implementations by grabbing port
setting from CLI first.
Take settings in the following order:
1. CLI arguments if present
2. config file
3. OS environment variables (for ease of
setting defaults if not present)
4. current defaults if a setting is not present in any location
Additionally provide similar configuration capabilities in between
config file and environment variables.
For consistency use the same variable name in the config file as
in the os environment.
For naming standards use all capitals and start with 'TABPY_'
"""
self.settings = {}
self.subdirectory = ""
self.tabpy_state = None
self.python_service = None
self.credentials = {}
parser = configparser.ConfigParser()
if os.path.isfile(config_file):
with open(config_file) as f:
parser.read_string(f.read())
else:
logger.warning(
"Unable to find config file at '{}', "
"using default settings.".format(config_file))
def set_parameter(settings_key,
config_key,
default_val=None,
check_env_var=False):
if config_key is not None and\
parser.has_option('TabPy', config_key):
self.settings[settings_key] = parser.get('TabPy', config_key)
elif check_env_var:
self.settings[settings_key] = os.getenv(
config_key, default_val)
elif default_val is not None:
self.settings[settings_key] = default_val
set_parameter(SettingsParameters.Port, ConfigParameters.TABPY_PORT,
default_val=9004, check_env_var=True)
set_parameter(SettingsParameters.ServerVersion, None,
default_val=__version__)
set_parameter(SettingsParameters.UploadDir,
ConfigParameters.TABPY_QUERY_OBJECT_PATH,
default_val='/tmp/query_objects', check_env_var=True)
if not os.path.exists(self.settings[SettingsParameters.UploadDir]):
os.makedirs(self.settings[SettingsParameters.UploadDir])
# set and validate transfer protocol
set_parameter(SettingsParameters.TransferProtocol,
ConfigParameters.TABPY_TRANSFER_PROTOCOL,
default_val='http')
self.settings[SettingsParameters.TransferProtocol] =\
self.settings[SettingsParameters.TransferProtocol].lower()
set_parameter(SettingsParameters.CertificateFile,
ConfigParameters.TABPY_CERTIFICATE_FILE)
set_parameter(SettingsParameters.KeyFile,
ConfigParameters.TABPY_KEY_FILE)
self._validate_transfer_protocol_settings()
# if state.ini does not exist try and create it - remove
# last dependence on batch/shell script
set_parameter(SettingsParameters.StateFilePath,
ConfigParameters.TABPY_STATE_PATH,
default_val='./tabpy-server/tabpy_server',
check_env_var=True)
self.settings[SettingsParameters.StateFilePath] = os.path.realpath(
os.path.normpath(
os.path.expanduser(
self.settings[SettingsParameters.StateFilePath])))
state_file_path = self.settings[SettingsParameters.StateFilePath]
logger.info("Loading state from state file %s" %
os.path.join(state_file_path, "state.ini"))
tabpy_state = _get_state_from_file(state_file_path)
self.tabpy_state = TabPyState(
config=tabpy_state, settings=self.settings)
self.python_service = PythonServiceHandler(PythonService())
self.settings['compress_response'] = True if TORNADO_MAJOR >= 4\
else "gzip"
set_parameter(SettingsParameters.StaticPath,
ConfigParameters.TABPY_STATIC_PATH,
default_val='./')
self.settings[SettingsParameters.StaticPath] =\
os.path.abspath(self.settings[SettingsParameters.StaticPath])
logger.debug(f'Static pages folder set to '
f'"{self.settings[SettingsParameters.StaticPath]}"')
# Set subdirectory from config if applicable
if tabpy_state.has_option("Service Info", "Subdirectory"):
self.subdirectory = "/" + \
tabpy_state.get("Service Info", "Subdirectory")
# If passwords file specified load credentials
set_parameter(ConfigParameters.TABPY_PWD_FILE,
ConfigParameters.TABPY_PWD_FILE)
if ConfigParameters.TABPY_PWD_FILE in self.settings:
if not self._parse_pwd_file():
msg = ('Failed to read passwords file '
f'{self.settings[ConfigParameters.TABPY_PWD_FILE]}')
logger.critical(msg)
raise RuntimeError(msg)
else:
logger.info(
"Password file is not specified: "
"Authentication is not enabled")
features = self._get_features()
self.settings[SettingsParameters.ApiVersions] =\
{'v1': {'features': features}}
set_parameter(SettingsParameters.LogRequestContext,
ConfigParameters.TABPY_LOG_DETAILS,
default_val='false')
self.settings[SettingsParameters.LogRequestContext] = (
self.settings[SettingsParameters.LogRequestContext].lower() !=
'false')
logger.info('Call context logging is {}'.format(
'enabled' if self.settings[SettingsParameters.LogRequestContext]
else 'disabled'))
def _validate_transfer_protocol_settings(self):
if SettingsParameters.TransferProtocol not in self.settings:
msg = 'Missing transfer protocol information.'
logger.critical(msg)
raise RuntimeError(msg)
protocol = self.settings[SettingsParameters.TransferProtocol]
if protocol == 'http':
return
if protocol != 'https':
msg = f'Unsupported transfer protocol: {protocol}'
logger.critical(msg)
raise RuntimeError(msg)
self._validate_cert_key_state(
'The parameter(s) {} must be set.',
SettingsParameters.CertificateFile in self.settings,
SettingsParameters.KeyFile in self.settings)
cert = self.settings[SettingsParameters.CertificateFile]
self._validate_cert_key_state(
'The parameter(s) {} must point to '
'an existing file.',
os.path.isfile(cert),
os.path.isfile(self.settings[SettingsParameters.KeyFile]))
tabpy_server.app.util.validate_cert(cert)
@staticmethod
def _validate_cert_key_state(msg, cert_valid, key_valid):
cert_and_key_param = '{} and {}'.format(
ConfigParameters.TABPY_CERTIFICATE_FILE,
ConfigParameters.TABPY_KEY_FILE)
https_error = 'Error using HTTPS: '
err = None
if not cert_valid and not key_valid:
err = https_error + msg.format(cert_and_key_param)
elif not cert_valid:
err = https_error + \
msg.format(ConfigParameters.TABPY_CERTIFICATE_FILE)
elif not key_valid:
err = https_error + msg.format(ConfigParameters.TABPY_KEY_FILE)
if err is not None:
logger.critical(err)
raise RuntimeError(err)
def _parse_pwd_file(self):
succeeded, self.credentials = parse_pwd_file(
self.settings[ConfigParameters.TABPY_PWD_FILE])
if succeeded and len(self.credentials) == 0:
logger.error('No credentials found')
succeeded = False
return succeeded
def _get_features(self):
features = {}
# Check for auth
if ConfigParameters.TABPY_PWD_FILE in self.settings:
features['authentication'] = {
'required': True, 'methods': {
'basic-auth': {}}}
return features