Modifying add_to_module to become decorate_module and adding test

Author: Robert McLay

docs/source/025_new.rst

@@ -1,6 +1,14 @@
 New Features in Lmod
 ====================
 
+**decorate_module**:
+  (Lmod 8.7.59+)  Sites can use this new hook to add text to a
+  modulefile. Note that if this hook exists all modules will call this
+  hook, so sites will typically only want to text to certain modules.
+  Also this added text must be written in Lua.  TCL modulefiles will
+  have already been converted to Lua.
+
+
 **LMOD_FILE_IGNORE_PATTERNS**
   (Lmod 8.7.56+)  Sites can replace the default value with their own
   list of file patterns to ignore.

docs/source/170_hooks.rst

@@ -178,7 +178,7 @@ used in the Lmod program.
   property table.  See *rt/uitSitePkg/mf/site_scripts/SitePackage.lua*
   for a complete example.
 
-**add_to_module** (table):
+**decorate_module** (table):
   (Returns: table)
   This hook allows a site to add contents to a module file (e.g. add
   ``add_property(...)`` based on the location of the module file). It

rt/hook/decorate_module/SitePackage.lua

@@ -0,0 +1,11 @@
+local Hook = require("Hook")
+
+function test_hook(t)
+   if (t.name == "decorate") then
+      return {"LmodMessage('I made it!')"}
+   end
+   return {}
+end
+
+Hook.register("decorate_module", test_hook, "append")
+

rt/hook/err.txt

@@ -2,7 +2,7 @@
 step 1
 lua ProjectDIR/src/lmod.in.lua shell --regression_testing --version
 ===========================
-Modules based on Lua: Version 8.7.40 2024-06-11 15:18 -06:00
+Modules based on Lua: Version 8.7.57 2025-02-25 17:22 -07:00
     by Robert McLay [email protected]
 ===========================
 step 2
@@ -36,3 +36,12 @@ Load hook B called on admin
 Load hook A called on admin
 Load hook B called on intel
 Load hook A called on intel
+===========================
+step 7
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing load A
+===========================
+===========================
+step 8
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing load decorate
+===========================
+I made it!

rt/hook/hook.tdesc

@@ -37,6 +37,13 @@ testdescript = {
      export LMOD_PACKAGE_PATH=$(testDir)/prepend
      runLmod load admin intel               # 6
 
+     export LMOD_PACKAGE_PATH=$(testDir)/decorate_module; 
+     runLmod load A                         # 7
+     runLmod load decorate                  # 8
+
+     
+
+
      HOME=$ORIG_HOME
      cat _stdout.[0-9][0-9][0-9] > _stdout.orig
      joinBase64Results  -bash  _stdout.orig _stdout.new

rt/hook/mf/Core/A/1.0.lua

@@ -0,0 +1 @@
+setenv("A","1")

rt/hook/mf/Core/decorate/1.0.lua

@@ -0,0 +1 @@
+setenv("foo","bar")

rt/hook/out.txt

@@ -120,3 +120,31 @@ PATH=/vol/local/intel/idb/idb/bin:/vol/local/intel/fc/fc/bin:/vol/local/intel/cc
 export PATH;
 _ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={compiler="intel",},mT={admin={fn="ProjectDIR/rt/hook/mf/Core/admin/admin-1.0.lua",fullName="admin/admin-1.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="admin",wV="^admin.*zfinal-.000000001.*zfinal",},intel={actionA={"prepend_path(\"MODULEPATH\",\"ProjectDIR/rt/hook/mf/Compiler/intel/10.1\")",},fn="ProjectDIR/rt/hook/mf/Core/intel/intel.lua",fullName="intel/intel",loadOrder=2,propT={},stackDepth=0,status="active",userName="intel",wV="*intel.*zfinal",},},mpathA={"ProjectDIR/rt/hook/mf/Compiler/intel/10.1","ProjectDIR/rt/hook/mf/Core",},}';
 export _ModuleTable_;
+===========================
+step 7
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing load A
+===========================
+A=1;
+export A;
+LOADEDMODULES=admin/admin-1.0:intel/intel:A/1.0;
+export LOADEDMODULES;
+MODULEPATH=ProjectDIR/rt/hook/mf/Compiler/intel/10.1:ProjectDIR/rt/hook/mf/Core;
+export MODULEPATH;
+_LMFILES_=ProjectDIR/rt/hook/mf/Core/admin/admin-1.0.lua:ProjectDIR/rt/hook/mf/Core/intel/intel.lua:ProjectDIR/rt/hook/mf/Core/A/1.0.lua;
+export _LMFILES_;
+_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={compiler="intel",},mT={A={fn="ProjectDIR/rt/hook/mf/Core/A/1.0.lua",fullName="A/1.0",loadOrder=3,propT={},stackDepth=0,status="active",userName="A",wV="000000001.*zfinal",},admin={fn="ProjectDIR/rt/hook/mf/Core/admin/admin-1.0.lua",fullName="admin/admin-1.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="admin",wV="^admin.*zfinal-.000000001.*zfinal",},intel={actionA={"prepend_path(\"MODULEPATH\",\"ProjectDIR/rt/hook/mf/Compiler/intel/10.1\")",},fn="ProjectDIR/rt/hook/mf/Core/intel/intel.lua",fullName="intel/intel",loadOrder=2,propT={},stackDepth=0,status="active",userName="intel",wV="*intel.*zfinal",},},mpathA={"ProjectDIR/rt/hook/mf/Compiler/intel/10.1","ProjectDIR/rt/hook/mf/Core",},}';
+export _ModuleTable_;
+===========================
+step 8
+lua ProjectDIR/src/lmod.in.lua shell --regression_testing load decorate
+===========================
+LOADEDMODULES=admin/admin-1.0:intel/intel:A/1.0:decorate/1.0;
+export LOADEDMODULES;
+MODULEPATH=ProjectDIR/rt/hook/mf/Compiler/intel/10.1:ProjectDIR/rt/hook/mf/Core;
+export MODULEPATH;
+_LMFILES_=ProjectDIR/rt/hook/mf/Core/admin/admin-1.0.lua:ProjectDIR/rt/hook/mf/Core/intel/intel.lua:ProjectDIR/rt/hook/mf/Core/A/1.0.lua:ProjectDIR/rt/hook/mf/Core/decorate/1.0.lua;
+export _LMFILES_;
+_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={compiler="intel",},mT={A={fn="ProjectDIR/rt/hook/mf/Core/A/1.0.lua",fullName="A/1.0",loadOrder=3,propT={},stackDepth=0,status="active",userName="A",wV="000000001.*zfinal",},admin={fn="ProjectDIR/rt/hook/mf/Core/admin/admin-1.0.lua",fullName="admin/admin-1.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="admin",wV="^admin.*zfinal-.000000001.*zfinal",},decorate={fn="ProjectDIR/rt/hook/mf/Core/decorate/1.0.lua",fullName="decorate/1.0",loadOrder=4,propT={},stackDepth=0,status="active",userName="decorate",wV="000000001.*zfinal",},intel={actionA={"prepend_path(\"MODULEPATH\",\"ProjectDIR/rt/hook/mf/Compiler/intel/10.1\")",},fn="ProjectDIR/rt/hook/mf/Core/intel/intel.lua",fullName="intel/intel",loadOrder=2,propT={},stackDepth=0,status="active",userName="intel",wV="*intel.*zfinal",},},mpathA={"ProjectDIR/rt/hook/mf/Compiler/intel/10.1","ProjectDIR/rt/hook/mf/Core",},}';
+export _ModuleTable_;
+foo=bar;
+export foo;

src/Hook.lua

@@ -76,7 +76,8 @@ local validT =
       reverseMapPathFilter = {}, -- This hook returns two arrays keepA, ignoreA to keep or
                                  -- ignore a path in the reverseMap mapping
       colorize_fullName    = {}, -- Allow module avail and list to colorize name and/or version
-      add_to_module        = {}, -- Allow dynamic additions to modules. The additions are still run through the sandbox. It passes the following table as a parameter {path, name, version, contents}.
+      decorate_module      = {}, -- Allow dynamic additions to modules. The additions are still run through the sandbox. 
+                                 -- It passes the following table as a parameter {path, name, version, contents}.
 }
 
 local s_actionT = { append = true, prepend = true, replace = true }

src/loadModuleFile.lua

@@ -154,9 +154,8 @@ function loadModuleFile(t)
    end
 
    -- dynamic additions via hook
-   local additional_lines = hook.apply("add_to_module", {path=myFileName(), name=myModuleName(), version=myModuleVersion(), contents=whole}) or {}
-   additional_lines = concatTbl(additional_lines, "\n")
-   whole = whole .. "\n" .. additional_lines
+   local additional_lines = hook.apply("decorate_module", {path=myFileName(), name=myModuleName(), version=myModuleVersion(), contents=whole}) or {}
+   whole = whole .. "\n" .. concatTbl(additional_lines, "\n")
 
    -- Use the sandbox to evaluate modulefile text.
    if (whole) then