-
Notifications
You must be signed in to change notification settings - Fork 12
/
model.py
594 lines (474 loc) · 18.8 KB
/
model.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
# Copyright (c) 2017 "Shopify inc." All rights reserved.
# Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.
from __future__ import unicode_literals
import collections
import datetime
import re
import sys
import enum
import typing # pylint: disable=unused-import
import untangle
from pyoozie import exceptions
_COORD_ID_RE = re.compile('^(?P<id>.*-C)(?:@(?P<action>[1-9][0-9]*))?$')
_WORKFLOW_ID_RE = re.compile('^(?P<id>.*-W)(?:@(?P<action>.*))?$')
def parse_coordinator_id(string):
parts = _COORD_ID_RE.match(string) if string else None
coord_id = parts.group('id') if parts else None
action = parts.group('action') if parts else None
action = int(action) if action else None
return coord_id, action
def parse_workflow_id(string):
parts = _WORKFLOW_ID_RE.match(string) if string else None
coord_id = parts.group('id') if parts else None
action = parts.group('action') if parts else None
return coord_id, action
def _parse_coordinator_id(_, job_id):
if job_id:
coord_id, action = parse_coordinator_id(job_id)
if coord_id and not action:
return job_id
raise exceptions.OozieException.parse_error("Invalid coordinator id: {}".format(job_id))
return None
def _parse_coordinator_action_id(_, job_id):
if job_id:
coord_id, action = parse_coordinator_id(job_id)
if coord_id and action:
return job_id
raise exceptions.OozieException.parse_error("Invalid coordinator action id: {}".format(job_id))
return None
def _parse_workflow_id(_, job_id):
if job_id:
wf_id, action = parse_workflow_id(job_id)
if wf_id and not action:
return job_id
raise exceptions.OozieException.parse_error("Invalid workflow id: {}".format(job_id))
return None
def _parse_workflow_action_id(_, job_id):
if job_id:
wf_id, action = parse_workflow_id(job_id)
if wf_id and action:
return job_id
raise exceptions.OozieException.parse_error("Invalid workflow action id: {}".format(job_id))
return None
def _parse_workflow_parent_id(_, job_id):
if job_id:
wf_id, action = parse_coordinator_id(job_id)
if wf_id and action:
return job_id
wf_id, action = parse_workflow_id(job_id)
if wf_id and not action:
return job_id
raise exceptions.OozieException.parse_error("Invalid workflow parent id: {}".format(job_id))
return None
def _parse_time(_, time_string):
if time_string:
try:
return datetime.datetime.strptime(time_string, '%a, %d %b %Y %H:%M:%S %Z')
except ValueError as err:
raise exceptions.OozieException.parse_error("Error parsing time '{}'".format(time_string), err)
return None
def _parse_configuration(_, conf_string):
if conf_string is None:
return None
elif conf_string:
xml = conf_string if sys.version_info >= (3, 0) else conf_string.encode('utf-8')
conf = untangle.parse(xml).configuration
return {prop.name.cdata: prop.value.cdata for prop in conf.property}
else:
return {}
def _parse_workflow_actions(artifact, actions_list):
actions_list = actions_list or []
actions = [WorkflowAction(artifact._client, action, parent=artifact) for action in actions_list]
return {action.name: action for action in actions}
def _parse_coordinator_actions(artifact, actions_list):
actions_list = actions_list or []
actions = [CoordinatorAction(artifact._client, action, parent=artifact) for action in actions_list]
return {action.actionNumber: action for action in actions}
def _parse_coordinator_status(_, status_string):
return CoordinatorStatus.parse(status_string)
def _parse_coordinator_action_status(_, status_string):
return CoordinatorActionStatus.parse(status_string)
def _parse_workflow_status(_, status_string):
return WorkflowStatus.parse(status_string)
def _parse_workflow_action_status(_, status_string):
return WorkflowActionStatus.parse(status_string)
class ArtifactType(enum.Enum):
Coordinator = 1
CoordinatorAction = 2
Workflow = 3
WorkflowAction = 4
_StatusValue = collections.namedtuple('_StatusValue',
['status_id', 'is_active', 'is_running', 'is_suspendable', 'is_suspended'])
def _status(status_id, is_active=False, is_running=False, is_suspendable=False, is_suspended=False):
if is_running and not is_active:
raise exceptions.OozieException.parse_error("A running status implies active")
return _StatusValue(status_id, is_active, is_running, is_suspendable, is_suspended)
class _StatusEnum(enum.Enum):
def __str__(self):
return self.name
@classmethod
def parse(cls, status_string):
values = cls.__members__
return values.get(status_string, values['UNKNOWN'])
@classmethod
def active(cls):
return [status for status in cls if status.is_active()]
@classmethod
def running(cls):
return [status for status in cls if status.is_running()]
@classmethod
def suspendable(cls):
return [status for status in cls if status.is_suspendable()]
@classmethod
def suspended(cls):
return [status for status in cls if status.is_suspended()]
def is_unknown(self):
return self._value_.status_id == 0
def is_active(self):
return self._value_.is_active
def is_running(self):
return self._value_.is_running
def is_suspendable(self):
return self._value_.is_suspendable
def is_suspended(self):
return self._value_.is_suspended
class CoordinatorStatus(_StatusEnum):
UNKNOWN = _status(0)
DONEWITHERROR = _status(1)
FAILED = _status(2)
IGNORED = _status(3)
KILLED = _status(4)
PAUSED = _status(5, is_active=True)
PAUSEDWITHERROR = _status(6, is_active=True)
PREMATER = _status(7, is_active=True)
PREP = _status(8, is_active=True, is_suspendable=True)
PREPPAUSED = _status(9, is_active=True)
PREPSUSPENDED = _status(10, is_active=True, is_suspended=True)
RUNNING = _status(11, is_active=True, is_running=True, is_suspendable=True)
RUNNINGWITHERROR = _status(12, is_active=True, is_running=True, is_suspendable=True)
SUCCEEDED = _status(13)
SUSPENDED = _status(14, is_active=True, is_running=True, is_suspended=True)
SUSPENDEDWITHERROR = _status(15, is_active=True, is_running=True, is_suspended=True)
class CoordinatorActionStatus(_StatusEnum):
UNKNOWN = _status(0)
FAILED = _status(1)
IGNORED = _status(2)
KILLED = _status(3)
READY = _status(4, is_active=True)
RUNNING = _status(5, is_active=True, is_running=True, is_suspendable=True)
SKIPPED = _status(6)
SUBMITTED = _status(7, is_active=True)
SUCCEEDED = _status(8)
SUSPENDED = _status(9, is_active=True, is_running=True, is_suspended=True)
TIMEDOUT = _status(10)
WAITING = _status(11, is_active=True)
class WorkflowStatus(_StatusEnum):
UNKNOWN = _status(0)
FAILED = _status(1)
KILLED = _status(2)
PREP = _status(3, is_active=True)
RUNNING = _status(4, is_active=True, is_running=True, is_suspendable=True)
SUCCEEDED = _status(5)
SUSPENDED = _status(6, is_active=True, is_running=True, is_suspended=True)
class WorkflowActionStatus(_StatusEnum):
UNKNOWN = _status(0)
DONE = _status(1)
END_MANUAL = _status(2)
END_RETRY = _status(3)
ERROR = _status(4)
FAILED = _status(5)
KILLED = _status(6)
OK = _status(7)
PREP = _status(8, is_active=True)
RUNNING = _status(9, is_active=True, is_running=True)
START_MANUAL = _status(10)
START_RETRY = _status(11)
USER_RETRY = _status(12, is_active=True)
class _OozieArtifact(object):
REQUIRED_KEYS = {} # type: typing.Dict[unicode, typing.Callable]
SUPPORTED_KEYS = {'toString': None} # type: typing.Dict[unicode, typing.Optional[typing.Callable]]
def __init__(self, oozie_client, details, parent=None):
self._client = oozie_client
self._parent = parent
details = dict(details)
for key, func in self.REQUIRED_KEYS.items():
value = details.pop(key, None)
try:
parsed_value = func(self, value) if func else value
except exceptions.OozieException as err:
raise exceptions.OozieException.required_key_missing(key, self, err)
if parsed_value is None:
raise exceptions.OozieException.required_key_missing(key, self)
else:
setattr(self, key, parsed_value)
for key, func in self.SUPPORTED_KEYS.items():
value = details.pop(key, None)
value = func(self, value) if func else value
setattr(self, key, value)
self._details = details
self._validate_degenerate_fields()
def __str__(self):
return self.toString
def fill_in_details(self):
# Fetch any missing data not supplied
return self
def _validate_degenerate_fields(self):
# For any fields that must be in sync, ensure they are.
# If values are missing, extrapolate them
pass
def is_coordinator(self):
return False
def is_workflow(self):
return False
def is_action(self):
return False
class Coordinator(_OozieArtifact):
REQUIRED_KEYS = {
'coordJobId': _parse_coordinator_id,
}
SUPPORTED_KEYS = {
'acl': None,
'actions': _parse_coordinator_actions,
'bundleId': None,
'concurrency': None,
'conf': _parse_configuration,
'consoleUrl': None,
'coordExternalId': None,
'coordJobName': None,
'coordJobPath': None,
'endTime': _parse_time,
'executionPolicy': None,
'frequency': None,
'group': None,
'lastAction': _parse_time,
'mat_throttling': None,
'nextMaterializedTime': _parse_time,
'pauseTime': None,
'startTime': _parse_time,
'status': _parse_coordinator_status,
'timeOut': None,
'timeUnit': None,
'timeZone': None,
'toString': None,
'total': None,
'user': None,
}
def __init__(self, *args, **kwargs):
super(Coordinator, self).__init__(*args, **kwargs)
self._workflow = None
def fill_in_details(self):
# Undefined `conf` is probably bad, empty is ok
if self.conf is None:
coord = self._client.job_last_coordinator_info(coordinator_id=self.coordJobId)
return coord
else:
return self
def _validate_degenerate_fields(self):
# For any fields that must be in sync, ensure they are.
# If values are missing, extrapolate them
self.toString = self.toString or 'Coordinator application id[{}] status[{}]'.format(
self.coordJobId,
self.status)
if self.coordJobId not in self.toString:
raise exceptions.OozieException.parse_error("toString does not contain coordinator ID")
if not self.status.is_unknown() and str(self.status) not in self.toString:
raise exceptions.OozieException.parse_error("toString does not contain status")
def is_coordinator(self):
return True
def coordinator(self):
return self
def parent(self):
return None
def action(self, number):
if number in self.actions:
action = self.actions[number]
else:
action = self._client.job_coordinator_action(action_number=number, coordinator=self)
return action
class CoordinatorAction(_OozieArtifact):
REQUIRED_KEYS = {
'id': _parse_coordinator_action_id,
}
SUPPORTED_KEYS = {
'actionNumber': None,
'consoleUrl': None,
'coordJobId': _parse_coordinator_id,
'createdConf': None,
'createdTime': _parse_time,
'errorCode': None,
'errorMessage': None,
'externalId': _parse_workflow_id,
'externalStatus': None,
'lastModifiedTime': _parse_time,
'missingDependencies': None,
'nominalTime': _parse_time,
'pushMissingDependencies': None,
'runConf': None,
'status': _parse_coordinator_action_status,
'toString': None,
'trackerUri': None,
'type': None,
}
def __init__(self, *args, **kwargs):
self.status = CoordinatorActionStatus.UNKNOWN
super(CoordinatorAction, self).__init__(*args, **kwargs)
self._workflow = None
def _validate_degenerate_fields(self):
# For any fields that must be in sync, ensure they are.
# If values are missing, extrapolate them
coord_id, action = parse_coordinator_id(self.id)
self.coordJobId = self.coordJobId or coord_id
if self.coordJobId != coord_id:
raise exceptions.OozieException.parse_error("coordJobId does not match coordinator action ID")
self.actionNumber = self.actionNumber or action
if self.actionNumber != action:
raise exceptions.OozieException.parse_error("actionNumber does not match coordinator action ID")
self.toString = self.toString or 'CoordinatorAction name[{}] status[{}]'.format(self.id, self.status)
if self.id not in self.toString:
raise exceptions.OozieException.parse_error("toString does not contain coordinator action ID")
if not self.status.is_unknown() and str(self.status) not in self.toString:
raise exceptions.OozieException.parse_error("toString does not contain status")
def is_coordinator(self):
return True
def is_action(self):
return True
def workflow(self):
# TODO: revisit this to support multiple runs
# Use .../job/...-C@xx?show=allruns to query
if not self._workflow and self.externalId:
workflow = self._client.job_workflow_info(workflow_id=self.externalId)
if workflow:
workflow._parent = self
self._workflow = workflow
return self._workflow
def coordinator(self):
if not self._parent:
self._parent = self._client.job_coordinator_info(coordinator_id=self.coordJobId)
return self._parent
def coordinator_action(self):
return self
def parent(self):
return self.coordinator()
class Workflow(_OozieArtifact):
REQUIRED_KEYS = {
'id': _parse_workflow_id,
}
SUPPORTED_KEYS = {
'acl': None,
'actions': _parse_workflow_actions,
'appName': None,
'appPath': None,
'conf': _parse_configuration,
'consoleUrl': None,
'createdTime': _parse_time,
'endTime': _parse_time,
'externalId': None,
'group': None,
'lastModTime': _parse_time,
'parentId': _parse_workflow_parent_id,
'run': None,
'startTime': _parse_time,
'status': _parse_workflow_status,
'toString': None,
'user': None,
}
def __init__(self, *args, **kwargs):
super(Workflow, self).__init__(*args, **kwargs)
self._workflow = None
def fill_in_details(self):
# Undefined `conf` is probably bad, empty is ok
if self.conf is None:
workflow = self._client.job_workflow_info(workflow_id=self.id)
return workflow
else:
return self
def _validate_degenerate_fields(self):
# For any fields that must be in sync, ensure they are.
# If values are missing, extrapolate them
self.toString = self.toString or 'Workflow id[{}] status[{}]'.format(self.id, self.status)
if self.id not in self.toString:
raise exceptions.OozieException.parse_error("toString does not contain workflow ID")
if not self.status.is_unknown() and str(self.status) not in self.toString:
raise exceptions.OozieException.parse_error("toString does not contain status")
def is_workflow(self):
return True
def coordinator(self):
parent = self.parent()
if parent:
return parent.coordinator()
def coordinator_action(self):
parent = self.parent()
if parent:
return parent.coordinator_action()
def parent(self):
if not self._parent and self.parentId:
self._parent = self._client.job_action_info(self.parentId)
return self._parent
def action(self, name):
return self.actions.get(name, None)
class WorkflowAction(_OozieArtifact):
REQUIRED_KEYS = {
'id': _parse_workflow_action_id,
}
SUPPORTED_KEYS = {
'conf': None,
'consoleUrl': None,
'cred': None,
'data': None,
'endTime': _parse_time,
'errorCode': None,
'errorMessage': None,
'externalChildIDs': None,
'externalId': None,
'externalStatus': None,
'name': None,
'retries': None,
'startTime': _parse_time,
'stats': None,
'status': _parse_workflow_action_status,
'toString': None,
'trackerUri': None,
'transition': None,
'type': None,
'userRetryCount': None,
'userRetryInterval': None,
'userRetryMax': None,
}
def __init__(self, *args, **kwargs):
super(WorkflowAction, self).__init__(*args, **kwargs)
self._subworkflow = None
def _validate_degenerate_fields(self):
# For any fields that must be in sync, ensure they are.
# If values are missing, extrapolate them
_, action = parse_workflow_id(self.id)
self.name = self.name or action
if self.name != action:
raise exceptions.OozieException.parse_error("name does not match workflow action ID")
self.toString = self.toString or 'Action name[{}] status[{}]'.format(self.name, self.status)
if self.name not in self.toString:
raise exceptions.OozieException.parse_error("toString does not contain workflow action name")
if not self.status.is_unknown() and str(self.status) not in self.toString:
raise exceptions.OozieException.parse_error("toString does not contain status")
def is_workflow(self):
return True
def is_action(self):
return True
def subworkflow(self):
if not self._subworkflow and self.type == 'sub-workflow' and self.externalId:
workflow = self._client.job_workflow_info(self.externalId)
if workflow:
workflow._parent = self
self._subworkflow = workflow
return self._subworkflow
def coordinator(self):
parent = self.parent()
if parent:
return parent.coordinator()
def coordinator_action(self):
parent = self.parent()
if parent:
return parent.coordinator_action()
def parent(self):
if not self._parent and self.externalId:
self._parent = self._client.job_workflow_info(self.externalId)
return self._parent