Merge pull request #4908 from boegel/post_run_shell_cmd

trigger `post_run_shell_cmd_hook` before raising error if shell command failed + pass down full `RunShellCmdResult` instance

Author: ocaisa

easybuild/tools/run.py

@@ -589,6 +589,17 @@ def to_cmd_str(cmd):
                             work_dir=work_dir, out_file=cmd_out_fp, err_file=cmd_err_fp, cmd_sh=cmd_sh,
                             thread_id=thread_id, task_id=task_id)
 
+    if with_hooks:
+        run_hook_kwargs = {
+            'exit_code': res.exit_code,
+            'interactive': interactive,
+            'output': res.output,
+            'stderr': res.stderr,
+            'work_dir': res.work_dir,
+            'shell_cmd_result': res,
+        }
+        run_hook(RUN_SHELL_CMD, hooks, post_step_hook=True, args=[cmd], kwargs=run_hook_kwargs)
+
     # always log command output
     cmd_name = cmd_str.split(' ')[0]
     if split_stderr:
@@ -618,16 +629,6 @@ def to_cmd_str(cmd):
         except OSError as err:
             raise EasyBuildError(f"Failed to return to {initial_work_dir} after executing command `{cmd_str}`: {err}")
 
-    if with_hooks:
-        run_hook_kwargs = {
-            'exit_code': res.exit_code,
-            'interactive': interactive,
-            'output': res.output,
-            'stderr': res.stderr,
-            'work_dir': res.work_dir,
-        }
-        run_hook(RUN_SHELL_CMD, hooks, post_step_hook=True, args=[cmd], kwargs=run_hook_kwargs)
-
     if not hidden:
         time_since_start = time_str_since(start_time)
         trace_msg(f"command completed: exit {res.exit_code}, ran in {time_since_start}")

test/framework/run.py

@@ -2068,7 +2068,7 @@ def pre_run_shell_cmd_hook(cmd, *args, **kwargs):
                     print("pre-run hook '%s' in %s" % (cmd, work_dir))
                     import sys
                     sys.stderr.write('pre-run hook done\\n')
-                if not cmd.startswith('echo'):
+                if cmd != 'false' and not cmd.startswith('echo'):
                     cmds = cmd.split(';')
                     return '; '.join(cmds[:-1] + ["echo " + cmds[-1].lstrip()])
 
@@ -2126,6 +2126,18 @@ def post_run_shell_cmd_hook(cmd, *args, **kwargs):
         regex = re.compile('>> running shell command:\n\techo make', re.M)
         self.assertTrue(regex.search(stdout), "Pattern '%s' found in: %s" % (regex.pattern, stdout))
 
+        with self.mocked_stdout_stderr():
+            # run_shell_cmd will raise RunShellCmdError which we don't care about here,
+            # we just want to verify that the post_run_shell_cmd_hook has run
+            try:
+                run_shell_cmd("false")
+            except RunShellCmdError:
+                pass
+            stdout = self.get_stdout()
+
+        expected_last_line = "\npost-run hook 'false' (exit code: 1, output: '')\n"
+        self.assertTrue(stdout.endswith(expected_last_line), f"Stdout should end with '{expected_last_line}': {stdout}")
+
     def test_run_shell_cmd_delete_cwd(self):
         """
         Test commands that destroy directories inside initial working directory