Proposed way to add breakpoints to easybuild

easybuild/tools/config.py

@@ -231,6 +231,7 @@ def mk_full_default_path(name, prefix=DEFAULT_PREFIX):
         'amdgcn_capabilities',
         'backup_modules',
         'banned_linked_shared_libs',
+        'breakpoints',
         'checksum_priority',
         'container_config',
         'container_image_format',

easybuild/tools/hooks.py

@@ -220,6 +220,17 @@ def find_hook(label, hooks, pre_step_hook=False, post_step_hook=False):
     return res
 
 
+def _breakpoint():
+    """Simple breakpoint hook that opens a bash shell."""
+    old_ps1 = os.environ.get('PS1', '')
+    old_promptcmd = os.environ.get('PROMPT_COMMAND', '')
+    os.environ['PROMPT_COMMAND'] = ''
+    os.environ['PS1'] = 'easybuild-breakpoint> '
+    os.system('bash --norc --noprofile')
+    os.environ['PS1'] = old_ps1
+    os.environ['PROMPT_COMMAND'] = old_promptcmd
+
+
 def run_hook(label, hooks, pre_step_hook=False, post_step_hook=False, args=None, kwargs=None, msg=None):
     """
     Run hook with specified label and return result of calling the hook or None.
@@ -231,6 +242,17 @@ def run_hook(label, hooks, pre_step_hook=False, post_step_hook=False, args=None,
     :param args: arguments to pass to hook function
     :param msg: custom message that is printed when hook is called
     """
+    breakpoints = build_option('breakpoints')
+    bk_hooks = {}
+    if breakpoints:
+        for bk in breakpoints:
+            if not bk.endswith(HOOK_SUFF):
+                bk += HOOK_SUFF
+            bk_hooks[bk] = lambda *a, **k: _breakpoint()
+    bp_hook = find_hook(label, bk_hooks, pre_step_hook=pre_step_hook, post_step_hook=post_step_hook)
+    if bp_hook:
+        bp_hook()
+
     hook = find_hook(label, hooks, pre_step_hook=pre_step_hook, post_step_hook=post_step_hook)
     res = None
     if hook:

easybuild/tools/options.py

@@ -627,6 +627,10 @@ def config_options(self):
                                     None, "store_true", False,),
             'avail-repositories': ("Show all repository types (incl. non-usable)",
                                    None, "store_true", False,),
+            'breakpoints': (
+                "Drop into an interactive shell on the specified steps (use same names as for hooks comma separated)",
+                'strlist', 'store', None
+            ),
             'buildpath': ("Temporary build path", None, 'store', mk_full_default_path('buildpath')),
             'containerpath': ("Location where container recipe & image will be stored", None, 'store',
                               mk_full_default_path('containerpath')),