Merge pull request #956 from douglasjacobsen/prevent-strip-expander

Move `lstrip` from expander to output capture suffix

Author: douglasjacobsen

lib/ramble/ramble/application.py

@@ -1143,7 +1143,7 @@ def _define_commands(
                         suffix_part = f"{redirect}{bg_cmd}"
 
                         expanded_cmd = self.expander.expand_var(command_part, exec_vars)
-                        suffix_cmd = self.expander.expand_var(suffix_part, exec_vars)
+                        suffix_cmd = self.expander.expand_var(suffix_part, exec_vars).lstrip()
 
                         self._command_list.append(expanded_cmd + " " + suffix_cmd)
                         self._command_list_without_logs.append(expanded_cmd)

lib/ramble/ramble/expander.py

@@ -597,7 +597,7 @@ def expand_var(
         try:
             value = self._partial_expand(
                 expansions, str(var), allow_passthrough=passthrough_setting
-            ).lstrip()
+            )
         except RamblePassthroughError as e:
             if not passthrough_setting:
                 raise RambleSyntaxError(

lib/ramble/ramble/test/end_to_end/formatted_executables.py

@@ -190,3 +190,92 @@ def test_object_formatted_executables(mock_modifiers, request):
     with open(exec_path) as f:
         data = f.read()
         assert '    FROM_MOD echo "Test formatted exec"' in data
+
+
+def test_nested_formatted_executables_are_properly_formatted(request):
+    test_config = r"""
+ramble:
+  variables:
+    mpi_command: 'mpirun -n {n_ranks} -ppn {processes_per_node}'
+    batch_submit: '{execute_experiment}'
+    processes_per_node: '16'
+    n_threads: '1'
+  formatted_executables:
+    level_one:
+      prefix: 'test_l1 '
+      indentation: 2
+      join_separator: '\n'
+      commands:
+      - 'l1line1'
+      - 'l1line2'
+      - 'l1line3'
+    level_two:
+      prefix: 'test_l2 '
+      join_separator: '\n'
+      indentation: 2
+      commands:
+      - 'l2line1'
+      - 'l2line2'
+      - '{level_one}'
+    level_three:
+      prefix: 'test_l3 '
+      join_separator: '\n'
+      indentation: 2
+      commands:
+      - 'l3line1'
+      - '{level_two}'
+  applications:
+    basic:
+      workloads:
+        working_wl:
+          experiments:
+            simple_test:
+              variables:
+                n_nodes: 1
+  software:
+    packages: {}
+    environments: {}
+"""
+    workspace_name = request.node.name
+    with ramble.workspace.create(workspace_name) as ws:
+        ws.write()
+
+        config_path = os.path.join(ws.config_dir, ramble.workspace.config_file_name)
+
+        with open(config_path, "w+") as f:
+            f.write(test_config)
+
+        with open(os.path.join(ws.config_dir, "execute_experiment.tpl"), "w+") as f:
+            f.write("{level_three}\n")
+            f.write("\n\n    {level_three}\n")
+        ws._re_read()
+
+        workspace("setup", "--dry-run", global_args=["-w", workspace_name])
+
+        experiment_root = ws.experiment_dir
+        exp_dir = os.path.join(experiment_root, "basic", "working_wl", "simple_test")
+        exp_script = os.path.join(exp_dir, "execute_experiment")
+
+        import re
+
+        test_regexes = [
+            re.compile(r"^  test_l3 l3line1$"),
+            re.compile(r"^  test_l3   test_l2 l2line1$"),
+            re.compile(r"^  test_l3   test_l2   test_l1 l1line1$"),
+            re.compile(r"^      test_l3 l3line1$"),
+        ]
+
+        tests = [
+            False,
+            False,
+            False,
+            False,
+        ]
+
+        with open(exp_script) as f:
+            for line in f.readlines():
+                for idx, regex in enumerate(test_regexes):
+                    if regex.search(line):
+                        tests[idx] = True
+
+        assert all(tests)