Add option to dump workflow spec (#29)

CHANGELOG.md → CHANGES.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v0.1.9
+
+1. Moved argparse logic out of script task and into runner
+1. Added option --dump-spec to dump the workflow spec
+1. Bump to SpiffWorkflow 3.0.0rc2
+
 ## v0.1.8
 
 1. Fixed issue when `$EDITOR` contained spaces

VERSION

@@ -1 +1 @@
-0.1.8
+0.1.9

requirements.txt

@@ -1 +1 @@
-SpiffWorkflow==2.0.1
+SpiffWorkflow==3.0.0rc2

src/git_debranch/bpmn/git-debranch/all_branches.bpmn

@@ -17,7 +17,8 @@
           </spiffworkflow:parameters>
         </spiffworkflow:serviceTaskOperator>
         <spiffworkflow:preScript>spawn_args = ["git", "fetch", "-p"]</spiffworkflow:preScript>
-        <spiffworkflow:postScript>del(spawn_args)</spiffworkflow:postScript>
+        <spiffworkflow:postScript>del(spawn_args)
+del(result)</spiffworkflow:postScript>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1pz1noe</bpmn:incoming>
       <bpmn:outgoing>Flow_1ogqfb8</bpmn:outgoing>

src/git_debranch/console_scripts.py

@@ -1,10 +1,14 @@
-import argparse
 import sys
 
 from git_debranch import workflow
 
 def main():
-    result = workflow.run(sys.argv)
+    argv = sys.argv
+    if "--dump-spec" in argv:
+        print(workflow.spec_json())
+        exit(0)
+
+    result = workflow.run(argv)
 
     if result.stderr:
         print(result.stderr, file=sys.stderr)

src/git_debranch/runner.py

@@ -8,7 +8,7 @@
 
 def run_workflow(workflow):
     while not workflow.is_completed():
-        tasks = workflow.get_tasks(TaskState.READY)
+        tasks = workflow.get_tasks(state=TaskState.READY)
         task = tasks[0] if len(tasks) > 0 else None
         if task is None:
             break

src/git_debranch/script_engine.py

@@ -1,7 +1,7 @@
 import json
 import subprocess
 
-from SpiffWorkflow.bpmn.PythonScriptEngine import PythonScriptEngine
+from SpiffWorkflow.bpmn.script_engine import PythonScriptEngine
 
 class CustomScriptEngine(PythonScriptEngine):
     def call_service(self, operation_name, operation_params, task_data):

src/git_debranch/workflow.py

@@ -1,6 +1,10 @@
+import json
+
 from dataclasses import dataclass
 
+from SpiffWorkflow.bpmn.serializer.workflow import BpmnWorkflowSerializer
 from SpiffWorkflow.bpmn.specs.control import BpmnStartTask
+from SpiffWorkflow.spiff.serializer.config import SPIFF_CONFIG
 
 from git_debranch.loader import load_workflow
 from git_debranch.runner import run_workflow
@@ -27,3 +31,15 @@ def run(argv):
     returncode = result.get("returncode", 0 if completed else -1)
     return WorkflowResult(completed, stderr, stdout, returncode)
 
+def spec_json():
+    registry = BpmnWorkflowSerializer.configure(SPIFF_CONFIG)
+    serializer = BpmnWorkflowSerializer(registry=registry)
+    workflow = load_workflow()
+    workflow_dct = serializer.to_dict(workflow)
+    workflow_specs_dct = {
+        "serializer_version": "jbirddog/git-debranch",
+        "spec": workflow_dct["spec"],
+        "subprocess_specs": workflow_dct["subprocess_specs"],
+    }
+    return json.dumps(workflow_specs_dct, sort_keys=True, indent=2)
+