| 1 |
############################################################################## |
| 2 |
# Modules Revision 3.0 |
| 3 |
# Providing a flexible user environment |
| 4 |
# |
| 5 |
# File: modules.20-locate/%M% |
| 6 |
# Revision: %I% |
| 7 |
# First Edition: 2026/08/19 |
| 8 |
# Last Mod.: %U%, %G% |
| 9 |
# |
| 10 |
# Authors: Xavier Delaruelle, [email protected] |
| 11 |
# |
| 12 |
# Description: Testuite testsequence |
| 13 |
# Command: |
| 14 |
# Modulefiles: |
| 15 |
# Sub-Command: avail, load, is-avail |
| 16 |
# |
| 17 |
# Comment: %C{ |
| 18 |
# Check modulepath content ignore patterns defined with the |
| 19 |
# modulepath-ignore modulefile command |
| 20 |
# }C% |
| 21 |
# |
| 22 |
############################################################################## |
| 23 |
|
| 24 |
# ensure avail tests are made using in depth mode |
| 25 |
setenv_var MODULES_AVAIL_INDEPTH 1 |
| 26 |
|
| 27 |
# ensure avail tests have implicit default enabled |
| 28 |
setenv_var MODULES_IMPLICIT_DEFAULT 1 |
| 29 |
|
| 30 |
# ensure auto symbolic versions are set for these tests |
| 31 |
setenv_var MODULES_ADVANCED_VERSION_SPEC 1 |
| 32 |
|
| 33 |
# create modulepaths for tests |
| 34 |
set mp1 $env(HOME)/mpign1 |
| 35 |
set mp2 $env(HOME)/mpign2 |
| 36 |
set mp3 $env(HOME)/mpign3 |
| 37 |
set mfcontent "#%Module\nmodule-whatis \[module-info name\]" |
| 38 |
|
| 39 |
file mkdir $mp1/foo $mp1/bar $mp1/baz $mp1/helper |
| 40 |
set fid [open $mp1/.modulerc w] |
| 41 |
puts $fid "#%Module\nmodulepath-ignore *.tcl helper/ *.log" |
| 42 |
close $fid |
| 43 |
set fid [open $mp1/foo/.modulerc w] |
| 44 |
puts $fid "#%Module\nmodulepath-ignore 2*" |
| 45 |
close $fid |
| 46 |
set fid [open $mp1/baz/.version w] |
| 47 |
puts $fid "#%Module\nmodulepath-ignore 3*\nset ModulesVersion 1.0" |
| 48 |
close $fid |
| 49 |
foreach f [list foo/1.0 foo/2.0 foo/run.log bar/1.0 bar/2.0 baz/1.0\ |
| 50 |
baz/3.0] { |
| 51 |
set fid [open $mp1/$f w] |
| 52 |
puts $fid $mfcontent |
| 53 |
close $fid |
| 54 |
} |
| 55 |
set fid [open $mp1/foo/lib.tcl w] |
| 56 |
puts $fid "proc helperproc {} {}" |
| 57 |
close $fid |
| 58 |
set fid [open $mp1/helper/util w] |
| 59 |
puts $fid "not a modulefile" |
| 60 |
close $fid |
| 61 |
|
| 62 |
setenv_path_var MODULEPATH $mp1 |
| 63 |
|
| 64 |
# ignored files and directories are excluded from module search |
| 65 |
set tserr "bar/1.0 |
| 66 |
bar/2.0 |
| 67 |
baz/1.0 |
| 68 |
foo/1.0" |
| 69 |
testouterr_cmd sh {avail -a -t -o } OK $tserr |
| 70 |
|
| 71 |
# targeted search of an ignored element finds nothing |
| 72 |
testouterr_cmd sh {avail -t -o foo/2.0} OK {} |
| 73 |
testouterr_cmd sh {avail -t -o bar/2.0} OK bar/2.0 |
| 74 |
|
| 75 |
# direct access to an ignored element leads to a not found error |
| 76 |
testouterr_cmd sh {load foo/2.0} ERR $err_path'foo/2.0' |
| 77 |
testouterr_cmd sh {is-avail foo/2.0} ERR {} |
| 78 |
testouterr_cmd sh {is-avail bar/2.0} OK {} |
| 79 |
|
| 80 |
# disabled modulepath_ignore configuration option skips all patterns |
| 81 |
setenv_var MODULES_MODULEPATH_IGNORE 0 |
| 82 |
set tserr "bar/1.0 |
| 83 |
bar/2.0 |
| 84 |
baz/1.0 |
| 85 |
baz/3.0 |
| 86 |
foo/1.0 |
| 87 |
foo/2.0 |
| 88 |
foo/run.log" |
| 89 |
testouterr_cmd sh {avail -a -t -o } OK $tserr |
| 90 |
unsetenv_var MODULES_MODULEPATH_IGNORE |
| 91 |
|
| 92 |
# --no-modulepath-ignore command line switch skips patterns for one |
| 93 |
# execution |
| 94 |
testouterr_cmd sh {--no-modulepath-ignore avail -a -t -o } OK $tserr |
| 95 |
|
| 96 |
skip_if_quick_mode $mp1 |
| 97 |
|
| 98 |
# ignore all accept some idiom with negated patterns |
| 99 |
file mkdir $mp2/app |
| 100 |
set fid [open $mp2/.modulerc w] |
| 101 |
puts $fid "#%Module\nmodulepath-ignore * !*/ !*.mod" |
| 102 |
close $fid |
| 103 |
foreach f [list app/1.0.mod app/2.0] { |
| 104 |
set fid [open $mp2/$f w] |
| 105 |
puts $fid $mfcontent |
| 106 |
close $fid |
| 107 |
} |
| 108 |
setenv_path_var MODULEPATH $mp2 |
| 109 |
testouterr_cmd sh {avail -a -t -o } OK app/1.0.mod |
| 110 |
|
| 111 |
# global rc file patterns apply to every modulepath |
| 112 |
if {[info exists env(MODULERCFILE)]} { |
| 113 |
set save_modulercfile $env(MODULERCFILE) |
| 114 |
} |
| 115 |
set fid [open $env(HOME)/testglobalrc w] |
| 116 |
puts $fid "#%Module\nmodulepath-ignore bar/" |
| 117 |
close $fid |
| 118 |
setenv_var MODULERCFILE $env(HOME)/testglobalrc |
| 119 |
setenv_path_var MODULEPATH $mp1 |
| 120 |
set tserr "baz/1.0 |
| 121 |
foo/1.0" |
| 122 |
testouterr_cmd sh {avail -a -t -o } OK $tserr |
| 123 |
# patterns defined within modulepath take precedence over global patterns |
| 124 |
setenv_path_var MODULEPATH $mp2 |
| 125 |
testouterr_cmd sh {avail -a -t -o } OK app/1.0.mod |
| 126 |
if {[info exists save_modulercfile]} { |
| 127 |
setenv_var MODULERCFILE $save_modulercfile |
| 128 |
unset save_modulercfile |
| 129 |
} else { |
| 130 |
unsetenv_var MODULERCFILE |
| 131 |
} |
| 132 |
file delete $env(HOME)/testglobalrc |
| 133 |
|
| 134 |
# user rc file patterns also apply to every modulepath (even if user rc |
| 135 |
# file is named '.modulerc', it does not lie within a modulepath, so the |
| 136 |
# patterns it defines are global ones) |
| 137 |
set userhome $env(HOME)/ignhome |
| 138 |
file mkdir $userhome |
| 139 |
set fid [open $userhome/.modulerc w] |
| 140 |
puts $fid "#%Module\nmodulepath-ignore bar/" |
| 141 |
close $fid |
| 142 |
set save_home $env(HOME) |
| 143 |
setenv_var HOME $userhome |
| 144 |
setenv_path_var MODULEPATH $mp1 |
| 145 |
set tserr "baz/1.0 |
| 146 |
foo/1.0" |
| 147 |
testouterr_cmd sh {avail -a -t -o } OK $tserr |
| 148 |
# patterns from user rc file are dropped when this file is ignored |
| 149 |
set tserr "bar/1.0 |
| 150 |
bar/2.0 |
| 151 |
baz/1.0 |
| 152 |
foo/1.0" |
| 153 |
testouterr_cmd sh {--ignore-user-rc avail -a -t -o } OK $tserr |
| 154 |
setenv_var HOME $save_home |
| 155 |
unset save_home |
| 156 |
file delete -force $userhome |
| 157 |
|
| 158 |
# double asterisk (leading, middle and mid-segment), character range |
| 159 |
# (regular and negated), single character, escaped characters, leading |
| 160 |
# slash anchor, unclosed character range, trailing backslash (matched |
| 161 |
# literally, so 'esc\' pattern does not match 'esc' file) and void (slash |
| 162 |
# or negation character only, matching nothing) patterns, defined over |
| 163 |
# several modulepath-ignore calls in same rc file |
| 164 |
set mp4 $env(HOME)/mpign4 |
| 165 |
file mkdir $mp4/app $mp4/lib/x $mp4/sub/doc $mp4/qux $mp4/quax $mp4/a/x/y\ |
| 166 |
$mp4/mx |
| 167 |
set fid [open $mp4/.modulerc w] |
| 168 |
puts $fid "#%Module\nmodulepath-ignore **/doc lib/** {app/\[13\]*}\ |
| 169 |
{\\!bang} qu?x\nmodulepath-ignore /root1* a/**/b {e\[!0-9\]f} m**n\ |
| 170 |
{br\[ack} {sp\\*t}\nmodulepath-ignore / ! esc\\\\" |
| 171 |
close $fid |
| 172 |
foreach f [list app/1.0 app/2.0 app/3.0 lib/x/1.0 sub/doc/1.0 sub/1.0\ |
| 173 |
qux/1.0 quax/1.0 !bang root1.0 sub/root1.5 a/b a/x/b a/x/y/b a/c exf\ |
| 174 |
e5f mooon mx/n {br[ack} {sp*t} spot esc] { |
| 175 |
set fid [open $mp4/$f w] |
| 176 |
puts $fid $mfcontent |
| 177 |
close $fid |
| 178 |
} |
| 179 |
setenv_path_var MODULEPATH $mp4 |
| 180 |
set tserr "a/c |
| 181 |
app/2.0 |
| 182 |
e5f |
| 183 |
esc |
| 184 |
mx/n |
| 185 |
qux/1.0 |
| 186 |
spot |
| 187 |
sub/1.0 |
| 188 |
sub/root1.5" |
| 189 |
testouterr_cmd sh {avail -a -t -o } OK $tserr |
| 190 |
|
| 191 |
# directories matching ignored_dirs configuration option and backup or |
| 192 |
# version control files cannot be re-included by a negated pattern and are |
| 193 |
# still ignored when modulepath_ignore option is disabled |
| 194 |
set mp5 $env(HOME)/mpign5 |
| 195 |
file mkdir $mp5/.git $mp5/mod |
| 196 |
set fid [open $mp5/.modulerc w] |
| 197 |
puts $fid "#%Module\nmodulepath-ignore !.git/ !*~" |
| 198 |
close $fid |
| 199 |
foreach f [list .git/1.0 mod/1.0 mod/1.0~] { |
| 200 |
set fid [open $mp5/$f w] |
| 201 |
puts $fid $mfcontent |
| 202 |
close $fid |
| 203 |
} |
| 204 |
setenv_path_var MODULEPATH $mp5 |
| 205 |
testouterr_cmd sh {avail -a -t -o } OK mod/1.0 |
| 206 |
testouterr_cmd sh {--no-modulepath-ignore avail -a -t -o } OK mod/1.0 |
| 207 |
testouterr_cmd sh {--no-modulepath-ignore avail -a -t -o .git} OK {} |
| 208 |
testouterr_cmd sh {--no-modulepath-ignore load .git/1.0} ERR\ |
| 209 |
$err_path'.git/1.0' |
| 210 |
|
| 211 |
# a '.version' rc file matching a '.version' pattern is exempt and still |
| 212 |
# evaluated; a directory bearing an rc file name is handled as an rc file |
| 213 |
# when fetched with its directory content, so it is not walked down |
| 214 |
# whether patterns apply or not |
| 215 |
set mp6 $env(HOME)/mpign6 |
| 216 |
file mkdir $mp6/mod/.version $mp6/other |
| 217 |
set fid [open $mp6/.modulerc w] |
| 218 |
puts $fid "#%Module\nmodulepath-ignore .version" |
| 219 |
close $fid |
| 220 |
set fid [open $mp6/other/.version w] |
| 221 |
puts $fid "#%Module\nset ModulesVersion 1.0" |
| 222 |
close $fid |
| 223 |
foreach f [list mod/.version/1.0 mod/1.0 other/1.0 other/2.0] { |
| 224 |
set fid [open $mp6/$f w] |
| 225 |
puts $fid $mfcontent |
| 226 |
close $fid |
| 227 |
} |
| 228 |
setenv_path_var MODULEPATH $mp6 |
| 229 |
set tserr "mod/1.0 |
| 230 |
other/1.0 |
| 231 |
other/2.0" |
| 232 |
testouterr_cmd sh {avail -a -t -o } OK $tserr |
| 233 |
testouterr_cmd sh {avail -t -o other/default} OK other/1.0 |
| 234 |
testouterr_cmd sh {--no-modulepath-ignore avail -a -t -o } OK $tserr |
| 235 |
|
| 236 |
# ignore patterns are taken into account when determining the implicit |
| 237 |
# default version of a directory on the shortcut search made for an exact |
| 238 |
# 'name/version' specification: highest version is ignored so the next one |
| 239 |
# is the implicit default (patterns are obtained from the rc file evaluated |
| 240 |
# when directory content is fetched, prior the trimElemListForStopmod |
| 241 |
# optimization procedure narrows down the element list) |
| 242 |
set mp7 $env(HOME)/mpign7 |
| 243 |
file mkdir $mp7/foo |
| 244 |
set fid [open $mp7/foo/.modulerc w] |
| 245 |
puts $fid "#%Module\nmodulepath-ignore 3*" |
| 246 |
close $fid |
| 247 |
foreach f [list foo/1.0 foo/2.0 foo/3.0] { |
| 248 |
set fid [open $mp7/$f w] |
| 249 |
puts $fid $mfcontent |
| 250 |
close $fid |
| 251 |
} |
| 252 |
setenv_path_var MODULEPATH $mp7 |
| 253 |
set ans [list] |
| 254 |
lappend ans [list set _LMFILES_ $mp7/foo/1.0] |
| 255 |
lappend ans [list set LOADEDMODULES foo/1.0] |
| 256 |
testouterr_cmd sh {load foo/1.0} $ans {} |
| 257 |
set ans [list] |
| 258 |
lappend ans [list set __MODULES_LMALTNAME foo/2.0&as|foo/default&as|foo/latest] |
| 259 |
lappend ans [list set _LMFILES_ $mp7/foo/2.0] |
| 260 |
lappend ans [list set LOADEDMODULES foo/2.0] |
| 261 |
testouterr_cmd sh {load foo/2.0} $ans {} |
| 262 |
|
| 263 |
# a default version explicitly set in a '.version' file targeting an |
| 264 |
# ignored version leads to a not found error, as ignored elements are |
| 265 |
# handled as if they do not exist |
| 266 |
set mp8 $env(HOME)/mpign8 |
| 267 |
file mkdir $mp8/bar |
| 268 |
set fid [open $mp8/bar/.version w] |
| 269 |
puts $fid "#%Module\nset ModulesVersion 2.0" |
| 270 |
close $fid |
| 271 |
set fid [open $mp8/bar/.modulerc w] |
| 272 |
puts $fid "#%Module\nmodulepath-ignore 2*" |
| 273 |
close $fid |
| 274 |
foreach f [list bar/1.0 bar/2.0] { |
| 275 |
set fid [open $mp8/$f w] |
| 276 |
puts $fid $mfcontent |
| 277 |
close $fid |
| 278 |
} |
| 279 |
setenv_path_var MODULEPATH $mp8 |
| 280 |
testouterr_cmd sh {avail -t -o bar} OK bar/1.0 |
| 281 |
testouterr_cmd sh {load bar} ERR $err_path'bar/2.0' |
| 282 |
|
| 283 |
# modulepath-ignore is not allowed in modulefile |
| 284 |
file mkdir $mp3/err |
| 285 |
set fid [open $mp3/err/1.0 w] |
| 286 |
puts $fid "#%Module\nmodulepath-ignore *.x" |
| 287 |
close $fid |
| 288 |
set fid [open $mp3/err/2.0 w] |
| 289 |
puts $fid "#%Module\nmodulepath-ignore" |
| 290 |
close $fid |
| 291 |
setenv_path_var MODULEPATH $mp3 |
| 292 |
set tserr [msg_load err/1.0 [msg_moderr {modulepath-ignore command not\ |
| 293 |
allowed in modulefile} {modulepath-ignore *.x} $mp3/err/1.0 2]] |
| 294 |
testouterr_cmd sh {load err/1.0} ERR $tserr |
| 295 |
|
| 296 |
# an argument is expected for modulepath-ignore command |
| 297 |
set tserr [msg_load err/2.0 [msg_moderr {No pattern specified in argument}\ |
| 298 |
modulepath-ignore $mp3/err/2.0 2]] |
| 299 |
testouterr_cmd sh {load err/2.0} ERR $tserr |
| 300 |
|
| 301 |
# |
| 302 |
# Cleanup |
| 303 |
# |
| 304 |
|
| 305 |
file delete -force $mp1 $mp2 $mp3 $mp4 $mp5 $mp6 $mp7 $mp8 |
| 306 |
|
| 307 |
reset_test_env |