1 # Copyright (c) 2012 OPEN CASCADE SAS
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.
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.
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.
18 ############################################################################
19 # This file defines scripts for execution of OCCT tests.
20 # It should be loaded automatically when DRAW is started, and provides
21 # top-level commands starting with 'test'. Type 'help test' to get their
23 # See OCCT Tests User Guide for description of the test system.
25 # Note: procedures with names starting with underscore are for internal use
26 # inside the test system.
27 ############################################################################
29 # Default verbose level for command _run_test
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]+)(.*)}
35 # Basic command to run indicated test case in DRAW
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
44 proc test {group grid casename {echo 0}} {
45 # get test case paths (will raise error if input is invalid)
46 _get_test $group $grid $casename dir gridname casefile
48 # if echo specified as "-echo", convert it to bool
49 if { "$echo" == "-echo" } { set echo t }
52 uplevel _run_test $dir $group $gridname $casefile $echo
56 _check_log $dir $group $gridname $casename [dlog get]
62 # Basic command to run indicated test case in DRAW
64 Run all tests, or specified group, or one grid
65 Use: testgrid [group [grid]] [options...]
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)
73 proc testgrid {args} {
74 global env tcl_platform _tests_verbose
76 ######################################################
78 ######################################################
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"
87 set parallel [_get_nb_cpus]
92 for {set narg 0} {$narg < [llength $args]} {incr narg} {
93 set arg [lindex $args $narg]
96 if { $arg == "-parallel" } {
98 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
99 set parallel [expr [lindex $args $narg]]
101 error "Option -parallel requires argument"
107 if { $arg == "-refresh" } {
109 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
110 set refresh [expr [lindex $args $narg]]
112 error "Option -refresh requires argument"
118 if { $arg == "-outdir" } {
120 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
121 set logdir [lindex $args $narg]
123 error "Option -outdir requires argument"
128 # allow overwrite logs
129 if { $arg == "-overwrite" } {
135 if { $arg == "-xml" } {
137 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
138 set xmlfile [lindex $args $narg]
140 if { $xmlfile == "" } {
141 set xmlfile TESTS-summary.xml
147 if { [regexp {^-} $arg] } {
148 error "Error: unsupported option \"$arg\""
151 # treat arguments not recognized as options as group and grid names
152 if { ! [info exists groupname] } {
154 } elseif { ! [info exists gridname] } {
157 error "Error: cannot interpret argument $narg ($arg): both group and grid names are already defined by previous args!"
161 # check that target log directory is empty or does not exist
162 set logdir [file normalize [string trim $logdir]]
163 if { $logdir == "" } {
164 # if specified logdir is empty string, generate unique name like
165 # results_<branch>_<timestamp>
167 if { ! [catch {exec git branch} gitout] &&
168 [regexp {[*] ([\w]+)} $gitout res branch] } {
169 set prefix "${prefix}_$branch"
171 set logdir "${prefix}_[clock format [clock seconds] -format {%Y-%m-%dT%H%M}]"
172 set logdir [file normalize $logdir]
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"
177 if { [catch {file mkdir $logdir}] || ! [file writable $logdir] } {
178 error "Error: Cannot create directory \"$logdir\", or it is not writable"
181 ######################################################
182 # prepare list of tests to be performed
183 ######################################################
185 # list of tests, each defined by a list of:
186 # test scripts directory
187 # group (subfolder) name
188 # grid (subfolder) name
190 # path to test case file
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 }
199 if { $_tests_verbose > 0 } { _log_and_puts log "Examining tests directory $dir" }
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"
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
216 # else search all directories in the current dir
217 if [catch {glob -directory $dir -tail -types d *} groups] { continue }
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" }
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"
231 # read grids.list file and make a list of grids to be executed
233 set fd [open $dir/$group/grids.list]
235 while { [gets $fd line] >= 0 } {
238 # skip comments and empty lines
239 if { [regexp "\[ \t\]*\#.*" $line] } { continue }
240 if { [string trim $line] == "" } { continue }
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"
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
255 # iterate by all grids
256 foreach grid $gridlist {
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]]
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"
274 # create directory for logging test results
275 if { $logdir != "" } { file mkdir $logdir/$group/$grid }
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 }
284 lappend tests_list [list $dir $group $grid $casename $casefile]
289 if { [llength $tests_list] < 1 } {
290 error "Error: no tests are found, check you input arguments and variable CSF_TestScriptsPath!"
293 ######################################################
295 ######################################################
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 catch {set log "$log\nDRAW build:\n[dversion]\n" }
300 set log "$log\nEnvironment:\n"
301 foreach envar [lsort [array names env]] {
302 set log "$log$envar=\"$env($envar)\"\n"
306 set refresh_timer [clock seconds]
307 uplevel dchrono _timer reset
308 uplevel dchrono _timer start
310 # if parallel execution is requested, allocate thread pool
311 if { $parallel > 0 } {
312 if { ! [info exists tcl_platform(threaded)] || [catch {package require Thread}] } {
313 _log_and_puts log "Warning: Tcl package Thread is not available, running in sequential mode"
316 set worker [tpool::create -minworkers $parallel -maxworkers $parallel]
317 # suspend the pool until all jobs are posted, to prevent blocking of the process
318 # of starting / processing jobs by running threads
319 catch {tpool::suspend $worker}
320 if { $_tests_verbose > 0 } { _log_and_puts log "Executing tests in (up to) $parallel threads" }
326 foreach test_def $tests_list {
327 # check for user break
328 if { "[info commands dbreak]" == "dbreak" && [catch dbreak] } {
333 set dir [lindex $test_def 0]
334 set group [lindex $test_def 1]
335 set grid [lindex $test_def 2]
336 set casename [lindex $test_def 3]
337 set casefile [lindex $test_def 4]
339 # command to set tests for generation of image in results directory
341 if { $logdir != "" } { set imgdir_cmd "set imagedir $logdir/$group/$grid" }
343 # prepare command file for running test case in separate instance of DRAW
344 set fd_cmd [open $logdir/$group/$grid/${casename}.tcl w]
345 puts $fd_cmd "$imgdir_cmd"
346 puts $fd_cmd "set test_image $casename"
347 puts $fd_cmd "_run_test $dir $group $grid $casefile t"
349 # use dlog command to obtain complete output of the test when it is absent (i.e. since OCCT 6.6.0)
350 # note: this is not needed if echo is set to 1 in call to _run_test above
351 if { ! [catch {dlog get}] } {
352 puts $fd_cmd "puts \[dlog get\]"
354 # else try to use old-style QA_ variables to get more output...
357 set env(QA_print_command) 1
360 # final 'exit' is needed when running on Linux under VirtualGl
364 # commant to run DRAW with a command file;
365 # note that empty string is passed as standard input to avoid possible
366 # hang-ups due to waiting for stdin of the launching process
367 set command "exec <<{} DRAWEXE -f $logdir/$group/$grid/${casename}.tcl"
369 # alternative method to run without temporary file; disabled as it needs too many backslashes
371 # set command "exec <<\"\" DRAWEXE -c $imgdir_cmd\\\; set test_image $casename\\\; \
372 # _run_test $dir $group $grid $casefile\\\; \
373 # puts \\\[dlog get\\\]\\\; exit"
376 # run test case, either in parallel or sequentially
377 if { $parallel > 0 } {
379 set job [tpool::post -nowait $worker "catch \"$command\" output; return \$output"]
380 set job_def($job) [list $logdir $dir $group $grid $casename]
382 # sequential execution
383 catch {eval $command} output
384 _log_test_case $output $logdir $dir $group $grid $casename log
386 # update summary log with requested period
387 if { $logdir != "" && $refresh > 0 && [expr [clock seconds] - $refresh_timer > $refresh] } {
388 # update and dump summary
389 _log_summarize $logdir $log
390 set refresh_timer [clock seconds]
395 # get results of started threads
396 if { $parallel > 0 } {
397 catch {tpool::resume $worker}
398 while { ! $userbreak && [llength [array names job_def]] > 0 } {
399 foreach job [tpool::wait $worker [array names job_def]] {
400 eval _log_test_case \[tpool::get $worker $job\] $job_def($job) log
404 # check for user break
405 if { "[info commands dbreak]" == "dbreak" && [catch dbreak] } {
409 # update summary log with requested period
410 if { $logdir != "" && $refresh > 0 && [clock seconds] > $refresh_timer + $refresh } {
411 _log_summarize $logdir $log
412 set refresh_timer [clock seconds]
415 # release thread pool
416 tpool::cancel $worker [array names job_def]
417 tpool::release $worker
420 uplevel dchrono _timer stop
421 set time [lindex [split [uplevel dchrono _timer show] "\n"] 0]
424 puts "*********** Stopped by user break ***********"
425 set time "${time} \nNote: the process is not finished, stopped by user break!"
428 ######################################################
429 # output summary logs and exit
430 ######################################################
432 _log_summarize $logdir $log $time
433 if { $logdir != "" } {
434 puts "Detailed logs are saved in $logdir"
436 if { $logdir != "" && $xmlfile != "" } {
437 # XML output file is assumed relative to log dir unless it is absolute
438 if { [ file pathtype $xmlfile] == "relative" } {
439 set xmlfile [file normalize $logdir/$xmlfile]
441 _log_xml_summary $logdir $xmlfile $log 0
442 puts "XML summary is saved to $xmlfile"
448 # Procedure to regenerate summary log from logs of test cases
450 Regenerate summary log in the test directory from logs of test cases.
451 This can be necessary if test grids are executed separately (e.g. on
452 different stations) or some grids have been re-executed.
453 Use: testsummarize dir
455 proc testsummarize {dir} {
456 global _test_case_regexp
458 if { ! [file isdirectory $dir] } {
459 error "Error: \"$dir\" is not a directory"
462 # get summary statements from all test cases in one log
465 # to avoid huge listing of logs, first find all subdirectories and iterate
466 # by them, parsing log files in each subdirectory independently
467 foreach grid [glob -directory $dir -types d -tails */*] {
468 foreach caselog [glob -nocomplain -directory [file join $dir $grid] -types f -tails *.log] {
469 set file [file join $dir $grid $caselog]
471 set fd [open $file r]
472 while { [gets $fd line] >= 0 } {
473 if { [regexp $_test_case_regexp $line res grp grd cas status message] } {
474 if { "[file join $grid $caselog]" != "[file join $grp $grd ${cas}.log]" } {
475 puts "Error: $file contains status line for another test case ($line)"
477 set log "$log$line\n"
483 if { $nbfound != 1 } {
484 puts "Error: $file contains $nbfound status lines, expected 1"
489 _log_summarize $dir $log "Summary regenerated from logs at [clock format [clock seconds]]"
493 # Procedure to compare results of two runs of test cases
495 Compare results of two executions of tests (CPU times, ...)
496 Use: testdiff dir1 dir2 [groupname [gridname]] [options...]
497 Where dir1 and dir2 are directories containing logs of two test runs.
499 -save filename: save resulting log in specified file (default name is
500 <dir1>/diff-<dir2>.log); HTML log is saved with same name
502 -status {same|ok|all}: filter cases for comparing by their status:
503 same - only cases with same status are compared (default)
504 ok - only cases with OK status in both logs are compared
505 all - results are compared regardless of status
507 1 - output only differences
508 2 - output also list of logs and directories present in one of dirs only
509 3 - (default) output also progress messages
511 proc testdiff {dir1 dir2 args} {
512 if { "$dir1" == "$dir2" } {
513 error "Input directories are the same"
516 ######################################################
518 ######################################################
521 set logfile [file join $dir1 "diff-[file tail $dir2].log"]
525 for {set narg 0} {$narg < [llength $args]} {incr narg} {
526 set arg [lindex $args $narg]
529 if { $arg == "-save" } {
531 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
532 set logfile [lindex $args $narg]
534 error "Error: Option -save must be followed by log file name"
540 if { $arg == "-status" } {
542 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
543 set status [lindex $args $narg]
544 } else { set status "" }
545 if { "$status" != "same" && "$status" != "all" && "$status" != "ok" } {
546 error "Error: Option -status must be followed by one of \"same\", \"all\", or \"ok\""
552 if { $arg == "-verbose" } {
554 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
555 set verbose [expr [lindex $args $narg]]
557 error "Error: Option -verbose must be followed by integer verbose level"
562 if { [regexp {^-} $arg] } {
563 error "Error: unsupported option \"$arg\""
566 # non-option arguments form a subdirectory path
567 set basename [file join $basename $arg]
570 # run diff procedure (recursive)
571 _test_diff $dir1 $dir2 $basename $status $verbose log
573 # save result to log file
574 if { "$logfile" != "" } {
575 _log_save $logfile $log
576 _log_html_diff "[file rootname $logfile].html" $log $dir1 $dir2
577 puts "Log is saved to $logfile (and .html)"
583 # Procedure to check data file before adding it to repository
585 Check data file and prepare it for putting to test data files repository.
586 Use: testfile [filelist]
589 - data file (non-binary) is in DOS encoding (CR/LF)
590 - same data file (with same or another name) already exists in the repository
591 - another file with the same name already exists
592 Note that names are assumed to be case-insensitive (for Windows).
594 Unless the file is already in the repository, tries to load it, reports
595 the recognized file format, file size, number of faces and edges in the
596 loaded shape (if any), and makes snapshot (in the temporary directory).
597 Finally it advises whether the file should be put to public section of the
600 proc testfile {filelist} {
603 # check that CSF_TestDataPath is defined
604 if { ! [info exists env(CSF_TestDataPath)] } {
605 error "Environment variable CSF_TestDataPath must be defined!"
608 # build registry of existing data files (name -> path) and (size -> path)
609 puts "Checking available test data files..."
610 foreach dir [_split_path $env(CSF_TestDataPath)] {
611 while {[llength $dir] != 0} {
612 set curr [lindex $dir 0]
613 set dir [lrange $dir 1 end]
614 eval lappend dir [glob -nocomplain -directory $curr -type d *]
615 foreach file [glob -nocomplain -directory $curr -type f *] {
616 set name [file tail $file]
617 set name_lower [string tolower $name]
619 # check that the file is not in DOS encoding
620 if { [_check_dos_encoding $file] } {
621 puts "Warning: file $file is in DOS encoding; was this intended?"
623 _check_file_format $file
625 # check if file with the same name is present twice or more
626 if { [info exists names($name_lower)] } {
627 puts "Error: more than one file with name $name is present in the repository:"
628 if { [_diff_files $file $names($name_lower)] } {
629 puts "(files are different by content)"
631 puts "(files are same by content)"
634 puts "--> $names($name_lower)"
638 # check if file with the same content exists
639 set size [file size $file]
640 if { [info exists sizes($size)] } {
641 foreach other $sizes($size) {
642 if { ! [_diff_files $file $other] } {
643 puts "Warning: two files with the same content found:"
650 # add the file to the registry
651 set names($name_lower) $file
652 lappend sizes($size) $file
656 if { [llength $filelist] <= 0 } { return }
658 # check the new files
660 puts "Checking new file(s)..."
661 foreach file $filelist {
662 # check for DOS encoding
663 if { [_check_dos_encoding $file] } {
664 puts "$file: Warning: DOS encoding detected"
667 set name [file tail $file]
668 set name_lower [string tolower $name]
670 # check for presence of the file with same name
671 if { [info exists names($name_lower)] } {
672 if { [_diff_files $file $names($name_lower)] } {
673 puts "$file: Error: name is already used by existing file\n--> $names($name_lower)"
675 puts "$file: OK: already in the repository \n--> $names($name_lower)"
680 # check if file with the same content exists
681 set size [file size $file]
682 if { [info exists sizes($size)] } {
684 foreach other $sizes($size) {
685 if { ! [_diff_files $file $other] } {
686 puts "$file: OK: the same file is already present under name [file tail $other]\n--> $other"
691 if { $found } { continue }
694 # try to read the file
695 set format [_check_file_format $file]
696 if { [catch {uplevel load_data_file $file $format a}] } {
697 puts "$file: Error: Cannot read as $format file"
701 # get number of faces and edges
704 set nbs [uplevel nbshapes a]
705 regexp {EDGE[ \t:]*([0-9]+)} $nbs res edges
706 regexp {FACE[ \t:]*([0-9]+)} $nbs res faces
708 # classify; first check file size and number of faces and edges
709 if { $size < 95000 && $faces < 20 && $edges < 100 } {
713 # check if one of names of that file corresponds to typical name for
714 # MDTV bugs or has extension .rle, this should be old model
715 if { [regexp -nocase {.*(cts|ats|pro|buc|ger|fra|usa|uki)[0-9]+.*} $name] ||
716 [regexp -nocase {[.]rle\y} $name] } {
722 puts "$file: $format size=[expr $size / 1024] KiB, nbfaces=$faces, nbedges=$edges -> $dir"
724 set tmpdir [_get_temp_dir]
725 file mkdir $tmpdir/$dir
732 uplevel vdump $tmpdir/$dir/[file rootname [file tail $file]].png
736 puts "Snapshots are saved in subdirectory [_get_temp_dir]"
740 # Procedure to locate data file for test given its name.
741 # The search is performed assuming that the function is called
742 # from the test case script; the search order is:
743 # - subdirectory "data" of the test script (grid) folder
744 # - subdirectories in environment variable CSF_TestDataPath
745 # - subdirectory set by datadir command
746 # If file is not found, raises Tcl error.
747 proc locate_data_file {filename} {
748 global env groupname gridname casename
750 # check if the file is located in the subdirectory data of the script dir
751 set scriptfile [info script]
752 if { $scriptfile != "" } {
753 set path [file join [file dirname $scriptfile] data $filename]
754 if { [file exists $path] } {
755 return [file normalize $path]
759 # check sub-directories in paths indicated by CSF_TestDataPath
760 if { [info exists env(CSF_TestDataPath)] } {
761 foreach dir [_split_path $env(CSF_TestDataPath)] {
762 while {[llength $dir] != 0} {
763 set name [lindex $dir 0]
764 set dir [lrange $dir 1 end]
765 eval lappend dir [glob -nocomplain -directory $name -type d *]
766 if { [file exists $name/$filename] } {
767 return [file normalize $name/$filename]
773 # check current datadir
774 if { [file exists [uplevel datadir]/$filename] } {
775 return [file normalize [uplevel datadir]/$filename]
779 error [join [list "File $filename could not be found" \
780 "(should be in paths indicated by CSF_TestDataPath environment variable, " \
781 "or in subfolder data in the script directory)"] "\n"]
784 # Internal procedure to find test case indicated by group, grid, and test case names;
786 # - dir: path to the base directory of the tests group
787 # - gridname: actual name of the grid
788 # - casefile: path to the test case script
789 # if no such test is found, raises error with appropriate message
790 proc _get_test {group grid casename _dir _gridname _casefile} {
792 upvar $_gridname gridname
793 upvar $_casefile casefile
797 # check that environment variable defining paths to test scripts is defined
798 if { ! [info exists env(CSF_TestScriptsPath)] ||
799 [llength $env(CSF_TestScriptsPath)] <= 0 } {
800 error "Error: Environment variable CSF_TestScriptsPath is not defined"
803 # iterate by all script paths
804 foreach dir [_split_path $env(CSF_TestScriptsPath)] {
805 # protection against empty paths
806 set dir [string trim $dir]
807 if { $dir == "" } { continue }
809 # check that directory exists
810 if { ! [file isdirectory $dir] } {
811 puts "Warning: directory $dir listed in CSF_TestScriptsPath does not exist, skipped"
815 # check if test group with given name exists in this dir
816 # if not, continue to the next test dir
817 if { ! [file isdirectory $dir/$group] } { continue }
819 # check that grid with given name (possibly alias) exists; stop otherwise
821 if { ! [file isdirectory $dir/$group/$gridname] } {
822 # check if grid is named by alias rather than by actual name
823 if { [file exists $dir/$group/grids.list] } {
824 set fd [open $dir/$group/grids.list]
825 while { [gets $fd line] >= 0 } {
826 if { [regexp "\[ \t\]*\#.*" $line] } { continue }
827 if { [regexp "^$grid\[ \t\]*\(\[A-Za-z0-9_.-\]+\)\$" $line res gridname] } {
834 if { ! [file isdirectory $dir/$group/$gridname] } { continue }
836 # get actual file name of the script; stop if it cannot be found
837 set casefile $dir/$group/$gridname/$casename
838 if { ! [file exists $casefile] } {
839 # check if this grid is aliased to another one
840 if { [file exists $dir/$group/$gridname/cases.list] } {
841 set fd [open $dir/$group/$gridname/cases.list]
842 if { [gets $fd line] >= 0 } {
843 set casefile [file normalize $dir/$group/$gridname/[string trim $line]/$casename]
848 if { [file exists $casefile] } {
854 # coming here means specified test is not found; report error
855 error [join [list "Error: test case $group / $grid / $casename is not found in paths listed in variable" \
856 "CSF_TestScriptsPath (current value is \"$env(CSF_TestScriptsPath)\")"] "\n"]
859 # Internal procedure to run test case indicated by base directory,
860 # grid and grid names, and test case file path.
861 # The log can be obtained by command "dlog get".
862 proc _run_test {scriptsdir group gridname casefile echo} {
866 uplevel dchrono _timer reset
867 uplevel dchrono _timer start
868 catch {uplevel meminfo w} membase
870 # enable commands logging; switch to old-style mode if dlog command is not present
872 if { [catch {dlog reset}] } {
879 rename puts puts-saved
881 global _tests_verbose
883 # log only output to stdout and stderr, not to file!
884 if {[llength $args] > 1} {
885 set optarg [lindex $args end-1]
886 if { $optarg == "stdout" || $optarg == "stderr" || $optarg == "-newline" } {
887 dlog add [lindex $args end]
889 eval puts-saved $args
892 dlog add [lindex $args end]
899 # set variables identifying test case
900 uplevel set casename [file tail $casefile]
901 uplevel set groupname $group
902 uplevel set gridname $gridname
903 uplevel set dirname $scriptsdir
905 # set variables for saving of images if not yet set
906 if { ! [uplevel info exists imagedir] } {
907 uplevel set imagedir [_get_temp_dir]
908 uplevel set test_image \$casename
911 # execute test scripts
912 if { [file exists $scriptsdir/$group/begin] } {
913 puts "Executing $scriptsdir/$group/begin..."; flush stdout
914 uplevel source $scriptsdir/$group/begin
916 if { [file exists $scriptsdir/$group/$gridname/begin] } {
917 puts "Executing $scriptsdir/$group/$gridname/begin..."; flush stdout
918 uplevel source $scriptsdir/$group/$gridname/begin
921 puts "Executing $casefile..."; flush stdout
922 uplevel source $casefile
924 if { [file exists $scriptsdir/$group/$gridname/end] } {
925 puts "Executing $scriptsdir/$group/$gridname/end..."; flush stdout
926 uplevel source $scriptsdir/$group/$gridname/end
928 if { [file exists $scriptsdir/$group/end] } {
929 puts "Executing $scriptsdir/$group/end..."; flush stdout
930 uplevel source $scriptsdir/$group/end
933 puts "Tcl Exception: $res"
937 if { $dlog_exists } {
942 rename puts-saved puts
947 # stop cpulimit killer if armed by the test
950 # add memory and timing info
952 if { ! [catch {uplevel meminfo w} memuse] } {
953 set stats "MEMORY DELTA: [expr ($memuse - $membase) / 1024] KiB\n"
955 uplevel dchrono _timer stop
956 set time [uplevel dchrono _timer show]
957 if [regexp -nocase {CPU user time:[ \t]*([0-9.e-]+)} $time res cpu] {
958 set stats "${stats}TOTAL CPU TIME: $cpu sec\n"
960 if { $dlog_exists && ! $echo } {
967 # Internal procedure to check log of test execution and decide if it passed or failed
968 proc _check_log {dir group gridname casename log {_summary {}} {_html_log {}}} {
970 if { $_summary != "" } { upvar $_summary summary }
971 if { $_html_log != "" } { upvar $_html_log html_log }
977 # load definition of 'bad words' indicating test failure
978 # note that rules are loaded in the order of decreasing priority (grid - group - common),
979 # thus grid rules will override group ones
981 foreach rulesfile [list $dir/$group/$gridname/parse.rules $dir/$group/parse.rules $dir/parse.rules] {
982 if [catch {set fd [open $rulesfile r]}] { continue }
983 while { [gets $fd line] >= 0 } {
984 # skip comments and empty lines
985 if { [regexp "\[ \t\]*\#.*" $line] } { continue }
986 if { [string trim $line] == "" } { continue }
988 if { ! [regexp {^([^/]*)/([^/]*)/(.*)$} $line res status rexp comment] } {
989 puts "Warning: cannot recognize parsing rule \"$line\" in file $rulesfile"
992 set status [string trim $status]
993 if { $comment != "" } { set status "$status ([string trim $comment])" }
994 set rexp [regsub -all {\\b} $rexp {\\y}] ;# convert regexp from Perl to Tcl style
995 lappend badwords [list $status $rexp]
999 if { [llength $badwords] <= 0 } {
1000 puts "Warning: no definition of error indicators found (check files parse.rules)"
1003 # analyse log line-by-line
1006 foreach line [split $log "\n"] {
1007 # check if line defines specific treatment of some messages
1008 if [regexp -nocase {^[ \t]*TODO ([^:]*):(.*)$} $line res platforms pattern] {
1009 if { ! [regexp -nocase {\mAll\M} $platforms] &&
1010 ! [regexp -nocase "\\m$env(os_type)\\M" $platforms] } {
1011 set html_log "$html_log\n$line"
1012 continue ;# TODO statement is for another platform
1015 # record TODOs that mark unstable cases
1016 if { [regexp {[\?]} $platforms] } {
1017 set todos_unstable([llength $todos]) 1
1020 lappend todos [regsub -all {\\b} [string trim $pattern] {\\y}] ;# convert regexp from Perl to Tcl style
1021 set html_log "$html_log\n[_html_highlight BAD $line]"
1025 # check for presence of messages indicating test result
1027 foreach bw $badwords {
1028 if { [regexp [lindex $bw 1] $line] } {
1029 # check if this is known bad case
1031 for {set i 0} {$i < [llength $todos]} {incr i} {
1032 if { [regexp [lindex $todos $i] $line] } {
1035 set html_log "$html_log\n[_html_highlight BAD $line]"
1040 # if it is not in todo, define status
1041 if { ! $is_known } {
1042 set stat [lindex $bw 0 0]
1043 set html_log "$html_log\n[_html_highlight $stat $line]"
1044 if { $status == "" && $stat != "OK" && ! [regexp -nocase {^IGNOR} $stat] } {
1045 set status [lindex $bw 0]
1052 if { ! $ismarked } {
1053 set html_log "$html_log\n$line"
1057 # check for presence of TEST COMPLETED statement
1058 if { $status == "" && ! [regexp {TEST COMPLETED} $log] } {
1059 # check whether absence of TEST COMPLETED is known problem
1060 set i [lsearch $todos "TEST INCOMPLETE"]
1064 set status "FAILED (no final message is found)"
1068 # check declared bad cases and diagnose possible improvement
1069 # (bad case declared but not detected).
1070 # Note that absence of the problem marked by TODO with question mark
1071 # (unstable) is not reported as improvement.
1072 if { $status == "" } {
1073 for {set i 0} {$i < [llength $todos]} {incr i} {
1074 if { ! [info exists todos_unstable($i)] &&
1075 (! [info exists todo_count($i)] || $todo_count($i) <= 0) } {
1076 set status "IMPROVEMENT (expected problem TODO no. [expr $i + 1] is not detected)"
1082 # report test as known bad if at least one of expected problems is found
1083 if { $status == "" && [llength [array names todo_count]] > 0 } {
1084 set status "BAD (known problem)"
1088 if { $status == "" } {set status "OK" }
1091 set status "FAILED ($res)"
1095 _log_and_puts summary "CASE $group $gridname $casename: $status"
1096 set html_log "[_html_highlight [lindex $status 0] $summary]\n$html_log"
1099 # Auxiliary procedure putting message to both cout and log variable (list)
1100 proc _log_and_puts {logvar message} {
1101 if { $logvar != "" } {
1103 if [info exists log] {
1104 set log "$log$message\n"
1106 set log "$message\n"
1112 # Auxiliary procedure to log result on single test case
1113 proc _log_test_case {output logdir dir group grid casename logvar} {
1116 # check result and make HTML log
1117 _check_log $dir $group $grid $casename $output summary html_log
1118 set log "$log$summary"
1121 if { $logdir != "" } {
1122 _log_html $logdir/$group/$grid/$casename.html $html_log "Test $group $grid $casename"
1123 _log_save $logdir/$group/$grid/$casename.log "$output\n$summary" "Test $group $grid $casename"
1127 # Auxiliary procedure to save log to file
1128 proc _log_save {file log {title {}}} {
1129 # create missing directories as needed
1130 catch {file mkdir [file dirname $file]}
1132 # try to open a file
1133 if [catch {set fd [open $file w]} res] {
1134 error "Error saving log file $file: $res"
1137 # dump log and close
1144 # Auxiliary procedure to make a (relative if possible) URL to a file for
1145 # inclusion a reference in HTML log
1146 proc _make_url {htmldir file} {
1147 set htmlpath [file split [file normalize $htmldir]]
1148 set filepath [file split [file normalize $file]]
1149 for {set i 0} {$i < [llength $htmlpath]} {incr i} {
1150 if { "[lindex $htmlpath $i]" != "[lindex $filepath $i]" } {
1151 if { $i == 0 } { break }
1152 return "[string repeat "../" [expr [llength $htmlpath] - $i - 1]][eval file join [lrange $filepath $i end]]"
1156 # if relative path could not be made, return full file URL
1157 return "file://[file normalize $file]"
1160 # Auxiliary procedure to save log to file
1161 proc _log_html {file log {title {}}} {
1162 # create missing directories as needed
1163 catch {file mkdir [file dirname $file]}
1165 # try to open a file
1166 if [catch {set fd [open $file w]} res] {
1167 error "Error saving log file $file: $res"
1171 puts $fd "<html><head><title>$title</title></head><body><h1>$title</h1>"
1173 # add images if present
1174 set imgbasename [file rootname [file tail $file]]
1175 foreach img [lsort [glob -nocomplain -directory [file dirname $file] -tails ${imgbasename}*.gif ${imgbasename}*.png ${imgbasename}*.jpg]] {
1176 puts $fd "<p>[file tail $img]<br><img src=\"$img\"/><p>"
1179 # print log body, trying to add HTML links to script files on lines like
1180 # "Executing <filename>..."
1182 foreach line [split $log "\n"] {
1183 if { [regexp {Executing[ \t]+([a-zA-Z0-9._/:-]+[^.])} $line res script] &&
1184 [file exists $script] } {
1185 set line [regsub $script $line "<a href=\"[_make_url $file $script]\">$script</a>"]
1189 puts $fd "</pre></body></html>"
1195 # Auxiliary method to make text with HTML highlighting according to status
1196 proc _html_color {status} {
1197 # choose a color for the cell according to result
1198 if { $status == "OK" } {
1200 } elseif { [regexp -nocase {^FAIL} $status] } {
1202 } elseif { [regexp -nocase {^BAD} $status] } {
1204 } elseif { [regexp -nocase {^IMP} $status] } {
1206 } elseif { [regexp -nocase {^SKIP} $status] } {
1208 } elseif { [regexp -nocase {^IGNOR} $status] } {
1211 puts "Warning: no color defined for status $status, using red as if FAILED"
1216 # Format text line in HTML to be colored according to the status
1217 proc _html_highlight {status line} {
1218 return "<table><tr><td bgcolor=\"[_html_color $status]\">$line</td></tr></table>"
1221 # Internal procedure to generate HTML page presenting log of the tests
1222 # execution in tabular form, with links to reports on individual cases
1223 proc _log_html_summary {logdir log totals regressions improvements total_time} {
1224 global _test_case_regexp
1226 # create missing directories as needed
1227 catch {file mkdir $logdir}
1229 # try to open a file and start HTML
1230 if [catch {set fd [open $logdir/summary.html w]} res] {
1231 error "Error creating log file: $res"
1234 # write HRML header, including command to refresh log if still in progress
1235 puts $fd "<html><head>"
1236 puts $fd "<title>Tests summary</title>"
1237 if { $total_time == "" } {
1238 puts $fd "<meta http-equiv=\"refresh\" content=\"10\">"
1240 puts $fd "<meta http-equiv=\"pragma\" content=\"NO-CACHE\">"
1241 puts $fd "</head><body>"
1244 set legend(OK) "Test passed OK"
1245 set legend(FAILED) "Test failed (regression)"
1246 set legend(BAD) "Known problem"
1247 set legend(IMPROVEMENT) "Possible improvement (expected problem not detected)"
1248 set legend(SKIPPED) "Test skipped due to lack of data file"
1249 puts $fd "<h1>Summary</h1><table>"
1250 foreach nbstat $totals {
1251 set status [lindex $nbstat 1]
1252 if { [info exists legend($status)] } {
1253 set comment $legend($status)
1255 set comment "User-defined status"
1257 puts $fd "<tr><td align=\"right\">[lindex $nbstat 0]</td><td bgcolor=\"[_html_color $status]\">$status</td><td>$comment</td></tr>"
1261 # time stamp and elapsed time info
1262 if { $total_time != "" } {
1263 puts $fd "<p>Generated on [clock format [clock seconds] -format {%Y-%m-%d %H:%M:%S}] on [info hostname]\n<p>"
1264 puts $fd [join [split $total_time "\n"] "<p>"]
1266 puts $fd "<p>NOTE: This is intermediate summary; the tests are still running! This page will refresh automatically until tests are finished."
1269 # print regressions and improvements
1270 foreach featured [list $regressions $improvements] {
1271 if { [llength $featured] <= 1 } { continue }
1272 set status [string trim [lindex $featured 0] { :}]
1273 puts $fd "<h2>$status</h2>"
1276 foreach test [lrange $featured 1 end] {
1277 if { ! [regexp {^(.*)\s+([\w.]+)$} $test res gg name] } {
1279 set name "Error building short list; check details"
1281 if { $gg != $groupgrid } {
1282 if { $groupgrid != "" } { puts $fd "</tr>" }
1284 puts $fd "<tr><td>$gg</td>"
1286 puts $fd "<td bgcolor=\"[_html_color $status]\"><a href=\"[regsub -all { } $gg /]/${name}.html\">$name</a></td>"
1288 if { $groupgrid != "" } { puts $fd "</tr>" }
1293 puts $fd "<h1>Details</h1>"
1295 # process log line-by-line
1298 foreach line [lsort -dictionary [split $log "\n"]] {
1299 # check that the line is case report in the form "CASE group grid name: result (explanation)"
1300 if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } {
1305 if { $grp != $group } {
1306 if { $letter != "" } { puts $fd "</tr></table>" }
1310 puts $fd "<h2>Group $group</h2>"
1314 if { $grd != $grid } {
1315 if { $letter != "" } { puts $fd "</tr></table>" }
1318 puts $fd "<h3>Grid $grid</h3>"
1321 # check if test case name is <letter><digit>;
1322 # if not, set alnum to period "." to recognize non-standard test name
1323 if { ! [regexp {([A-Za-z]+)([0-9]+)} $casename res alnum number] } {
1327 # start new row when letter changes or for non-standard names
1328 if { $alnum != $letter || $alnum == "." } {
1329 if { $letter != "" } {
1330 puts $fd "</tr><tr>"
1332 puts $fd "<table><tr>"
1337 puts $fd "<td bgcolor=\"[_html_color $result]\"><a href=\"$group/$grid/${casename}.html\">$casename</a></td>"
1339 puts $fd "</tr></table>"
1341 # add remaining lines of log as plain text
1342 puts $fd "<h2>Plain text messages</h2>\n<pre>"
1343 foreach line [split $log "\n"] {
1344 if { ! [regexp $_test_case_regexp $line] } {
1350 # close file and exit
1356 # Procedure to dump summary logs of tests
1357 proc _log_summarize {logdir log {total_time {}}} {
1359 # sort log records alphabetically to have the same behavior on Linux and Windows
1360 # (also needed if tests are run in parallel)
1361 set loglist [lsort -dictionary [split $log "\n"]]
1363 # classify test cases by status
1364 foreach line $loglist {
1365 if { [regexp {^CASE ([^:]*): ([[:alnum:]]+).*$} $line res caseid status] } {
1366 lappend stat($status) $caseid
1370 set improvements {Improvements:}
1371 set regressions {Failed:}
1372 if { [info exists stat] } {
1373 foreach status [lsort [array names stat]] {
1374 lappend totals [list [llength $stat($status)] $status]
1376 # separately count improvements (status starting with IMP) and regressions (all except IMP, OK, BAD, and SKIP)
1377 if { [regexp -nocase {^IMP} $status] } {
1378 eval lappend improvements $stat($status)
1379 } elseif { $status != "OK" && ! [regexp -nocase {^BAD} $status] && ! [regexp -nocase {^SKIP} $status] } {
1380 eval lappend regressions $stat($status)
1385 # if time is specified, add totals
1386 if { $total_time != "" } {
1387 if { [llength $improvements] > 1 } {
1388 _log_and_puts log [join $improvements "\n "]
1390 if { [llength $regressions] > 1 } {
1391 _log_and_puts log [join $regressions "\n "]
1393 if { [llength $improvements] == 1 && [llength $regressions] == 1 } {
1394 _log_and_puts log "No regressions"
1396 _log_and_puts log "Total cases: [join $totals {, }]"
1397 _log_and_puts log $total_time
1401 if { $logdir != "" } {
1402 _log_html_summary $logdir $log $totals $regressions $improvements $total_time
1403 _log_save $logdir/tests.log $log "Tests summary"
1409 # Internal procedure to generate XML log in JUnit style, for further
1410 # consumption by Jenkins or similar systems.
1412 # The output is intended to conform to XML schema supported by Jenkins found at
1413 # 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
1415 # The mapping of the fields is inspired by annotated schema of Apache Ant JUnit XML format found at
1416 # http://windyroad.org/dl/Open%20Source/JUnit.xsd
1417 proc _log_xml_summary {logdir filename log include_cout} {
1418 global _test_case_regexp
1420 catch {file mkdir [file dirname $filename]}
1422 # try to open a file and start XML
1423 if [catch {set fd [open $filename w]} res] {
1424 error "Error creating XML summary file $filename: $res"
1426 puts $fd "<?xml version='1.0' encoding='utf-8'?>"
1427 puts $fd "<testsuites>"
1429 # prototype for command to generate test suite tag
1430 set time_and_host "timestamp=\"[clock format [clock seconds] -format {%Y-%m-%dT%H:%M:%S}]\" hostname=\"[info hostname]\""
1431 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"}
1433 # sort log and process it line-by-line
1435 foreach line [lsort -dictionary [split $log "\n"]] {
1436 # check that the line is case report in the form "CASE group grid name: result (explanation)"
1437 if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } {
1440 set message [string trim $message " \t\r\n()"]
1442 # start new testsuite for each grid
1443 if { $grp != $group || $grd != $grid } {
1445 # write previous test suite
1446 if [info exists testcases] { eval $cmd_testsuite }
1461 # parse test log and get its CPU time
1464 if { [catch {set fdlog [open $logdir/$group/$grid/${casename}.log r]} ret] } {
1465 puts "Error: cannot open $logdir/$group/$grid/${casename}.log: $ret"
1467 while { [gets $fdlog logline] >= 0 } {
1468 if { $include_cout } {
1469 set testout "$testout$logline\n"
1471 if [regexp -nocase {TOTAL CPU TIME:\s*([\d.]+)\s*sec} $logline res cpu] {
1472 set add_cpu " time=\"$cpu\""
1473 set time [expr $time + $cpu]
1478 if { ! $include_cout } {
1479 set testout "$line\n"
1482 # record test case with its output and status
1483 # Mapping is: SKIPPED, BAD, and OK to OK, all other to failure
1484 set testcases "$testcases\n <testcase name=\"$casename\"$add_cpu status=\"$result\">\n"
1485 set testcases "$testcases\n <system-out>\n$testout </system-out>"
1486 if { $result != "OK" } {
1487 if { [regexp -nocase {^SKIP} $result] } {
1489 set testcases "$testcases\n <error name=\"$result\" message=\"$message\"/>"
1490 } elseif { [regexp -nocase {^BAD} $result] } {
1492 set testcases "$testcases\n <skipped>$message</skipped>"
1495 set testcases "$testcases\n <failure name=\"$result\" message=\"$message\"/>"
1498 set testcases "$testcases\n </testcase>"
1501 # write last test suite
1502 if [info exists testcases] { eval $cmd_testsuite }
1505 puts $fd "</testsuites>"
1510 # define custom platform name
1511 proc _tests_platform_def {} {
1512 global env tcl_platform
1514 if [info exists env(os_type)] { return }
1516 set env(os_type) $tcl_platform(platform)
1518 # use detailed mapping for various versions of Lunix
1519 # (note that mapping is rather non-uniform, for historical reasons)
1520 if { $tcl_platform(os) == "Linux" && ! [catch {exec cat /etc/issue} issue] } {
1521 if { [regexp {Mandriva[ \tA-Za-z]+([0-9]+)} $issue res num] } {
1522 set env(os_type) Mandriva$num
1523 } elseif { [regexp {Red Hat[ \tA-Za-z]+([0-9]+)} $issue res num] } {
1524 set env(os_type) RedHat$num
1525 } elseif { [regexp {Debian[ \tA-Za-z/]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } {
1526 set env(os_type) Debian$num$subnum
1527 } elseif { [regexp {CentOS[ \tA-Za-z]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } {
1528 set env(os_type) CentOS$num$subnum
1529 } elseif { [regexp {Scientific[ \tA-Za-z]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } {
1530 set env(os_type) SL$num$subnum
1531 } elseif { [regexp {Fedora Core[ \tA-Za-z]+([0-9]+)} $issue res num] } {
1532 set env(os_type) FedoraCore$num
1534 if { [exec uname -m] == "x86_64" } {
1535 set env(os_type) "$env(os_type)-64"
1537 } elseif { $tcl_platform(os) == "Darwin" } {
1538 set env(os_type) MacOS
1543 # Auxiliary procedure to split path specification (usually defined by
1544 # environment variable) into list of directories or files
1545 proc _split_path {pathspec} {
1548 # first replace all \ (which might occur on Windows) by /
1549 regsub -all "\\\\" $pathspec "/" pathspec
1551 # split path by platform-specific separator
1552 return [split $pathspec [_path_separator]]
1555 # Auxiliary procedure to define platform-specific separator for directories in
1556 # path specification
1557 proc _path_separator {} {
1560 # split path by platform-specific separator
1561 if { $tcl_platform(platform) == "windows" } {
1568 # Procedure to make a diff and common of two lists
1569 proc _list_diff {list1 list2 _in1 _in2 _common} {
1572 upvar $_common common
1577 foreach item $list1 {
1578 if { [lsearch -exact $list2 $item] >= 0 } {
1579 lappend common $item
1584 foreach item $list2 {
1585 if { [lsearch -exact $common $item] < 0 } {
1592 # procedure to load a file to Tcl string
1593 proc _read_file {filename} {
1594 set fd [open $filename r]
1595 set result [read -nonewline $fd]
1600 # procedure to construct name for the mage diff file
1601 proc _diff_img_name {dir1 dir2 casepath imgfile} {
1602 return [file join $dir1 $casepath "diff-[file tail $dir2]-$imgfile"]
1605 # Procedure to compare results of two runs of test cases
1606 proc _test_diff {dir1 dir2 basename status verbose _logvar {_statvar ""}} {
1609 # make sure to load diffimage command
1610 uplevel pload VISUALIZATION
1612 # prepare variable (array) for collecting statistics
1613 if { "$_statvar" != "" } {
1614 upvar $_statvar stat
1623 # first check subdirectories
1624 set path1 [file join $dir1 $basename]
1625 set path2 [file join $dir2 $basename]
1626 set list1 [glob -directory $path1 -types d -tails -nocomplain *]
1627 set list2 [glob -directory $path2 -types d -tails -nocomplain *]
1628 if { [llength $list1] >0 || [llength $list2] > 0 } {
1629 _list_diff $list1 $list2 in1 in2 common
1630 if { "$verbose" > 1 } {
1631 if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" }
1632 if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" }
1634 foreach subdir $common {
1635 if { "$verbose" > 2 } {
1636 _log_and_puts log "Checking [file join $basename $subdir]"
1638 _test_diff $dir1 $dir2 [file join $basename $subdir] $status $verbose log stat
1641 # check log files (only if directory has no subdirs)
1642 set list1 [glob -directory $path1 -types f -tails -nocomplain *.log]
1643 set list2 [glob -directory $path2 -types f -tails -nocomplain *.log]
1644 _list_diff $list1 $list2 in1 in2 common
1645 if { "$verbose" > 1 } {
1646 if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" }
1647 if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" }
1649 foreach logfile $common {
1651 set log1 [_read_file [file join $dir1 $basename $logfile]]
1652 set log2 [_read_file [file join $dir2 $basename $logfile]]
1653 set casename [file rootname $logfile]
1655 # check execution statuses
1656 set status1 UNDEFINED
1657 set status2 UNDEFINED
1658 if { ! [regexp {CASE [^:]*:\s*([\w]+)} $log1 res1 status1] ||
1659 ! [regexp {CASE [^:]*:\s*([\w]+)} $log2 res2 status2] ||
1660 "$status1" != "$status2" } {
1661 _log_and_puts log "STATUS [split $basename /] $casename: $status1 / $status2"
1663 # if test statuses are different, further comparison makes
1664 # no sense unless explicitly requested
1665 if { "$status" != "all" } {
1669 if { "$status" == "ok" && "$status1" != "OK" } {
1676 if { [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log1 res1 cpu1] &&
1677 [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log2 res1 cpu2] } {
1678 set stat(cpu1) [expr $stat(cpu1) + $cpu1]
1679 set stat(cpu2) [expr $stat(cpu2) + $cpu2]
1681 # compare CPU times with 10% precision (but not less 0.5 sec)
1682 if { [expr abs ($cpu1 - $cpu2) > 0.5 + 0.05 * abs ($cpu1 + $cpu2)] } {
1683 _log_and_puts log "CPU [split $basename /] $casename: $cpu1 / $cpu2"
1687 # check memory delta
1690 if { [regexp {MEMORY DELTA:\s*([\d.]+)} $log1 res1 mem1] &&
1691 [regexp {MEMORY DELTA:\s*([\d.]+)} $log2 res1 mem2] } {
1692 set stat(mem1) [expr $stat(mem1) + $mem1]
1693 set stat(mem2) [expr $stat(mem2) + $mem2]
1695 # compare memory usage with 10% precision (but not less 16 KiB)
1696 if { [expr abs ($mem1 - $mem2) > 16 + 0.05 * abs ($mem1 + $mem2)] } {
1697 _log_and_puts log "MEMORY [split $basename /] $casename: $mem1 / $mem2"
1702 set imglist1 [glob -directory $path1 -types f -tails -nocomplain $casename*.{png,gif}]
1703 set imglist2 [glob -directory $path2 -types f -tails -nocomplain $casename*.{png,gif}]
1704 _list_diff $imglist1 $imglist2 imgin1 imgin2 imgcommon
1705 if { "$verbose" > 1 } {
1706 if { [llength $imgin1] > 0 } { _log_and_puts log "Only in $path1: $imgin1" }
1707 if { [llength $imgin2] > 0 } { _log_and_puts log "Only in $path2: $imgin2" }
1709 foreach imgfile $imgcommon {
1710 # if { $verbose > 1 } { _log_and_puts log "Checking [split basename /] $casename: $imgfile" }
1711 set diffile [_diff_img_name $dir1 $dir2 $basename $imgfile]
1712 if { [catch {diffimage [file join $dir1 $basename $imgfile] \
1713 [file join $dir2 $basename $imgfile] \
1714 0 0 0 $diffile} diff] } {
1715 _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
1716 file delete -force $diffile ;# clean possible previous result of diffimage
1717 } elseif { $diff != 0 } {
1718 _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile differs"
1720 file delete -force $diffile ;# clean useless artifact of diffimage
1726 if { "$_statvar" == "" } {
1727 _log_and_puts log "Total MEMORY difference: $stat(mem1) / $stat(mem2)"
1728 _log_and_puts log "Total CPU difference: $stat(cpu1) / $stat(cpu2)"
1732 # Auxiliary procedure to save log of results comparison to file
1733 proc _log_html_diff {file log dir1 dir2} {
1734 # create missing directories as needed
1735 catch {file mkdir [file dirname $file]}
1737 # try to open a file
1738 if [catch {set fd [open $file w]} res] {
1739 error "Error saving log file $file: $res"
1743 puts $fd "<html><head><title>Diff $dir1 vs. $dir2</title></head><body>"
1744 puts $fd "<h1>Comparison of test results: $dir1 vs. $dir2</h1>"
1746 # print log body, trying to add HTML links to script files on lines like
1747 # "Executing <filename>..."
1749 set logpath [file split [file normalize $file]]
1750 foreach line [split $log "\n"] {
1753 if { [regexp {IMAGE[ \t]+([^:]+):[ \t]+([A-Za-z0-9_.-]+)} $line res case img] } {
1754 if { [catch {eval file join "" [lrange $case 0 end-1]} gridpath] } {
1755 # note: special handler for the case if test grid directoried are compared directly
1758 set img1 "<img src=\"[_make_url $file [file join $dir1 $gridpath $img]]\">"
1759 set img2 "<img src=\"[_make_url $file [file join $dir2 $gridpath $img]]\">"
1761 set difffile [_diff_img_name $dir1 $dir2 $gridpath $img]
1762 if { [file exists $difffile] } {
1763 set imgd "<img src=\"[_make_url $file $difffile]\">"
1768 puts $fd "<table><tr><th>[file tail $dir1]</th><th>[file tail $dir2]</th><th>Different pixels</th></tr>"
1769 puts $fd "<tr><td>$img1</td><td>$img2</td><td>$imgd</td></tr></table>"
1772 puts $fd "</pre></body></html>"
1778 # get number of CPUs on the system
1779 proc _get_nb_cpus {} {
1780 global tcl_platform env
1782 if { "$tcl_platform(platform)" == "windows" } {
1783 # on Windows, take the value of the environment variable
1784 if { [info exists env(NUMBER_OF_PROCESSORS)] &&
1785 ! [catch {expr $env(NUMBER_OF_PROCESSORS) > 0} res] && $res >= 0 } {
1786 return $env(NUMBER_OF_PROCESSORS)
1788 } elseif { "$tcl_platform(os)" == "Linux" } {
1789 # on Linux, take number of logical processors listed in /proc/cpuinfo
1790 if { [catch {open "/proc/cpuinfo" r} fd] } {
1791 return 0 ;# should never happen, but...
1794 while { [gets $fd line] >= 0 } {
1795 if { [regexp {^processor[ \t]*:} $line] } {
1801 } elseif { "$tcl_platform(os)" == "Darwin" } {
1802 # on MacOS X, call sysctl command
1803 if { ! [catch {exec sysctl hw.ncpu} ret] &&
1804 [regexp {^hw[.]ncpu[ \t]*:[ \t]*([0-9]+)} $ret res nb] } {
1809 # if cannot get good value, return 0 as default
1813 # check two files for difference
1814 proc _diff_files {file1 file2} {
1815 set fd1 [open $file1 "r"]
1816 set fd2 [open $file2 "r"]
1820 set nb1 [gets $fd1 line1]
1821 set nb2 [gets $fd2 line2]
1822 if { $nb1 != $nb2 } { set differ t; break }
1823 if { $nb1 < 0 } { break }
1824 if { [string compare $line1 $line2] } {
1835 # Check if file is in DOS encoding.
1836 # This check is done by presence of \r\n combination at the end of the first
1837 # line (i.e. prior to any other \n symbol).
1838 # Note that presence of non-ascii symbols typically used for recognition
1839 # of binary files is not suitable since some IGES and STEP files contain
1840 # non-ascii symbols.
1841 # Special check is added for PNG files which contain \r\n in the beginning.
1842 proc _check_dos_encoding {file} {
1843 set fd [open $file rb]
1845 if { [gets $fd line] && [regexp {.*\r$} $line] &&
1846 ! [regexp {^.PNG} $line] } {
1853 # procedure to recognize format of a data file by its first symbols (for OCCT
1854 # BREP and geometry DRAW formats, IGES, and STEP) and extension (all others)
1855 proc _check_file_format {file} {
1856 set fd [open $file rb]
1857 set line [read $fd 1024]
1861 set ext [file extension $file]
1863 if { [regexp {^DBRep_DrawableShape} $line] } {
1865 if { "$ext" != ".brep" && "$ext" != ".rle" &&
1866 "$ext" != ".draw" && "$ext" != "" } {
1869 } elseif { [regexp {^DrawTrSurf_} $line] } {
1871 if { "$ext" != ".rle" &&
1872 "$ext" != ".draw" && "$ext" != "" } {
1875 } elseif { [regexp {^[ \t]*ISO-10303-21} $line] } {
1877 if { "$ext" != ".step" && "$ext" != ".stp" } {
1880 } elseif { [regexp {^.\{72\}S[0 ]\{6\}1} $line] } {
1882 if { "$ext" != ".iges" && "$ext" != ".igs" } {
1885 } elseif { "$ext" == ".igs" } {
1887 } elseif { "$ext" == ".stp" } {
1890 set format [string toupper [string range $ext 1 end]]
1894 puts "$file: Warning: extension ($ext) does not match format ($format)"
1900 # procedure to load file knowing its format
1901 proc load_data_file {file format shape} {
1903 BREP { uplevel restore $file $shape }
1904 DRAW { uplevel restore $file $shape }
1905 IGES { pload XSDRAW; uplevel igesbrep $file $shape * }
1906 STEP { pload XSDRAW; uplevel stepread $file __a *; uplevel renamevar __a_1 $shape }
1907 STL { pload XSDRAW; uplevel readstl $shape $file }
1908 default { error "Cannot read $format file $file" }
1912 # procedure to get name of temporary directory,
1913 # ensuring it is existing and writeable
1914 proc _get_temp_dir {} {
1915 global env tcl_platform
1917 # check typical environment variables
1918 foreach var {TempDir Temp Tmp} {
1919 # check different case
1920 foreach name [list [string toupper $var] $var [string tolower $var]] {
1921 if { [info exists env($name)] && [file isdirectory $env($name)] &&
1922 [file writable $env($name)] } {
1923 return [regsub -all {\\} $env($name) /]
1928 # check platform-specific locations
1930 if { "$tcl_platform(platform)" == "windows" } {
1931 set paths "c:/TEMP c:/TMP /TEMP /TMP"
1932 if { [info exists env(HOMEDRIVE)] && [info exists env(HOMEPATH)] } {
1933 set fallback [regsub -all {\\} "$env(HOMEDRIVE)$(HOMEPATH)/tmp" /]
1936 set paths "/tmp /var/tmp /usr/tmp"
1937 if { [info exists env(HOME)] } {
1938 set fallback "$env(HOME)/tmp"
1941 foreach dir $paths {
1942 if { [file isdirectory $dir] && [file writable $dir] } {
1947 # fallback case: use subdir /tmp of home or current dir
1948 file mkdir $fallback