zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modules tcl: fix autoload mechanism in template (#36237)

Browse Source 
Adapt tcl modulefile template to call "module load" on autoload
dependency without testing if this dependency is already loaded or not.

The is-loaded test is not necessary, as module commands know how to cope
with an already loaded module. With environment-modules 4.2+ (released
in 2018) it is also important to have this "module load" command even if
dependency is already loaded in order to record that the modulefile
declares such dependency. This is important if you want to keep a
consistent environment when a dependent module is unloaded.

The "Autoloading" verbose message is also removed as recent module
commands will report such information to the user (depending on the
verbosity configured for the module command).

Such change has been test successfully with Modules 3.2 (EL7), 4.5 (EL8)
and 5.2 (latest) and also with Lmod 7 and 8 (as it is mentionned in
Spack docs that Lmod can be used along with tcl modules). Dependencies
are correctly loaded or unloaded, whether they are loaded/unloaded or
not.

This change fixes Tcl quoting issue introduced in #32853.

Fixes #19155.
This commit is contained in:
Xavier Delaruelle 2023-03-20 09:23:40 +01:00 committed by GitHub
parent 1af863a1e3
commit 41d7fe0a50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/spack/spack/test/modules/tcl.py
View File

@ -37,7 +37,6 @@ def test_autoload_direct(self, modulefile_content, module_configuration):
module_configuration("autoload_direct")
content = modulefile_content(mpileaks_spec_string)
assert len([x for x in content if "is-loaded" in x]) == 2
assert len([x for x in content if "module load " in x]) == 2
# dtbuild1 has
@ -47,7 +46,6 @@ def test_autoload_direct(self, modulefile_content, module_configuration):
# Just make sure the 'build' dependency is not there
content = modulefile_content("dtbuild1")
assert len([x for x in content if "is-loaded" in x]) == 2
assert len([x for x in content if "module load " in x]) == 2
# The configuration file sets the verbose keyword to False
@ -60,7 +58,6 @@ def test_autoload_all(self, modulefile_content, module_configuration):
module_configuration("autoload_all")
content = modulefile_content(mpileaks_spec_string)
assert len([x for x in content if "is-loaded" in x]) == 5
assert len([x for x in content if "module load " in x]) == 5
# dtbuild1 has
@ -70,13 +67,8 @@ def test_autoload_all(self, modulefile_content, module_configuration):
# Just make sure the 'build' dependency is not there
content = modulefile_content("dtbuild1")
assert len([x for x in content if "is-loaded" in x]) == 2
assert len([x for x in content if "module load " in x]) == 2
# The configuration file sets the verbose keyword to True
messages = [x for x in content if 'puts stderr "Autoloading' in x]
assert len(messages) == 2
def test_prerequisites_direct(self, modulefile_content, module_configuration):
"""Tests asking direct dependencies as prerequisites."""
@ -113,7 +105,6 @@ def test_alter_environment(self, modulefile_content, module_configuration, confi
assert len([x for x in content if x.startswith("prepend-path CMAKE_PREFIX_PATH")]) == 0
assert len([x for x in content if 'setenv FOO "foo"' in x]) == 0
assert len([x for x in content if "unsetenv BAR" in x]) == 0
assert len([x for x in content if "is-loaded 'foo/bar'" in x]) == 1
assert len([x for x in content if "module load foo/bar" in x]) == 1
assert len([x for x in content if "setenv LIBDWARF_ROOT" in x]) == 1
@ -124,7 +115,6 @@ def test_exclude(self, modulefile_content, module_configuration, config_name):
module_configuration(config_name)
content = modulefile_content("mpileaks ^zmpi")
assert len([x for x in content if "is-loaded" in x]) == 1
assert len([x for x in content if "module load " in x]) == 1
# Catch "Exception" to avoid using FileNotFoundError on Python 3
@ -135,7 +125,6 @@ def test_exclude(self, modulefile_content, module_configuration, config_name):
content = modulefile_content("zmpi target=x86_64")
assert len([x for x in content if "is-loaded" in x]) == 1
assert len([x for x in content if "module load " in x]) == 1
def test_naming_scheme_compat(self, factory, module_configuration):
@ -352,11 +341,11 @@ def test_autoload_with_constraints(self, modulefile_content, module_configuratio
# Test the mpileaks that should have the autoloaded dependencies
content = modulefile_content("mpileaks ^mpich2")
assert len([x for x in content if "is-loaded" in x]) == 2
assert len([x for x in content if "module load " in x]) == 2
# Test the mpileaks that should NOT have the autoloaded dependencies
content = modulefile_content("mpileaks ^mpich")
assert len([x for x in content if "is-loaded" in x]) == 0
assert len([x for x in content if "module load " in x]) == 0
def test_modules_no_arch(self, factory, module_configuration):
module_configuration("no_arch")

7
share/spack/templates/modules/modulefile.tcl
View File

@ -23,12 +23,7 @@ proc ModulesHelp { } {
{% block autoloads %}
{% for module in autoload %}
if {{ '{' }} ![ is-loaded '{{ module }}' ] {{ '}' }} {{ '{' }}
{% if verbose %}
puts stderr "Autoloading {{ module }}"
{% endif %}
module load {{ module }}
{{ '}' }}
module load {{ module }}
{% endfor %}
{% endblock %}
{# #}