-
Notifications
You must be signed in to change notification settings - Fork 27
/
utils.py
430 lines (361 loc) · 14.8 KB
/
utils.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
"""Utilities."""
import base64
from collections import OrderedDict
import inspect
import json
import logging
import os
import re
import time
import uuid
import sys
import platform
from typing import Any, Optional, Tuple, Union, Callable, Dict, List
from cryptography.fernet import Fernet
from ray.dashboard.modules.job.common import JobStatus
from django.conf import settings
from parsley import makeGrammar
import objsize
from .models import Job
logger = logging.getLogger("commands")
def try_json_loads(data: str) -> Tuple[bool, Optional[dict]]:
"""Dumb check if data is json :)"""
try:
json_object = json.loads(data)
except ValueError:
return False, None
return True, json_object
def ray_job_status_to_model_job_status(ray_job_status):
"""Maps ray job status to model job status."""
mapping = {
JobStatus.PENDING: Job.PENDING,
JobStatus.RUNNING: Job.RUNNING,
JobStatus.STOPPED: Job.STOPPED,
JobStatus.SUCCEEDED: Job.SUCCEEDED,
JobStatus.FAILED: Job.FAILED,
}
return mapping.get(ray_job_status, Job.FAILED)
def retry_function(
callback: Callable,
num_retries: int = 10,
interval: int = 1,
error_message: Optional[str] = None,
function_name: Optional[str] = None,
):
"""Retries to call callback function.
Args:
callback: function
num_retries: number of tries
interval: interval between tries
error_message: error message
function_name: name of executable function
Returns:
function result of None
"""
success = False
run = 0
result = None
name = function_name or inspect.stack()[1].function
while run < num_retries and not success:
run += 1
logger.debug("[%s] attempt %d", name, run)
try:
result = callback()
success = True
except Exception: # pylint: disable=broad-exception-caught
logger.debug("%s Retrying...", error_message)
time.sleep(interval)
return result
def encrypt_string(string: str) -> str:
"""Encrypts string using symmetrical encryption.
Args:
string: string to be encrypted
Returns:
encrypter string
"""
code_bytes = settings.SECRET_KEY.encode("utf-8")
fernet = Fernet(base64.urlsafe_b64encode(code_bytes.ljust(32)[:32]))
return fernet.encrypt(string.encode("utf-8")).decode("utf-8")
def decrypt_string(string: str) -> str:
"""Decrypts string symmetrically encrypted.
Args:
string: encrypted string
Returns:
decrypted string
"""
code_bytes = settings.SECRET_KEY.encode("utf-8")
fernet = Fernet(base64.urlsafe_b64encode(code_bytes.ljust(32)[:32]))
return fernet.decrypt(string.encode("utf-8")).decode("utf-8")
def build_env_variables(token, job: Job, args: str = None) -> Dict[str, str]:
"""Builds env variables for job.
Args:
token: django request token decoded
job: job
Returns:
env variables dict
"""
extra = {}
# only set arguments envvar if not too big
# remove this after sufficient time for users to upgrade client
arguments = "{}"
if args:
if objsize.get_deep_size(args) < 100000:
logger.debug("passing arguments as envvar for job %s", job.id)
arguments = args
else:
logger.warning(
"arguments for job %s are too large and will not be written to env var",
job.id,
)
if settings.SETTINGS_AUTH_MECHANISM != "default":
extra = {
"QISKIT_IBM_TOKEN": str(token),
"QISKIT_IBM_CHANNEL": settings.QISKIT_IBM_CHANNEL,
"QISKIT_IBM_URL": settings.QISKIT_IBM_URL,
}
return {
**{
"ENV_JOB_GATEWAY_TOKEN": str(token),
"ENV_JOB_GATEWAY_HOST": str(settings.SITE_HOST),
"ENV_JOB_ID_GATEWAY": str(job.id),
"ENV_JOB_ARGUMENTS": arguments,
},
**extra,
}
def encrypt_env_vars(env_vars: Dict[str, str]) -> Dict[str, str]:
"""Encrypts tokens in env variables.
Args:
env_vars: env variables dict
Returns:
encrypted env vars dict
"""
for key, value in env_vars.items():
if "token" in key.lower():
env_vars[key] = encrypt_string(value)
return env_vars
def decrypt_env_vars(env_vars: Dict[str, str]) -> Dict[str, str]:
"""Decrypts tokens in env variables.
Args:
env_vars: env variables dict
Returns:
decrypted env vars dict
"""
for key, value in env_vars.items():
if "token" in key.lower():
try:
env_vars[key] = decrypt_string(value)
except Exception: # pylint: disable=broad-exception-caught
logger.error("Cannot decrypt %s.", key)
return env_vars
def generate_cluster_name(username: str) -> str:
"""generate cluster name.
Args:
username: user name for the cluster
Returns:
generated cluster name
"""
pattern = re.compile("[^a-zA-Z0-9-.]")
cluster_name = f"c-{re.sub(pattern,'-',username)}-{str(uuid.uuid4())[:8]}"
return cluster_name
def check_logs(logs: Union[str, None], job: Job) -> str:
"""Add error message to logs for faild jobs with empty logs.
Args:
logs: logs of the job
job: job model
Returns:
logs with error message and metadata.
"""
if job.status == Job.FAILED and logs in ["", None]:
logs = f"Job {job.id} failed due to an internal error."
logger.warning("Job %s failed due to an internal error.", job.id)
return logs
def safe_request(request: Callable) -> Optional[Dict[str, Any]]:
"""Makes safe request and parses json response."""
result = None
response = None
try:
response = request()
except Exception: # pylint: disable=broad-exception-caught
logger.error("Exception sending request in safe_request")
if response is not None and response.ok:
try:
result = json.loads(response.text)
except Exception: # pylint: disable=broad-exception-caught
logger.error("Response is not valid json in safe_request")
if response is not None and not response.ok:
logger.error("%d : %s", response.status_code, response.text)
return result
def remove_duplicates_from_list(original_list: List[Any]) -> List[Any]:
"""Remove duplicates from a list maintining the order.
Args:
original_list: list with the original values
Returns:
a list without duplicates maintining the order
"""
return list(OrderedDict.fromkeys(original_list))
# Utilities for parsing python dependency information
# source: https://peps.python.org/pep-0508/#complete-grammar
RAW_DEPENDENCY_GRAMMAR = """
wsp = ' ' | '\t'
version_cmp = wsp* <'<=' | '<' | '!=' | '==' | '>=' | '>' | '~=' | '==='>
version = wsp* <( letterOrDigit | '-' | '_' | '.' | '*' | '+' | '!' )+>
version_one = version_cmp:op version:v wsp* -> (op, v)
version_many = version_one:v1 (wsp* ',' version_one)*:v2 -> [v1] + v2
versionspec = ('(' version_many:v ')' ->v) | version_many
urlspec = '@' wsp* <URI_reference>
marker_op = version_cmp | (wsp* 'in') | (wsp* 'not' wsp+ 'in')
python_str_c = (wsp | letter | digit | '(' | ')' | '.' | '{' | '}' |
'-' | '_' | '*' | '#' | ':' | ';' | ',' | '/' | '?' |
'[' | ']' | '!' | '~' | '`' | '@' | '$' | '%' | '^' |
'&' | '=' | '+' | '|' | '<' | '>' )
dquote = '"'
squote = '\\''
python_str = (squote <(python_str_c | dquote)*>:s squote |
dquote <(python_str_c | squote)*>:s dquote) -> s
env_var = ('python_version' | 'python_full_version' |
'os_name' | 'sys_platform' | 'platform_release' |
'platform_system' | 'platform_version' |
'platform_machine' | 'platform_python_implementation' |
'implementation_name' | 'implementation_version' |
'extra' # ONLY when defined by a containing layer
):varname -> lookup(varname)
marker_var = wsp* (env_var | python_str)
marker_expr = marker_var:l marker_op:o marker_var:r -> (o, l, r)
| wsp* '(' marker:m wsp* ')' -> m
marker_and = marker_expr:l wsp* 'and' marker_expr:r -> ('and', l, r)
| marker_expr:m -> m
marker_or = marker_and:l wsp* 'or' marker_and:r -> ('or', l, r)
| marker_and:m -> m
marker = marker_or
quoted_marker = ';' wsp* marker
identifier_end = letterOrDigit | (('-' | '_' | '.' )* letterOrDigit)
identifier = < letterOrDigit identifier_end* >
name = identifier
extras_list = identifier:i (wsp* ',' wsp* identifier)*:ids -> [i] + ids
extras = '[' wsp* extras_list?:e wsp* ']' -> e
name_req = (name:n wsp* extras?:e wsp* versionspec?:v wsp* quoted_marker?:m
-> (n, e or [], v or [], m))
url_req = (name:n wsp* extras?:e wsp* urlspec:v (wsp+ | end) quoted_marker?:m
-> (n, e or [], v, m))
specification = wsp* ( url_req | name_req ):s wsp* -> s
# The result is a tuple - name, list-of-extras,
# list-of-version-constraints-or-a-url, marker-ast or None
URI_reference = <URI | relative_ref>
URI = scheme ':' hier_part ('?' query )? ( '#' fragment)?
hier_part = ('//' authority path_abempty) | path_absolute | path_rootless | path_empty
absolute_URI = scheme ':' hier_part ( '?' query )?
relative_ref = relative_part ( '?' query )? ( '#' fragment )?
relative_part = '//' authority path_abempty | path_absolute | path_noscheme | path_empty
scheme = letter ( letter | digit | '+' | '-' | '.')*
authority = ( userinfo '@' )? host ( ':' port )?
userinfo = ( unreserved | pct_encoded | sub_delims | ':')*
host = IP_literal | IPv4address | reg_name
port = digit*
IP_literal = '[' ( IPv6address | IPvFuture) ']'
IPvFuture = 'v' hexdig+ '.' ( unreserved | sub_delims | ':')+
IPv6address = (
( h16 ':'){6} ls32
| '::' ( h16 ':'){5} ls32
| ( h16 )? '::' ( h16 ':'){4} ls32
| ( ( h16 ':')? h16 )? '::' ( h16 ':'){3} ls32
| ( ( h16 ':'){0,2} h16 )? '::' ( h16 ':'){2} ls32
| ( ( h16 ':'){0,3} h16 )? '::' h16 ':' ls32
| ( ( h16 ':'){0,4} h16 )? '::' ls32
| ( ( h16 ':'){0,5} h16 )? '::' h16
| ( ( h16 ':'){0,6} h16 )? '::' )
h16 = hexdig{1,4}
ls32 = ( h16 ':' h16) | IPv4address
IPv4address = dec_octet '.' dec_octet '.' dec_octet '.' dec_octet
nz = ~'0' digit
dec_octet = (
digit # 0-9
| nz digit # 10-99
| '1' digit{2} # 100-199
| '2' ('0' | '1' | '2' | '3' | '4') digit # 200-249
| '25' ('0' | '1' | '2' | '3' | '4' | '5') )# %250-255
reg_name = ( unreserved | pct_encoded | sub_delims)*
path = (
path_abempty # begins with '/' or is empty
| path_absolute # begins with '/' but not '//'
| path_noscheme # begins with a non-colon segment
| path_rootless # begins with a segment
| path_empty ) # zero characters
path_abempty = ( '/' segment)*
path_absolute = '/' ( segment_nz ( '/' segment)* )?
path_noscheme = segment_nz_nc ( '/' segment)*
path_rootless = segment_nz ( '/' segment)*
path_empty = pchar{0}
segment = pchar*
segment_nz = pchar+
segment_nz_nc = ( unreserved | pct_encoded | sub_delims | '@')+
# non-zero-length segment without any colon ':'
pchar = unreserved | pct_encoded | sub_delims | ':' | '@'
query = ( pchar | '/' | '?')*
fragment = ( pchar | '/' | '?')*
pct_encoded = '%' hexdig
unreserved = letter | digit | '-' | '.' | '_' | '~'
reserved = gen_delims | sub_delims
gen_delims = ':' | '/' | '?' | '#' | '(' | ')?' | '@'
sub_delims = '!' | '$' | '&' | '\\'' | '(' | ')' | '*' | '+' | ',' | ';' | '='
hexdig = digit | 'a' | 'A' | 'b' | 'B' | 'c' | 'C' | 'd' | 'D' | 'e' | 'E' | 'f' | 'F'
"""
def create_dependency_grammar(grammar=RAW_DEPENDENCY_GRAMMAR):
"""Create dependency grammar."""
if hasattr(sys, "implementation"):
sys_version = sys.implementation.version
version = f"{sys_version.major}.{sys_version.minor}.{sys_version.micro}"
kind = sys.implementation.version.releaselevel
if kind != "final":
version += kind[0] + str(sys.implementation.version.serial)
implementation_version = version
implementation_name = sys.implementation.name
else:
implementation_version = "0"
implementation_name = ""
bindings = {
"implementation_name": implementation_name,
"implementation_version": implementation_version,
"os_name": os.name,
"platform_machine": platform.machine(),
"platform_python_implementation": platform.python_implementation(),
"platform_release": platform.release(),
"platform_system": platform.system(),
"platform_version": platform.version(),
"python_full_version": platform.python_version(),
"python_version": ".".join(platform.python_version_tuple()[:2]),
"sys_platform": sys.platform,
}
dependency_grammar = makeGrammar(grammar, {"lookup": bindings.__getitem__})
return dependency_grammar
def parse_dependency(dep, grammar):
"""Parse dependency."""
parsed = grammar(dep).specification()
dep_name = parsed[0]
dep_ver = parsed[2]
return dep_name, dep_ver
def create_dependency_allowlist():
"""
Create dictionary with allowed dependencies and versions.
Sample format:
allowlist = { "wheel": ["0.44.0", "0.43.2"] }
where the values for each key are allowed versions of dependency.
"""
try:
with open(settings.GATEWAY_ALLOWLIST_CONFIG, encoding="utf-8", mode="r") as f:
allowlist = json.load(f)
except IOError as e:
logger.error("Unable to open allowlist config file: %s", e)
raise ValueError("Unable to open allowlist config file") from e
except ValueError as e:
logger.error("Unable to decode dependency allowlist: %s", e)
raise ValueError("Unable to decode dependency allowlist") from e
return allowlist
def sanitize_name(name: str):
"""Sanitize name"""
if name:
sanitized_name = ""
for c in name:
if c.isalnum() or c in ["_", "-", "/"]:
sanitized_name += c
return sanitized_name
return name