def test_on_parse_finish(self):
workflow = Workflow(input_directory_path=None,
output_directory_path=None,
dag_name=None)
mapper = self._get_kill_mapper(name="fail_task")
workflow.nodes["task"] = ParsedNode(mock.Mock(autospec=BaseMapper))
workflow.nodes["fail_task"] = ParsedNode(mapper)
workflow.nodes["success_task"] = ParsedNode(
mock.Mock(autospec=BaseMapper))
workflow.nodes["success_task"].set_is_ok(True)
workflow.nodes["fail_task"].set_is_error(True)
workflow.relations = {
Relation(from_task_id="task", to_task_id="fail_task"),
Relation(from_task_id="task", to_task_id="success_task"),
}
mapper.on_parse_finish(workflow)
self.assertEqual(set(workflow.nodes.keys()), {"task", "success_task"})
self.assertEqual(
workflow.relations,
{Relation(from_task_id="task", to_task_id="success_task")})
def test_on_parse_finish_decision_should_not_remove_end_node(self):
workflow = Workflow(input_directory_path=None,
output_directory_path=None,
dag_name=None)
mapper = self._get_end_mapper("end_task")
workflow.nodes["first_task"] = ParsedNode(
mock.Mock(spec=DecisionMapper, last_task_id="first_task"))
workflow.nodes["second_task"] = ParsedNode(
mock.Mock(spec=BaseMapper, last_task_id="second_task"))
workflow.nodes["end_task"] = ParsedNode(mapper)
workflow.relations = {
Relation(from_task_id="first_task", to_task_id="end_task"),
Relation(from_task_id="second_task", to_task_id="end_task"),
}
mapper.on_parse_finish(workflow)
self.assertEqual(set(workflow.nodes.keys()),
{"first_task", "second_task", "end_task"})
self.assertEqual(
workflow.relations,
{Relation(from_task_id="first_task", to_task_id="end_task")})
def test_convert_nodes(self):
tasks_1 = [
Task(task_id="first_task", template_name="dummy.tpl"),
Task(task_id="second_task", template_name="dummy.tpl"),
]
relations_1 = {
Relation(from_task_id="first_task", to_task_id="tasks_2")
}
tasks_2 = [Task(task_id="third_task", template_name="dummy.tpl")]
relations_2 = {}
mapper_1 = mock.MagicMock(
**{"to_tasks_and_relations.return_value": (tasks_1, relations_1)})
mapper_2 = mock.MagicMock(
**{"to_tasks_and_relations.return_value": (tasks_2, relations_2)})
node_1 = ParsedNode(mapper=mapper_1)
node_2 = ParsedNode(mapper=mapper_2)
nodes = dict(TASK_1=node_1, TASK_2=node_2)
self.converter.convert_nodes(nodes=nodes)
self.assertIs(node_1.tasks, tasks_1)
self.assertIs(node_2.tasks, tasks_2)
self.assertIs(node_1.relations, relations_1)
self.assertIs(node_2.relations, relations_2)
def test_write_dag_file(self, render_template_mock):
relations = {Relation(from_task_id="TASK_1", to_task_id="TASK_2")}
nodes = dict(
TASK_1=ParsedNode(DummyMapper(ET.Element("dummy"), name="TASK_1")))
dependencies = {"import awesome_stuff"}
workflow = Workflow(
input_directory_path="/tmp/input_directory",
output_directory_path="/tmp/input_directory",
dag_name="test_dag",
relations=relations,
nodes=nodes,
dependencies=dependencies,
)
content = self.converter.render_workflow(workflow=workflow)
render_template_mock.assert_called_once_with(
dag_name="test_dag",
dependencies=["import awesome_stuff"],
nodes=[nodes["TASK_1"]],
params={"user.name": "USER"},
relations={Relation(from_task_id="TASK_1", to_task_id="TASK_2")},
schedule_interval=None,
start_days_ago=None,
template_name="workflow.tpl",
)
self.assertEqual(content, "TEXT_CONTENT")
class SubWorkflowTemplateTestCase(TestCase, TemplateTestMixin):
TEMPLATE_NAME = "subworkflow.tpl"
DEFAULT_TEMPLATE_PARAMS = dict(
dependencies=["import awesome_stuff"],
nodes=[
ParsedNode(
mock.MagicMock(spec=DummyMapper),
tasks=[
Task(task_id="first_task", template_name="dummy.tpl"),
Task(task_id="second_task", template_name="dummy.tpl"),
],
relations=[
Relation(from_task_id="first_task",
to_task_id="second_task")
],
)
],
params={"user.name": "USER"},
relations={Relation(from_task_id="TASK_1", to_task_id="TASK_2")},
schedule_interval=None,
start_days_ago=None,
)
def test_green_path(self):
res = render_template(self.TEMPLATE_NAME,
**self.DEFAULT_TEMPLATE_PARAMS)
self.assertValidPython(res)
def parse_join_node(self, join_node):
"""
Join nodes wait for the corresponding beginning fork node paths to
finish. As the parser we are assuming the Oozie workflow follows the
schema perfectly.
"""
map_class = self.control_map["join"]
mapper = map_class(oozie_node=join_node, name=join_node.attrib["name"])
p_node = ParsedNode(mapper)
p_node.add_downstream_node_name(join_node.attrib["to"])
mapper.on_parse_node()
logging.info(f"Parsed {mapper.name} as Join Node.")
self.workflow.nodes[join_node.attrib["name"]] = p_node
self.workflow.dependencies.update(mapper.required_imports())
def test_on_parse_finish(self):
workflow = Workflow(input_directory_path=None,
output_directory_path=None,
dag_name=None)
mapper = self._get_start_mapper(name="first_task")
workflow.nodes["first_task"] = ParsedNode(
mock.Mock(autospec=BaseMapper))
workflow.nodes["second_task"] = ParsedNode(mapper)
workflow.relations = {
Relation(from_task_id="first_task", to_task_id="second_task")
}
mapper.on_parse_finish(workflow)
self.assertEqual(set(workflow.nodes.keys()), {"second_task"})
self.assertEqual(workflow.relations, set())
def parse_fork_node(self, root, fork_node):
"""
Fork nodes need to be dummy operators with multiple parallel downstream
tasks.
This parses the fork node, the action nodes that it references and then
the join node at the end.
This will only parse well-formed xml-adhering workflows where all paths
end at the join node.
"""
map_class = self.control_map["fork"]
fork_name = fork_node.attrib["name"]
mapper = map_class(oozie_node=fork_node, name=fork_name)
p_node = ParsedNode(mapper)
mapper.on_parse_node()
logging.info(f"Parsed {mapper.name} as Fork Node.")
paths = []
for node in fork_node:
if "path" in node.tag:
# Parse all the downstream tasks that can run in parallel.
curr_name = node.attrib["start"]
paths.append(xml_utils.find_node_by_name(root, curr_name))
self.workflow.nodes[fork_name] = p_node
self.workflow.dependencies.update(mapper.required_imports())
for path in paths:
p_node.add_downstream_node_name(path.attrib["name"])
logging.info(f"Added {mapper.name}'s downstream: {path.attrib['name']}")
# Theoretically these will all be action nodes, however I don't
# think that is guaranteed.
# The end of the execution path has not been reached
self.parse_node(root, path)
if path.attrib["name"] not in self.workflow.nodes:
root.remove(path)
def parse_end_node(self, end_node):
"""
Upon reaching the end node, the workflow is considered completed successfully.
Thus it gets mapped to a dummy node that always completes.
"""
map_class = self.control_map["end"]
mapper = map_class(oozie_node=end_node, name=end_node.attrib["name"])
p_node = ParsedNode(mapper)
mapper.on_parse_node()
logging.info(f"Parsed {mapper.name} as End Node.")
self.workflow.nodes[end_node.attrib["name"]] = p_node
self.workflow.dependencies.update(mapper.required_imports())
def parse_start_node(self, start_node):
"""
The start node is the entry point for a workflow job, it indicates the
first workflow node the workflow job must transition to.
When a workflow is started, it automatically transitions to the
node specified in the start.
A workflow definition must have one start node.
"""
map_class = self.control_map["start"]
# Theoretically this could cause conflicts, but it is very unlikely
start_name = "start_node_" + str(uuid.uuid4())[:4]
mapper = map_class(oozie_node=start_node, name=start_name)
p_node = ParsedNode(mapper)
p_node.add_downstream_node_name(start_node.attrib["to"])
mapper.on_parse_node()
logging.info(f"Parsed {mapper.name} as Start Node.")
self.workflow.nodes[start_name] = p_node
self.workflow.dependencies.update(mapper.required_imports())
def parse_decision_node(self, decision_node):
"""
A decision node enables a workflow to make a selection on the execution
path to follow.
The behavior of a decision node can be seen as a switch-case statement.
A decision node consists of a list of predicates-transition pairs plus
a default transition. Predicates are evaluated in order or appearance
until one of them evaluates to true and the corresponding transition is
taken. If none of the predicates evaluates to true the default
transition is taken.
example oozie wf decision node:
<decision name="[NODE-NAME]">
<switch>
<case to="[NODE_NAME]">[PREDICATE]</case>
...
<case to="[NODE_NAME]">[PREDICATE]</case>
<default to="[NODE_NAME]"/>
</switch>
</decision>
"""
map_class = self.control_map["decision"]
mapper = map_class(oozie_node=decision_node, name=decision_node.attrib["name"])
p_node = ParsedNode(mapper)
for cases in decision_node[0]:
p_node.add_downstream_node_name(cases.attrib["to"])
mapper.on_parse_node()
logging.info(f"Parsed {mapper.name} as Decision Node.")
self.workflow.nodes[decision_node.attrib["name"]] = p_node
self.workflow.dependencies.update(mapper.required_imports())
def parse_kill_node(self, kill_node: ET.Element):
"""
When a workflow node reaches the `kill` node, it finishes in an error.
A workflow definition may have zero or more kill nodes.
"""
map_class = self.control_map["kill"]
mapper = map_class(
oozie_node=kill_node, name=kill_node.attrib["name"], trigger_rule=TriggerRule.ONE_FAILED
)
p_node = ParsedNode(mapper)
mapper.on_parse_node()
logging.info(f"Parsed {mapper.name} as Kill Node.")
self.workflow.nodes[kill_node.attrib["name"]] = p_node
self.workflow.dependencies.update(mapper.required_imports())
def test_create_dag_file(self, black_mock, open_mock, _):
workflow = Workflow(
dag_name="A",
input_directory_path="in_dir",
output_directory_path="out_dir",
relations={Relation(from_task_id="AAA", to_task_id="BBB")},
nodes=dict(
AAA=ParsedNode(DummyMapper(ET.Element("dummy"), name="AAA"))),
dependencies={"import AAAA"},
)
self.converter.create_dag_file(workflow)
open_mock.assert_called_once_with("/tmp/test_dag.py", "w")
black_mock.format_file_in_place.assert_called_once_with(
Path("/tmp/test_dag.py"),
fast=mock.ANY,
mode=mock.ANY,
write_back=mock.ANY)
def parse_action_node(self, action_node: ET.Element):
"""
Action nodes are the mechanism by which a workflow triggers the
execution of a computation/processing task.
Action nodes are required to have an action-choice (map-reduce, etc.),
ok, and error node in the xml.
"""
# The 0th element of the node is the actual action tag.
# In the form of 'action'
action_operation_node = action_node[0]
action_name = action_operation_node.tag
if action_name not in self.action_map:
action_name = "unknown"
map_class = self.action_map[action_name]
mapper = map_class(
oozie_node=action_operation_node,
name=action_node.attrib["name"],
params=self.params,
dag_name=self.workflow.dag_name,
action_mapper=self.action_map,
control_mapper=self.control_map,
input_directory_path=self.workflow.input_directory_path,
output_directory_path=self.workflow.output_directory_path,
)
p_node = ParsedNode(mapper)
ok_node = action_node.find("ok")
if ok_node is None:
raise Exception("Missing ok node in {}".format(action_node))
p_node.add_downstream_node_name(ok_node.attrib["to"])
error_node = action_node.find("error")
if error_node is None:
raise Exception("Missing error node in {}".format(action_node))
p_node.set_error_node_name(error_node.attrib["to"])
mapper.on_parse_node()
logging.info(f"Parsed {mapper.name} as Action Node of type {action_name}.")
self.workflow.dependencies.update(mapper.required_imports())
self.workflow.nodes[mapper.name] = p_node