From 99dc045eedf5c276ac8f91241a28a283957aaa45 Mon Sep 17 00:00:00 2001
From: Christoph Niethammer <niethammer@hlrs.de>
Date: Tue, 31 Jul 2012 22:04:46 +0000
Subject: [PATCH] Improved version of the check_modules.sh script fixing all
 current problems.

* Checks proper module loading
* Checks proper module unloading
* Fixed problem with module purge
* Nice color output
* Detailed logfile
---
 check_modules.sh | 112 ++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 91 insertions(+), 21 deletions(-)

diff --git a/check_modules.sh b/check_modules.sh
index 46b7a9d..cc332f8 100755
--- a/check_modules.sh
+++ b/check_modules.sh
@@ -2,45 +2,115 @@
 #
 # Christoph Niethammer <niethammer@hlrs.de>, (c) 2012
 #
-# TODO: 
-# - check for proper module unloading
+# Script checking the module environment for problems during module loading/unloading
+# 
+# Usage:
+# check_modules.sh [MODULE]
+#
+# Options:
+#   MODULE   May be any valid module path as used for 'module avail [MODULE]'
 #
 
+# Command line options: 
+moduleclass=$1  # check only subset of modules 
+
+# definitions for esear color output to display 
+Color_Off='\e[0m'       # Text Reset
+IGreen='\e[0;92m'       # Intense Green
+IRed='\e[0;91m'         # Intense Red
+
+# intermediate files, logfiles
+TMP=${TMP:=/tmp}
+logfile="check_modules.log"  # logfile with detailed information
+module_load_logfile="$TMP/.module_load.log"  # output of 'module load commands 
+module_rm_logfile="$TMP/.module_rm.log"  # output of 'module rm' commands
+module_clean_env_file="$TMP/.module_clean_env"  # original environment
+
+# safe the original environment
+set > $module_clean_env_file
+
+# list of all failed modules
 failed_modules=()
 
-TMP=${TMP:=/tmp}
-logfile="check_modules.log"
-module_load_logfile="$TMP/.module_load.log"
-module_rm_logfile="$TMP/.module_rm.log"
 
-moduleclass=$1
 
-echo "Module environment check, $(date)" | tee $logfile
+echo "--------------------" | tee $logfile
+echo "Module environment check" | tee -a $logfile
+echo "--------------------" | tee -a $logfile
+echo "Date: $(date)" | tee -a $logfile
+echo "Host: $(/bin/hostname)" | tee -a $logfile
+echo "USER: $USER" | tee -a $logfile
+echo "Logfile: $logfile" | tee -a $logfile
+echo "--------------------" | tee -a $logfile
+echo "Environment:" >> $logfile
+cat $module_clean_env_file >> $logfile
+echo "--------------------" >> $logfile
+
+for m_original in $(module av -t $moduleclass 2>&1); do
+    if [[ $m_original =~ ^[A-Za-z] ]]; then # skip any non module line in output
+        m=$(echo $m_original | sed -e 's/(.*)//') # Remove aliases e.g. (default)
+        echo -n "Checking $m_original ... " 
+        echo "Checking $m_original ... " >> $logfile
+
+        cmd="module load $m"
+        echo $cmd >> $logfile
+        $cmd > $module_load_logfile 2>&1 
+        cat $module_load_logfile >> $logfile
+        module li >>$logfile 2>&1
+
+        # check if module was loaded and did not report errors during loading
+        if  module li -t 2>&1 | grep $m >/dev/null &&  ! grep ERROR $module_load_logfile >/dev/null  ; then 
+
+            cmd="module rm $m"
+            echo $cmd >> $logfile
+            $cmd > $module_rm_logfile 2>&1
+            cat $module_rm_logfile >> $logfile
+            module li >>$logfile 2>&1
+
+            # check if module was unloaded
+            if module li -t 2>&1 | grep $m > /dev/null; then
+                echo -e "${IRed}unloading failed${Color_Off}"
+                echo "ERROR: unloading module '$m' failed" >> $logfile
+                failed_modules=(${failed_modules[@]} $m_original)
+            else
+                echo -e "${IGreen}success${Color_Off}"
+                echo "SUCCESS" >> $logfile
+            fi
 
-for m in $(module av -t $moduleclass 2>&1); do
-    if [[ $m =~ ^[A-Za-z] ]]; then
-        m=$(echo $m | sed -e 's/(.*)//')
-        echo -n "Checking $m ... " | tee -a $logfile
-        module load $m > $module_load_logfile 2>&1 
-        # check if module was loaded
-        if module li 2>&1 | grep $m > /dev/null; then 
-            echo "success" | tee -a $logfile
         else 
-            echo "failed" | tee -a $logfile
+            echo -e "${IRed}loading failed${Color_Off}"
+            echo "ERROR: loading module '$m' failed" >> $logfile
             failed_modules=(${failed_modules[@]} $m)
-            cat $module_load_logfile >> $logfile
         fi
-        module rm $m > $module_rm_logfile  2>&1
-        module purge 2>/dev/null
+
+        # clean up module environment
+        cmd="module purge"
+        echo $cmd >> $logfile
+        $cmd >>$logfile 2>&1
+        module li >>$logfile 2>&1
+        echo "Resetting environment ..." >>$logfile
+
+        # Reset the complete environment manually to overcome problems with
+        # inconsistent internal caches of the module command after module purge.
+        source $module_clean_env_file 2>/dev/null
+
+        # clean up intermediate files
         rm -f $module_load_logfile
         rm -f $module_rm_logfile
+
+        echo >>$logfile 2>&1
     fi
 done
 
+# clean up file storing the initial environment 
+rm -f $module_clean_env_file
+
+
 echo "----------------------------------------"
-echo "Summary of failed modules:"
+echo "Summary of failed modules (${#failed_modules[@]}):"
 echo "----------------------------------------"
 for m in ${failed_modules[@]}; do
     echo "$m"
 done
 echo "----------------------------------------"
+