Make "getenv" available from modulerc eval context

Fixes #588

Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>

Author: xdelaruelle

NEWS.rst

@@ -48,6 +48,8 @@ Modules 5.7.0 (not yet released)
 * Install: reorder the options in the :file:`configure` script help message
   alphabetically.
 * Doc: add manual page for :ref:`modulecmd(1)` command.
+* Make :mfcmd:`getenv` modulefile command available from module rc file
+  evaluation context. (fix issue #588)
 
 
 .. _5.6 release notes:

doc/source/changes.rst

@@ -1111,6 +1111,9 @@ The following modulefile Tcl commands appeared on Modules 5.
  environment variable value or its fallback when modulefile is evaluated in
  *display* mode.
 
+ Starting version 5.7, this command is also available from module rc file
+ context.
+
 :mfcmd:`prereq`, :mfcmd:`module load/try-load/load-any/switch<module>`
 
  Starting Modules 5.1, these modulefile commands accept the :option:`--tag`

doc/source/modulefile.rst

@@ -343,6 +343,9 @@ the *modulefile* is being loaded.
     .. versionchanged:: 5.1
        Option ``--return-value`` added
 
+    .. versionchanged:: 5.7
+       Command available from module rc file context
+
 .. mfcmd:: getvariant [--return-value] variant [value]
 
  Returns value of designated *variant*. If *variant* is not defined, *value*
@@ -1772,15 +1775,16 @@ for each interpretation context.
 | Commands available from   | Commands available from run-command (rc) file       |
 | modulefile interpretation | interpretation                                      |
 +===========================+=====================================================+
-| All the Modules specific  | :mfcmd:`hide-modulefile`, :mfcmd:`hide-version`,    |
-| and standard Tcl commands | :mfcmd:`is-loaded`, :mfcmd:`is-used`,               |
-|                           | :mfcmd:`lsb-release`, :mfcmd:`module-alias`,        |
-|                           | :mfcmd:`module-forbid`, :mfcmd:`module-hide`,       |
-|                           | :mfcmd:`module-info`, :mfcmd:`module-tag`,          |
-|                           | :mfcmd:`module-version`, :mfcmd:`module-virtual`,   |
-|                           | :mfcmd:`module-warn`, :mfcmd:`modulepath-label`,    |
-|                           | :mfcmd:`system`, :mfcmd:`uname`,                    |
-|                           | :mfcmd:`versioncmp` and standard Tcl commands       |
+| All the Modules specific  | :mfcmd:`getenv`, :mfcmd:`hide-modulefile`,          |
+| and standard Tcl commands | :mfcmd:`hide-version`, :mfcmd:`is-loaded`,          |
+|                           | :mfcmd:`is-used`, :mfcmd:`lsb-release`,             |
+|                           | :mfcmd:`module-alias`, :mfcmd:`module-forbid`,      |
+|                           | :mfcmd:`module-hide`, :mfcmd:`module-info`,         |
+|                           | :mfcmd:`module-tag`, :mfcmd:`module-version`,       |
+|                           | :mfcmd:`module-virtual`, :mfcmd:`module-warn`,      |
+|                           | :mfcmd:`modulepath-label`, :mfcmd:`system`,         |
+|                           | :mfcmd:`uname`, :mfcmd:`versioncmp` and standard    |
+|                           | Tcl commands                                        |
 +---------------------------+-----------------------------------------------------+
 
 .. note:: Global and user run-command files are interpreted like modulefiles

tcl/interp.tcl.in

@@ -522,14 +522,14 @@ proc execute-modulerc {modfile modname modspec} {
 
       # list interpreter alias commands to define
       array set ::g_modrcAliases [list uname uname system system versioncmp\
-         versioncmp hide-modulefile hide-modulefile hide-version\
-         hide-modulefile is-loaded is-loaded is-used is-used module-version\
-         module-version module-alias module-alias module-virtual\
-         module-virtual module-forbid module-forbid module-hide module-hide\
-         module-tag module-tag module-info module-info modulepath-label\
-         modulepath-label setModulesVersion setModulesVersion\
-         getModuleContent getModuleContent lsb-release lsb-release\
-         module-warn module-warn]
+         versioncmp getenv getenv hide-modulefile hide-modulefile\
+         hide-version hide-modulefile is-loaded is-loaded is-used is-used\
+         module-version module-version module-alias module-alias\
+         module-virtual module-virtual module-forbid module-forbid\
+         module-hide module-hide module-tag module-tag module-info\
+         module-info modulepath-label modulepath-label setModulesVersion\
+         setModulesVersion getModuleContent getModuleContent lsb-release\
+         lsb-release module-warn module-warn]
 
       if {[getConf source_cache]} {
          set ::g_modrcAliases(source) sourceModfileCmd

testsuite/modulefiles.4/foo/.modulerc

@@ -23,3 +23,13 @@ if {[info exists env(TESTSUITE_CONFLICT_UNLOAD)]} {
         }
     }
 }
+if {[info exists env(TESTSUITE_RC_GETENV)]} {
+    switch -- $env(TESTSUITE_RC_GETENV) {
+        sym {
+            module-version foo/1.0 [getenv TESTSUITE_RC_GETENV]
+        }
+        unk {
+            module-version foo/1.0 [getenv UNK_VAR foo]
+        }
+    }
+}

testsuite/modules.50-cmds/260-getenv.exp

@@ -184,6 +184,18 @@ $modlin"
 testouterr_cmd_re sh "display $module" OK $tserr
 
 
+# test usage from rc file
+setenv_var MODULES_SEARCH_MATCH starts_with
+setenv_var MODULEPATH $modpath.4
+setenv_var TESTSUITE_RC_GETENV sym
+set tserr {foo/1.0(sym)  }
+testouterr_cmd sh {avail -o sym foo/1.0} OK $tserr
+
+setenv_var TESTSUITE_RC_GETENV unk
+set tserr {foo/1.0(foo)  }
+testouterr_cmd sh {avail -o sym foo/1.0} OK $tserr
+
+
 #
 #  Cleanup
 #