Mirrors/ansible-playbook-grapher
2
0
Fork 0
mirror of https://github.com/haidaraM/ansible-playbook-grapher synced 2024-11-10 06:04:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore: type annotations + update signatures

Browse source
This commit is contained in:
Mohamed El Mouctar HAIDARA 2021-09-19 19:22:23 +02:00
parent 790bacdb00
commit 7a92fe8e7a
2 changed files with 20 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
ansibleplaybookgrapher/graph.py
View file

@ -42,7 +42,7 @@ class CompositeNode(Node):
@property
def total_length(self) -> int:
"""
Return the total length of elements in this Composite node
Return the total length of elements in this composite node
:return:
"""
return sum([len(val) for val in self._compositions.values()])
@ -83,8 +83,8 @@ class PlaybookNode(CompositeNode):
A playbook is a list of play
"""
def __init__(self, node_label: str, plays: List['PlayNode'] = None):
super().__init__(node_label, generate_id())
def __init__(self, node_label: str, plays: List['PlayNode'] = None, node_id: str = None):
super().__init__(node_label, node_id or generate_id("playbook_"))
self._compositions['plays'] = plays or []
@property
@ -116,30 +116,29 @@ class PlayNode(CompositeNode):
- post_tasks
"""
def __init__(self, node_label: str, node_id: str = None, hosts: List[str] = None):
def __init__(self, node_label: str, hosts: List[str] = None, node_id: str = None):
"""
:param node_label:
:param node_id:
:param hosts: List of hosts attached to the play
"""
play_id = node_id or generate_id("play_")
super().__init__(node_label, play_id)
super().__init__(node_label, node_id or generate_id("play_"))
self.hosts = hosts or []
@property
def roles(self):
def roles(self) -> List['EdgeNode']:
return self._compositions["roles"]
@property
def pre_tasks(self):
def pre_tasks(self) -> List['EdgeNode']:
return self._compositions["pre_tasks"]
@property
def post_tasks(self):
def post_tasks(self) -> List['EdgeNode']:
return self._compositions["post_tasks"]
@property
def tasks(self):
def tasks(self) -> List['EdgeNode']:
return self._compositions["tasks"]
@ -148,8 +147,15 @@ class EdgeNode(CompositeNode):
An edge between two nodes. It's a special case of composite node with only one composition with one element
"""
def __init__(self, node_label: str, source: Node, destination: Node):
super().__init__(node_label, generate_id("edge_"))
def __init__(self, node_label: str, source: Node, destination: Node, node_id: str = None):
"""
:param node_label: The edge label
:param source: The edge source node
:param destination: The edge destination node
:param node_id: The edge id
"""
super().__init__(node_label, node_id or generate_id("edge_"))
self.source = source
self.add_node("nodes", destination)

4
tests/test_postprocessor.py
View file

@ -89,7 +89,7 @@ def test_post_processor_without_graph_representation(post_processor: GraphVizPos
@pytest.mark.parametrize("post_processor", [SIMPLE_PLAYBOOK_SVG], indirect=True)
def test_post_processor_with_graph_representation(post_processor: GraphVizPostProcessor, tmpdir):
"""
Test the post processor a graph representation
Test the post processor for a graph representation
:param post_processor:
:param tmpdir:
:return:
@ -97,7 +97,7 @@ def test_post_processor_with_graph_representation(post_processor: GraphVizPostPr
playbook_node = PlaybookNode('')
svg_post_processed_path = tmpdir.join("simple_playbook_postprocess_graph.svg")
play = PlayNode("play 1", "play_hostsall")
play = PlayNode("play 1", node_id="play_hostsall")
playbook_node.add_node('plays', play)
task_1 = TaskNode("task 1")
task_2 = TaskNode("task 1")