Skip to content

Commit

Permalink
PR #686: added --pod test and updated gold files for help and i18n tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert McLay committed Jun 18, 2024
1 parent 5ba01ea commit 7f715ee
Show file tree
Hide file tree
Showing 3 changed files with 157 additions and 1 deletion.
151 changes: 151 additions & 0 deletions rt/help/err.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,157 @@ LMOD_SYSTEM_DEFAULT_MODULES D __unknown__ <empty>
LMOD_USING_FAST_TCL_INTERP Other yes no
===========================
step 7
lua ProjectDIR/src/lmod.in.lua shell --regression_testing --pod
===========================
module
=head1 SYNOPSIS
module [options] sub-command [args ...]
=head1 DESCRIPTION
This tool allow a user to control their environment by load and unloading modulefiles. See https://lmod.readthedocs.org for more details.
=head1 OPTIONS
=over 4
=item I<-h -? -H --help>
This help message
=item I<-s availStyle --style=availStyle>
Site controlled avail style: system (default: system)
=item I<--regression_testing>
Lmod regression testing
=item I<-b --brief>
brief listing with only user specified modules
=item I<-D>
Program tracing written to stderr
=item I<--debug=dbglvl>
Program tracing written to stderr (where dbglvl is a number 1,2,3)
=item I<--pin_versions>
When doing a restore use specified version, do not follow defaults
=item I<-d --default>
List default modules only when used with avail
=item I<-q --quiet>
Do not print out warnings
=item I<--expert>
Expert mode
=item I<-t --terse>
Write out in machine readable format for commands: list, avail, spider, savelist
=item I<--initial_load>
loading Lmod for first time in a user shell
=item I<--latest>
Load latest (ignore default)
=item I<-I --ignore_cache>
Treat the cache file(s) as out-of-date
=item I<--novice>
Turn off expert and quiet flag
=item I<--raw>
Print modulefile in raw output when used with show
=item I<-w twidth --width=twidth>
Use this as max term width
=item I<-v --version>
Print version info and quit
=item I<-r --regexp>
use regular expression match
=item I<--gitversion>
Dump git version in a machine readable way and quit
=item I<--dumpversion>
Dump version in a machine readable way and quit
=item I<--check_syntax --checkSyntax>
Checking module command syntax: do not load
=item I<--config>
Report Lmod Configuration
=item I<--miniConfig>
Report Lmod Configuration differences
=item I<--config_json>
Report Lmod Configuration in json format
=item I<--mt>
Report Module Table State
=item I<--timer>
report run times
=item I<-f --force>
force removal of a sticky module or save an empty collection
=item I<--redirect>
Send the output of list, avail, spider to stdout (not stderr)
=item I<--no_redirect>
Force output of list, avail and spider to stderr
=item I<--show_hidden>
Avail and spider will report hidden modules
=item I<--spider_timeout=timeout>
a timeout for spider
=item I<-T --trace>
trace major changes such as loads
=item I<--nx --no_extensions>
Do not print extensions
=item I<--loc --location>
Just print the file location when using show
=item I<--terse_show_extensions>
report extensions when doing a terse avail
=item I<--pod>
Generate pod format
=back
=head1 COMMAND OVERVIEW
module [options] sub-command [args ...]
Help sub-commands:
help prints this message
help module [...] print help message from module(s)
Loading/Unloading sub-commands:
load | add module [...] load module(s)
try-load | try-add module [...] Add module(s), do not complain if not found
del | unload module [...] Remove module(s), do not complain if not found
swap | sw | switch m1 m2 unload m1 and load m2
purge unload all modules
refresh reload aliases from current list of modules.
update reload all currently loaded modules.
Listing / Searching sub-commands:
list List loaded modules
list s1 s2 ... List loaded modules that match the pattern
avail | av List available modules
avail | av string List available modules that contain "string".
category | cat List all categories
category | cat s1 s2 ... List all categories that match the pattern and display their modules
overview | ov List all available modules by short names with number of versions
overview | ov string List available modules by short names with number of versions that contain "string"
spider List all possible modules
spider module List all possible version of that module file
spider string List all module that contain the "string".
spider name/version Detailed information about that version of the module.
whatis module Print whatis information about module
keyword | key string Search all name and whatis that contain "string".
Searching with Lmod:
All searching (spider, list, avail, keyword) support regular expressions:
-r spider '^p' Finds all the modules that start with `p' or `P'
-r spider mpi Finds all modules that have "mpi" in their name.
-r spider 'mpi$ Finds all modules that end with "mpi" in their name.
Handling a collection of modules:
save | s Save the current list of modules to a user defined "default" collection.
save | s name Save the current list of modules to "name" collection.
reset The same as "restore system"
restore | r Restore modules from the user's "default" or system default.
restore | r name Restore modules from "name" collection.
restore system Restore module state to system defaults.
savelist List of saved collections.
describe | mcc name Describe the contents of a module collection.
disable name Disable (i.e. remove) a collection.
Deprecated commands:
getdefault [name] load name collection of modules or user's "default" if no name given.
===> Use "restore" instead <====
setdefault [name] Save current list of modules to name if given, otherwise save as the default list for you the user.
===> Use "save" instead. <====
Miscellaneous sub-commands:
is-loaded modulefile return a true status if module is loaded
is-avail modulefile return a true status if module can be loaded
show modulefile show the commands in the module file.
use [-a] path Prepend or Append path to MODULEPATH.
unuse path remove path from MODULEPATH.
tablelist output list of active modules as a lua table.
Important Environment Variables:
LMOD_COLORIZE If defined to be "YES" then Lmod prints properties and warning in color.
Lmod Web Sites
Documentation: https://lmod.readthedocs.org
GitHub: https://github.com/TACC/Lmod
SourceForge: https://lmod.sf.net
TACC Homepage: https://www.tacc.utexas.edu/research-development/tacc-projects/lmod
To report a bug please read https://lmod.readthedocs.io/en/latest/075_bug_reporting.html
=head1 AUTHOR
Robert McLay [email protected]
===========================
step 8
lua ProjectDIR/src/chkJson
===========================
Json is missing key: dot_files
Expand Down
3 changes: 2 additions & 1 deletion rt/help/help.tdesc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ testdescript = {
runLmod help amber # 4
runLmod --config # 5
runLmod --miniConfig # 6
runLmod --pod # 7
LD_PRELOAD= $LUA_EXEC $projectDir/src/lmod.in.lua bash --config_json 2> config.json
runBase $LUA_EXEC $projectDir/src/chkJson < config.json # 7
runBase $LUA_EXEC $projectDir/src/chkJson < config.json # 8
HOME=$ORIG_HOME
Expand Down
4 changes: 4 additions & 0 deletions rt/help/out.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,9 @@ lua ProjectDIR/src/lmod.in.lua shell --regression_testing --miniConfig
===========================
===========================
step 7
lua ProjectDIR/src/lmod.in.lua shell --regression_testing --pod
===========================
===========================
step 8
lua ProjectDIR/src/chkJson
===========================

0 comments on commit 7f715ee

Please sign in to comment.