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 paginate 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 parseEqualListConfValue: Ignore invalid default.*\\n)?DEBUG setConf: colors set to '.*'"
73 lappend ans "DEBUG setConf: color set to '0'"
74 lappend ans "DEBUG setConf: paginate set to '$paginate'"
75 if {$paginate} {
76 lappend ans "DEBUG setConf: pager set to '$pager_cmd'"
77 if {[file tail $pager_cmd] ni {{} cat}} {
78 lappend ans "DEBUG setState: shelltype set to '$shelltype'"
79 }
80 if {$use} {
81 lappend ans "DEBUG setState: is_stderr_tty set to '$is_stderr_tty'"
82 }
83 }
84 lappend ans "DEBUG setState: paginate set to '[expr {$is_stderr_tty && $use && $paginate}]'"
85 # check command exist if specified full path
86 if {$is_stderr_tty && $use && $paginate && [string index $cmd 0] eq "/" && ![file exists $cmd]} {
87 lappend ans "DEBUG setState: inhibit_errreport set to '0'"
88 lappend ans "$warn_msgs: couldn't execute \"$cmd\": no such file or directory"
89 set reportfd stderr
90 } elseif {$is_stderr_tty && $use && $paginate} {
91 set reportfd file\\d
92 } else {
93 set reportfd stderr
94 }
95 lappend ans "DEBUG setState: report_format set to 'regular'"
96 lappend ans "DEBUG setState: reportfd set to '$reportfd'"
97 lappend ans "DEBUG setState: timer set to '0'"
98 lappend ans $::vers_reportre
99 lappend ans "DEBUG setConf: logger set to '$::install_loggercmd'"
100 lappend ans "DEBUG setState: logging set to '0'"
101 lappend ans "DEBUG setState: logfd set to ''"
102 if {!$is_stderr_tty || !$use || !$paginate || [string index $cmd 0] eq "/" && ![file exists $cmd]} {
103 lappend ans "DEBUG setState: error_count set to '0'"
104 }
105
106 testouterr_cmd_re $shell "-V -D$modarg" "" [join $ans "\n"]
107 }
108
109 #
110 # The tests
111 #
112
113 foreach paginate {0 1} {
114
115 setenv_var MODULES_PAGINATE $paginate
116
117 # vanilla test, no related-env variable set
118 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
119 pager_test_case "--paginate" $pager_dfl_use 1 $install_pager $install_pageropts
120 pager_test_case "--no-pager" 0 0 $install_pager $install_pageropts
121
122 skip_if_quick_mode
123
124 # play with LESS env variable, should not have impact on install pager opts
125 set opts "-K"
126 if {$verbose} {
127 send_user "\tSetup LESS = '$opts'\n"
128 }
129 set env(LESS) $opts
130 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
131 pager_test_case "-p" $pager_dfl_use 1 $install_pager $install_pageropts
132 pager_test_case "-P" 0 0 $install_pager $install_pageropts
133
134 set opts ""
135 if {$verbose} {
136 send_user "\tSetup LESS = '$opts'\n"
137 }
138 set env(LESS) $opts
139 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
140 pager_test_case "--paginate" $pager_dfl_use 1 $install_pager $install_pageropts
141 pager_test_case "--no-pager" 0 0 $install_pager $install_pageropts
142
143 if {$verbose} {
144 send_user "\tUnset LESS\n"
145 }
146 unset env(LESS)
147
148
149 # play with PAGER env variable
150 # should not have any effect on modules pager configuration
151 set cmd "more"
152 if {$verbose} {
153 send_user "\tSetup PAGER = '$cmd'\n"
154 }
155 set env(PAGER) $cmd
156 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
157 pager_test_case "--paginate" $pager_dfl_use 1 $install_pager $install_pageropts
158 pager_test_case "--no-pager" 0 0 $install_pager $install_pageropts
159
160 set cmd ""
161 if {$verbose} {
162 send_user "\tSetup PAGER = '$cmd'\n"
163 }
164 set env(PAGER) $cmd
165 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
166 pager_test_case "-p" $pager_dfl_use 1 $install_pager $install_pageropts
167 pager_test_case "-P" 0 0 $install_pager $install_pageropts
168
169 set cmd "cat"
170 if {$verbose} {
171 send_user "\tSetup PAGER = '$cmd'\n"
172 }
173 set env(PAGER) $cmd
174 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
175 pager_test_case "--paginate" $pager_dfl_use 1 $install_pager $install_pageropts
176 pager_test_case "--no-pager" 0 0 $install_pager $install_pageropts
177
178 set opts "-K"
179 if {$verbose} {
180 send_user "\tSetup LESS = '$opts'\n"
181 }
182 set env(LESS) $opts
183 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
184 pager_test_case "--paginate" $pager_dfl_use 1 $install_pager $install_pageropts
185 pager_test_case "--no-pager" 0 0 $install_pager $install_pageropts
186
187 set cmd "/usr/bin/more"
188 if {$verbose} {
189 send_user "\tSetup PAGER = '$cmd'\n"
190 }
191 set env(PAGER) $cmd
192 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
193 pager_test_case "-p" $pager_dfl_use 1 $install_pager $install_pageropts
194 pager_test_case "-P" 0 0 $install_pager $install_pageropts
195
196 set cmd "/usr/bin/less"
197 if {$verbose} {
198 send_user "\tSetup PAGER = '$cmd'\n"
199 }
200 set env(PAGER) $cmd
201 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
202 pager_test_case "--paginate" $pager_dfl_use 1 $install_pager $install_pageropts
203 pager_test_case "--no-pager" 0 0 $install_pager $install_pageropts
204
205 set cmd "less -e"
206 if {$verbose} {
207 send_user "\tSetup PAGER = '$cmd'\n"
208 }
209 set env(PAGER) "$cmd"
210 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
211 pager_test_case "--paginate" $pager_dfl_use 1 $install_pager $install_pageropts
212 pager_test_case "--no-pager" 0 0 $install_pager $install_pageropts
213
214 set cmd "/usr/bin/less"
215 if {$verbose} {
216 send_user "\tUnset LESS\n"
217 send_user "\tSetup PAGER = '$cmd'\n"
218 }
219 unset env(LESS)
220 set env(PAGER) $cmd
221 pager_test_case "" $pager_dfl_use $paginate $install_pager $install_pageropts
222 pager_test_case "--paginate" $pager_dfl_use 1 $install_pager $install_pageropts
223 pager_test_case "--no-pager" 0 0 $install_pager $install_pageropts
224
225
226 # play with MODULES_PAGER env variable
227 set cmd "more"
228 if {$verbose} {
229 send_user "\tSetup MODULES_PAGER = '$cmd'\n"
230 }
231 set env(MODULES_PAGER) $cmd
232 pager_test_case "" 1 $paginate $cmd ""
233 pager_test_case "--paginate" 1 1 $cmd ""
234 pager_test_case "--no-pager" 0 0 $cmd ""
235
236 set cmd ""
237 if {$verbose} {
238 send_user "\tSetup MODULES_PAGER = '$cmd'\n"
239 }
240 set env(MODULES_PAGER) $cmd
241 pager_test_case "" 0 $paginate $cmd ""
242 pager_test_case "-p" 0 1 $cmd ""
243 pager_test_case "-P" 0 0 $cmd ""
244
245 set cmd "cat"
246 if {$verbose} {
247 send_user "\tSetup MODULES_PAGER = '$cmd'\n"
248 }
249 set env(MODULES_PAGER) $cmd
250 pager_test_case "" 0 $paginate $cmd ""
251 pager_test_case "--paginate" 0 1 $cmd ""
252 pager_test_case "--no-pager" 0 0 $cmd ""
253
254 set cmd "less"
255 set opts "-e"
256 if {$verbose} {
257 send_user "\tSetup MODULES_PAGER = '$cmd $opts'\n"
258 }
259 set env(MODULES_PAGER) "$cmd $opts"
260 pager_test_case "" 1 $paginate $cmd $opts
261 pager_test_case "--paginate" 1 1 $cmd $opts
262 pager_test_case "--no-pager" 0 0 $cmd $opts
263
264 if {$verbose} {
265 send_user "\tUnset PAGER\n"
266 }
267 unset env(PAGER)
268 pager_test_case "" 1 $paginate $cmd $opts
269 pager_test_case "-p" 1 1 $cmd $opts
270 pager_test_case "-P" 0 0 $cmd $opts
271
272 if {$verbose} {
273 send_user "\tSetup LESS = '-K'\n"
274 }
275 set env(LESS) "-K"
276 pager_test_case "" 1 $paginate $cmd $opts
277 pager_test_case "--paginate" 1 1 $cmd $opts
278 pager_test_case "--no-pager" 0 0 $cmd $opts
279
280
281 # bad command set as pager
282 set cmd "/unk/foo"
283 set opts ""
284 if {$verbose} {
285 send_user "\tSetup MODULES_PAGER = '$cmd'\n"
286 }
287 set env(MODULES_PAGER) $cmd
288 pager_test_case "" 1 $paginate $cmd $opts
289 pager_test_case "-p" 1 1 $cmd $opts
290 pager_test_case "-P" 0 0 $cmd $opts
291
292
293 # test activation depending on selected shell
294 set cmd "less"
295 set opts "-e"
296 setenv_var MODULES_PAGER "$cmd $opts"
297
298 foreach shell $supported_shells {
299 set shell_paginate [expr {$shell in [list {*}$real_shells cmd pwsh]}]
300 pager_test_case "" $shell_paginate $paginate $cmd $opts $shell
301 pager_test_case "--paginate" $shell_paginate 1 $cmd $opts $shell
302 pager_test_case "--no-pager" 0 0 $cmd $opts $shell
303 }
304
305
306 # restore environment
307 if {$verbose} {
308 send_user "\tUnset LESS\n"
309 send_user "\tUnset MODULES_PAGER\n"
310 }
311 unset env(LESS)
312 unset env(MODULES_PAGER)
313
314 # test stderr output made during modulefile evaluation comes in correct order
315 # regarding other debugging information when pager is effectively enabled
316 if {$is_stderr_tty} {
317
318 set module "info/command"
319 set modulefile "$modpath/$module"
320 set ans [list]
321 lappend ans [list set _LMFILES_ $modulefile]
322 lappend ans [list set LOADEDMODULES $module]
323 set anserr [list]
324 lappend anserr "DEBUG setState: cmdline set to '$MODULECMD sh load $module -D'"
325 if {$::install_multilibsupport eq {y}} {
326 lappend anserr "DEBUG setState: machine set to '$::tcl_platform(machine)'"
327 }
328 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')?"
329 lappend anserr "DEBUG setConf: siteconfig set to '$siteconfig_filere'"
330 lappend anserr "DEBUG sourceSiteConfig: Source site configuration \\($siteconfig_filere\\)"
331 lappend anserr "DEBUG setState: siteconfig_loaded set to '1'"
332 lappend anserr "DEBUG setConf: locked_configs set to '$install_lockedconfigs'"
333 lappend anserr "DEBUG setState: supported_shells set to 'sh bash ksh zsh csh tcsh fish cmd tcl perl python ruby lisp cmake r pwsh'"
334 lappend anserr "DEBUG setState: shell set to 'sh'"
335 lappend anserr "DEBUG setState: subcmd set to 'load'"
336 lappend anserr "DEBUG setState: subcmd_args set to '$module'"
337 lappend anserr "DEBUG setState: init_error_report set to '1'"
338 lappend anserr "(DEBUG .*)+"
339 lappend anserr "DEBUG setConf: paginate set to '$paginate'"
340 if {$paginate} {
341 lappend anserr "DEBUG setConf: pager set to '$install_pagercmd'"
342 lappend anserr "DEBUG setState: shelltype set to 'sh'"
343 lappend anserr "DEBUG setState: is_stderr_tty set to '1'"
344 }
345 lappend anserr "DEBUG setState: paginate set to '$paginate'"
346 lappend anserr "DEBUG setState: report_format set to 'regular'"
347 if {$paginate} {
348 lappend anserr "DEBUG setState: reportfd set to 'file\\d'"
349 } else {
350 lappend anserr "DEBUG setState: reportfd set to 'stderr'"
351 }
352 lappend anserr "DEBUG setState: timer set to '0'"
353 lappend anserr "(DEBUG .*)+"
354 lappend anserr "load"
355 lappend anserr "(DEBUG .*)+"
356 testouterr_cmd_re "sh" "load $module -D" $ans [join $anserr "\n"]
357
358 }
359
360 }
361
362 #
363 # Clean up variables used in this test case
364 #
365
366 reset_test_env
367
368 # remove procs
369 rename pager_test_case {}