Implement hooks for failure scenarios: crash_hook, cancel_hook, fail_hook

easybuild/main.py

@@ -69,9 +69,10 @@
 from easybuild.tools.github import add_pr_labels, install_github_token, list_prs, merge_pr, new_branch_github, new_pr
 from easybuild.tools.github import new_pr_from_branch
 from easybuild.tools.github import sync_branch_with_develop, sync_pr_with_develop, update_branch, update_pr
-from easybuild.tools.hooks import BUILD_AND_INSTALL_LOOP, PRE_PREF, POST_PREF, START, END, load_hooks, run_hook
+from easybuild.tools.hooks import BUILD_AND_INSTALL_LOOP, PRE_PREF, POST_PREF, CRASH, START, \
+     END, CANCEL, FAIL, load_hooks, run_hook
 from easybuild.tools.modules import modules_tool
-from easybuild.tools.options import opts_dict_to_eb_opts, set_up_configuration, use_color
+from easybuild.tools.options import opts_dict_to_eb_opts, parse_options, set_up_configuration, use_color
 from easybuild.tools.output import COLOR_GREEN, COLOR_RED, STATUS_BAR, colorize, print_checks, rich_live_cm
 from easybuild.tools.output import start_progress_bar, stop_progress_bar, update_progress_bar
 from easybuild.tools.robot import check_conflicts, dry_run, missing_deps, resolve_dependencies, search_easyconfigs
@@ -732,9 +733,16 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
 
 
 if __name__ == "__main__":
+    eb_go = parse_options()
+    hooks = load_hooks(eb_go.options.hooks)
     try:
         main()
     except EasyBuildError as err:
+        run_hook(FAIL, hooks, args=[err])
         print_error(err.msg)
     except KeyboardInterrupt as err:
+        run_hook(CANCEL, hooks, args=[err])
         print_error("Cancelled by user: %s" % err)
+    except Exception as err:
+        run_hook(CRASH, hooks, args=[err])
+        print_error("Encountered an unrecoverable error: %s" % err)

easybuild/tools/hooks.py

@@ -66,6 +66,10 @@
 MODULE_WRITE = 'module_write'
 END = 'end'
 
+FAIL = 'fail'
+CANCEL = 'cancel'
+CRASH = 'crash'
+
 PRE_PREF = 'pre_'
 POST_PREF = 'post_'
 HOOK_SUFF = '_hook'
@@ -101,6 +105,9 @@
      for p in [PRE_PREF, POST_PREF]] + [
     POST_PREF + BUILD_AND_INSTALL_LOOP,
     END,
+    FAIL,
+    CANCEL,
+    CRASH,
 ]
 KNOWN_HOOKS = [h + HOOK_SUFF for h in HOOK_NAMES]
 

test/framework/options.py

@@ -719,6 +719,9 @@ def test_avail_hooks(self):
             "	post_testcases_hook",
             "	post_build_and_install_loop_hook",
             "	end_hook",
+            "	fail_hook",
+            "	cancel_hook",
+            "	crash_hook",
             '',
         ])
         self.assertEqual(stdout, expected)