suggest 'extract' as as correct step name instead of 'source' when used in skipsteps

Author: boegel

easybuild/framework/easyconfig/easyconfig.py

@@ -72,7 +72,7 @@
 from easybuild.tools.filetools import convert_name, copy_file, create_index, decode_class_name, encode_class_name
 from easybuild.tools.filetools import find_backup_name_candidate, find_easyconfigs, load_index
 from easybuild.tools.filetools import read_file, write_file
-from easybuild.tools.hooks import PARSE, STEP_NAMES, load_hooks, run_hook
+from easybuild.tools.hooks import PARSE, EXTRACT_STEP, STEP_NAMES, load_hooks, run_hook
 from easybuild.tools.module_naming_scheme.mns import DEVEL_MODULE_SUFFIX
 from easybuild.tools.module_naming_scheme.utilities import avail_module_naming_schemes, det_full_ec_version
 from easybuild.tools.module_naming_scheme.utilities import det_hidden_modname, is_valid_module_name
@@ -871,6 +871,10 @@ def validate(self, check_osdeps=True):
                 error_line = "* %s" % step
                 # try to find close match, may be just a typo in the step name
                 close_matches = difflib.get_close_matches(step, STEP_NAMES, 2, 0.8)
+                # 'source' step was renamed to 'extract' in EasyBuild 5.0, see provide a useful suggestion in that case;
+                # see https://github.com/easybuilders/easybuild-framework/pull/4629
+                if not close_matches and step == 'source':
+                    close_matches.append(EXTRACT_STEP)
                 if close_matches:
                     error_line += " (did you mean %s?)" % ', or '.join("'%s'" % s for s in close_matches)
                 error_lines.append(error_line)

easybuild/tools/hooks.py

@@ -44,6 +44,7 @@
 CLEANUP_STEP = 'cleanup'
 CONFIGURE_STEP = 'configure'
 EXTENSIONS_STEP = 'extensions'
+EXTRACT_STEP = 'extract'
 FETCH_STEP = 'fetch'
 INSTALL_STEP = 'install'
 MODULE_STEP = 'module'
@@ -55,7 +56,6 @@
 PREPARE_STEP = 'prepare'
 READY_STEP = 'ready'
 SANITYCHECK_STEP = 'sanitycheck'
-EXTRACT_STEP = 'extract'
 TEST_STEP = 'test'
 TESTCASES_STEP = 'testcases'
 

test/framework/options.py

@@ -411,7 +411,7 @@ def test_skipsteps(self):
         # see https://github.com/easybuilders/easybuild-framework/pull/4629
         test_ec_txt += "\nskipsteps = ['source']\n"
         write_file(test_ec, test_ec_txt)
-        error_pattern = error_pattern.replace('wrong-step-name', 'source')
+        error_pattern = error_pattern.replace('wrong-step-name', r"source \(did you mean 'extract'\?\)")
         self.assertErrorRegex(EasyBuildError, error_pattern, self.eb_main, args, do_build=True, raise_error=True)
 
         # check use of skipsteps to skip sanity check