Commit | Line | Data |
---|---|---|
40093367 | 1 | # Copyright (c) 2012 OPEN CASCADE SAS |
2 | # | |
3 | # The content of this file is subject to the Open CASCADE Technology Public | |
4 | # License Version 6.5 (the "License"). You may not use the content of this file | |
5 | # except in compliance with the License. Please obtain a copy of the License | |
6 | # at http://www.opencascade.org and read it completely before using this file. | |
7 | # | |
8 | # The Initial Developer of the Original Code is Open CASCADE S.A.S., having its | |
9 | # main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France. | |
10 | # | |
11 | # The Original Code and all software distributed under the License is | |
12 | # distributed on an "AS IS" basis, without warranty of any kind, and the | |
13 | # Initial Developer hereby disclaims all such warranties, including without | |
14 | # limitation, any warranties of merchantability, fitness for a particular | |
15 | # purpose or non-infringement. Please see the License for the specific terms | |
16 | # and conditions governing the rights and limitations under the License. | |
17 | ||
18 | ############################################################################ | |
19 | # This file defines scripts for execution of OCCT tests. | |
20 | # It should be loaded automatically when DRAW is started, and provides | |
351bbcba | 21 | # top-level commands starting with 'test'. Type 'help test' to get their |
22 | # synopsys. | |
40093367 | 23 | # See OCCT Tests User Guide for description of the test system. |
24 | # | |
25 | # Note: procedures with names starting with underscore are for internal use | |
26 | # inside the test system. | |
27 | ############################################################################ | |
28 | ||
29 | # Default verbose level for command _run_test | |
30 | set _tests_verbose 0 | |
31 | ||
32 | # regexp for parsing test case results in summary log | |
33 | set _test_case_regexp {^CASE\s+([\w.-]+)\s+([\w.-]+)\s+([\w.-]+)\s*:\s*([\w]+)(.*)} | |
34 | ||
35 | # Basic command to run indicated test case in DRAW | |
b725d7c5 | 36 | help test { |
37 | Run specified test case | |
38 | Use: test group grid casename [echo=0] | |
39 | - If echo is set to 0 (default), log is stored in memory and only summary | |
40 | is output (the log can be obtained with command "dlog get") | |
41 | - If echo is set to 1 or "-echo", all commands and results are echoed | |
42 | immediately, but log is not saved and summary is not produced | |
43 | } | |
5df3a117 | 44 | proc test {group grid casename {echo 0}} { |
40093367 | 45 | # get test case paths (will raise error if input is invalid) |
46 | _get_test $group $grid $casename dir gridname casefile | |
47 | ||
b725d7c5 | 48 | # if echo specified as "-echo", convert it to bool |
49 | if { "$echo" == "-echo" } { set echo t } | |
50 | ||
40093367 | 51 | # run test |
c97067ad | 52 | uplevel _run_test $dir $group $gridname $casefile $echo |
40093367 | 53 | |
54 | # check log | |
5df3a117 | 55 | if { ! $echo } { |
56 | _check_log $dir $group $gridname $casename [dlog get] | |
57 | } | |
40093367 | 58 | |
59 | return | |
60 | } | |
61 | ||
62 | # Basic command to run indicated test case in DRAW | |
b725d7c5 | 63 | help testgrid { |
64 | Run all tests, or specified group, or one grid | |
65 | Use: testgrid [group [grid]] [options...] | |
66 | Allowed options are: | |
67 | -parallel N: run N parallel processes (default is number of CPUs, 0 to disable) | |
9753e6de | 68 | -refresh N: save summary logs every N seconds (default 600, minimal 1, 0 to disable) |
b725d7c5 | 69 | -outdir dirname: set log directory (should be empty or non-existing) |
70 | -overwrite: force writing logs in existing non-empty directory | |
71 | -xml filename: write XML report for Jenkins (in JUnit-like format) | |
40093367 | 72 | } |
b725d7c5 | 73 | proc testgrid {args} { |
40093367 | 74 | global env tcl_platform _tests_verbose |
75 | ||
76 | ###################################################### | |
77 | # check arguments | |
78 | ###################################################### | |
79 | ||
80 | # check that environment variable defining paths to test scripts is defined | |
81 | if { ! [info exists env(CSF_TestScriptsPath)] || | |
82 | [llength $env(CSF_TestScriptsPath)] <= 0 } { | |
83 | error "Error: Environment variable CSF_TestScriptsPath is not defined" | |
84 | } | |
85 | ||
86 | # treat options | |
b725d7c5 | 87 | set parallel [_get_nb_cpus] |
40093367 | 88 | set refresh 60 |
b725d7c5 | 89 | set logdir "" |
40093367 | 90 | set overwrite 0 |
91 | set xmlfile "" | |
92 | for {set narg 0} {$narg < [llength $args]} {incr narg} { | |
93 | set arg [lindex $args $narg] | |
94 | ||
95 | # parallel execution | |
96 | if { $arg == "-parallel" } { | |
97 | incr narg | |
b725d7c5 | 98 | if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { |
40093367 | 99 | set parallel [expr [lindex $args $narg]] |
100 | } else { | |
b725d7c5 | 101 | error "Option -parallel requires argument" |
40093367 | 102 | } |
103 | continue | |
104 | } | |
105 | ||
106 | # refresh logs time | |
107 | if { $arg == "-refresh" } { | |
108 | incr narg | |
b725d7c5 | 109 | if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { |
40093367 | 110 | set refresh [expr [lindex $args $narg]] |
111 | } else { | |
b725d7c5 | 112 | error "Option -refresh requires argument" |
113 | } | |
114 | continue | |
115 | } | |
116 | ||
117 | # output directory | |
118 | if { $arg == "-outdir" } { | |
119 | incr narg | |
120 | if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { | |
121 | set logdir [lindex $args $narg] | |
122 | } else { | |
123 | error "Option -outdir requires argument" | |
40093367 | 124 | } |
125 | continue | |
126 | } | |
127 | ||
128 | # allow overwrite logs | |
129 | if { $arg == "-overwrite" } { | |
130 | set overwrite 1 | |
131 | continue | |
132 | } | |
133 | ||
134 | # refresh logs time | |
135 | if { $arg == "-xml" } { | |
136 | incr narg | |
b725d7c5 | 137 | if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { |
40093367 | 138 | set xmlfile [lindex $args $narg] |
139 | } | |
140 | if { $xmlfile == "" } { | |
141 | set xmlfile TESTS-summary.xml | |
142 | } | |
143 | continue | |
144 | } | |
145 | ||
146 | # unsupported option | |
147 | if { [regexp {^-} $arg] } { | |
148 | error "Error: unsupported option \"$arg\"" | |
149 | } | |
150 | ||
151 | # treat arguments not recognized as options as group and grid names | |
152 | if { ! [info exists groupname] } { | |
153 | set groupname $arg | |
154 | } elseif { ! [info exists gridname] } { | |
155 | set gridname $arg | |
156 | } else { | |
157 | error "Error: cannot interpret argument $narg ($arg): both group and grid names are already defined by previous args!" | |
158 | } | |
159 | } | |
160 | ||
161 | # check that target log directory is empty or does not exist | |
162 | set logdir [file normalize [string trim $logdir]] | |
163 | if { $logdir == "" } { | |
b725d7c5 | 164 | # if specified logdir is empty string, generate unique name like |
165 | # results_<branch>_<timestamp> | |
166 | set prefix "results" | |
167 | if { ! [catch {exec git branch} gitout] && | |
168 | [regexp {[*] ([\w]+)} $gitout res branch] } { | |
169 | set prefix "${prefix}_$branch" | |
170 | } | |
171 | set logdir "${prefix}_[clock format [clock seconds] -format {%Y-%m-%dT%H%M}]" | |
40093367 | 172 | set logdir [file normalize $logdir] |
173 | } | |
174 | if { [file isdirectory $logdir] && ! $overwrite && ! [catch {glob -directory $logdir *}] } { | |
175 | error "Error: Specified log directory \"$logdir\" is not empty; please clean it before running tests" | |
176 | } | |
177 | if { [catch {file mkdir $logdir}] || ! [file writable $logdir] } { | |
178 | error "Error: Cannot create directory \"$logdir\", or it is not writable" | |
179 | } | |
180 | ||
181 | ###################################################### | |
182 | # prepare list of tests to be performed | |
183 | ###################################################### | |
184 | ||
185 | # list of tests, each defined by a list of: | |
186 | # test scripts directory | |
187 | # group (subfolder) name | |
188 | # grid (subfolder) name | |
189 | # test case name | |
190 | # path to test case file | |
191 | set tests_list {} | |
192 | ||
193 | # iterate by all script paths | |
194 | foreach dir [_split_path $env(CSF_TestScriptsPath)] { | |
195 | # protection against empty paths | |
196 | set dir [string trim $dir] | |
197 | if { $dir == "" } { continue } | |
198 | ||
199 | if { $_tests_verbose > 0 } { _log_and_puts log "Examining tests directory $dir" } | |
200 | ||
201 | # check that directory exists | |
202 | if { ! [file isdirectory $dir] } { | |
203 | _log_and_puts log "Warning: directory $dir listed in CSF_TestScriptsPath does not exist, skipped" | |
204 | continue | |
205 | } | |
206 | ||
207 | # if test group is specified, check that directory with given name exists in this dir | |
208 | # if not, continue to the next test dir | |
209 | if { [info exists groupname] && $groupname != "" } { | |
210 | if { [file isdirectory $dir/$groupname] } { | |
211 | set groups $groupname | |
212 | } else { | |
213 | continue | |
214 | } | |
215 | } else { | |
216 | # else search all directories in the current dir | |
217 | if [catch {glob -directory $dir -tail -types d *} groups] { continue } | |
218 | } | |
219 | ||
220 | # iterate by groups | |
221 | if { $_tests_verbose > 0 } { _log_and_puts log "Groups to be executed: $groups" } | |
222 | foreach group [lsort -dictionary $groups] { | |
223 | if { $_tests_verbose > 0 } { _log_and_puts log "Examining group directory $group" } | |
224 | ||
225 | # file grids.list must exist: it defines sequence of grids in the group | |
226 | if { ! [file exists $dir/$group/grids.list] } { | |
227 | _log_and_puts log "Warning: directory $dir/$group does not contain file grids.list, skipped" | |
228 | continue | |
229 | } | |
230 | ||
231 | # read grids.list file and make a list of grids to be executed | |
232 | set gridlist {} | |
233 | set fd [open $dir/$group/grids.list] | |
234 | set nline 0 | |
235 | while { [gets $fd line] >= 0 } { | |
236 | incr nline | |
237 | ||
238 | # skip comments and empty lines | |
239 | if { [regexp "\[ \t\]*\#.*" $line] } { continue } | |
240 | if { [string trim $line] == "" } { continue } | |
241 | ||
242 | # get grid id and name | |
243 | if { ! [regexp "^\(\[0-9\]+\)\[ \t\]*\(\[A-Za-z0-9_.-\]+\)\$" $line res gridid grid] } { | |
244 | _log_and_puts log "Warning: cannot recognize line $nline in file $dir/$group/grids.list as \"gridid gridname\"; ignored" | |
245 | continue | |
246 | } | |
247 | ||
248 | # if specific grid is requested, check that it is present; otherwise make complete list | |
249 | if { ! [info exists gridname] || $gridname == "" || $gridname == $gridid || $gridname == $grid } { | |
250 | lappend gridlist $grid | |
251 | } | |
252 | } | |
253 | close $fd | |
254 | ||
255 | # iterate by all grids | |
256 | foreach grid $gridlist { | |
257 | ||
258 | # check if this grid is aliased to another one | |
259 | set griddir $dir/$group/$grid | |
260 | if { [file exists $griddir/cases.list] } { | |
261 | set fd [open $griddir/cases.list] | |
262 | if { [gets $fd line] >= 0 } { | |
263 | set griddir [file normalize $dir/$group/$grid/[string trim $line]] | |
264 | } | |
265 | close $fd | |
266 | } | |
267 | ||
268 | # check if grid directory actually exists | |
269 | if { ! [file isdirectory $griddir] } { | |
270 | _log_and_puts log "Error: tests directory for grid $grid ($griddir) is missing; skipped" | |
271 | continue | |
272 | } | |
273 | ||
274 | # create directory for logging test results | |
275 | if { $logdir != "" } { file mkdir $logdir/$group/$grid } | |
276 | ||
277 | # iterate by all tests in the grid directory | |
278 | if { [catch {glob -directory $griddir -type f *} testfiles] } { continue } | |
279 | foreach casefile [lsort -dictionary $testfiles] { | |
280 | # filter out begin and end files | |
281 | set casename [file tail $casefile] | |
282 | if { $casename == "begin" || $casename == "end" } { continue } | |
283 | ||
284 | lappend tests_list [list $dir $group $grid $casename $casefile] | |
285 | } | |
286 | } | |
287 | } | |
288 | } | |
289 | if { [llength $tests_list] < 1 } { | |
290 | error "Error: no tests are found, check you input arguments and variable CSF_TestScriptsPath!" | |
291 | } | |
292 | ||
293 | ###################################################### | |
294 | # run tests | |
295 | ###################################################### | |
296 | ||
297 | # log command arguments and environment | |
9753e6de | 298 | lappend log "Command: testgrid $args" |
299 | lappend log "Host: [info hostname]" | |
300 | lappend log "Started on: [clock format [clock seconds] -format {%Y-%m-%d %H:%M:%S}]" | |
301 | catch {lappend log "DRAW build:\n[dversion]" } | |
302 | lappend log "Environment:" | |
8a262fa1 | 303 | foreach envar [lsort [array names env]] { |
9753e6de | 304 | lappend log "$envar=\"$env($envar)\"" |
40093367 | 305 | } |
9753e6de | 306 | lappend log "" |
40093367 | 307 | |
308 | set refresh_timer [clock seconds] | |
309 | uplevel dchrono _timer reset | |
310 | uplevel dchrono _timer start | |
311 | ||
312 | # if parallel execution is requested, allocate thread pool | |
313 | if { $parallel > 0 } { | |
314 | if { ! [info exists tcl_platform(threaded)] || [catch {package require Thread}] } { | |
315 | _log_and_puts log "Warning: Tcl package Thread is not available, running in sequential mode" | |
316 | set parallel 0 | |
317 | } else { | |
318 | set worker [tpool::create -minworkers $parallel -maxworkers $parallel] | |
319 | # suspend the pool until all jobs are posted, to prevent blocking of the process | |
320 | # of starting / processing jobs by running threads | |
b725d7c5 | 321 | catch {tpool::suspend $worker} |
40093367 | 322 | if { $_tests_verbose > 0 } { _log_and_puts log "Executing tests in (up to) $parallel threads" } |
9753e6de | 323 | # limit number of jobs in the queue by reasonable value |
324 | # to prevent slowdown due to unnecessary queue processing | |
325 | set nbpooled 0 | |
326 | set nbpooled_max [expr 10 * $parallel] | |
327 | set nbpooled_ok [expr 5 * $parallel] | |
40093367 | 328 | } |
329 | } | |
330 | ||
331 | # start test cases | |
8a262fa1 | 332 | set userbreak 0 |
40093367 | 333 | foreach test_def $tests_list { |
8a262fa1 | 334 | # check for user break |
9753e6de | 335 | if { $userbreak || "[info commands dbreak]" == "dbreak" && [catch dbreak] } { |
8a262fa1 | 336 | set userbreak 1 |
337 | break | |
338 | } | |
339 | ||
40093367 | 340 | set dir [lindex $test_def 0] |
341 | set group [lindex $test_def 1] | |
342 | set grid [lindex $test_def 2] | |
343 | set casename [lindex $test_def 3] | |
344 | set casefile [lindex $test_def 4] | |
345 | ||
346 | # command to set tests for generation of image in results directory | |
347 | set imgdir_cmd "" | |
348 | if { $logdir != "" } { set imgdir_cmd "set imagedir $logdir/$group/$grid" } | |
349 | ||
350 | # prepare command file for running test case in separate instance of DRAW | |
351 | set fd_cmd [open $logdir/$group/$grid/${casename}.tcl w] | |
352 | puts $fd_cmd "$imgdir_cmd" | |
353 | puts $fd_cmd "set test_image $casename" | |
b725d7c5 | 354 | puts $fd_cmd "_run_test $dir $group $grid $casefile t" |
5df3a117 | 355 | |
40093367 | 356 | # use dlog command to obtain complete output of the test when it is absent (i.e. since OCCT 6.6.0) |
5df3a117 | 357 | # note: this is not needed if echo is set to 1 in call to _run_test above |
40093367 | 358 | if { ! [catch {dlog get}] } { |
359 | puts $fd_cmd "puts \[dlog get\]" | |
360 | } else { | |
361 | # else try to use old-style QA_ variables to get more output... | |
362 | set env(QA_DUMP) 1 | |
363 | set env(QA_DUP) 1 | |
364 | set env(QA_print_command) 1 | |
365 | } | |
5df3a117 | 366 | |
40093367 | 367 | # final 'exit' is needed when running on Linux under VirtualGl |
368 | puts $fd_cmd "exit" | |
369 | close $fd_cmd | |
8418c617 | 370 | |
371 | # commant to run DRAW with a command file; | |
372 | # note that empty string is passed as standard input to avoid possible | |
373 | # hang-ups due to waiting for stdin of the launching process | |
374 | set command "exec <<{} DRAWEXE -f $logdir/$group/$grid/${casename}.tcl" | |
375 | ||
40093367 | 376 | # alternative method to run without temporary file; disabled as it needs too many backslashes |
377 | # else { | |
8418c617 | 378 | # set command "exec <<\"\" DRAWEXE -c $imgdir_cmd\\\; set test_image $casename\\\; \ |
40093367 | 379 | # _run_test $dir $group $grid $casefile\\\; \ |
380 | # puts \\\[dlog get\\\]\\\; exit" | |
381 | # } | |
382 | ||
383 | # run test case, either in parallel or sequentially | |
384 | if { $parallel > 0 } { | |
385 | # parallel execution | |
386 | set job [tpool::post -nowait $worker "catch \"$command\" output; return \$output"] | |
387 | set job_def($job) [list $logdir $dir $group $grid $casename] | |
9753e6de | 388 | incr nbpooled |
389 | if { $nbpooled > $nbpooled_max } { | |
390 | _testgrid_process_jobs $worker $nbpooled_ok | |
391 | } | |
40093367 | 392 | } else { |
393 | # sequential execution | |
394 | catch {eval $command} output | |
395 | _log_test_case $output $logdir $dir $group $grid $casename log | |
396 | ||
397 | # update summary log with requested period | |
398 | if { $logdir != "" && $refresh > 0 && [expr [clock seconds] - $refresh_timer > $refresh] } { | |
399 | # update and dump summary | |
400 | _log_summarize $logdir $log | |
401 | set refresh_timer [clock seconds] | |
402 | } | |
403 | } | |
404 | } | |
405 | ||
406 | # get results of started threads | |
407 | if { $parallel > 0 } { | |
9753e6de | 408 | _testgrid_process_jobs $worker |
40093367 | 409 | # release thread pool |
9753e6de | 410 | if { $nbpooled > 0 } { |
411 | tpool::cancel $worker [array names job_def] | |
412 | } | |
413 | catch {tpool::resume $worker} | |
40093367 | 414 | tpool::release $worker |
415 | } | |
416 | ||
417 | uplevel dchrono _timer stop | |
418 | set time [lindex [split [uplevel dchrono _timer show] "\n"] 0] | |
419 | ||
8a262fa1 | 420 | if { $userbreak } { |
9753e6de | 421 | _log_and_puts log "*********** Stopped by user break ***********" |
8a262fa1 | 422 | set time "${time} \nNote: the process is not finished, stopped by user break!" |
423 | } | |
424 | ||
40093367 | 425 | ###################################################### |
426 | # output summary logs and exit | |
427 | ###################################################### | |
428 | ||
429 | _log_summarize $logdir $log $time | |
430 | if { $logdir != "" } { | |
431 | puts "Detailed logs are saved in $logdir" | |
432 | } | |
433 | if { $logdir != "" && $xmlfile != "" } { | |
434 | # XML output file is assumed relative to log dir unless it is absolute | |
435 | if { [ file pathtype $xmlfile] == "relative" } { | |
436 | set xmlfile [file normalize $logdir/$xmlfile] | |
437 | } | |
438 | _log_xml_summary $logdir $xmlfile $log 0 | |
439 | puts "XML summary is saved to $xmlfile" | |
440 | } | |
441 | ||
442 | return | |
443 | } | |
444 | ||
22db40eb | 445 | # Procedure to regenerate summary log from logs of test cases |
446 | help testsummarize { | |
447 | Regenerate summary log in the test directory from logs of test cases. | |
448 | This can be necessary if test grids are executed separately (e.g. on | |
449 | different stations) or some grids have been re-executed. | |
450 | Use: testsummarize dir | |
451 | } | |
452 | proc testsummarize {dir} { | |
453 | global _test_case_regexp | |
454 | ||
455 | if { ! [file isdirectory $dir] } { | |
456 | error "Error: \"$dir\" is not a directory" | |
457 | } | |
458 | ||
459 | # get summary statements from all test cases in one log | |
9753e6de | 460 | set log {} |
22db40eb | 461 | |
462 | # to avoid huge listing of logs, first find all subdirectories and iterate | |
463 | # by them, parsing log files in each subdirectory independently | |
464 | foreach grid [glob -directory $dir -types d -tails */*] { | |
465 | foreach caselog [glob -nocomplain -directory [file join $dir $grid] -types f -tails *.log] { | |
466 | set file [file join $dir $grid $caselog] | |
467 | set nbfound 0 | |
468 | set fd [open $file r] | |
469 | while { [gets $fd line] >= 0 } { | |
470 | if { [regexp $_test_case_regexp $line res grp grd cas status message] } { | |
471 | if { "[file join $grid $caselog]" != "[file join $grp $grd ${cas}.log]" } { | |
472 | puts "Error: $file contains status line for another test case ($line)" | |
473 | } | |
9753e6de | 474 | lappend log $line |
22db40eb | 475 | incr nbfound |
476 | } | |
477 | } | |
478 | close $fd | |
479 | ||
480 | if { $nbfound != 1 } { | |
481 | puts "Error: $file contains $nbfound status lines, expected 1" | |
482 | } | |
483 | } | |
484 | } | |
485 | ||
486 | _log_summarize $dir $log "Summary regenerated from logs at [clock format [clock seconds]]" | |
487 | return | |
488 | } | |
489 | ||
cc6a292d | 490 | # Procedure to compare results of two runs of test cases |
b725d7c5 | 491 | help testdiff { |
492 | Compare results of two executions of tests (CPU times, ...) | |
22db40eb | 493 | Use: testdiff dir1 dir2 [groupname [gridname]] [options...] |
b725d7c5 | 494 | Where dir1 and dir2 are directories containing logs of two test runs. |
495 | Allowed options are: | |
22db40eb | 496 | -save filename: save resulting log in specified file (default name is |
60874ff8 | 497 | <dir1>/diff-<dir2>.log); HTML log is saved with same name |
22db40eb | 498 | and extension .html |
b725d7c5 | 499 | -status {same|ok|all}: filter cases for comparing by their status: |
500 | same - only cases with same status are compared (default) | |
501 | ok - only cases with OK status in both logs are compared | |
502 | all - results are compared regardless of status | |
503 | -verbose level: | |
504 | 1 - output only differences | |
22db40eb | 505 | 2 - output also list of logs and directories present in one of dirs only |
506 | 3 - (default) output also progress messages | |
cc6a292d | 507 | } |
508 | proc testdiff {dir1 dir2 args} { | |
509 | if { "$dir1" == "$dir2" } { | |
510 | error "Input directories are the same" | |
511 | } | |
512 | ||
513 | ###################################################### | |
514 | # check arguments | |
515 | ###################################################### | |
516 | ||
517 | # treat options | |
22db40eb | 518 | set logfile [file join $dir1 "diff-[file tail $dir2].log"] |
cc6a292d | 519 | set basename "" |
520 | set status "same" | |
521 | set verbose 3 | |
522 | for {set narg 0} {$narg < [llength $args]} {incr narg} { | |
523 | set arg [lindex $args $narg] | |
524 | ||
525 | # log file name | |
526 | if { $arg == "-save" } { | |
527 | incr narg | |
22db40eb | 528 | if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { |
cc6a292d | 529 | set logfile [lindex $args $narg] |
530 | } else { | |
531 | error "Error: Option -save must be followed by log file name" | |
532 | } | |
533 | continue | |
534 | } | |
535 | ||
cc6a292d | 536 | # status filter |
537 | if { $arg == "-status" } { | |
538 | incr narg | |
22db40eb | 539 | if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { |
cc6a292d | 540 | set status [lindex $args $narg] |
541 | } else { set status "" } | |
542 | if { "$status" != "same" && "$status" != "all" && "$status" != "ok" } { | |
543 | error "Error: Option -status must be followed by one of \"same\", \"all\", or \"ok\"" | |
544 | } | |
545 | continue | |
546 | } | |
547 | ||
548 | # verbose level | |
549 | if { $arg == "-verbose" } { | |
550 | incr narg | |
22db40eb | 551 | if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { |
cc6a292d | 552 | set verbose [expr [lindex $args $narg]] |
22db40eb | 553 | } else { |
554 | error "Error: Option -verbose must be followed by integer verbose level" | |
cc6a292d | 555 | } |
556 | continue | |
557 | } | |
558 | ||
22db40eb | 559 | if { [regexp {^-} $arg] } { |
cc6a292d | 560 | error "Error: unsupported option \"$arg\"" |
22db40eb | 561 | } |
562 | ||
563 | # non-option arguments form a subdirectory path | |
564 | set basename [file join $basename $arg] | |
cc6a292d | 565 | } |
566 | ||
567 | # run diff procedure (recursive) | |
568 | _test_diff $dir1 $dir2 $basename $status $verbose log | |
569 | ||
570 | # save result to log file | |
571 | if { "$logfile" != "" } { | |
9753e6de | 572 | _log_save $logfile [join $log "\n"] |
22db40eb | 573 | _log_html_diff "[file rootname $logfile].html" $log $dir1 $dir2 |
574 | puts "Log is saved to $logfile (and .html)" | |
cc6a292d | 575 | } |
576 | ||
577 | return | |
578 | } | |
579 | ||
351bbcba | 580 | # Procedure to check data file before adding it to repository |
581 | help testfile { | |
582 | Check data file and prepare it for putting to test data files repository. | |
583 | Use: testfile [filelist] | |
584 | ||
585 | Will report if: | |
586 | - data file (non-binary) is in DOS encoding (CR/LF) | |
587 | - same data file (with same or another name) already exists in the repository | |
588 | - another file with the same name already exists | |
589 | Note that names are assumed to be case-insensitive (for Windows). | |
590 | ||
591 | Unless the file is already in the repository, tries to load it, reports | |
592 | the recognized file format, file size, number of faces and edges in the | |
60874ff8 | 593 | loaded shape (if any), and makes snapshot (in the temporary directory). |
351bbcba | 594 | Finally it advises whether the file should be put to public section of the |
595 | repository. | |
596 | } | |
597 | proc testfile {filelist} { | |
598 | global env | |
599 | ||
600 | # check that CSF_TestDataPath is defined | |
601 | if { ! [info exists env(CSF_TestDataPath)] } { | |
602 | error "Environment variable CSF_TestDataPath must be defined!" | |
603 | } | |
604 | ||
605 | # build registry of existing data files (name -> path) and (size -> path) | |
606 | puts "Checking available test data files..." | |
607 | foreach dir [_split_path $env(CSF_TestDataPath)] { | |
608 | while {[llength $dir] != 0} { | |
609 | set curr [lindex $dir 0] | |
610 | set dir [lrange $dir 1 end] | |
611 | eval lappend dir [glob -nocomplain -directory $curr -type d *] | |
612 | foreach file [glob -nocomplain -directory $curr -type f *] { | |
613 | set name [file tail $file] | |
614 | set name_lower [string tolower $name] | |
615 | ||
616 | # check that the file is not in DOS encoding | |
617 | if { [_check_dos_encoding $file] } { | |
618 | puts "Warning: file $file is in DOS encoding; was this intended?" | |
619 | } | |
620 | _check_file_format $file | |
621 | ||
622 | # check if file with the same name is present twice or more | |
623 | if { [info exists names($name_lower)] } { | |
624 | puts "Error: more than one file with name $name is present in the repository:" | |
625 | if { [_diff_files $file $names($name_lower)] } { | |
626 | puts "(files are different by content)" | |
627 | } else { | |
628 | puts "(files are same by content)" | |
629 | } | |
630 | puts "--> $file" | |
631 | puts "--> $names($name_lower)" | |
632 | continue | |
633 | } | |
634 | ||
635 | # check if file with the same content exists | |
636 | set size [file size $file] | |
637 | if { [info exists sizes($size)] } { | |
638 | foreach other $sizes($size) { | |
639 | if { ! [_diff_files $file $other] } { | |
640 | puts "Warning: two files with the same content found:" | |
641 | puts "--> $file" | |
642 | puts "--> $other" | |
643 | } | |
644 | } | |
645 | } | |
646 | ||
647 | # add the file to the registry | |
648 | set names($name_lower) $file | |
649 | lappend sizes($size) $file | |
650 | } | |
651 | } | |
652 | } | |
653 | if { [llength $filelist] <= 0 } { return } | |
654 | ||
655 | # check the new files | |
656 | set has_images f | |
657 | puts "Checking new file(s)..." | |
658 | foreach file $filelist { | |
659 | # check for DOS encoding | |
660 | if { [_check_dos_encoding $file] } { | |
661 | puts "$file: Warning: DOS encoding detected" | |
662 | } | |
663 | ||
664 | set name [file tail $file] | |
665 | set name_lower [string tolower $name] | |
666 | ||
667 | # check for presence of the file with same name | |
668 | if { [info exists names($name_lower)] } { | |
669 | if { [_diff_files $file $names($name_lower)] } { | |
670 | puts "$file: Error: name is already used by existing file\n--> $names($name_lower)" | |
671 | } else { | |
672 | puts "$file: OK: already in the repository \n--> $names($name_lower)" | |
673 | continue | |
674 | } | |
675 | } | |
676 | ||
677 | # check if file with the same content exists | |
678 | set size [file size $file] | |
679 | if { [info exists sizes($size)] } { | |
680 | set found f | |
681 | foreach other $sizes($size) { | |
682 | if { ! [_diff_files $file $other] } { | |
683 | puts "$file: OK: the same file is already present under name [file tail $other]\n--> $other" | |
684 | set found t | |
685 | break | |
686 | } | |
687 | } | |
688 | if { $found } { continue } | |
689 | } | |
690 | ||
691 | # try to read the file | |
692 | set format [_check_file_format $file] | |
693 | if { [catch {uplevel load_data_file $file $format a}] } { | |
694 | puts "$file: Error: Cannot read as $format file" | |
695 | continue | |
696 | } | |
697 | ||
698 | # get number of faces and edges | |
699 | set edges 0 | |
700 | set faces 0 | |
701 | set nbs [uplevel nbshapes a] | |
702 | regexp {EDGE[ \t:]*([0-9]+)} $nbs res edges | |
703 | regexp {FACE[ \t:]*([0-9]+)} $nbs res faces | |
704 | ||
705 | # classify; first check file size and number of faces and edges | |
706 | if { $size < 95000 && $faces < 20 && $edges < 100 } { | |
707 | set dir public | |
708 | } else { | |
709 | set dir private | |
710 | # check if one of names of that file corresponds to typical name for | |
711 | # MDTV bugs or has extension .rle, this should be old model | |
712 | if { [regexp -nocase {.*(cts|ats|pro|buc|ger|fra|usa|uki)[0-9]+.*} $name] || | |
713 | [regexp -nocase {[.]rle\y} $name] } { | |
714 | set dir old | |
715 | } | |
716 | } | |
717 | ||
718 | # add stats | |
719 | puts "$file: $format size=[expr $size / 1024] KiB, nbfaces=$faces, nbedges=$edges -> $dir" | |
720 | ||
60874ff8 | 721 | set tmpdir [_get_temp_dir] |
722 | file mkdir $tmpdir/$dir | |
351bbcba | 723 | |
724 | # make snapshot | |
725 | pload AISV | |
726 | uplevel vdisplay a | |
727 | uplevel vfit | |
728 | uplevel vzfit | |
60874ff8 | 729 | uplevel vdump $tmpdir/$dir/[file rootname [file tail $file]].png |
351bbcba | 730 | set has_images t |
731 | } | |
732 | if { $has_images } { | |
60874ff8 | 733 | puts "Snapshots are saved in subdirectory [_get_temp_dir]" |
351bbcba | 734 | } |
735 | } | |
736 | ||
22db40eb | 737 | # Procedure to locate data file for test given its name. |
738 | # The search is performed assuming that the function is called | |
739 | # from the test case script; the search order is: | |
740 | # - subdirectory "data" of the test script (grid) folder | |
741 | # - subdirectories in environment variable CSF_TestDataPath | |
742 | # - subdirectory set by datadir command | |
743 | # If file is not found, raises Tcl error. | |
744 | proc locate_data_file {filename} { | |
745 | global env groupname gridname casename | |
746 | ||
747 | # check if the file is located in the subdirectory data of the script dir | |
748 | set scriptfile [info script] | |
749 | if { $scriptfile != "" } { | |
750 | set path [file join [file dirname $scriptfile] data $filename] | |
751 | if { [file exists $path] } { | |
752 | return [file normalize $path] | |
753 | } | |
754 | } | |
755 | ||
756 | # check sub-directories in paths indicated by CSF_TestDataPath | |
757 | if { [info exists env(CSF_TestDataPath)] } { | |
758 | foreach dir [_split_path $env(CSF_TestDataPath)] { | |
759 | while {[llength $dir] != 0} { | |
760 | set name [lindex $dir 0] | |
761 | set dir [lrange $dir 1 end] | |
80482e01 | 762 | # skip directories starting with dot |
763 | if { [regexp {^[.]} $name] } { continue } | |
22db40eb | 764 | if { [file exists $name/$filename] } { |
765 | return [file normalize $name/$filename] | |
766 | } | |
80482e01 | 767 | eval lappend dir [glob -nocomplain -directory $name -type d *] |
22db40eb | 768 | } |
769 | } | |
770 | } | |
771 | ||
772 | # check current datadir | |
773 | if { [file exists [uplevel datadir]/$filename] } { | |
774 | return [file normalize [uplevel datadir]/$filename] | |
775 | } | |
776 | ||
777 | # raise error | |
c97067ad | 778 | error [join [list "File $filename could not be found" \ |
22db40eb | 779 | "(should be in paths indicated by CSF_TestDataPath environment variable, " \ |
780 | "or in subfolder data in the script directory)"] "\n"] | |
781 | } | |
782 | ||
40093367 | 783 | # Internal procedure to find test case indicated by group, grid, and test case names; |
784 | # returns: | |
785 | # - dir: path to the base directory of the tests group | |
786 | # - gridname: actual name of the grid | |
787 | # - casefile: path to the test case script | |
788 | # if no such test is found, raises error with appropriate message | |
789 | proc _get_test {group grid casename _dir _gridname _casefile} { | |
790 | upvar $_dir dir | |
791 | upvar $_gridname gridname | |
792 | upvar $_casefile casefile | |
793 | ||
794 | global env | |
795 | ||
796 | # check that environment variable defining paths to test scripts is defined | |
797 | if { ! [info exists env(CSF_TestScriptsPath)] || | |
798 | [llength $env(CSF_TestScriptsPath)] <= 0 } { | |
799 | error "Error: Environment variable CSF_TestScriptsPath is not defined" | |
800 | } | |
801 | ||
802 | # iterate by all script paths | |
803 | foreach dir [_split_path $env(CSF_TestScriptsPath)] { | |
804 | # protection against empty paths | |
805 | set dir [string trim $dir] | |
806 | if { $dir == "" } { continue } | |
807 | ||
808 | # check that directory exists | |
809 | if { ! [file isdirectory $dir] } { | |
810 | puts "Warning: directory $dir listed in CSF_TestScriptsPath does not exist, skipped" | |
811 | continue | |
812 | } | |
813 | ||
814 | # check if test group with given name exists in this dir | |
815 | # if not, continue to the next test dir | |
816 | if { ! [file isdirectory $dir/$group] } { continue } | |
817 | ||
818 | # check that grid with given name (possibly alias) exists; stop otherwise | |
819 | set gridname $grid | |
820 | if { ! [file isdirectory $dir/$group/$gridname] } { | |
821 | # check if grid is named by alias rather than by actual name | |
822 | if { [file exists $dir/$group/grids.list] } { | |
823 | set fd [open $dir/$group/grids.list] | |
824 | while { [gets $fd line] >= 0 } { | |
825 | if { [regexp "\[ \t\]*\#.*" $line] } { continue } | |
826 | if { [regexp "^$grid\[ \t\]*\(\[A-Za-z0-9_.-\]+\)\$" $line res gridname] } { | |
827 | break | |
828 | } | |
829 | } | |
830 | close $fd | |
831 | } | |
832 | } | |
833 | if { ! [file isdirectory $dir/$group/$gridname] } { continue } | |
834 | ||
835 | # get actual file name of the script; stop if it cannot be found | |
836 | set casefile $dir/$group/$gridname/$casename | |
837 | if { ! [file exists $casefile] } { | |
838 | # check if this grid is aliased to another one | |
839 | if { [file exists $dir/$group/$gridname/cases.list] } { | |
840 | set fd [open $dir/$group/$gridname/cases.list] | |
841 | if { [gets $fd line] >= 0 } { | |
842 | set casefile [file normalize $dir/$group/$gridname/[string trim $line]/$casename] | |
843 | } | |
844 | close $fd | |
845 | } | |
846 | } | |
847 | if { [file exists $casefile] } { | |
848 | # normal return | |
849 | return | |
850 | } | |
851 | } | |
852 | ||
853 | # coming here means specified test is not found; report error | |
854 | error [join [list "Error: test case $group / $grid / $casename is not found in paths listed in variable" \ | |
855 | "CSF_TestScriptsPath (current value is \"$env(CSF_TestScriptsPath)\")"] "\n"] | |
856 | } | |
857 | ||
858 | # Internal procedure to run test case indicated by base directory, | |
859 | # grid and grid names, and test case file path. | |
860 | # The log can be obtained by command "dlog get". | |
5df3a117 | 861 | proc _run_test {scriptsdir group gridname casefile echo} { |
40093367 | 862 | global env |
863 | ||
864 | # start timer | |
865 | uplevel dchrono _timer reset | |
866 | uplevel dchrono _timer start | |
22db40eb | 867 | catch {uplevel meminfo w} membase |
40093367 | 868 | |
869 | # enable commands logging; switch to old-style mode if dlog command is not present | |
870 | set dlog_exists 1 | |
871 | if { [catch {dlog reset}] } { | |
872 | set dlog_exists 0 | |
5df3a117 | 873 | } elseif { $echo } { |
874 | decho on | |
40093367 | 875 | } else { |
876 | dlog reset | |
877 | dlog on | |
878 | rename puts puts-saved | |
879 | proc puts args { | |
880 | global _tests_verbose | |
881 | ||
882 | # log only output to stdout and stderr, not to file! | |
883 | if {[llength $args] > 1} { | |
d33dea30 PK |
884 | set optarg [lindex $args end-1] |
885 | if { $optarg == "stdout" || $optarg == "stderr" || $optarg == "-newline" } { | |
40093367 | 886 | dlog add [lindex $args end] |
c97067ad | 887 | } else { |
888 | eval puts-saved $args | |
40093367 | 889 | } |
890 | } else { | |
891 | dlog add [lindex $args end] | |
892 | } | |
40093367 | 893 | } |
894 | } | |
895 | ||
40093367 | 896 | # evaluate test case |
897 | if [catch { | |
60874ff8 | 898 | # set variables identifying test case |
40093367 | 899 | uplevel set casename [file tail $casefile] |
8418c617 | 900 | uplevel set groupname $group |
901 | uplevel set gridname $gridname | |
c97067ad | 902 | uplevel set dirname $scriptsdir |
40093367 | 903 | |
60874ff8 | 904 | # set variables for saving of images if not yet set |
905 | if { ! [uplevel info exists imagedir] } { | |
906 | uplevel set imagedir [_get_temp_dir] | |
907 | uplevel set test_image \$casename | |
908 | } | |
909 | ||
910 | # execute test scripts | |
40093367 | 911 | if { [file exists $scriptsdir/$group/begin] } { |
912 | puts "Executing $scriptsdir/$group/begin..."; flush stdout | |
913 | uplevel source $scriptsdir/$group/begin | |
914 | } | |
915 | if { [file exists $scriptsdir/$group/$gridname/begin] } { | |
916 | puts "Executing $scriptsdir/$group/$gridname/begin..."; flush stdout | |
917 | uplevel source $scriptsdir/$group/$gridname/begin | |
918 | } | |
919 | ||
920 | puts "Executing $casefile..."; flush stdout | |
921 | uplevel source $casefile | |
922 | ||
923 | if { [file exists $scriptsdir/$group/$gridname/end] } { | |
924 | puts "Executing $scriptsdir/$group/$gridname/end..."; flush stdout | |
925 | uplevel source $scriptsdir/$group/$gridname/end | |
926 | } | |
927 | if { [file exists $scriptsdir/$group/end] } { | |
928 | puts "Executing $scriptsdir/$group/end..."; flush stdout | |
929 | uplevel source $scriptsdir/$group/end | |
930 | } | |
931 | } res] { | |
932 | puts "Tcl Exception: $res" | |
933 | } | |
934 | ||
40093367 | 935 | # stop logging |
936 | if { $dlog_exists } { | |
5df3a117 | 937 | if { $echo } { |
938 | decho off | |
939 | } else { | |
940 | rename puts {} | |
941 | rename puts-saved puts | |
942 | dlog off | |
943 | } | |
40093367 | 944 | } |
945 | ||
8418c617 | 946 | # stop cpulimit killer if armed by the test |
947 | cpulimit | |
948 | ||
22db40eb | 949 | # add memory and timing info |
950 | set stats "" | |
951 | if { ! [catch {uplevel meminfo w} memuse] } { | |
952 | set stats "MEMORY DELTA: [expr ($memuse - $membase) / 1024] KiB\n" | |
953 | } | |
40093367 | 954 | uplevel dchrono _timer stop |
955 | set time [uplevel dchrono _timer show] | |
956 | if [regexp -nocase {CPU user time:[ \t]*([0-9.e-]+)} $time res cpu] { | |
22db40eb | 957 | set stats "${stats}TOTAL CPU TIME: $cpu sec\n" |
958 | } | |
959 | if { $dlog_exists && ! $echo } { | |
960 | dlog add $stats | |
961 | } else { | |
962 | puts $stats | |
40093367 | 963 | } |
964 | } | |
965 | ||
966 | # Internal procedure to check log of test execution and decide if it passed or failed | |
967 | proc _check_log {dir group gridname casename log {_summary {}} {_html_log {}}} { | |
968 | global env | |
969 | if { $_summary != "" } { upvar $_summary summary } | |
970 | if { $_html_log != "" } { upvar $_html_log html_log } | |
9753e6de | 971 | set summary {} |
972 | set html_log {} | |
40093367 | 973 | |
974 | if [catch { | |
975 | ||
976 | # load definition of 'bad words' indicating test failure | |
977 | # note that rules are loaded in the order of decreasing priority (grid - group - common), | |
978 | # thus grid rules will override group ones | |
979 | set badwords {} | |
980 | foreach rulesfile [list $dir/$group/$gridname/parse.rules $dir/$group/parse.rules $dir/parse.rules] { | |
981 | if [catch {set fd [open $rulesfile r]}] { continue } | |
982 | while { [gets $fd line] >= 0 } { | |
983 | # skip comments and empty lines | |
984 | if { [regexp "\[ \t\]*\#.*" $line] } { continue } | |
985 | if { [string trim $line] == "" } { continue } | |
986 | # extract regexp | |
987 | if { ! [regexp {^([^/]*)/([^/]*)/(.*)$} $line res status rexp comment] } { | |
988 | puts "Warning: cannot recognize parsing rule \"$line\" in file $rulesfile" | |
989 | continue | |
990 | } | |
991 | set status [string trim $status] | |
992 | if { $comment != "" } { set status "$status ([string trim $comment])" } | |
993 | set rexp [regsub -all {\\b} $rexp {\\y}] ;# convert regexp from Perl to Tcl style | |
994 | lappend badwords [list $status $rexp] | |
995 | } | |
996 | close $fd | |
997 | } | |
998 | if { [llength $badwords] <= 0 } { | |
999 | puts "Warning: no definition of error indicators found (check files parse.rules)" | |
1000 | } | |
1001 | ||
1002 | # analyse log line-by-line | |
1003 | set todos {} | |
1004 | set status "" | |
1005 | foreach line [split $log "\n"] { | |
1006 | # check if line defines specific treatment of some messages | |
b58dfc5e | 1007 | set deb_info [dversion] |
1008 | if [regexp -nocase {^[ \s]*TODO ([^:]*):(.*)$} $line res platforms pattern] { | |
1009 | if { [regexp {DEBUG_} $platforms] != 1 } { | |
1010 | if { ! [regexp -nocase {\mAll\M} $platforms] && | |
1011 | ! [regexp -nocase "\\m$env(os_type)\\M" $platforms] } { | |
1012 | lappend html_log $line | |
1013 | continue ;# TODO statement is for another platform | |
1014 | } | |
1015 | ||
1016 | # record TODOs that mark unstable cases | |
1017 | if { [regexp {[\?]} $platforms] } { | |
1018 | set todos_unstable([llength $todos]) 1 | |
1019 | } | |
1020 | ||
1021 | lappend todos [regsub -all {\\b} [string trim $pattern] {\\y}] ;# convert regexp from Perl to Tcl style | |
1022 | lappend html_log [_html_highlight BAD $line] | |
1023 | continue | |
1024 | } | |
1025 | ||
1026 | if { [regexp "Debug mode" $deb_info] != 1 && [regexp {DEBUG_} $platforms] == 1 } { | |
1027 | continue | |
40093367 | 1028 | } |
1029 | ||
b58dfc5e | 1030 | if { [regexp "Debug mode" $deb_info] == 1 && [regexp {DEBUG_} $platforms] == 1 } { |
1031 | if { ! [regexp -nocase {\mAll\M} $platforms] && | |
1032 | ! [regexp -nocase "\\m$env(os_type)\\M" $platforms] } { | |
1033 | lappend html_log $line | |
1034 | continue ;# TODO statement is for another platform | |
1035 | } | |
40093367 | 1036 | |
b58dfc5e | 1037 | # record TODOs that mark unstable cases |
1038 | if { [regexp {[\?]} $platforms] } { | |
1039 | set todos_unstable([llength $todos]) 1 | |
1040 | } | |
1041 | ||
1042 | lappend todos [regsub -all {\\b} [string trim $pattern] {\\y}] ;# convert regexp from Perl to Tcl style | |
1043 | lappend html_log [_html_highlight BAD $line] | |
1044 | continue | |
1045 | } | |
40093367 | 1046 | } |
b58dfc5e | 1047 | |
40093367 | 1048 | # check for presence of messages indicating test result |
1049 | set ismarked 0 | |
1050 | foreach bw $badwords { | |
1051 | if { [regexp [lindex $bw 1] $line] } { | |
1052 | # check if this is known bad case | |
1053 | set is_known 0 | |
1054 | for {set i 0} {$i < [llength $todos]} {incr i} { | |
1055 | if { [regexp [lindex $todos $i] $line] } { | |
1056 | set is_known 1 | |
1057 | incr todo_count($i) | |
9753e6de | 1058 | lappend html_log [_html_highlight BAD $line] |
40093367 | 1059 | break |
1060 | } | |
1061 | } | |
1062 | ||
1063 | # if it is not in todo, define status | |
1064 | if { ! $is_known } { | |
1065 | set stat [lindex $bw 0 0] | |
9753e6de | 1066 | lappend html_log [_html_highlight $stat $line] |
40093367 | 1067 | if { $status == "" && $stat != "OK" && ! [regexp -nocase {^IGNOR} $stat] } { |
1068 | set status [lindex $bw 0] | |
1069 | } | |
1070 | } | |
1071 | set ismarked 1 | |
1072 | break | |
1073 | } | |
1074 | } | |
1075 | if { ! $ismarked } { | |
9753e6de | 1076 | lappend html_log $line |
40093367 | 1077 | } |
1078 | } | |
1079 | ||
1080 | # check for presence of TEST COMPLETED statement | |
1081 | if { $status == "" && ! [regexp {TEST COMPLETED} $log] } { | |
1082 | # check whether absence of TEST COMPLETED is known problem | |
1083 | set i [lsearch $todos "TEST INCOMPLETE"] | |
1084 | if { $i >= 0 } { | |
1085 | incr todo_count($i) | |
1086 | } else { | |
1087 | set status "FAILED (no final message is found)" | |
1088 | } | |
1089 | } | |
1090 | ||
1091 | # check declared bad cases and diagnose possible improvement | |
1092 | # (bad case declared but not detected). | |
1093 | # Note that absence of the problem marked by TODO with question mark | |
1094 | # (unstable) is not reported as improvement. | |
1095 | if { $status == "" } { | |
1096 | for {set i 0} {$i < [llength $todos]} {incr i} { | |
1097 | if { ! [info exists todos_unstable($i)] && | |
1098 | (! [info exists todo_count($i)] || $todo_count($i) <= 0) } { | |
1099 | set status "IMPROVEMENT (expected problem TODO no. [expr $i + 1] is not detected)" | |
1100 | break; | |
1101 | } | |
1102 | } | |
1103 | } | |
1104 | ||
1105 | # report test as known bad if at least one of expected problems is found | |
1106 | if { $status == "" && [llength [array names todo_count]] > 0 } { | |
1107 | set status "BAD (known problem)" | |
1108 | } | |
1109 | ||
1110 | # report normal OK | |
1111 | if { $status == "" } {set status "OK" } | |
1112 | ||
1113 | } res] { | |
1114 | set status "FAILED ($res)" | |
1115 | } | |
1116 | ||
1117 | # put final message | |
1118 | _log_and_puts summary "CASE $group $gridname $casename: $status" | |
9753e6de | 1119 | set summary [join $summary "\n"] |
1120 | set html_log "[_html_highlight [lindex $status 0] $summary]\n[join $html_log \n]" | |
40093367 | 1121 | } |
1122 | ||
1123 | # Auxiliary procedure putting message to both cout and log variable (list) | |
1124 | proc _log_and_puts {logvar message} { | |
1125 | if { $logvar != "" } { | |
1126 | upvar $logvar log | |
9753e6de | 1127 | lappend log $message |
40093367 | 1128 | } |
1129 | puts $message | |
1130 | } | |
1131 | ||
1132 | # Auxiliary procedure to log result on single test case | |
1133 | proc _log_test_case {output logdir dir group grid casename logvar} { | |
1134 | upvar $logvar log | |
1135 | ||
1136 | # check result and make HTML log | |
1137 | _check_log $dir $group $grid $casename $output summary html_log | |
9753e6de | 1138 | lappend log $summary |
40093367 | 1139 | |
1140 | # save log to file | |
1141 | if { $logdir != "" } { | |
1142 | _log_html $logdir/$group/$grid/$casename.html $html_log "Test $group $grid $casename" | |
1143 | _log_save $logdir/$group/$grid/$casename.log "$output\n$summary" "Test $group $grid $casename" | |
1144 | } | |
1145 | } | |
1146 | ||
1147 | # Auxiliary procedure to save log to file | |
1148 | proc _log_save {file log {title {}}} { | |
1149 | # create missing directories as needed | |
1150 | catch {file mkdir [file dirname $file]} | |
1151 | ||
1152 | # try to open a file | |
1153 | if [catch {set fd [open $file w]} res] { | |
1154 | error "Error saving log file $file: $res" | |
1155 | } | |
1156 | ||
1157 | # dump log and close | |
1158 | puts $fd "$title\n" | |
1159 | puts $fd $log | |
1160 | close $fd | |
1161 | return | |
1162 | } | |
1163 | ||
22db40eb | 1164 | # Auxiliary procedure to make a (relative if possible) URL to a file for |
1165 | # inclusion a reference in HTML log | |
1166 | proc _make_url {htmldir file} { | |
1167 | set htmlpath [file split [file normalize $htmldir]] | |
1168 | set filepath [file split [file normalize $file]] | |
1169 | for {set i 0} {$i < [llength $htmlpath]} {incr i} { | |
1170 | if { "[lindex $htmlpath $i]" != "[lindex $filepath $i]" } { | |
1171 | if { $i == 0 } { break } | |
1172 | return "[string repeat "../" [expr [llength $htmlpath] - $i - 1]][eval file join [lrange $filepath $i end]]" | |
1173 | } | |
1174 | } | |
1175 | ||
1176 | # if relative path could not be made, return full file URL | |
1177 | return "file://[file normalize $file]" | |
1178 | } | |
1179 | ||
40093367 | 1180 | # Auxiliary procedure to save log to file |
1181 | proc _log_html {file log {title {}}} { | |
1182 | # create missing directories as needed | |
1183 | catch {file mkdir [file dirname $file]} | |
1184 | ||
1185 | # try to open a file | |
1186 | if [catch {set fd [open $file w]} res] { | |
1187 | error "Error saving log file $file: $res" | |
1188 | } | |
1189 | ||
1190 | # print header | |
22db40eb | 1191 | puts $fd "<html><head><title>$title</title></head><body><h1>$title</h1>" |
40093367 | 1192 | |
1193 | # add images if present | |
1194 | set imgbasename [file rootname [file tail $file]] | |
1195 | foreach img [lsort [glob -nocomplain -directory [file dirname $file] -tails ${imgbasename}*.gif ${imgbasename}*.png ${imgbasename}*.jpg]] { | |
3b21f8ae | 1196 | puts $fd "<p>[file tail $img]<br><img src=\"$img\"/><p>" |
40093367 | 1197 | } |
1198 | ||
b725d7c5 | 1199 | # print log body, trying to add HTML links to script files on lines like |
1200 | # "Executing <filename>..." | |
40093367 | 1201 | puts $fd "<pre>" |
b725d7c5 | 1202 | foreach line [split $log "\n"] { |
1203 | if { [regexp {Executing[ \t]+([a-zA-Z0-9._/:-]+[^.])} $line res script] && | |
1204 | [file exists $script] } { | |
22db40eb | 1205 | set line [regsub $script $line "<a href=\"[_make_url $file $script]\">$script</a>"] |
b725d7c5 | 1206 | } |
1207 | puts $fd $line | |
1208 | } | |
40093367 | 1209 | puts $fd "</pre></body></html>" |
1210 | ||
1211 | close $fd | |
1212 | return | |
1213 | } | |
1214 | ||
1215 | # Auxiliary method to make text with HTML highlighting according to status | |
1216 | proc _html_color {status} { | |
1217 | # choose a color for the cell according to result | |
1218 | if { $status == "OK" } { | |
1219 | return lightgreen | |
1220 | } elseif { [regexp -nocase {^FAIL} $status] } { | |
1221 | return red | |
1222 | } elseif { [regexp -nocase {^BAD} $status] } { | |
1223 | return yellow | |
1224 | } elseif { [regexp -nocase {^IMP} $status] } { | |
1225 | return orange | |
1226 | } elseif { [regexp -nocase {^SKIP} $status] } { | |
1227 | return gray | |
1228 | } elseif { [regexp -nocase {^IGNOR} $status] } { | |
1229 | return gray | |
1230 | } else { | |
1231 | puts "Warning: no color defined for status $status, using red as if FAILED" | |
1232 | return red | |
1233 | } | |
1234 | } | |
1235 | ||
1236 | # Format text line in HTML to be colored according to the status | |
1237 | proc _html_highlight {status line} { | |
1238 | return "<table><tr><td bgcolor=\"[_html_color $status]\">$line</td></tr></table>" | |
1239 | } | |
1240 | ||
1241 | # Internal procedure to generate HTML page presenting log of the tests | |
1242 | # execution in tabular form, with links to reports on individual cases | |
1243 | proc _log_html_summary {logdir log totals regressions improvements total_time} { | |
1244 | global _test_case_regexp | |
1245 | ||
9753e6de | 1246 | # create missing directories as needed |
1247 | file mkdir $logdir | |
40093367 | 1248 | |
1249 | # try to open a file and start HTML | |
1250 | if [catch {set fd [open $logdir/summary.html w]} res] { | |
1251 | error "Error creating log file: $res" | |
1252 | } | |
1253 | ||
1254 | # write HRML header, including command to refresh log if still in progress | |
1255 | puts $fd "<html><head>" | |
1256 | puts $fd "<title>Tests summary</title>" | |
1257 | if { $total_time == "" } { | |
1258 | puts $fd "<meta http-equiv=\"refresh\" content=\"10\">" | |
1259 | } | |
1260 | puts $fd "<meta http-equiv=\"pragma\" content=\"NO-CACHE\">" | |
1261 | puts $fd "</head><body>" | |
1262 | ||
1263 | # put summary | |
1264 | set legend(OK) "Test passed OK" | |
1265 | set legend(FAILED) "Test failed (regression)" | |
1266 | set legend(BAD) "Known problem" | |
1267 | set legend(IMPROVEMENT) "Possible improvement (expected problem not detected)" | |
1268 | set legend(SKIPPED) "Test skipped due to lack of data file" | |
1269 | puts $fd "<h1>Summary</h1><table>" | |
1270 | foreach nbstat $totals { | |
1271 | set status [lindex $nbstat 1] | |
1272 | if { [info exists legend($status)] } { | |
1273 | set comment $legend($status) | |
1274 | } else { | |
1275 | set comment "User-defined status" | |
1276 | } | |
1277 | puts $fd "<tr><td align=\"right\">[lindex $nbstat 0]</td><td bgcolor=\"[_html_color $status]\">$status</td><td>$comment</td></tr>" | |
1278 | } | |
1279 | puts $fd "</table>" | |
1280 | ||
1281 | # time stamp and elapsed time info | |
1282 | if { $total_time != "" } { | |
8a262fa1 | 1283 | puts $fd "<p>Generated on [clock format [clock seconds] -format {%Y-%m-%d %H:%M:%S}] on [info hostname]\n<p>" |
1284 | puts $fd [join [split $total_time "\n"] "<p>"] | |
40093367 | 1285 | } else { |
1286 | puts $fd "<p>NOTE: This is intermediate summary; the tests are still running! This page will refresh automatically until tests are finished." | |
1287 | } | |
1288 | ||
1289 | # print regressions and improvements | |
1290 | foreach featured [list $regressions $improvements] { | |
1291 | if { [llength $featured] <= 1 } { continue } | |
1292 | set status [string trim [lindex $featured 0] { :}] | |
1293 | puts $fd "<h2>$status</h2>" | |
1294 | puts $fd "<table>" | |
1295 | set groupgrid "" | |
1296 | foreach test [lrange $featured 1 end] { | |
1297 | if { ! [regexp {^(.*)\s+([\w.]+)$} $test res gg name] } { | |
1298 | set gg UNKNOWN | |
1299 | set name "Error building short list; check details" | |
1300 | } | |
1301 | if { $gg != $groupgrid } { | |
1302 | if { $groupgrid != "" } { puts $fd "</tr>" } | |
1303 | set groupgrid $gg | |
1304 | puts $fd "<tr><td>$gg</td>" | |
1305 | } | |
1306 | puts $fd "<td bgcolor=\"[_html_color $status]\"><a href=\"[regsub -all { } $gg /]/${name}.html\">$name</a></td>" | |
1307 | } | |
1308 | if { $groupgrid != "" } { puts $fd "</tr>" } | |
1309 | puts $fd "</table>" | |
1310 | } | |
1311 | ||
9753e6de | 1312 | # put detailed log with TOC |
1313 | puts $fd "<hr><h1>Details</h1>" | |
1314 | puts $fd "<div style=\"float:right; padding: 10px; border-style: solid; border-color: blue; border-width: 2px;\">" | |
40093367 | 1315 | |
1316 | # process log line-by-line | |
1317 | set group {} | |
1318 | set letter {} | |
9753e6de | 1319 | set body {} |
1320 | foreach line [lsort -dictionary $log] { | |
40093367 | 1321 | # check that the line is case report in the form "CASE group grid name: result (explanation)" |
1322 | if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } { | |
1323 | continue | |
1324 | } | |
1325 | ||
1326 | # start new group | |
1327 | if { $grp != $group } { | |
9753e6de | 1328 | if { $letter != "" } { lappend body "</tr></table>" } |
40093367 | 1329 | set letter {} |
1330 | set group $grp | |
1331 | set grid {} | |
9753e6de | 1332 | puts $fd "<a href=\"#$group\">$group</a><br>" |
1333 | lappend body "<h2><a name=\"$group\">Group $group</a></h2>" | |
40093367 | 1334 | } |
1335 | ||
1336 | # start new grid | |
1337 | if { $grd != $grid } { | |
9753e6de | 1338 | if { $letter != "" } { lappend body "</tr></table>" } |
40093367 | 1339 | set letter {} |
1340 | set grid $grd | |
9753e6de | 1341 | puts $fd " <a href=\"#$group-$grid\">$grid</a><br>" |
1342 | lappend body "<h2><a name=\"$group-$grid\">Grid $group $grid</a></h2>" | |
40093367 | 1343 | } |
1344 | ||
1345 | # check if test case name is <letter><digit>; | |
1346 | # if not, set alnum to period "." to recognize non-standard test name | |
9753e6de | 1347 | if { ! [regexp {\A([A-Za-z]{1,2})([0-9]{1,2})\Z} $casename res alnum number] && |
1348 | ! [regexp {\A([A-Za-z0-9]+)_([0-9]+)\Z} $casename res alnum number] } { | |
1349 | set alnum $casename | |
40093367 | 1350 | } |
1351 | ||
1352 | # start new row when letter changes or for non-standard names | |
1353 | if { $alnum != $letter || $alnum == "." } { | |
1354 | if { $letter != "" } { | |
9753e6de | 1355 | lappend body "</tr><tr>" |
40093367 | 1356 | } else { |
9753e6de | 1357 | lappend body "<table><tr>" |
40093367 | 1358 | } |
1359 | set letter $alnum | |
1360 | } | |
1361 | ||
9753e6de | 1362 | lappend body "<td bgcolor=\"[_html_color $result]\"><a href=\"$group/$grid/${casename}.html\">$casename</a></td>" |
40093367 | 1363 | } |
9753e6de | 1364 | puts $fd "</div>\n[join $body "\n"]</tr></table>" |
40093367 | 1365 | |
1366 | # add remaining lines of log as plain text | |
1367 | puts $fd "<h2>Plain text messages</h2>\n<pre>" | |
9753e6de | 1368 | foreach line $log { |
40093367 | 1369 | if { ! [regexp $_test_case_regexp $line] } { |
1370 | puts $fd "$line" | |
1371 | } | |
1372 | } | |
1373 | puts $fd "</pre>" | |
1374 | ||
1375 | # close file and exit | |
1376 | puts $fd "</body>" | |
1377 | close $fd | |
1378 | return | |
1379 | } | |
1380 | ||
1381 | # Procedure to dump summary logs of tests | |
1382 | proc _log_summarize {logdir log {total_time {}}} { | |
1383 | ||
1384 | # sort log records alphabetically to have the same behavior on Linux and Windows | |
1385 | # (also needed if tests are run in parallel) | |
9753e6de | 1386 | set loglist [lsort -dictionary $log] |
40093367 | 1387 | |
1388 | # classify test cases by status | |
1389 | foreach line $loglist { | |
1390 | if { [regexp {^CASE ([^:]*): ([[:alnum:]]+).*$} $line res caseid status] } { | |
1391 | lappend stat($status) $caseid | |
1392 | } | |
1393 | } | |
1394 | set totals {} | |
1395 | set improvements {Improvements:} | |
1396 | set regressions {Failed:} | |
1397 | if { [info exists stat] } { | |
1398 | foreach status [lsort [array names stat]] { | |
1399 | lappend totals [list [llength $stat($status)] $status] | |
1400 | ||
1401 | # separately count improvements (status starting with IMP) and regressions (all except IMP, OK, BAD, and SKIP) | |
1402 | if { [regexp -nocase {^IMP} $status] } { | |
1403 | eval lappend improvements $stat($status) | |
1404 | } elseif { $status != "OK" && ! [regexp -nocase {^BAD} $status] && ! [regexp -nocase {^SKIP} $status] } { | |
1405 | eval lappend regressions $stat($status) | |
1406 | } | |
1407 | } | |
1408 | } | |
1409 | ||
1410 | # if time is specified, add totals | |
1411 | if { $total_time != "" } { | |
1412 | if { [llength $improvements] > 1 } { | |
1413 | _log_and_puts log [join $improvements "\n "] | |
1414 | } | |
1415 | if { [llength $regressions] > 1 } { | |
1416 | _log_and_puts log [join $regressions "\n "] | |
1417 | } | |
1418 | if { [llength $improvements] == 1 && [llength $regressions] == 1 } { | |
1419 | _log_and_puts log "No regressions" | |
1420 | } | |
1421 | _log_and_puts log "Total cases: [join $totals {, }]" | |
1422 | _log_and_puts log $total_time | |
1423 | } | |
1424 | ||
1425 | # save log to files | |
1426 | if { $logdir != "" } { | |
1427 | _log_html_summary $logdir $log $totals $regressions $improvements $total_time | |
9753e6de | 1428 | _log_save $logdir/tests.log [join $log "\n"] "Tests summary" |
40093367 | 1429 | } |
1430 | ||
1431 | return | |
1432 | } | |
1433 | ||
1434 | # Internal procedure to generate XML log in JUnit style, for further | |
1435 | # consumption by Jenkins or similar systems. | |
1436 | # | |
1437 | # The output is intended to conform to XML schema supported by Jenkins found at | |
1438 | # https://svn.jenkins-ci.org/trunk/hudson/dtkit/dtkit-format/dtkit-junit-model/src/main/resources/com/thalesgroup/dtkit/junit/model/xsd/junit-4.xsd | |
1439 | # | |
1440 | # The mapping of the fields is inspired by annotated schema of Apache Ant JUnit XML format found at | |
1441 | # http://windyroad.org/dl/Open%20Source/JUnit.xsd | |
1442 | proc _log_xml_summary {logdir filename log include_cout} { | |
1443 | global _test_case_regexp | |
1444 | ||
1445 | catch {file mkdir [file dirname $filename]} | |
1446 | ||
1447 | # try to open a file and start XML | |
1448 | if [catch {set fd [open $filename w]} res] { | |
1449 | error "Error creating XML summary file $filename: $res" | |
1450 | } | |
1451 | puts $fd "<?xml version='1.0' encoding='utf-8'?>" | |
1452 | puts $fd "<testsuites>" | |
1453 | ||
1454 | # prototype for command to generate test suite tag | |
1455 | set time_and_host "timestamp=\"[clock format [clock seconds] -format {%Y-%m-%dT%H:%M:%S}]\" hostname=\"[info hostname]\"" | |
1456 | set cmd_testsuite {puts $fd "<testsuite name=\"$group $grid\" tests=\"$nbtests\" failures=\"$nbfail\" errors=\"$nberr\" time=\"$time\" skipped=\"$nbskip\" $time_and_host>\n$testcases\n</testsuite>\n"} | |
1457 | ||
1458 | # sort log and process it line-by-line | |
1459 | set group {} | |
9753e6de | 1460 | foreach line [lsort -dictionary $log] { |
40093367 | 1461 | # check that the line is case report in the form "CASE group grid name: result (explanation)" |
1462 | if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } { | |
1463 | continue | |
1464 | } | |
1465 | set message [string trim $message " \t\r\n()"] | |
1466 | ||
1467 | # start new testsuite for each grid | |
1468 | if { $grp != $group || $grd != $grid } { | |
1469 | ||
1470 | # write previous test suite | |
1471 | if [info exists testcases] { eval $cmd_testsuite } | |
1472 | ||
1473 | set testcases {} | |
1474 | set nbtests 0 | |
1475 | set nberr 0 | |
1476 | set nbfail 0 | |
1477 | set nbskip 0 | |
1478 | set time 0. | |
1479 | ||
1480 | set group $grp | |
1481 | set grid $grd | |
1482 | } | |
1483 | ||
1484 | incr nbtests | |
1485 | ||
1486 | # parse test log and get its CPU time | |
1487 | set testout {} | |
1488 | set add_cpu {} | |
1489 | if { [catch {set fdlog [open $logdir/$group/$grid/${casename}.log r]} ret] } { | |
1490 | puts "Error: cannot open $logdir/$group/$grid/${casename}.log: $ret" | |
1491 | } else { | |
1492 | while { [gets $fdlog logline] >= 0 } { | |
1493 | if { $include_cout } { | |
1494 | set testout "$testout$logline\n" | |
1495 | } | |
1496 | if [regexp -nocase {TOTAL CPU TIME:\s*([\d.]+)\s*sec} $logline res cpu] { | |
1497 | set add_cpu " time=\"$cpu\"" | |
1498 | set time [expr $time + $cpu] | |
1499 | } | |
1500 | } | |
1501 | close $fdlog | |
1502 | } | |
1503 | if { ! $include_cout } { | |
1504 | set testout "$line\n" | |
1505 | } | |
1506 | ||
1507 | # record test case with its output and status | |
1508 | # Mapping is: SKIPPED, BAD, and OK to OK, all other to failure | |
1509 | set testcases "$testcases\n <testcase name=\"$casename\"$add_cpu status=\"$result\">\n" | |
1510 | set testcases "$testcases\n <system-out>\n$testout </system-out>" | |
1511 | if { $result != "OK" } { | |
1512 | if { [regexp -nocase {^SKIP} $result] } { | |
1513 | incr nberr | |
1514 | set testcases "$testcases\n <error name=\"$result\" message=\"$message\"/>" | |
1515 | } elseif { [regexp -nocase {^BAD} $result] } { | |
1516 | incr nbskip | |
1517 | set testcases "$testcases\n <skipped>$message</skipped>" | |
1518 | } else { | |
1519 | incr nbfail | |
1520 | set testcases "$testcases\n <failure name=\"$result\" message=\"$message\"/>" | |
1521 | } | |
1522 | } | |
1523 | set testcases "$testcases\n </testcase>" | |
1524 | } | |
1525 | ||
1526 | # write last test suite | |
1527 | if [info exists testcases] { eval $cmd_testsuite } | |
1528 | ||
1529 | # the end | |
1530 | puts $fd "</testsuites>" | |
1531 | close $fd | |
1532 | return | |
1533 | } | |
1534 | ||
1535 | # define custom platform name | |
1536 | proc _tests_platform_def {} { | |
1537 | global env tcl_platform | |
1538 | ||
1539 | if [info exists env(os_type)] { return } | |
1540 | ||
1541 | set env(os_type) $tcl_platform(platform) | |
1542 | ||
1543 | # use detailed mapping for various versions of Lunix | |
1544 | # (note that mapping is rather non-uniform, for historical reasons) | |
d9e8bb08 | 1545 | if { $tcl_platform(os) == "Linux" && ! [catch {exec cat /etc/issue} issue] } { |
40093367 | 1546 | if { [regexp {Mandriva[ \tA-Za-z]+([0-9]+)} $issue res num] } { |
1547 | set env(os_type) Mandriva$num | |
1548 | } elseif { [regexp {Red Hat[ \tA-Za-z]+([0-9]+)} $issue res num] } { | |
1549 | set env(os_type) RedHat$num | |
1550 | } elseif { [regexp {Debian[ \tA-Za-z/]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } { | |
1551 | set env(os_type) Debian$num$subnum | |
1552 | } elseif { [regexp {CentOS[ \tA-Za-z]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } { | |
1553 | set env(os_type) CentOS$num$subnum | |
1554 | } elseif { [regexp {Scientific[ \tA-Za-z]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } { | |
1555 | set env(os_type) SL$num$subnum | |
1556 | } elseif { [regexp {Fedora Core[ \tA-Za-z]+([0-9]+)} $issue res num] } { | |
1557 | set env(os_type) FedoraCore$num | |
1558 | } | |
1559 | if { [exec uname -m] == "x86_64" } { | |
1560 | set env(os_type) "$env(os_type)-64" | |
1561 | } | |
d9e8bb08 | 1562 | } elseif { $tcl_platform(os) == "Darwin" } { |
1563 | set env(os_type) MacOS | |
40093367 | 1564 | } |
1565 | } | |
1566 | _tests_platform_def | |
1567 | ||
1568 | # Auxiliary procedure to split path specification (usually defined by | |
1569 | # environment variable) into list of directories or files | |
1570 | proc _split_path {pathspec} { | |
1571 | global tcl_platform | |
1572 | ||
1573 | # first replace all \ (which might occur on Windows) by / | |
1574 | regsub -all "\\\\" $pathspec "/" pathspec | |
1575 | ||
1576 | # split path by platform-specific separator | |
1577 | return [split $pathspec [_path_separator]] | |
1578 | } | |
1579 | ||
1580 | # Auxiliary procedure to define platform-specific separator for directories in | |
1581 | # path specification | |
1582 | proc _path_separator {} { | |
1583 | global tcl_platform | |
1584 | ||
1585 | # split path by platform-specific separator | |
1586 | if { $tcl_platform(platform) == "windows" } { | |
1587 | return ";" | |
1588 | } else { | |
1589 | return ":" | |
1590 | } | |
1591 | } | |
1592 | ||
cc6a292d | 1593 | # Procedure to make a diff and common of two lists |
1594 | proc _list_diff {list1 list2 _in1 _in2 _common} { | |
1595 | upvar $_in1 in1 | |
1596 | upvar $_in2 in2 | |
1597 | upvar $_common common | |
1598 | ||
1599 | set in1 {} | |
1600 | set in2 {} | |
1601 | set common {} | |
1602 | foreach item $list1 { | |
1603 | if { [lsearch -exact $list2 $item] >= 0 } { | |
1604 | lappend common $item | |
1605 | } else { | |
1606 | lappend in1 $item | |
1607 | } | |
1608 | } | |
1609 | foreach item $list2 { | |
1610 | if { [lsearch -exact $common $item] < 0 } { | |
1611 | lappend in2 $item | |
1612 | } | |
1613 | } | |
1614 | return | |
1615 | } | |
1616 | ||
1617 | # procedure to load a file to Tcl string | |
1618 | proc _read_file {filename} { | |
1619 | set fd [open $filename r] | |
1620 | set result [read -nonewline $fd] | |
1621 | close $fd | |
1622 | return $result | |
1623 | } | |
1624 | ||
22db40eb | 1625 | # procedure to construct name for the mage diff file |
1626 | proc _diff_img_name {dir1 dir2 casepath imgfile} { | |
1627 | return [file join $dir1 $casepath "diff-[file tail $dir2]-$imgfile"] | |
1628 | } | |
1629 | ||
cc6a292d | 1630 | # Procedure to compare results of two runs of test cases |
1631 | proc _test_diff {dir1 dir2 basename status verbose _logvar {_statvar ""}} { | |
1632 | upvar $_logvar log | |
1633 | ||
22db40eb | 1634 | # make sure to load diffimage command |
1635 | uplevel pload VISUALIZATION | |
1636 | ||
cc6a292d | 1637 | # prepare variable (array) for collecting statistics |
1638 | if { "$_statvar" != "" } { | |
1639 | upvar $_statvar stat | |
1640 | } else { | |
1641 | set stat(cpu1) 0 | |
1642 | set stat(cpu2) 0 | |
22db40eb | 1643 | set stat(mem1) 0 |
1644 | set stat(mem2) 0 | |
cc6a292d | 1645 | set log {} |
1646 | } | |
1647 | ||
1648 | # first check subdirectories | |
1649 | set path1 [file join $dir1 $basename] | |
1650 | set path2 [file join $dir2 $basename] | |
1651 | set list1 [glob -directory $path1 -types d -tails -nocomplain *] | |
1652 | set list2 [glob -directory $path2 -types d -tails -nocomplain *] | |
1653 | if { [llength $list1] >0 || [llength $list2] > 0 } { | |
1654 | _list_diff $list1 $list2 in1 in2 common | |
1655 | if { "$verbose" > 1 } { | |
1656 | if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" } | |
1657 | if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" } | |
1658 | } | |
1659 | foreach subdir $common { | |
1660 | if { "$verbose" > 2 } { | |
1661 | _log_and_puts log "Checking [file join $basename $subdir]" | |
1662 | } | |
1663 | _test_diff $dir1 $dir2 [file join $basename $subdir] $status $verbose log stat | |
1664 | } | |
1665 | } else { | |
1666 | # check log files (only if directory has no subdirs) | |
1667 | set list1 [glob -directory $path1 -types f -tails -nocomplain *.log] | |
1668 | set list2 [glob -directory $path2 -types f -tails -nocomplain *.log] | |
1669 | _list_diff $list1 $list2 in1 in2 common | |
1670 | if { "$verbose" > 1 } { | |
1671 | if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" } | |
1672 | if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" } | |
1673 | } | |
1674 | foreach logfile $common { | |
1675 | # load two logs | |
1676 | set log1 [_read_file [file join $dir1 $basename $logfile]] | |
1677 | set log2 [_read_file [file join $dir2 $basename $logfile]] | |
22db40eb | 1678 | set casename [file rootname $logfile] |
cc6a292d | 1679 | |
1680 | # check execution statuses | |
1681 | set status1 UNDEFINED | |
1682 | set status2 UNDEFINED | |
1683 | if { ! [regexp {CASE [^:]*:\s*([\w]+)} $log1 res1 status1] || | |
1684 | ! [regexp {CASE [^:]*:\s*([\w]+)} $log2 res2 status2] || | |
1685 | "$status1" != "$status2" } { | |
22db40eb | 1686 | _log_and_puts log "STATUS [split $basename /] $casename: $status1 / $status2" |
cc6a292d | 1687 | |
1688 | # if test statuses are different, further comparison makes | |
1689 | # no sense unless explicitly requested | |
1690 | if { "$status" != "all" } { | |
1691 | continue | |
1692 | } | |
1693 | } | |
1694 | if { "$status" == "ok" && "$status1" != "OK" } { | |
1695 | continue | |
1696 | } | |
1697 | ||
1698 | # check CPU times | |
1699 | set cpu1 UNDEFINED | |
1700 | set cpu2 UNDEFINED | |
1701 | if { [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log1 res1 cpu1] && | |
1702 | [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log2 res1 cpu2] } { | |
1703 | set stat(cpu1) [expr $stat(cpu1) + $cpu1] | |
1704 | set stat(cpu2) [expr $stat(cpu2) + $cpu2] | |
1705 | ||
1706 | # compare CPU times with 10% precision (but not less 0.5 sec) | |
1707 | if { [expr abs ($cpu1 - $cpu2) > 0.5 + 0.05 * abs ($cpu1 + $cpu2)] } { | |
22db40eb | 1708 | _log_and_puts log "CPU [split $basename /] $casename: $cpu1 / $cpu2" |
cc6a292d | 1709 | } |
1710 | } | |
22db40eb | 1711 | |
1712 | # check memory delta | |
1713 | set mem1 UNDEFINED | |
1714 | set mem2 UNDEFINED | |
1715 | if { [regexp {MEMORY DELTA:\s*([\d.]+)} $log1 res1 mem1] && | |
1716 | [regexp {MEMORY DELTA:\s*([\d.]+)} $log2 res1 mem2] } { | |
1717 | set stat(mem1) [expr $stat(mem1) + $mem1] | |
1718 | set stat(mem2) [expr $stat(mem2) + $mem2] | |
1719 | ||
1720 | # compare memory usage with 10% precision (but not less 16 KiB) | |
1721 | if { [expr abs ($mem1 - $mem2) > 16 + 0.05 * abs ($mem1 + $mem2)] } { | |
1722 | _log_and_puts log "MEMORY [split $basename /] $casename: $mem1 / $mem2" | |
1723 | } | |
1724 | } | |
1725 | ||
1726 | # check images | |
1727 | set imglist1 [glob -directory $path1 -types f -tails -nocomplain $casename*.{png,gif}] | |
1728 | set imglist2 [glob -directory $path2 -types f -tails -nocomplain $casename*.{png,gif}] | |
1729 | _list_diff $imglist1 $imglist2 imgin1 imgin2 imgcommon | |
1730 | if { "$verbose" > 1 } { | |
1731 | if { [llength $imgin1] > 0 } { _log_and_puts log "Only in $path1: $imgin1" } | |
1732 | if { [llength $imgin2] > 0 } { _log_and_puts log "Only in $path2: $imgin2" } | |
1733 | } | |
1734 | foreach imgfile $imgcommon { | |
1735 | # if { $verbose > 1 } { _log_and_puts log "Checking [split basename /] $casename: $imgfile" } | |
1736 | set diffile [_diff_img_name $dir1 $dir2 $basename $imgfile] | |
1737 | if { [catch {diffimage [file join $dir1 $basename $imgfile] \ | |
1738 | [file join $dir2 $basename $imgfile] \ | |
1739 | 0 0 0 $diffile} diff] } { | |
1740 | _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile cannot be compared" | |
1741 | file delete -force $diffile ;# clean possible previous result of diffimage | |
1742 | } elseif { $diff != 0 } { | |
1743 | _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile differs" | |
1744 | } else { | |
1745 | file delete -force $diffile ;# clean useless artifact of diffimage | |
1746 | } | |
1747 | } | |
cc6a292d | 1748 | } |
1749 | } | |
1750 | ||
1751 | if { "$_statvar" == "" } { | |
22db40eb | 1752 | _log_and_puts log "Total MEMORY difference: $stat(mem1) / $stat(mem2)" |
cc6a292d | 1753 | _log_and_puts log "Total CPU difference: $stat(cpu1) / $stat(cpu2)" |
1754 | } | |
1755 | } | |
b725d7c5 | 1756 | |
22db40eb | 1757 | # Auxiliary procedure to save log of results comparison to file |
1758 | proc _log_html_diff {file log dir1 dir2} { | |
1759 | # create missing directories as needed | |
1760 | catch {file mkdir [file dirname $file]} | |
1761 | ||
1762 | # try to open a file | |
1763 | if [catch {set fd [open $file w]} res] { | |
1764 | error "Error saving log file $file: $res" | |
1765 | } | |
1766 | ||
1767 | # print header | |
1768 | puts $fd "<html><head><title>Diff $dir1 vs. $dir2</title></head><body>" | |
1769 | puts $fd "<h1>Comparison of test results: $dir1 vs. $dir2</h1>" | |
1770 | ||
1771 | # print log body, trying to add HTML links to script files on lines like | |
1772 | # "Executing <filename>..." | |
1773 | puts $fd "<pre>" | |
1774 | set logpath [file split [file normalize $file]] | |
9753e6de | 1775 | foreach line $log { |
22db40eb | 1776 | puts $fd $line |
1777 | ||
1778 | if { [regexp {IMAGE[ \t]+([^:]+):[ \t]+([A-Za-z0-9_.-]+)} $line res case img] } { | |
1779 | if { [catch {eval file join "" [lrange $case 0 end-1]} gridpath] } { | |
1780 | # note: special handler for the case if test grid directoried are compared directly | |
1781 | set gridpath "" | |
1782 | } | |
1783 | set img1 "<img src=\"[_make_url $file [file join $dir1 $gridpath $img]]\">" | |
1784 | set img2 "<img src=\"[_make_url $file [file join $dir2 $gridpath $img]]\">" | |
1785 | ||
1786 | set difffile [_diff_img_name $dir1 $dir2 $gridpath $img] | |
1787 | if { [file exists $difffile] } { | |
1788 | set imgd "<img src=\"[_make_url $file $difffile]\">" | |
1789 | } else { | |
1790 | set imgd "N/A" | |
1791 | } | |
1792 | ||
1793 | puts $fd "<table><tr><th>[file tail $dir1]</th><th>[file tail $dir2]</th><th>Different pixels</th></tr>" | |
1794 | puts $fd "<tr><td>$img1</td><td>$img2</td><td>$imgd</td></tr></table>" | |
1795 | } | |
1796 | } | |
1797 | puts $fd "</pre></body></html>" | |
1798 | ||
1799 | close $fd | |
1800 | return | |
1801 | } | |
1802 | ||
b725d7c5 | 1803 | # get number of CPUs on the system |
1804 | proc _get_nb_cpus {} { | |
1805 | global tcl_platform env | |
1806 | ||
1807 | if { "$tcl_platform(platform)" == "windows" } { | |
1808 | # on Windows, take the value of the environment variable | |
1809 | if { [info exists env(NUMBER_OF_PROCESSORS)] && | |
1810 | ! [catch {expr $env(NUMBER_OF_PROCESSORS) > 0} res] && $res >= 0 } { | |
1811 | return $env(NUMBER_OF_PROCESSORS) | |
1812 | } | |
1813 | } elseif { "$tcl_platform(os)" == "Linux" } { | |
1814 | # on Linux, take number of logical processors listed in /proc/cpuinfo | |
1815 | if { [catch {open "/proc/cpuinfo" r} fd] } { | |
1816 | return 0 ;# should never happen, but... | |
1817 | } | |
1818 | set nb 0 | |
1819 | while { [gets $fd line] >= 0 } { | |
1820 | if { [regexp {^processor[ \t]*:} $line] } { | |
1821 | incr nb | |
1822 | } | |
1823 | } | |
1824 | close $fd | |
1825 | return $nb | |
1826 | } elseif { "$tcl_platform(os)" == "Darwin" } { | |
1827 | # on MacOS X, call sysctl command | |
1828 | if { ! [catch {exec sysctl hw.ncpu} ret] && | |
1829 | [regexp {^hw[.]ncpu[ \t]*:[ \t]*([0-9]+)} $ret res nb] } { | |
1830 | return $nb | |
1831 | } | |
1832 | } | |
1833 | ||
1834 | # if cannot get good value, return 0 as default | |
1835 | return 0 | |
1836 | } | |
351bbcba | 1837 | |
1838 | # check two files for difference | |
1839 | proc _diff_files {file1 file2} { | |
1840 | set fd1 [open $file1 "r"] | |
1841 | set fd2 [open $file2 "r"] | |
1842 | ||
1843 | set differ f | |
1844 | while {! $differ} { | |
1845 | set nb1 [gets $fd1 line1] | |
1846 | set nb2 [gets $fd2 line2] | |
1847 | if { $nb1 != $nb2 } { set differ t; break } | |
1848 | if { $nb1 < 0 } { break } | |
1849 | if { [string compare $line1 $line2] } { | |
1850 | set differ t | |
1851 | } | |
1852 | } | |
1853 | ||
1854 | close $fd1 | |
1855 | close $fd2 | |
1856 | ||
1857 | return $differ | |
1858 | } | |
1859 | ||
1860 | # Check if file is in DOS encoding. | |
1861 | # This check is done by presence of \r\n combination at the end of the first | |
1862 | # line (i.e. prior to any other \n symbol). | |
1863 | # Note that presence of non-ascii symbols typically used for recognition | |
1864 | # of binary files is not suitable since some IGES and STEP files contain | |
1865 | # non-ascii symbols. | |
1866 | # Special check is added for PNG files which contain \r\n in the beginning. | |
1867 | proc _check_dos_encoding {file} { | |
1868 | set fd [open $file rb] | |
1869 | set isdos f | |
1870 | if { [gets $fd line] && [regexp {.*\r$} $line] && | |
1871 | ! [regexp {^.PNG} $line] } { | |
1872 | set isdos t | |
1873 | } | |
1874 | close $fd | |
1875 | return $isdos | |
1876 | } | |
1877 | ||
1878 | # procedure to recognize format of a data file by its first symbols (for OCCT | |
1879 | # BREP and geometry DRAW formats, IGES, and STEP) and extension (all others) | |
1880 | proc _check_file_format {file} { | |
1881 | set fd [open $file rb] | |
1882 | set line [read $fd 1024] | |
1883 | close $fd | |
1884 | ||
1885 | set warn f | |
1886 | set ext [file extension $file] | |
1887 | set format unknown | |
1888 | if { [regexp {^DBRep_DrawableShape} $line] } { | |
1889 | set format BREP | |
1890 | if { "$ext" != ".brep" && "$ext" != ".rle" && | |
1891 | "$ext" != ".draw" && "$ext" != "" } { | |
1892 | set warn t | |
1893 | } | |
1894 | } elseif { [regexp {^DrawTrSurf_} $line] } { | |
1895 | set format DRAW | |
1896 | if { "$ext" != ".rle" && | |
1897 | "$ext" != ".draw" && "$ext" != "" } { | |
1898 | set warn t | |
1899 | } | |
1900 | } elseif { [regexp {^[ \t]*ISO-10303-21} $line] } { | |
1901 | set format STEP | |
1902 | if { "$ext" != ".step" && "$ext" != ".stp" } { | |
1903 | set warn t | |
1904 | } | |
1905 | } elseif { [regexp {^.\{72\}S[0 ]\{6\}1} $line] } { | |
1906 | set format IGES | |
1907 | if { "$ext" != ".iges" && "$ext" != ".igs" } { | |
1908 | set warn t | |
1909 | } | |
1910 | } elseif { "$ext" == ".igs" } { | |
1911 | set format IGES | |
1912 | } elseif { "$ext" == ".stp" } { | |
1913 | set format STEP | |
1914 | } else { | |
1915 | set format [string toupper [string range $ext 1 end]] | |
1916 | } | |
1917 | ||
1918 | if { $warn } { | |
1919 | puts "$file: Warning: extension ($ext) does not match format ($format)" | |
1920 | } | |
1921 | ||
1922 | return $format | |
1923 | } | |
1924 | ||
1925 | # procedure to load file knowing its format | |
1926 | proc load_data_file {file format shape} { | |
1927 | switch $format { | |
1928 | BREP { uplevel restore $file $shape } | |
808b3f9f | 1929 | DRAW { uplevel restore $file $shape } |
351bbcba | 1930 | IGES { pload XSDRAW; uplevel igesbrep $file $shape * } |
1931 | STEP { pload XSDRAW; uplevel stepread $file __a *; uplevel renamevar __a_1 $shape } | |
1932 | STL { pload XSDRAW; uplevel readstl $shape $file } | |
1933 | default { error "Cannot read $format file $file" } | |
1934 | } | |
1935 | } | |
60874ff8 | 1936 | |
1937 | # procedure to get name of temporary directory, | |
1938 | # ensuring it is existing and writeable | |
1939 | proc _get_temp_dir {} { | |
723754e2 | 1940 | global env tcl_platform |
60874ff8 | 1941 | |
1942 | # check typical environment variables | |
1943 | foreach var {TempDir Temp Tmp} { | |
1944 | # check different case | |
1945 | foreach name [list [string toupper $var] $var [string tolower $var]] { | |
1946 | if { [info exists env($name)] && [file isdirectory $env($name)] && | |
1947 | [file writable $env($name)] } { | |
1948 | return [regsub -all {\\} $env($name) /] | |
1949 | } | |
1950 | } | |
1951 | } | |
1952 | ||
1953 | # check platform-specific locations | |
1954 | set fallback tmp | |
1955 | if { "$tcl_platform(platform)" == "windows" } { | |
1956 | set paths "c:/TEMP c:/TMP /TEMP /TMP" | |
1957 | if { [info exists env(HOMEDRIVE)] && [info exists env(HOMEPATH)] } { | |
1958 | set fallback [regsub -all {\\} "$env(HOMEDRIVE)$(HOMEPATH)/tmp" /] | |
1959 | } | |
1960 | } else { | |
1961 | set paths "/tmp /var/tmp /usr/tmp" | |
1962 | if { [info exists env(HOME)] } { | |
1963 | set fallback "$env(HOME)/tmp" | |
1964 | } | |
1965 | } | |
1966 | foreach dir $paths { | |
723754e2 | 1967 | if { [file isdirectory $dir] && [file writable $dir] } { |
60874ff8 | 1968 | return $dir |
1969 | } | |
1970 | } | |
1971 | ||
1972 | # fallback case: use subdir /tmp of home or current dir | |
1973 | file mkdir $fallback | |
1974 | return $fallback | |
1975 | } | |
9753e6de | 1976 | |
1977 | # extract of code from testgrid command used to process jobs running in | |
1978 | # parallel until number of jobs in the queue becomes equal or less than | |
1979 | # specified value | |
1980 | proc _testgrid_process_jobs {worker {nb_ok 0}} { | |
1981 | # bind local vars to variables of the caller procedure | |
1982 | upvar log log | |
1983 | upvar logdir logdir | |
1984 | upvar job_def job_def | |
1985 | upvar nbpooled nbpooled | |
1986 | upvar userbreak userbreak | |
1987 | upvar refresh refresh | |
1988 | upvar refresh_timer refresh_timer | |
1989 | ||
1990 | catch {tpool::resume $worker} | |
1991 | while { ! $userbreak && $nbpooled > $nb_ok } { | |
1992 | foreach job [tpool::wait $worker [array names job_def]] { | |
1993 | eval _log_test_case \[tpool::get $worker $job\] $job_def($job) log | |
1994 | unset job_def($job) | |
1995 | incr nbpooled -1 | |
1996 | } | |
1997 | ||
1998 | # check for user break | |
1999 | if { "[info commands dbreak]" == "dbreak" && [catch dbreak] } { | |
2000 | set userbreak 1 | |
2001 | } | |
2002 | ||
2003 | # update summary log with requested period | |
2004 | if { $logdir != "" && $refresh > 0 && [clock seconds] > $refresh_timer + $refresh } { | |
2005 | _log_summarize $logdir $log | |
2006 | set refresh_timer [clock seconds] | |
2007 | } | |
2008 | } | |
2009 | catch {tpool::suspend $worker} | |
2010 | } |