-
Notifications
You must be signed in to change notification settings - Fork 119
/
util.py
605 lines (456 loc) · 15.1 KB
/
util.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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
import collections
import contextlib
import functools
import json
import logging
import os
import platform
import re
import shutil
import sys
import tempfile
import time
import concurrent.futures
import jsonschema
import prettytable
import pystache
import six
from dcos import constants
from dcos.errors import DCOSException
def get_logger(name):
"""Get a logger
:param name: The name of the logger. E.g. __name__
:type name: str
:returns: The logger for the specified name
:rtype: logging.Logger
"""
return logging.getLogger(name)
@contextlib.contextmanager
def tempdir():
"""A context manager for temporary directories.
The lifetime of the returned temporary directory corresponds to the
lexical scope of the returned file descriptor.
:return: Reference to a temporary directory
:rtype: str
"""
tmpdir = tempfile.mkdtemp()
try:
yield tmpdir
finally:
shutil.rmtree(tmpdir, ignore_errors=True)
@contextlib.contextmanager
def temptext():
"""A context manager for temporary files.
The lifetime of the returned temporary file corresponds to the
lexical scope of the returned file descriptor.
:return: reference to a temporary file
:rtype: (fd, str)
"""
fd, path = tempfile.mkstemp()
try:
yield (fd, path)
finally:
# Close the file descriptor and ignore errors
try:
os.close(fd)
except OSError:
pass
# delete the path
shutil.rmtree(path, ignore_errors=True)
def ensure_dir(directory):
"""If `directory` does not exist, create it.
:param directory: path to the directory
:type directory: string
:rtype: None
"""
if not os.path.exists(directory):
logger.info('Creating directory: %r', directory)
os.makedirs(directory, 0o775)
def read_file(path):
"""
:param path: path to file
:type path: str
:returns: contents of file
:rtype: str
"""
if not os.path.isfile(path):
raise DCOSException('Path [{}] is not a file'.format(path))
with open_file(path) as file_:
return file_.read()
def get_config():
"""
:returns: Configuration object
:rtype: Toml
"""
# avoid circular import
from dcos import config
return config.load_from_path(
os.environ[constants.DCOS_CONFIG_ENV])
def get_config_vals(keys, config=None):
"""Gets config values for each of the keys. Raises a DCOSException if
any of the keys don't exist.
:param config: config
:type config: Toml
:param keys: keys in the config dict
:type keys: [str]
:returns: values for each of the keys
:rtype: [object]
"""
config = config or get_config()
missing = [key for key in keys if key not in config]
if missing:
raise missing_config_exception(keys)
return [config[key] for key in keys]
def missing_config_exception(keys):
""" DCOSException for a missing config value
:param keys: keys in the config dict
:type keys: [str]
:returns: DCOSException
:rtype: DCOSException
"""
msg = '\n'.join(
'Missing required config parameter: "{0}".'.format(key) +
' Please run `dcos config set {0} <value>`.'.format(key)
for key in keys)
return DCOSException(msg)
def which(program):
"""Returns the path to the named executable program.
:param program: The program to locate:
:type program: str
:rtype: str
"""
def is_exe(file_path):
return os.path.isfile(file_path) and os.access(file_path, os.X_OK)
file_path, filename = os.path.split(program)
if file_path:
if is_exe(program):
return program
elif constants.PATH_ENV in os.environ:
for path in os.environ[constants.PATH_ENV].split(os.pathsep):
path = path.strip('"')
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return exe_file
if is_windows_platform() and not program.endswith('.exe'):
return which(program + '.exe')
return None
def dcos_path():
"""Returns the real DCOS path based on the current executable
:returns: the real path to the DCOS path
:rtype: str
"""
return os.path.dirname(os.path.dirname(os.sys.executable))
def configure_logger_from_environ():
"""Configure the program's logger using the environment variable
:rtype: None
"""
return configure_logger(os.environ.get(constants.DCOS_LOG_LEVEL_ENV))
def configure_logger(log_level):
"""Configure the program's logger.
:param log_level: Log level for configuring logging
:type log_level: str
:rtype: None
"""
if log_level is None:
logging.disable(logging.CRITICAL)
return None
if log_level in constants.VALID_LOG_LEVEL_VALUES:
logging.basicConfig(
format='%(message)s',
stream=sys.stderr,
level=log_level.upper())
return None
msg = 'Log level set to an unknown value {!r}. Valid values are {!r}'
raise DCOSException(
msg.format(log_level, constants.VALID_LOG_LEVEL_VALUES))
def load_json(reader):
"""Deserialize a reader into a python object
:param reader: the json reader
:type reader: a :code:`.read()`-supporting object
:returns: the deserialized JSON object
:rtype: dict | list | str | int | float | bool
"""
try:
return json.load(reader)
except Exception as error:
logger.error(
'Unhandled exception while loading JSON: %r',
error)
raise DCOSException('Error loading JSON: {}'.format(error))
def load_jsons(value):
"""Deserialize a string to a python object
:param value: The JSON string
:type value: str
:returns: The deserialized JSON object
:rtype: dict | list | str | int | float | bool
"""
try:
return json.loads(value)
except:
error = sys.exc_info()[0]
logger.error(
'Unhandled exception while loading JSON: %r -- %r',
value,
error)
raise DCOSException('Error loading JSON.')
def validate_json(instance, schema):
"""Validate an instance under the given schema.
:param instance: the instance to validate
:type instance: dict
:param schema: the schema to validate with
:type schema: dict
:returns: list of errors as strings
:rtype: list
"""
def sort_key(ve):
return six.u(_hack_error_message_fix(ve.message))
validator = jsonschema.Draft4Validator(schema)
validation_errors = list(validator.iter_errors(instance))
validation_errors = sorted(validation_errors, key=sort_key)
return [_format_validation_error(e) for e in validation_errors]
# TODO(jsancio): clean up this hack
# The error string from jsonschema already contains improperly formatted
# JSON values, so we have to resort to removing the unicode prefix using
# a regular expression.
def _hack_error_message_fix(message):
"""
:param message: message to fix by removing u'...'
:type message: str
:returns: the cleaned up message
:rtype: str
"""
# This regular expression matches the character 'u' followed by the
# single-quote character, all optionally preceded by a left square
# bracket, parenthesis, curly brace, or whitespace character.
return re.compile("([\[\(\{\s])u'").sub(
"\g<1>'",
re.compile("^u'").sub("'", message))
def _format_validation_error(error):
"""
:param error: validation error to format
:type error: jsonchema.exceptions.ValidationError
:returns: string representation of the validation error
:rtype: str
"""
error_message = _hack_error_message_fix(error.message)
match = re.search("(.+) is a required property", error_message)
if match:
message = 'Error: missing required property {}.'.format(
match.group(1))
else:
message = 'Error: {}\n'.format(error_message)
if len(error.absolute_path) > 0:
message += 'Path: {}\n'.format(
'.'.join([str(path) for path in error.absolute_path]))
message += 'Value: {}'.format(json.dumps(error.instance))
return message
def create_schema(obj):
""" Creates a basic json schema derived from `obj`.
:param obj: object for which to derive a schema
:type obj: str | int | float | dict | list
:returns: json schema
:rtype: dict
"""
if isinstance(obj, bool):
return {'type': 'boolean'}
elif isinstance(obj, float):
return {'type': 'number'}
elif isinstance(obj, six.integer_types):
return {'type': 'integer'}
elif isinstance(obj, six.string_types):
return {'type': 'string'}
elif isinstance(obj, collections.Mapping):
schema = {'type': 'object',
'properties': {},
'additionalProperties': False,
'required': list(obj.keys())}
for key, val in obj.items():
schema['properties'][key] = create_schema(val)
return schema
elif isinstance(obj, collections.Sequence):
schema = {'type': 'array'}
if obj:
schema['items'] = create_schema(obj[0])
return schema
else:
raise ValueError(
'Cannot create schema with object {} of unrecognized type'
.format(str(obj)))
def list_to_err(errs):
"""convert list of error strings to a single string
:param errors: list of string errors
:type errors: list of strings
:returns: error message
:rtype: str
"""
return str.join('\n\n', errs)
def parse_int(string):
"""Parse string and an integer
:param string: string to parse as an integer
:type string: str
:returns: the interger value of the string
:rtype: int
"""
try:
return int(string)
except:
error = sys.exc_info()[0]
logger.error(
'Unhandled exception while parsing string as int: %r -- %r',
string,
error)
raise DCOSException('Error parsing string as int')
def render_mustache_json(template, data):
"""Render the supplied mustache template and data as a JSON value
:param template: the mustache template to render
:type template: str
:param data: the data to use as a rendering context
:type data: dict
:returns: the rendered template
:rtype: dict | list | str | int | float | bool
"""
try:
r = CustomJsonRenderer()
rendered = r.render(template, data)
except Exception as e:
raise DCOSException(e)
logger.debug('Rendered mustache template: %s', rendered)
return load_jsons(rendered)
def is_windows_platform():
"""
:returns: True is program is running on Windows platform, False
in other case
:rtype: boolean
"""
return platform.system() == "Windows"
class CustomJsonRenderer(pystache.Renderer):
def str_coerce(self, val):
"""
Coerce a non-string value to a string.
This method is called whenever a non-string is encountered during the
rendering process when a string is needed (e.g. if a context value
for string interpolation is not a string).
:param val: the mustache template to render
:type val: any
:returns: a string containing a JSON representation of the value
:rtype: str
"""
return json.dumps(val)
def duration(fn):
""" Decorator to log the duration of a function.
:param fn: function to measure
:type fn: function
:returns: wrapper function
:rtype: function
"""
@functools.wraps(fn)
def timer(*args, **kwargs):
start = time.time()
try:
return fn(*args, **kwargs)
finally:
logger.debug("duration: {0}.{1}: {2:2.2f}s".format(
fn.__module__,
fn.__name__,
time.time() - start))
return timer
def humanize_bytes(b):
""" Return a human representation of a number of bytes.
:param b: number of bytes
:type b: number
:returns: human representation of a number of bytes
:rtype: str
"""
abbrevs = (
(1 << 30, 'GB'),
(1 << 20, 'MB'),
(1 << 10, 'kB'),
(1, 'B')
)
for factor, suffix in abbrevs:
if b >= factor:
break
return "{0:.2f} {1}".format(b/float(factor), suffix)
def table(fields, objs, sortby=None):
"""Returns a PrettyTable. `fields` represents the header schema of
the table. `objs` represents the objects to be rendered into
rows.
:param fields: An OrderedDict, where each element represents a
column. The key is the column header, and the
value is the function that transforms an element of
`objs` into a value for that column.
:type fields: OrderdDict(str, function)
:param objs: objects to render into rows
:type objs: [object]
"""
tb = prettytable.PrettyTable(
[k.upper() for k in fields.keys()],
border=False,
hrules=prettytable.NONE,
vrules=prettytable.NONE,
left_padding_width=0,
right_padding_width=1,
sortby=sortby
)
for obj in objs:
row = [fn(obj) for fn in fields.values()]
tb.add_row(row)
return tb
@contextlib.contextmanager
def open_file(path, *args):
"""Context manager that opens a file, and raises a DCOSException if
it fails.
:param path: file path
:type path: str
:param *args: other arguments to pass to `open`
:type *args: [str]
:returns: a context manager
:rtype: context manager
"""
try:
file_ = open(path, *args)
yield file_
except IOError as e:
raise io_exception(path, e.errno)
file_.close()
def io_exception(path, errno):
"""Returns a DCOSException for when there is an error opening the
file at `path`
:param path: file path
:type path: str
:param errno: IO error number
:type errno: int
:returns: DCOSException
:rtype: DCOSException
"""
return DCOSException('Error opening file [{}]: {}'.format(
path, os.strerror(errno)))
STREAM_CONCURRENCY = 20
def stream(fn, objs):
"""Apply `fn` to `objs` in parallel, yielding the (Future, obj) for
each as it completes.
:param fn: function
:type fn: function
:param objs: objs
:type objs: objs
:returns: iterator over (Future, typeof(obj))
:rtype: iterator over (Future, typeof(obj))
"""
with concurrent.futures.ThreadPoolExecutor(STREAM_CONCURRENCY) as pool:
jobs = {pool.submit(fn, obj): obj for obj in objs}
for job in concurrent.futures.as_completed(jobs):
yield job, jobs[job]
def get_ssh_options(config_file, options):
"""Returns the SSH arguments for the given parameters. Used by
commands that wrap SSH.
:param config_file: SSH config file.
:type config_file: str | None
:param options: SSH options
:type options: [str]
:rtype: str
"""
ssh_options = ' '.join('-o {}'.format(opt) for opt in options)
if config_file:
ssh_options += ' -F {}'.format(config_file)
return ssh_options
logger = get_logger(__name__)