-
Notifications
You must be signed in to change notification settings - Fork 580
/
app.py
416 lines (354 loc) · 15.3 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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
import concurrent.futures
import configparser
import logging
from logging import config
import multiprocessing
import os
import shutil
import signal
import tabpy.tabpy_server
from tabpy.tabpy import __version__
from tabpy.tabpy_server.app.ConfigParameters import ConfigParameters
from tabpy.tabpy_server.app.SettingsParameters import SettingsParameters
from tabpy.tabpy_server.app.util import parse_pwd_file
from tabpy.tabpy_server.management.state import TabPyState
from tabpy.tabpy_server.management.util import _get_state_from_file
from tabpy.tabpy_server.psws.callbacks import init_model_evaluator, init_ps_server
from tabpy.tabpy_server.psws.python_service import PythonService, PythonServiceHandler
from tabpy.tabpy_server.handlers import (
EndpointHandler,
EndpointsHandler,
EvaluationPlaneHandler,
QueryPlaneHandler,
ServiceInfoHandler,
StatusHandler,
UploadDestinationHandler,
)
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:
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()
max_request_size = (
int(self.settings[SettingsParameters.MaxRequestSizeInMb]) * 1024 * 1024
)
logger.info(f"Setting max request size to {max_request_size} bytes")
init_model_evaluator(self.settings, self.tabpy_state, self.python_service)
protocol = self.settings[SettingsParameters.TransferProtocol]
ssl_options = None
if protocol == "https":
ssl_options = {
"certfile": self.settings[SettingsParameters.CertificateFile],
"keyfile": self.settings[SettingsParameters.KeyFile],
}
elif protocol != "http":
msg = f"Unsupported transfer protocol {protocol}."
logger.critical(msg)
raise RuntimeError(msg)
application.listen(
self.settings[SettingsParameters.Port],
ssl_options=ssl_options,
max_buffer_size=max_request_size,
max_body_size=max_request_size,
)
logger.info(
"Web service listening on port "
f"{str(self.settings[SettingsParameters.Port])}"
)
tornado.ioloop.IOLoop.instance().start()
def _create_tornado_web_app(self):
class TabPyTornadoApp(tornado.web.Application):
is_closing = False
def signal_handler(self, signal, _):
logger.critical(f"Exiting on signal {signal}...")
self.is_closing = True
def try_exit(self):
if self.is_closing:
tornado.ioloop.IOLoop.instance().stop()
logger.info("Shutting down TabPy...")
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 = TabPyTornadoApp(
[
# 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,
)
signal.signal(signal.SIGINT, application.signal_handler)
tornado.ioloop.PeriodicCallback(application.try_exit, 500).start()
signal.signal(signal.SIGINT, application.signal_handler)
tornado.ioloop.PeriodicCallback(application.try_exit, 500).start()
return application
def _set_parameter(self, parser, settings_key, config_key, default_val):
key_is_set = False
if (
config_key is not None
and parser.has_section("TabPy")
and parser.has_option("TabPy", config_key)
):
self.settings[settings_key] = parser.get("TabPy", config_key)
key_is_set = True
logger.debug(
f"Parameter {settings_key} set to "
f'"{self.settings[settings_key]}" '
"from config file or environment variable"
)
if not key_is_set and default_val is not None:
self.settings[settings_key] = default_val
key_is_set = True
logger.debug(
f"Parameter {settings_key} set to "
f'"{self.settings[settings_key]}" '
"from default value"
)
if not key_is_set:
logger.debug(f"Parameter {settings_key} is not set")
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 = {}
pkg_path = os.path.dirname(tabpy.__file__)
parser = configparser.ConfigParser(os.environ)
if os.path.isfile(config_file):
with open(config_file) as f:
parser.read_string(f.read())
else:
logger.warning(
f"Unable to find config file at {config_file}, "
"using default settings."
)
settings_parameters = [
(SettingsParameters.Port, ConfigParameters.TABPY_PORT, 9004),
(SettingsParameters.ServerVersion, None, __version__),
(SettingsParameters.EvaluateTimeout, ConfigParameters.TABPY_EVALUATE_TIMEOUT, 30),
(SettingsParameters.UploadDir, ConfigParameters.TABPY_QUERY_OBJECT_PATH,
os.path.join(pkg_path, "tmp", "query_objects")),
(SettingsParameters.TransferProtocol, ConfigParameters.TABPY_TRANSFER_PROTOCOL,
"http"),
(SettingsParameters.CertificateFile, ConfigParameters.TABPY_CERTIFICATE_FILE,
None),
(SettingsParameters.KeyFile, ConfigParameters.TABPY_KEY_FILE, None),
(SettingsParameters.StateFilePath, ConfigParameters.TABPY_STATE_PATH,
os.path.join(pkg_path, "tabpy_server")),
(SettingsParameters.StaticPath, ConfigParameters.TABPY_STATIC_PATH, "./"),
(ConfigParameters.TABPY_PWD_FILE, ConfigParameters.TABPY_PWD_FILE, None),
(SettingsParameters.LogRequestContext, ConfigParameters.TABPY_LOG_DETAILS,
"false"),
(SettingsParameters.MaxRequestSizeInMb, ConfigParameters.TABPY_MAX_REQUEST_SIZE_MB,
100),
]
for setting, parameter, default_val in settings_parameters:
self._set_parameter(parser, setting, parameter, default_val)
try:
self.settings[SettingsParameters.EvaluateTimeout] = float(
self.settings[SettingsParameters.EvaluateTimeout]
)
except ValueError:
logger.warning(
"Evaluate timeout must be a float type. Defaulting "
"to evaluate timeout of 30 seconds."
)
self.settings[SettingsParameters.EvaluateTimeout] = 30
if not os.path.exists(self.settings[SettingsParameters.UploadDir]):
os.makedirs(self.settings[SettingsParameters.UploadDir])
# set and validate transfer protocol
self.settings[SettingsParameters.TransferProtocol] = self.settings[
SettingsParameters.TransferProtocol
].lower()
self._validate_transfer_protocol_settings()
# if state.ini does not exist try and create it - remove
# last dependence on batch/shell script
self.settings[SettingsParameters.StateFilePath] = os.path.realpath(
os.path.normpath(
os.path.expanduser(self.settings[SettingsParameters.StateFilePath])
)
)
state_config, self.tabpy_state = self._build_tabpy_state()
self.python_service = PythonServiceHandler(PythonService())
self.settings["compress_response"] = True
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 state_config.has_option("Service Info", "Subdirectory"):
self.subdirectory = "/" + state_config.get("Service Info", "Subdirectory")
# If passwords file specified load credentials
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}}
self.settings[SettingsParameters.LogRequestContext] = (
self.settings[SettingsParameters.LogRequestContext].lower() != "false"
)
call_context_state = (
"enabled"
if self.settings[SettingsParameters.LogRequestContext]
else "disabled"
)
logger.info(f"Call context logging is {call_context_state}")
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.tabpy_server.app.util.validate_cert(cert)
@staticmethod
def _validate_cert_key_state(msg, cert_valid, key_valid):
cert_and_key_param = (
f"{ConfigParameters.TABPY_CERTIFICATE_FILE} and "
f"{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
def _build_tabpy_state(self):
pkg_path = os.path.dirname(tabpy.__file__)
state_file_dir = self.settings[SettingsParameters.StateFilePath]
state_file_path = os.path.join(state_file_dir, "state.ini")
if not os.path.isfile(state_file_path):
state_file_template_path = os.path.join(
pkg_path, "tabpy_server", "state.ini.template"
)
logger.debug(
f"File {state_file_path} not found, creating from "
f"template {state_file_template_path}..."
)
shutil.copy(state_file_template_path, state_file_path)
logger.info(f"Loading state from state file {state_file_path}")
tabpy_state = _get_state_from_file(state_file_dir)
return tabpy_state, TabPyState(config=tabpy_state, settings=self.settings)