Implement hooks for failure scenarios: crash_hook, cancel_hook, fail_hook

easybuild/main.py

@@ -69,7 +69,8 @@
 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
+from easybuild.tools.hooks import 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.output import COLOR_GREEN, COLOR_RED, STATUS_BAR, colorize, print_checks, rich_live_cm
@@ -579,9 +580,11 @@ def process_eb_args(eb_args, eb_go, cfg_settings, modtool, testing, init_session
     return overall_success
 
 
-def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
+def main(eb_go=None, cfg_settings=None, args=None, logfile=None, do_build=None, testing=False, modtool=None):
     """
     Main function: parse command line options, and act accordingly.
+    :param: eb_go: easybuild general options object
+    :param: cfg_settings: configuration settings of easybuild
     :param args: command line arguments to use
     :param logfile: log file to use
     :param do_build: whether or not to actually perform the build
@@ -590,6 +593,9 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
 
     register_lock_cleanup_signal_handlers()
 
+    if not all([eb_go, cfg_settings]):
+        eb_go, cfg_settings = set_up_configuration(args=args, logfile=logfile, testing=testing)
+
     # if $CDPATH is set, unset it, it'll only cause trouble...
     # see https://github.com/easybuilders/easybuild-framework/issues/2944
     if 'CDPATH' in os.environ:
@@ -602,7 +608,6 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
 
     # purposely session state very early, to avoid modules loaded by EasyBuild meddling in
     init_session_state = session_state()
-    eb_go, cfg_settings = set_up_configuration(args=args, logfile=logfile, testing=testing)
     options, orig_paths = eb_go.options, eb_go.args
 
     if 'python2' not in build_option('silence_deprecation_warnings'):
@@ -731,10 +736,29 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
         cleanup(logfile, eb_tmpdir, testing, silent=False)
 
 
+def prepare_main(args=None, logfile=None, testing=None):
+    """
+    Prepare Main: Set up eb_go and consequently, cfg_settings in order to obtain the hooks,
+    and prevent the configuration being set up twice.
+    :param args: command line arguments to take into account when parsing the EasyBuild configuration settings
+    :param logfile: log file to use
+    :param testing: enable testing mode
+    """
+    eb_go, cfg_settings = set_up_configuration(args=args, logfile=logfile, testing=testing)
+    return eb_go, cfg_settings
+
+
 if __name__ == "__main__":
+    eb_go, cfg_settings = prepare_main()
+    hooks = load_hooks(eb_go.options.hooks)
     try:
-        main()
+        main(eb_go, cfg_settings)
     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'
 
+CANCEL = 'cancel'
+CRASH = 'crash'
+FAIL = 'fail'
+
 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,
+    CANCEL,
+    CRASH,
+    FAIL,
 ]
 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",
+            "	cancel_hook",
+            "	crash_hook",
+            "	fail_hook",
             '',
         ])
         self.assertEqual(stdout, expected)