feat(workflow): add support for multiline commands in "run" key

Before, it was not possible to create a workflow steps like:

- name: do_multiple_things
  run: |
    cd /some/long/path; \
      echo "hello world" > hello.txt; \
      cat hello.txt

- name: have_many_arguments
  run: |
    ./run_something.sh \
      --arg1 value1 \
      --arg2 value2 \
      --arg2 value3

This could end up forcing users to either have very long lines in the
workflow, if many arguments had to be given to a tool, *or* have a `cd`
prefix for every command in a list of commands if they all had to be
executed in a specific directory.

This commit adds multiline support, which follows the syntax of shell
scripts where a backslash (\) continues the command onto the next line.

Signed-off-by: Nadja Brix Koch <n.koch@samsung.com>

Author: NaddiNadja

src/cijoe/core/resources.py

@@ -380,7 +380,16 @@ def dict_normalize(topic: dict):
                 )
                 return errors
 
-            step["with"]["commands"] = step["run"].splitlines()
+            # non-empty lines in "run"
+            lines = filter(None, map(lambda l: l.strip(), step["run"].splitlines()))
+            step["with"]["commands"] = []
+            buffer = []
+
+            for line in lines:
+                buffer.append(line)
+                if not line.strip().endswith("\\"):
+                    step["with"]["commands"].append("\n".join(buffer))
+                    buffer = []
 
             del step["run"]
 

tests/core/test_workflow.py

@@ -118,3 +118,84 @@ def test_workflow_report_command_ordering(tmp_path):
     ):
         val = int(Path(key).stem.split("_")[1])
         assert count == val
+
+
+def test_workflow_run(tmp_path):
+    config_path = (tmp_path / "test-config-empty.toml").resolve()
+    config_path.write_text("")
+
+    data = copy.deepcopy(WORKFLOW_SKELETON)
+    data["steps"].append(
+        {
+            "name": "cmdrunner",
+            "run": """
+                echo hello
+                echo world
+            """,
+        }
+    )
+
+    output_path = (tmp_path / "output").resolve()
+    workflow_file = (tmp_path / "workflow.yaml").resolve()
+    workflow_file.write_text(yaml.dump(data))
+
+    result = subprocess.run(
+        [
+            "cijoe",
+            str(workflow_file),
+            "--output",
+            str(output_path),
+            "--config",
+            str(config_path),
+        ],
+        cwd=str(tmp_path),
+    )
+    assert result.returncode == 0
+
+    runlog = runlog_from_path(output_path / "002_cmdrunner")
+
+    assert len(runlog) == 2
+
+    for i, v in enumerate(runlog.values()):
+        if i == 0:
+            assert "hello" in v["output"]
+        elif i == 1:
+            assert "world" in v["output"]
+
+
+def test_workflow_run_multiline(tmp_path):
+    config_path = (tmp_path / "test-config-empty.toml").resolve()
+    config_path.write_text("")
+
+    data = copy.deepcopy(WORKFLOW_SKELETON)
+    data["steps"].append(
+        {
+            "name": "cmdrunner",
+            "run": """
+                echo hello \
+                  world
+            """,
+        }
+    )
+
+    output_path = (tmp_path / "output").resolve()
+    workflow_file = (tmp_path / "workflow.yaml").resolve()
+    workflow_file.write_text(yaml.dump(data))
+
+    result = subprocess.run(
+        [
+            "cijoe",
+            str(workflow_file),
+            "--output",
+            str(output_path),
+            "--config",
+            str(config_path),
+        ],
+        cwd=str(tmp_path),
+    )
+    assert result.returncode == 0
+
+    runlog = runlog_from_path(output_path / "002_cmdrunner")
+
+    assert len(runlog) == 1
+    assert "hello world" in runlog["cmd_01"]["output"]