Merge pull request #3107 from boegel/extensions_opt_in

make including 'extensions' statement in generated Lua module files opt-in for now

Author: akesandgren

easybuild/tools/config.py

@@ -228,6 +228,7 @@ def mk_full_default_path(name, prefix=DEFAULT_PREFIX):
         'lib64_fallback_sanity_check',
         'logtostdout',
         'minimal_toolchains',
+        'module_extensions',
         'module_only',
         'package',
         'read_only_installdir',

easybuild/tools/module_generator.py

@@ -1159,13 +1159,14 @@ def get_description(self, conflict=True):
         for line in self._generate_whatis_lines():
             whatis_lines.append("whatis(%s%s%s)" % (self.START_STR, self.check_str(line), self.END_STR))
 
-        extensions_list = self._generate_extensions_list()
-
-        if extensions_list:
-            extensions_stmt = 'extensions(%s)' % ', '.join(['"%s"' % x for x in extensions_list])
-            # put this behind a Lmod version check as 'extensions' is only supported since Lmod 8.2.0,
-            # see https://lmod.readthedocs.io/en/latest/330_extensions.html#module-extensions
-            lines.extend(['', self.conditional_statement(self.check_version("8", "2"), extensions_stmt)])
+        if build_option('module_extensions'):
+            extensions_list = self._generate_extensions_list()
+
+            if extensions_list:
+                extensions_stmt = 'extensions(%s)' % ', '.join(['"%s"' % x for x in extensions_list])
+                # put this behind a Lmod version check as 'extensions' is only supported since Lmod 8.2.0,
+                # see https://lmod.readthedocs.io/en/latest/330_extensions.html#module-extensions
+                lines.extend(['', self.conditional_statement(self.check_version("8", "2"), extensions_stmt)])
 
         txt += '\n'.join([''] + lines + ['']) % {
             'name': self.app.name,

easybuild/tools/options.py

@@ -475,6 +475,8 @@ def config_options(self):
             'module-depends-on': ("Use depends_on (Lmod 7.6.1+) for dependencies in all generated modules "
                                   "(implies recursive unloading of modules).",
                                   None, 'store_true', False),
+            'module-extensions': ("Include 'extensions' statement in generated module file (Lua syntax only)",
+                                  None, 'store_true', False),
             'module-naming-scheme': ("Module naming scheme to use", None, 'store', DEFAULT_MNS),
             'module-syntax': ("Syntax to be used for module files", 'choice', 'store', DEFAULT_MODULE_SYNTAX,
                               sorted(avail_module_generators().keys())),

test/framework/module_generator.py

@@ -701,6 +701,9 @@ def test_module_extensions(self):
         if self.MODULE_GENERATOR_CLASS == ModuleGeneratorTcl:
             return
 
+        # currently requires opt-in via --module-extensions
+        init_config(build_options={'module_extensions': True})
+
         test_dir = os.path.abspath(os.path.dirname(__file__))
         os.environ['MODULEPATH'] = os.path.join(test_dir, 'modules')
         test_ec = os.path.join(test_dir, 'easyconfigs', 'test_ecs', 't', 'toy', 'toy-0.0-gompi-2018a-test.eb')