add test to verify that sanity check for extensions is also run with --module-only, unless --force is used

Author: boegel

test/framework/toy_build.py

@@ -51,7 +51,7 @@
 from easybuild.tools.build_log import EasyBuildError
 from easybuild.tools.config import get_module_syntax, get_repositorypath
 from easybuild.tools.environment import modify_env
-from easybuild.tools.filetools import adjust_permissions, change_dir, copy_file, mkdir
+from easybuild.tools.filetools import adjust_permissions, change_dir, copy_file, mkdir, move_file
 from easybuild.tools.filetools import read_file, remove_dir, remove_file, which, write_file
 from easybuild.tools.module_generator import ModuleGeneratorTcl
 from easybuild.tools.modules import Lmod
@@ -1682,6 +1682,58 @@ def test_module_only(self):
             modtxt = read_file(toy_mod + '.lua')
             self.assertTrue(re.search('load.*intel/2018a', modtxt), "load statement for intel/2018a found in module")
 
+    def test_module_only_extensions(self):
+        """
+        Test use of --module-only with extensions involved.
+        Sanity check should catch problems with extensions,
+        extensions can be skipped using --skip-exts.
+        """
+        topdir = os.path.abspath(os.path.dirname(__file__))
+        toy_ec = os.path.join(topdir, 'easyconfigs', 'test_ecs', 't', 'toy', 'toy-0.0.eb')
+
+        toy_mod = os.path.join(self.test_installpath, 'modules', 'all', 'toy', '0.0')
+        if get_module_syntax() == 'Lua':
+            toy_mod += '.lua'
+
+        test_ec = os.path.join(self.test_prefix, 'test.ec')
+        test_ec_txt = read_file(toy_ec)
+        test_ec_txt += '\n' + '\n'.join([
+            "sanity_check_commands = ['barbar', 'toy']",
+            "sanity_check_paths = {'files': ['bin/barbar', 'bin/toy'], 'dirs': ['bin']}",
+            "exts_list = [",
+            "    ('barbar', '0.0', {",
+            "        'start_dir': 'src',",
+            "        'exts_filter': ('ls -l lib/lib%(ext_name)s.a', ''),",
+            "    })",
+            "]",
+        ])
+        write_file(test_ec, test_ec_txt)
+
+        # clean up $MODULEPATH to only modules in test prefix dir are found
+        self.reset_modulepath([os.path.join(self.test_installpath, 'modules', 'all')])
+        self.assertEqual(self.modtool.available('toy'), [])
+
+        # install toy/0.0
+        self.eb_main([test_ec], do_build=True, raise_error=True)
+
+        # remove module file so we can try --module-only
+        remove_file(toy_mod)
+
+        # rename file required for barbar extension, so we can check whether sanity check catches it
+        libbarbar = os.path.join(self.test_installpath, 'software', 'toy', '0.0', 'lib', 'libbarbar.a')
+        move_file(libbarbar, libbarbar + '.foobar')
+
+        # check whether sanity check fails now when using --module-only
+        error_pattern = 'Sanity check failed: command "ls -l lib/libbarbar.a" failed'
+        for extra_args in (['--module-only'], ['--module-only', '--rebuild']):
+            self.assertErrorRegex(EasyBuildError, error_pattern, self.eb_main, [test_ec] + extra_args,
+                                  do_build=True, raise_error=True)
+        self.assertFalse(os.path.exists(toy_mod))
+
+        # we can force module generation via --force (which skips sanity check entirely)
+        self.eb_main([test_ec, '--module-only', '--force'], do_build=True, raise_error=True)
+        self.assertTrue(os.path.exists(toy_mod))
+
     def test_backup_modules(self):
         """Test use of backing up of modules with --module-only."""