Debian Codegraph @

testsuite/modules.00-init/100-pager.exp

raw
1 ##############################################################################
2 # Modules Revision 3.0
3 # Providing a flexible user environment
4 #
5 # File: modules.00-init/%M%
6 # Revision: %I%
7 # First Edition: 2017/10/30
8 # Last Mod.: %U%, %G%
9 #
10 # Authors: Xavier Delaruelle, [email protected]
11 #
12 # Description: Testuite testsequence
13 # Command:
14 # Sub-Command:
15 #
16 # Comment: %C{
17 # Check pager-related switches and configs.
18 # }C%
19 #
20 ##############################################################################
21
22 # check if stderr terminal attachment state is forced
23 set is_stderr_tty [siteconfig_isStderrTty]
24 if {$verbose} {
25 send_user "\tIs STDERR a TTY? = '$is_stderr_tty'\n"
26 }
27
28
29 # helper proc to generate pager test and expected debugging output
30 proc pager_test_case {modarg use asked cmd opts {shell sh}} {
31 global MODULECMD env install_pager install_pageropts siteconfig_filere warn_msgs is_stderr_tty install_termbg
32
33 if {$modarg ne ""} {
34 set modarg " $modarg"
35 }
36
37 set pager_cmd $cmd
38 if {$opts ne {}} {
39 append pager_cmd " $opts"
40 }
41
42 switch -- $shell {
43 ksh - bash - zsh {
44 set shelltype sh
45 }
46 tcsh {
47 set shelltype csh
48 }
49 default {
50 set shelltype $shell
51 }
52 }
53
54 set ans [list]
55
56 lappend ans "DEBUG setState: cmdline set to '$MODULECMD $shell -V -D${modarg}'"
57 if {$::install_libtclenvmodules ne {n}} {
58 if {$::install_multilibsupport eq {y}} {
59 lappend ans "DEBUG setState: machine set to '$::tcl_platform(machine)'"
60 }
61 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')?"
62 }
63 lappend ans "DEBUG setConf: siteconfig set to '$siteconfig_filere'(\\nDEBUG sourceSiteConfig: Source site configuration \\($siteconfig_filere\\))?(\\nDEBUG setState: siteconfig_loaded set to '1')?"
64 lappend ans "DEBUG setConf: locked_configs set to '$::install_lockedconfigs'"
65 lappend ans "DEBUG setState: supported_shells set to 'sh bash ksh zsh csh tcsh fish cmd tcl perl python ruby lisp cmake r pwsh'"
66 lappend ans "DEBUG setState: shell set to '$shell'"
67 lappend ans "DEBUG setState: subcmd set to ''"
68 lappend ans "DEBUG setState: subcmd_args set to ''"
69 lappend ans "DEBUG setState: init_error_report set to '1'"
70 lappend ans "DEBUG setConf: verbosity set to 'debug'"
71 lappend ans "DEBUG setConf: term_background set to '$install_termbg'"
72 lappend ans "(DEBUG initConfColors: Ignore invalid default.*\\n)?DEBUG setConf: colors set to '.*'"
73 lappend ans "DEBUG setConf: color set to '0'"
74 lappend ans "DEBUG setConf: pager set to '$pager_cmd'"
75 if {[file tail $pager_cmd] ni {{} cat}} {
76 lappend ans "DEBUG setState: shelltype set to '$shelltype'"
77 }
78 if {$use} {
79 lappend ans "DEBUG setState: is_stderr_tty set to '$is_stderr_tty'"
80 }
81 lappend ans "DEBUG setState: paginate set to '[expr {$is_stderr_tty && $use}]'"
82 # check command exist if specified full path
83 if {$is_stderr_tty && $use && [string index $cmd 0] eq "/" && ![file exists $cmd]} {
84 lappend ans "DEBUG setState: inhibit_errreport set to '0'"
85 lappend ans "$warn_msgs: couldn't execute \"$cmd\": no such file or directory"
86 set reportfd stderr
87 } elseif {$is_stderr_tty && $use} {
88 set reportfd file\\d
89 } else {
90 set reportfd stderr
91 }
92 lappend ans "DEBUG setState: report_format set to 'regular'"
93 lappend ans "DEBUG setState: reportfd set to '$reportfd'"
94 lappend ans "DEBUG setState: timer set to '0'"
95 lappend ans $::vers_reportre
96 lappend ans "DEBUG setConf: logger set to '$::install_loggercmd'"
97 lappend ans "DEBUG setState: logging set to '0'"
98 lappend ans "DEBUG setState: logfd set to ''"
99 if {!$is_stderr_tty || !$use || [string index $cmd 0] eq "/" && ![file exists $cmd]} {
100 lappend ans "DEBUG setState: error_count set to '0'"
101 }
102
103 testouterr_cmd_re $shell "-V -D$modarg" "" [join $ans "\n"]
104 }
105
106 #
107 # The tests
108 #
109
110 # vanilla test, no related-env variable set
111 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
112 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
113 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
114
115 skip_if_quick_mode
116
117 # play with LESS env variable, should not have impact on install pager opts
118 set opts "-K"
119 if {$verbose} {
120 send_user "\tSetup LESS = '$opts'\n"
121 }
122 set env(LESS) $opts
123 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
124 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
125 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
126
127 set opts ""
128 if {$verbose} {
129 send_user "\tSetup LESS = '$opts'\n"
130 }
131 set env(LESS) $opts
132 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
133 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
134 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
135
136 if {$verbose} {
137 send_user "\tUnset LESS\n"
138 }
139 unset env(LESS)
140
141
142 # play with PAGER env variable
143 # should not have any effect on modules pager configuration
144 set cmd "more"
145 if {$verbose} {
146 send_user "\tSetup PAGER = '$cmd'\n"
147 }
148 set env(PAGER) $cmd
149 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
150 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
151 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
152
153 set cmd ""
154 if {$verbose} {
155 send_user "\tSetup PAGER = '$cmd'\n"
156 }
157 set env(PAGER) $cmd
158 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
159 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
160 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
161
162 set cmd "cat"
163 if {$verbose} {
164 send_user "\tSetup PAGER = '$cmd'\n"
165 }
166 set env(PAGER) $cmd
167 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
168 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
169 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
170
171 set opts "-K"
172 if {$verbose} {
173 send_user "\tSetup LESS = '$opts'\n"
174 }
175 set env(LESS) $opts
176 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
177 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
178 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
179
180 set cmd "/usr/bin/more"
181 if {$verbose} {
182 send_user "\tSetup PAGER = '$cmd'\n"
183 }
184 set env(PAGER) $cmd
185 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
186 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
187 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
188
189 set cmd "/usr/bin/less"
190 if {$verbose} {
191 send_user "\tSetup PAGER = '$cmd'\n"
192 }
193 set env(PAGER) $cmd
194 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
195 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
196 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
197
198 set cmd "less -e"
199 if {$verbose} {
200 send_user "\tSetup PAGER = '$cmd'\n"
201 }
202 set env(PAGER) "$cmd"
203 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
204 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
205 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
206
207 set cmd "/usr/bin/less"
208 if {$verbose} {
209 send_user "\tUnset LESS\n"
210 send_user "\tSetup PAGER = '$cmd'\n"
211 }
212 unset env(LESS)
213 set env(PAGER) $cmd
214 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
215 pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
216 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
217
218
219 # play with MODULES_PAGER env variable
220 set cmd "more"
221 if {$verbose} {
222 send_user "\tSetup MODULES_PAGER = '$cmd'\n"
223 }
224 set env(MODULES_PAGER) $cmd
225 pager_test_case "" 1 "-" $cmd ""
226 pager_test_case "--paginate" 1 "1" $cmd ""
227 pager_test_case "--no-pager" 0 "0" $cmd ""
228
229 set cmd ""
230 if {$verbose} {
231 send_user "\tSetup MODULES_PAGER = '$cmd'\n"
232 }
233 set env(MODULES_PAGER) $cmd
234 pager_test_case "" 0 "-" $cmd ""
235 pager_test_case "--paginate" 0 "1" $cmd ""
236 pager_test_case "--no-pager" 0 "0" $cmd ""
237
238 set cmd "cat"
239 if {$verbose} {
240 send_user "\tSetup MODULES_PAGER = '$cmd'\n"
241 }
242 set env(MODULES_PAGER) $cmd
243 pager_test_case "" 0 "-" $cmd ""
244 pager_test_case "--paginate" 0 "1" $cmd ""
245 pager_test_case "--no-pager" 0 "0" $cmd ""
246
247 set cmd "less"
248 set opts "-e"
249 if {$verbose} {
250 send_user "\tSetup MODULES_PAGER = '$cmd $opts'\n"
251 }
252 set env(MODULES_PAGER) "$cmd $opts"
253 pager_test_case "" 1 "-" $cmd $opts
254 pager_test_case "--paginate" 1 "1" $cmd $opts
255 pager_test_case "--no-pager" 0 "0" $cmd $opts
256
257 if {$verbose} {
258 send_user "\tUnset PAGER\n"
259 }
260 unset env(PAGER)
261 pager_test_case "" 1 "-" $cmd $opts
262 pager_test_case "--paginate" 1 "1" $cmd $opts
263 pager_test_case "--no-pager" 0 "0" $cmd $opts
264
265 if {$verbose} {
266 send_user "\tSetup LESS = '-K'\n"
267 }
268 set env(LESS) "-K"
269 pager_test_case "" 1 "-" $cmd $opts
270 pager_test_case "--paginate" 1 "1" $cmd $opts
271 pager_test_case "--no-pager" 0 "0" $cmd $opts
272
273
274 # bad command set as pager
275 set cmd "/unk/foo"
276 set opts ""
277 if {$verbose} {
278 send_user "\tSetup MODULES_PAGER = '$cmd'\n"
279 }
280 set env(MODULES_PAGER) $cmd
281 pager_test_case "" 1 "-" $cmd $opts
282 pager_test_case "--paginate" 1 "1" $cmd $opts
283 pager_test_case "--no-pager" 0 "0" $cmd $opts
284
285
286 # test activation depending on selected shell
287 set cmd "less"
288 set opts "-e"
289 setenv_var MODULES_PAGER "$cmd $opts"
290
291 foreach shell $supported_shells {
292 set shell_paginate [expr {$shell in [list {*}$real_shells cmd pwsh]}]
293 pager_test_case "" $shell_paginate "-" $cmd $opts $shell
294 pager_test_case "--paginate" $shell_paginate "1" $cmd $opts $shell
295 pager_test_case "--no-pager" 0 "0" $cmd $opts $shell
296 }
297
298
299 # restore environment
300 if {$verbose} {
301 send_user "\tUnset LESS\n"
302 send_user "\tUnset MODULES_PAGER\n"
303 }
304 unset env(LESS)
305 unset env(MODULES_PAGER)
306
307
308 # test stderr output made during modulefile evaluation comes in correct order
309 # regarding other debugging information when pager is effectively enabled
310 if {$is_stderr_tty} {
311
312 set module "info/command"
313 set modulefile "$modpath/$module"
314 lappend ans [list set _LMFILES_ $modulefile]
315 lappend ans [list set LOADEDMODULES $module]
316 lappend anserr "DEBUG setState: cmdline set to '$MODULECMD sh load $module -D'"
317 if {$::install_multilibsupport eq {y}} {
318 lappend anserr "DEBUG setState: machine set to '$::tcl_platform(machine)'"
319 }
320 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')?"
321 lappend anserr "DEBUG setConf: siteconfig set to '$siteconfig_filere'"
322 lappend anserr "DEBUG sourceSiteConfig: Source site configuration \\($siteconfig_filere\\)"
323 lappend anserr "DEBUG setState: siteconfig_loaded set to '1'"
324 lappend anserr "DEBUG setConf: locked_configs set to '$install_lockedconfigs'"
325 lappend anserr "DEBUG setState: supported_shells set to 'sh bash ksh zsh csh tcsh fish cmd tcl perl python ruby lisp cmake r pwsh'"
326 lappend anserr "DEBUG setState: shell set to 'sh'"
327 lappend anserr "DEBUG setState: subcmd set to 'load'"
328 lappend anserr "DEBUG setState: subcmd_args set to '$module'"
329 lappend anserr "DEBUG setState: init_error_report set to '1'"
330 lappend anserr "(DEBUG .*)+"
331 lappend anserr "DEBUG setConf: pager set to '$install_pagercmd'"
332 lappend anserr "DEBUG setState: shelltype set to 'sh'"
333 lappend anserr "DEBUG setState: is_stderr_tty set to '1'"
334 lappend anserr "DEBUG setState: paginate set to '1'"
335 lappend anserr "DEBUG setState: report_format set to 'regular'"
336 lappend anserr "DEBUG setState: reportfd set to 'file\\d'"
337 lappend anserr "DEBUG setState: timer set to '0'"
338 lappend anserr "(DEBUG .*)+"
339 lappend anserr "load"
340 lappend anserr "(DEBUG .*)+"
341 testouterr_cmd_re "sh" "load $module -D" $ans [join $anserr "\n"]
342
343 }
344
345 #
346 # Clean up variables used in this test case
347 #
348
349 reset_test_env
350
351 # remove procs
352 rename pager_test_case {}