first version of Workflow::to_mermaid method

[maximilien]

Closes issue #290

• implements Workflow::to_mermaid
• includes a new Mermaid class where all the code is
• includes both mermaid markdown for sequenceDiagram and flowchart
• includes tests

Only tested with tests/yamsl/workflows/simple_workflow.yaml but should work for the others. If not please open bug.

Also, does not include representation for loop or condition or exception or on events. I will address these in issue #297

[akihikokuroda]

It looks good. I tried some other workflow files. Some of them got exceptions because the agent is not required in the step. Would you change the ['agent'] to .get('agent') not to cause the exception.

--- a/maestro/src/mermaid.py
+++ b/maestro/src/mermaid.py
@@ -53,15 +53,15 @@ class Mermaid:
     def __to_sequenceDiagram(self, sb):
         sb += "sequenceDiagram\n"

-        for agent in self.workflow['spec']['template']['agents']:
+        for agent in self.workflow['spec']['template'].get('agents'):
             sb += f"participant {agent}\n"

         steps, i = self.workflow['spec']['template']['steps'], 0
         for step in steps:
-            agentL = step['agent']
+            agentL = step.get('agent')
             agentR = None
             if i < (len(steps) - 1):
-                agentR = steps[i+1]['agent']
+                agentR = steps[i+1].get('agent')
             if agentR != None:
                 sb += f"{agentL}->>{agentR}: {step['name']}\n"
             else:
@@ -84,10 +84,10 @@ class Mermaid:
         steps, i = self.workflow['spec']['template']['steps'], 0

         for step in steps:
-            agentL = step['agent']
+            agentL = step.get('agent')
             agentR = None
             if i < (len(steps) - 1):
-                agentR = steps[i+1]['agent']
+                agentR = steps[i+1].get('agent')
             if agentR != None:
                 sb += f"{agentL}-- {step['name']} -->{agentR}\n"
             else:

[maximilien]

Will do. Thx

[maximilien]

@akihikokuroda should be good to go!

[akihikokuroda]

LGTM!