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