############################################################################## # Modules Revision 3.0 # Providing a flexible user environment # # File: modules.00-init/%M% # Revision: %I% # First Edition: 2017/10/30 # Last Mod.: %U%, %G% # # Authors: Xavier Delaruelle, xavier.delaruelle@cea.fr # # Description: Testuite testsequence # Command: # Sub-Command: # # Comment: %C{ # Check pager-related switches and configs. # }C% # ############################################################################## # check if stderr terminal attachment state is forced set is_stderr_tty [siteconfig_isStderrTty] if {$verbose} { send_user "\tIs STDERR a TTY? = '$is_stderr_tty'\n" } # helper proc to generate pager test and expected debugging output proc pager_test_case {modarg use asked cmd opts {shell sh}} { global MODULECMD env install_pager install_pageropts siteconfig_filere warn_msgs is_stderr_tty install_termbg if {$modarg ne ""} { set modarg " $modarg" } set pager_cmd $cmd if {$opts ne {}} { append pager_cmd " $opts" } switch -- $shell { ksh - bash - zsh { set shelltype sh } tcsh { set shelltype csh } default { set shelltype $shell } } set ans [list] lappend ans "DEBUG setState: cmdline set to '$MODULECMD $shell -V -D${modarg}'" if {$::install_libtclenvmodules ne {n}} { if {$::install_multilibsupport eq {y}} { lappend ans "DEBUG setState: machine set to '$::tcl_platform(machine)'" } lappend ans "DEBUG setConf: tcl_ext_lib set to '$::tclextlib_file'(\\nDEBUG Load Tcl extension library \\(.+\\))?(\\nDEBUG setState: tcl_ext_lib_loaded set to '1')?" } lappend ans "DEBUG setConf: siteconfig set to '$siteconfig_filere'(\\nDEBUG sourceSiteConfig: Source site configuration \\($siteconfig_filere\\))?(\\nDEBUG setState: siteconfig_loaded set to '1')?" lappend ans "DEBUG setConf: locked_configs set to '$::install_lockedconfigs'" lappend ans "DEBUG setState: supported_shells set to 'sh bash ksh zsh csh tcsh fish cmd tcl perl python ruby lisp cmake r pwsh'" lappend ans "DEBUG setState: shell set to '$shell'" lappend ans "DEBUG setState: subcmd set to ''" lappend ans "DEBUG setState: subcmd_args set to ''" lappend ans "DEBUG setState: init_error_report set to '1'" lappend ans "DEBUG setConf: verbosity set to 'debug'" lappend ans "DEBUG setConf: term_background set to '$install_termbg'" lappend ans "(DEBUG initConfColors: Ignore invalid default.*\\n)?DEBUG setConf: colors set to '.*'" lappend ans "DEBUG setConf: color set to '0'" lappend ans "DEBUG setConf: pager set to '$pager_cmd'" if {[file tail $pager_cmd] ni {{} cat}} { lappend ans "DEBUG setState: shelltype set to '$shelltype'" } if {$use} { lappend ans "DEBUG setState: is_stderr_tty set to '$is_stderr_tty'" } lappend ans "DEBUG setState: paginate set to '[expr {$is_stderr_tty && $use}]'" # check command exist if specified full path if {$is_stderr_tty && $use && [string index $cmd 0] eq "/" && ![file exists $cmd]} { lappend ans "DEBUG setState: inhibit_errreport set to '0'" lappend ans "$warn_msgs: couldn't execute \"$cmd\": no such file or directory" set reportfd stderr } elseif {$is_stderr_tty && $use} { set reportfd file\\d } else { set reportfd stderr } lappend ans "DEBUG setState: report_format set to 'regular'" lappend ans "DEBUG setState: reportfd set to '$reportfd'" lappend ans "DEBUG setState: timer set to '0'" lappend ans $::vers_reportre lappend ans "DEBUG setConf: logger set to '$::install_loggercmd'" lappend ans "DEBUG setState: logging set to '0'" lappend ans "DEBUG setState: logfd set to ''" if {!$is_stderr_tty || !$use || [string index $cmd 0] eq "/" && ![file exists $cmd]} { lappend ans "DEBUG setState: error_count set to '0'" } testouterr_cmd_re $shell "-V -D$modarg" "" [join $ans "\n"] } # # The tests # # vanilla test, no related-env variable set pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts skip_if_quick_mode # play with LESS env variable, should not have impact on install pager opts set opts "-K" if {$verbose} { send_user "\tSetup LESS = '$opts'\n" } set env(LESS) $opts pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts set opts "" if {$verbose} { send_user "\tSetup LESS = '$opts'\n" } set env(LESS) $opts pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts if {$verbose} { send_user "\tUnset LESS\n" } unset env(LESS) # play with PAGER env variable # should not have any effect on modules pager configuration set cmd "more" if {$verbose} { send_user "\tSetup PAGER = '$cmd'\n" } set env(PAGER) $cmd pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts set cmd "" if {$verbose} { send_user "\tSetup PAGER = '$cmd'\n" } set env(PAGER) $cmd pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts set cmd "cat" if {$verbose} { send_user "\tSetup PAGER = '$cmd'\n" } set env(PAGER) $cmd pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts set opts "-K" if {$verbose} { send_user "\tSetup LESS = '$opts'\n" } set env(LESS) $opts pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts set cmd "/usr/bin/more" if {$verbose} { send_user "\tSetup PAGER = '$cmd'\n" } set env(PAGER) $cmd pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts set cmd "/usr/bin/less" if {$verbose} { send_user "\tSetup PAGER = '$cmd'\n" } set env(PAGER) $cmd pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts set cmd "less -e" if {$verbose} { send_user "\tSetup PAGER = '$cmd'\n" } set env(PAGER) "$cmd" pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts set cmd "/usr/bin/less" if {$verbose} { send_user "\tUnset LESS\n" send_user "\tSetup PAGER = '$cmd'\n" } unset env(LESS) set env(PAGER) $cmd pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts # play with MODULES_PAGER env variable set cmd "more" if {$verbose} { send_user "\tSetup MODULES_PAGER = '$cmd'\n" } set env(MODULES_PAGER) $cmd pager_test_case "" 1 "-" $cmd "" pager_test_case "--paginate" 1 "1" $cmd "" pager_test_case "--no-pager" 0 "0" $cmd "" set cmd "" if {$verbose} { send_user "\tSetup MODULES_PAGER = '$cmd'\n" } set env(MODULES_PAGER) $cmd pager_test_case "" 0 "-" $cmd "" pager_test_case "--paginate" 0 "1" $cmd "" pager_test_case "--no-pager" 0 "0" $cmd "" set cmd "cat" if {$verbose} { send_user "\tSetup MODULES_PAGER = '$cmd'\n" } set env(MODULES_PAGER) $cmd pager_test_case "" 0 "-" $cmd "" pager_test_case "--paginate" 0 "1" $cmd "" pager_test_case "--no-pager" 0 "0" $cmd "" set cmd "less" set opts "-e" if {$verbose} { send_user "\tSetup MODULES_PAGER = '$cmd $opts'\n" } set env(MODULES_PAGER) "$cmd $opts" pager_test_case "" 1 "-" $cmd $opts pager_test_case "--paginate" 1 "1" $cmd $opts pager_test_case "--no-pager" 0 "0" $cmd $opts if {$verbose} { send_user "\tUnset PAGER\n" } unset env(PAGER) pager_test_case "" 1 "-" $cmd $opts pager_test_case "--paginate" 1 "1" $cmd $opts pager_test_case "--no-pager" 0 "0" $cmd $opts if {$verbose} { send_user "\tSetup LESS = '-K'\n" } set env(LESS) "-K" pager_test_case "" 1 "-" $cmd $opts pager_test_case "--paginate" 1 "1" $cmd $opts pager_test_case "--no-pager" 0 "0" $cmd $opts # bad command set as pager set cmd "/unk/foo" set opts "" if {$verbose} { send_user "\tSetup MODULES_PAGER = '$cmd'\n" } set env(MODULES_PAGER) $cmd pager_test_case "" 1 "-" $cmd $opts pager_test_case "--paginate" 1 "1" $cmd $opts pager_test_case "--no-pager" 0 "0" $cmd $opts # test activation depending on selected shell set cmd "less" set opts "-e" setenv_var MODULES_PAGER "$cmd $opts" foreach shell $supported_shells { set shell_paginate [expr {$shell in [list {*}$real_shells cmd pwsh]}] pager_test_case "" $shell_paginate "-" $cmd $opts $shell pager_test_case "--paginate" $shell_paginate "1" $cmd $opts $shell pager_test_case "--no-pager" 0 "0" $cmd $opts $shell } # restore environment if {$verbose} { send_user "\tUnset LESS\n" send_user "\tUnset MODULES_PAGER\n" } unset env(LESS) unset env(MODULES_PAGER) # test stderr output made during modulefile evaluation comes in correct order # regarding other debugging information when pager is effectively enabled if {$is_stderr_tty} { set module "info/command" set modulefile "$modpath/$module" lappend ans [list set _LMFILES_ $modulefile] lappend ans [list set LOADEDMODULES $module] lappend anserr "DEBUG setState: cmdline set to '$MODULECMD sh load $module -D'" if {$::install_multilibsupport eq {y}} { lappend anserr "DEBUG setState: machine set to '$::tcl_platform(machine)'" } lappend anserr "DEBUG setConf: tcl_ext_lib set to '$tclextlib_file'(\\nDEBUG Load Tcl extension library \\(.+\\))?(\\nDEBUG setState: tcl_ext_lib_loaded set to '1')?" lappend anserr "DEBUG setConf: siteconfig set to '$siteconfig_filere'" lappend anserr "DEBUG sourceSiteConfig: Source site configuration \\($siteconfig_filere\\)" lappend anserr "DEBUG setState: siteconfig_loaded set to '1'" lappend anserr "DEBUG setConf: locked_configs set to '$install_lockedconfigs'" lappend anserr "DEBUG setState: supported_shells set to 'sh bash ksh zsh csh tcsh fish cmd tcl perl python ruby lisp cmake r pwsh'" lappend anserr "DEBUG setState: shell set to 'sh'" lappend anserr "DEBUG setState: subcmd set to 'load'" lappend anserr "DEBUG setState: subcmd_args set to '$module'" lappend anserr "DEBUG setState: init_error_report set to '1'" lappend anserr "(DEBUG .*)+" lappend anserr "DEBUG setConf: pager set to '$install_pagercmd'" lappend anserr "DEBUG setState: shelltype set to 'sh'" lappend anserr "DEBUG setState: is_stderr_tty set to '1'" lappend anserr "DEBUG setState: paginate set to '1'" lappend anserr "DEBUG setState: report_format set to 'regular'" lappend anserr "DEBUG setState: reportfd set to 'file\\d'" lappend anserr "DEBUG setState: timer set to '0'" lappend anserr "(DEBUG .*)+" lappend anserr "load" lappend anserr "(DEBUG .*)+" testouterr_cmd_re "sh" "load $module -D" $ans [join $anserr "\n"] } # # Clean up variables used in this test case # reset_test_env # remove procs rename pager_test_case {}