Merge branch 'main' into testing

README.new

@@ -125,3 +125,5 @@ Lmod 8.7+
             * TACC issue: Change the current version of zsh with the string ${ZSH_VERSION} when builting
               the init/zsh file.
    (8.7.34) * TACC issue: (Again) Cannot use the string ${ZSH_VERSION} in $FPATH.  Instead change orig zsh version to current one.
+   (8.7.35) * Issue #687: Let is-loaded and is-avail set  non-zero exit status.  This is different from warnings.
+            * Issue #688: Do not produce a Lua error on a non-existant collection

rt/is_cmd/err.txt

@@ -0,0 +1,26 @@
+===========================
+step 1
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing --version
+===========================
+Modules based on Lua: Version 8.7.34  2024-01-05 19:34 -07:00
+    by Robert McLay [email protected]
+===========================
+step 2
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing load A
+===========================
+===========================
+step 3
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing is-loaded A
+===========================
+===========================
+step 4
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing is-loaded AA
+===========================
+===========================
+step 5
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing is-avail B
+===========================
+===========================
+step 6
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing is-avail BB
+===========================

rt/is_cmd/is_cmd.tdesc

@@ -0,0 +1,56 @@
+-- -*- lua -*-
+
+testdescript = {
+   owner   = "rtm",
+   product = "modules",
+   description = [[
+	 Test isavail functionality
+   ]],
+   keywords = {"isloaded" },
+
+   active = 1,
+   testName = "isavail",
+   job_submit_method = "INTERACTIVE",
+
+   runScript = [[
+
+     . $(projectDir)/rt/common_funcs.sh
+     unsetMT
+     initStdEnvVars
+     MODULEPATH_ROOT=$(testDir)/mf;     export MODULEPATH_ROOT
+     MODULEPATH=$MODULEPATH_ROOT/Core;  export MODULEPATH
+
+     rm -fr _stderr.* _stdout.* err.* out.* .lmod.d .cache .config
+
+     runLmod --version                # 1
+     runLmod load A                   # 2
+     runLmod is-loaded A              # 3
+     runLmod is-loaded AA             # 4
+     runLmod is-avail B               # 5
+     runLmod is-avail BB              # 6
+
+     HOME=$ORIG_HOME
+
+     cat _stdout.[0-9][0-9][0-9] > _stdout.orig
+     joinBase64Results  -bash  _stdout.orig _stdout.new
+     cleanUp _stdout.new out.txt
+
+     cat _stderr.[0-9][0-9][0-9] > _stderr.orig
+     cleanUp _stderr.orig err.txt
+
+     rm -f results.csv
+     wrapperDiff --csv results.csv $(testDir)/out.txt out.txt
+     wrapperDiff --csv results.csv $(testDir)/err.txt err.txt
+     testFinish -r $(resultFn) -t $(runtimeFn) results.csv
+   ]],
+
+
+   blessScript = [[
+         # perform what is needed
+   ]],
+
+   tests = {
+      { id='t1'},
+   },
+
+}

rt/is_cmd/out.txt

@@ -0,0 +1,52 @@
+===========================
+step 1
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing --version
+===========================
+===========================
+step 2
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing load A
+===========================
+LOADEDMODULES=A/1.0;
+export LOADEDMODULES;
+__LMOD_REF_COUNT_MODULEPATH=ProjectDIR/rt/is_cmd/mf/Core:1;
+export __LMOD_REF_COUNT_MODULEPATH;
+MODULEPATH=ProjectDIR/rt/is_cmd/mf/Core;
+export MODULEPATH;
+_LMFILES_=ProjectDIR/rt/is_cmd/mf/Core/A/1.0.lua;
+export _LMFILES_;
+_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={},mT={A={fn="ProjectDIR/rt/is_cmd/mf/Core/A/1.0.lua",fullName="A/1.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="A",wV="000000001.*zfinal",},},mpathA={"ProjectDIR/rt/is_cmd/mf/Core",},systemBaseMPATH="ProjectDIR/rt/is_cmd/mf/Core",}';
+export _ModuleTable_;
+===========================
+step 3
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing is-loaded A
+===========================
+MODULEPATH=ProjectDIR/rt/is_cmd/mf/Core;
+export MODULEPATH;
+_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={},mT={A={fn="ProjectDIR/rt/is_cmd/mf/Core/A/1.0.lua",fullName="A/1.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="A",wV="000000001.*zfinal",},},mpathA={"ProjectDIR/rt/is_cmd/mf/Core",},systemBaseMPATH="ProjectDIR/rt/is_cmd/mf/Core",}';
+export _ModuleTable_;
+===========================
+step 4
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing is-loaded AA
+===========================
+MODULEPATH=ProjectDIR/rt/is_cmd/mf/Core;
+export MODULEPATH;
+_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={},mT={A={fn="ProjectDIR/rt/is_cmd/mf/Core/A/1.0.lua",fullName="A/1.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="A",wV="000000001.*zfinal",},},mpathA={"ProjectDIR/rt/is_cmd/mf/Core",},systemBaseMPATH="ProjectDIR/rt/is_cmd/mf/Core",}';
+export _ModuleTable_;
+false
+===========================
+step 5
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing is-avail B
+===========================
+MODULEPATH=ProjectDIR/rt/is_cmd/mf/Core;
+export MODULEPATH;
+_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={},mT={A={fn="ProjectDIR/rt/is_cmd/mf/Core/A/1.0.lua",fullName="A/1.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="A",wV="000000001.*zfinal",},},mpathA={"ProjectDIR/rt/is_cmd/mf/Core",},systemBaseMPATH="ProjectDIR/rt/is_cmd/mf/Core",}';
+export _ModuleTable_;
+===========================
+step 6
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing is-avail BB
+===========================
+MODULEPATH=ProjectDIR/rt/is_cmd/mf/Core;
+export MODULEPATH;
+_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={},mT={A={fn="ProjectDIR/rt/is_cmd/mf/Core/A/1.0.lua",fullName="A/1.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="A",wV="000000001.*zfinal",},},mpathA={"ProjectDIR/rt/is_cmd/mf/Core",},systemBaseMPATH="ProjectDIR/rt/is_cmd/mf/Core",}';
+export _ModuleTable_;
+false

src/Hub.lua

@@ -157,7 +157,6 @@ function M.access(self, ...)
 
 
    if (#a > 0) then
-      setWarningFlag()
       LmodWarning{msg="w_Failed_2_Find",quote_comma_list=concatTbl(a,"\", \""),
                              module_list=concatTbl(a," ")}
    end

src/MT.lua

@@ -278,8 +278,12 @@ end
 -- collection is not found.
 function M.reportContents(self, t)
    dbg.start{"mt:reportContents(",t.fn,")"}
-   local f = io.open(t.fn,"r")
    local a       = {}
+   if (not t.fn) then
+      dbg.fini("mt:reportContents")
+      return a
+   end
+   local f = io.open(t.fn,"r")
    if (not f) then
       dbg.fini("mt:reportContents")
       return a

src/MainControl.lua

@@ -833,7 +833,6 @@ function M.warning(self, ...)
       sA[#sA+1]   = moduleStackTraceBack()
       sA[#sA+1]   = "\n"
       io.stderr:write(concatTbl(sA,""),"\n")
-      setWarningFlag()
    end
 end
 
@@ -1127,7 +1126,6 @@ end
 -- @param mA A array of MName objects.
 function M.try_load(self, mA)
    dbg.start{"MainControl:try_load(mA)"}
-   --deactivateWarning()
    self:load(mA)
    dbg.fini("MainControl:try_load")
 end
@@ -1511,9 +1509,6 @@ function M.purge(self,t)
    unload_usr_internal(mA, force)
    s_purgeFlg = false
 
-   -- A purge should not set the warning flag.
-   clearWarningFlag()
-   dbg.print{"warningFlag: ", getWarningFlag(),"\n"}
    dbg.fini("MainControl:Purge")
 end
 

src/Spider.lua

@@ -1029,7 +1029,6 @@ function M.spiderSearch(self, dbT, providedByT, userSearchPat, helpFlg)
    end
 
    if (next(matchT) == nil) then
-      setWarningFlag()
       LmodSystemError{msg="e_Failed_2_Find", name=origUserSearchPat}
    end
 

src/cmdfuncs.lua

@@ -307,7 +307,7 @@ function IsAvail(...)
    for i = 1, argA.n do
       local mname = MName:new("load", argA[i])
       if (not mname:valid()) then
-         setWarningFlag()
+         setStatusFlag()
          break
       end
    end
@@ -318,7 +318,7 @@ function IsLoaded(...)
    for i = 1, argA.n do
       local mname = MName:new("mt", argA[i])
       if (not mname:isloaded()) then
-         setWarningFlag()
+         setStatusFlag()
          break
       end
    end

src/lmod.in.lua

@@ -576,6 +576,10 @@ function main()
    if (optionTbl.reportTimer) then
       io.stderr:write(timer:report(),"\n")
    end
+
+   if (getStatusFlag()) then
+      LmodErrorExit()
+   end
 end
 
 main()

src/myGlobals.lua

@@ -571,6 +571,11 @@ parseVersion  = false
 ------------------------------------------------------------------------
 s_warning     = false
 
+------------------------------------------------------------------------
+-- s_status:   When set return a non-zero status
+------------------------------------------------------------------------
+s_status      = false
+
 ------------------------------------------------------------------------
 -- s_haveWarnings:  if warning are allowed (or ignored).  For example
 --                  a try-load command turns off warnings.

src/utils.lua

@@ -868,23 +868,17 @@ function haveWarnings()
    return s_haveWarnings
 end
 
---------------------------------------------------------------------------
--- Reset warning flag to false.
-function clearWarningFlag()
-   s_warning = false
-end
-
 --------------------------------------------------------------------------
 -- Set warning flags to true.
-function setWarningFlag()
-   dbg.print{"setting warning flag\n"}
-   s_warning = true
+function setStatusFlag()
+   dbg.print{"setting status flag\n"}
+   s_status = true
 end
 
 --------------------------------------------------------------------------
 -- Get warning flag value.
-function getWarningFlag()
-   return s_warning
+function getStatusFlag()
+   return s_status
 end
 
 local function l_restoreEnv(oldEnvT, newEnvT)