0031006: Draw Harness - locate_data_file fails on path containing spaces
[occt.git] / src / DrawResources / TestCommands.tcl
1 # Copyright (c) 2013-2014 OPEN CASCADE SAS
2 #
3 # This file is part of Open CASCADE Technology software library.
4 #
5 # This library is free software; you can redistribute it and/or modify it under
6 # the terms of the GNU Lesser General Public License version 2.1 as published
7 # by the Free Software Foundation, with special exception defined in the file
8 # OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 # distribution for complete text of the license and disclaimer of any warranty.
10 #
11 # Alternatively, this file may be used under the terms of Open CASCADE
12 # commercial license or contractual agreement.
13
14 ############################################################################
15 # This file defines scripts for execution of OCCT tests.
16 # It should be loaded automatically when DRAW is started, and provides
17 # top-level commands starting with 'test'. Type 'help test' to get their
18 # synopsys.
19 # See OCCT Tests User Guide for description of the test system.
20 #
21 # Note: procedures with names starting with underscore are for internal use 
22 # inside the test system.
23 ############################################################################
24
25 # Default verbose level for command _run_test
26 set _tests_verbose 0
27
28 # regexp for parsing test case results in summary log
29 set _test_case_regexp {^CASE\s+([\w.-]+)\s+([\w.-]+)\s+([\w.-]+)\s*:\s*([\w]+)(.*)}
30
31 # Basic command to run indicated test case in DRAW
32 help test {
33   Run specified test case
34   Use: test group grid casename [options...]
35   Allowed options are:
36   -echo: all commands and results are echoed immediately,
37          but log is not saved and summary is not produced
38          It is also possible to use "1" instead of "-echo"
39          If echo is OFF, log is stored in memory and only summary
40          is output (the log can be obtained with command "dlog get")
41   -outfile filename: set log file (should be non-existing),
42          it is possible to save log file in text file or
43          in html file(with snapshot), for that "filename"
44          should have ".html" extension
45   -overwrite: force writing log in existing file
46   -beep: play sound signal at the end of the test
47   -errors: show all lines from the log report that are recognized as errors
48          This key will be ignored if the "-echo" key is already set.
49 }
50 proc test {group grid casename {args {}}} {
51     # set default values of arguments
52     set echo 0
53     set errors 0
54     set logfile ""
55     set overwrite 0
56     set signal 0
57
58     # get test case paths (will raise error if input is invalid)
59     _get_test $group $grid $casename dir gridname casefile
60
61     # check arguments
62     for {set narg 0} {$narg < [llength $args]} {incr narg} {
63         set arg [lindex $args $narg]
64         # if echo specified as "-echo", convert it to bool
65         if { $arg == "-echo" || $arg == "1" } {
66             set echo t
67             continue
68         }
69
70         # output log file
71         if { $arg == "-outfile" } {
72             incr narg
73             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
74                 set logfile [lindex $args $narg]
75             } else {
76                 error "Option -outfile requires argument"
77             }
78             continue
79         }
80
81         # allow overwrite existing log
82         if { $arg == "-overwrite" } {
83             set overwrite 1
84             continue
85         }
86
87         # sound signal at the end of the test
88         if { $arg == "-beep" } {
89             set signal t
90             continue
91         }
92
93         # if errors specified as "-errors", convert it to bool
94         if { $arg == "-errors" } {
95             set errors t
96             continue
97         }
98
99         # unsupported option
100         error "Error: unsupported option \"$arg\""
101     }
102     # run test
103     uplevel _run_test $dir $group $gridname $casefile $echo 
104
105     # check log
106     if { !$echo } {
107         _check_log $dir $group $gridname $casename $errors [dlog get] summary html_log
108
109         # create log file
110         if { ! $overwrite && [file isfile $logfile] } {
111             error "Error: Specified log file \"$logfile\" exists; please remove it before running test or use -overwrite option"
112         }
113         if {$logfile != ""} {
114             if {[file extension $logfile] == ".html"} {
115                 if {[regexp {vdump ([^\s\n]+)} $html_log dump snapshot]} {
116                     catch {file copy -force $snapshot [file rootname $logfile][file extension $snapshot]}
117                 }
118                 _log_html $logfile $html_log "Test $group $grid $casename"
119             } else {
120                 _log_save $logfile "[dlog get]\n$summary" "Test $group $grid $casename"
121             }
122         }
123     }
124
125     # play sound signal at the end of test
126     if {$signal} {
127         puts "\7\7\7\7"
128     }
129     return
130 }
131
132 # Basic command to run indicated test case in DRAW
133 help testgrid {
134   Run all tests, or specified group, or one grid
135   Use: testgrid [groupmask [gridmask [casemask]]] [options...]
136   Allowed options are:
137   -exclude N: exclude group, subgroup or single test case from executing, where
138               N is name of group, subgroup or case. Excluded items should be separated by comma.
139               Option should be used as the first argument after list of executed groups, grids, and test cases.
140   -parallel N: run N parallel processes (default is number of CPUs, 0 to disable)
141   -refresh N: save summary logs every N seconds (default 600, minimal 1, 0 to disable)
142   -outdir dirname: set log directory (should be empty or non-existing)
143   -overwrite: force writing logs in existing non-empty directory
144   -xml filename: write XML report for Jenkins (in JUnit-like format)
145   -beep: play sound signal at the end of the tests
146   -regress dirname: re-run only a set of tests that have been detected as regressions on some previous run.
147                     Here "dirname" is path to directory containing results of previous run.
148   Groups, grids, and test cases to be executed can be specified by list of file 
149   masks, separated by spaces or comma; default is all (*).
150 }
151 proc testgrid {args} {
152     global env tcl_platform _tests_verbose
153
154     ######################################################
155     # check arguments
156     ######################################################
157
158     # check that environment variable defining paths to test scripts is defined
159     if { ! [info exists env(CSF_TestScriptsPath)] || 
160         [llength $env(CSF_TestScriptsPath)] <= 0 } {
161         error "Error: Environment variable CSF_TestScriptsPath is not defined"
162     }
163
164     # treat options
165     set parallel [_get_nb_cpus]
166     set refresh 60
167     set logdir ""
168     set overwrite 0
169     set xmlfile ""
170     set signal 0
171     set exc_group 0
172     set exc_grid 0
173     set exc_case 0
174     set regress 0
175     set prev_logdir ""
176     for {set narg 0} {$narg < [llength $args]} {incr narg} {
177         set arg [lindex $args $narg]
178
179         # parallel execution
180         if { $arg == "-parallel" } {
181             incr narg
182             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
183                 set parallel [expr [lindex $args $narg]]
184             } else {
185                 error "Option -parallel requires argument"
186             }
187             continue
188         }
189
190         # refresh logs time
191         if { $arg == "-refresh" } {
192             incr narg
193             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
194                 set refresh [expr [lindex $args $narg]]
195             } else {
196                 error "Option -refresh requires argument"
197             }
198             continue
199         }
200
201         # output directory
202         if { $arg == "-outdir" } {
203             incr narg
204             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
205                 set logdir [lindex $args $narg]
206             } else {
207                 error "Option -outdir requires argument"
208             }
209             continue
210         }
211
212         # allow overwrite logs 
213         if { $arg == "-overwrite" } {
214             set overwrite 1
215             continue
216         }
217
218         # refresh logs time
219         if { $arg == "-xml" } {
220             incr narg
221             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
222                 set xmlfile [lindex $args $narg]
223             }
224             if { $xmlfile == "" } {
225                 set xmlfile TESTS-summary.xml
226             }
227             continue
228         }
229
230         # sound signal at the end of the test
231         if { $arg == "-beep" } {
232             set signal t
233             continue
234         }
235
236         # re-run only a set of tests that have been detected as regressions on some previous run
237         if { $arg == "-regress" } {
238             incr narg
239             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
240                 set prev_logdir [lindex $args $narg]
241                 set regress 1
242             } else {
243                 error "Option -regress requires argument"
244             }
245             continue
246         }
247
248         # exclude group, subgroup or single test case from executing
249         if { $arg == "-exclude" } {
250             incr narg
251             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
252                 set argts $args
253                 set idx_begin [string first " -ex" $argts]
254                 if { ${idx_begin} != "-1" } {
255                     set argts [string replace $argts 0 $idx_begin]
256                 }
257                 set idx_exclude [string first "exclude" $argts]
258                 if { ${idx_exclude} != "-1" } {
259                     set argts [string replace $argts 0 $idx_exclude+7]
260                 }
261                 set idx [string first " -" $argts]
262                 if { ${idx} != "-1" } {
263                     set argts [string replace $argts $idx end]
264                 }
265                 set argts [split $argts ,]
266                 foreach argt $argts {
267                     if { [llength $argt] == 1 } {
268                         lappend exclude_group $argt
269                         set exc_group 1
270                     } elseif { [llength $argt] == 2 } {
271                         lappend exclude_grid $argt
272                         set exc_grid 1
273                         incr narg
274                     } elseif { [llength $argt] == 3 } {
275                         lappend exclude_case $argt
276                         set exc_case 1
277                         incr narg
278                         incr narg
279                     }
280                 }
281             } else {
282                 error "Option -exclude requires argument"
283             }
284             continue
285         }
286
287         # unsupported option
288         if { [regexp {^-} $arg] } {
289             error "Error: unsupported option \"$arg\""
290         }
291
292         # treat arguments not recognized as options as group and grid names
293         if { ! [info exists groupmask] } {
294             set groupmask [split $arg ,]
295         } elseif { ! [info exists gridmask] } {
296             set gridmask [split $arg ,]
297         } elseif { ! [info exists casemask] } {
298             set casemask [split $arg ,]
299         } else {
300             error "Error: cannot interpret argument $narg ($arg)"
301         }
302     }
303
304     # check that target log directory is empty or does not exist
305     set logdir [file normalize [string trim $logdir]]
306     set prev_logdir [file normalize [string trim $prev_logdir]]
307     if { $logdir == "" } {
308         # if specified logdir is empty string, generate unique name like 
309         # results/<branch>_<timestamp>
310         set prefix ""
311         if { ! [catch {exec git branch} gitout] &&
312              [regexp {[*] ([\w-]+)} $gitout res branch] } {
313             set prefix "${branch}_"
314         }
315         set logdir "results/${prefix}[clock format [clock seconds] -format {%Y-%m-%dT%H%M}]"
316
317         set logdir [file normalize $logdir]
318     }
319     if { [file isdirectory $logdir] && ! $overwrite && ! [catch {glob -directory $logdir *}] } {
320         error "Error: Specified log directory \"$logdir\" is not empty; please clean it before running tests"
321     } 
322     if { [catch {file mkdir $logdir}] || ! [file writable $logdir] } {
323         error "Error: Cannot create directory \"$logdir\", or it is not writable"
324     }
325
326     # masks for search of test groups, grids, and cases
327     if { ! [info exists groupmask] } { set groupmask * }
328     if { ! [info exists gridmask ] } { set gridmask  * }
329     if { ! [info exists casemask ] } { set casemask  * }
330
331     # Find test cases with FAILED and IMPROVEMENT statuses in previous run
332     # if option "regress" is given
333     set rerun_group_grid_case {}
334
335     if { ${regress} > 0 } {
336         if { "${groupmask}" != "*"} {
337             lappend rerun_group_grid_case [list $groupmask $gridmask $casemask]
338         }
339     } else {
340         lappend rerun_group_grid_case [list $groupmask $gridmask $casemask]
341     }
342
343     if { ${regress} > 0 } {
344         if { [file exists ${prev_logdir}/tests.log] } {
345             set fd [open ${prev_logdir}/tests.log]
346             while { [gets $fd line] >= 0 } {
347                 if {[regexp {CASE ([^\s]+) ([^\s]+) ([^\s]+): FAILED} $line dump group grid casename] ||
348                     [regexp {CASE ([^\s]+) ([^\s]+) ([^\s]+): IMPROVEMENT} $line dump group grid casename]} {
349                     lappend rerun_group_grid_case [list $group $grid $casename]
350                 }
351             }
352             close $fd
353         } else {
354             error "Error: file ${prev_logdir}/tests.log is not found, check your input arguments!"
355         }
356     }
357
358     ######################################################
359     # prepare list of tests to be performed
360     ######################################################
361
362     # list of tests, each defined by a list of:
363     # test scripts directory
364     # group (subfolder) name
365     # grid (subfolder) name
366     # test case name
367     # path to test case file
368     set tests_list {}
369
370     foreach group_grid_case ${rerun_group_grid_case} {
371         set groupmask [lindex $group_grid_case 0]
372         set gridmask  [lindex $group_grid_case 1]
373         set casemask  [lindex $group_grid_case 2]
374
375         # iterate by all script paths
376         foreach dir [lsort -unique [_split_path $env(CSF_TestScriptsPath)]] {
377             # protection against empty paths
378             set dir [string trim $dir]
379             if { $dir == "" } { continue }
380
381             if { $_tests_verbose > 0 } { _log_and_puts log "Examining tests directory $dir" }
382
383             # check that directory exists
384             if { ! [file isdirectory $dir] } {
385                 _log_and_puts log "Warning: directory $dir listed in CSF_TestScriptsPath does not exist, skipped"
386                 continue
387             }
388
389             # search all directories in the current dir with specified mask
390             if [catch {glob -directory $dir -tail -types d {*}$groupmask} groups] { continue }
391
392             # exclude selected groups from all groups
393             if { ${exc_group} > 0 } {
394                 foreach exclude_group_element ${exclude_group} {
395                     set idx [lsearch $groups "${exclude_group_element}"]
396                     if { ${idx} != "-1" } {
397                         set groups [lreplace $groups $idx $idx]
398                     } else {
399                         continue
400                     }
401                 }
402             }
403
404             # iterate by groups
405             if { $_tests_verbose > 0 } { _log_and_puts log "Groups to be executed: $groups" }
406             foreach group [lsort -dictionary $groups] {
407                 if { $_tests_verbose > 0 } { _log_and_puts log "Examining group directory $group" }
408
409                 # file grids.list must exist: it defines sequence of grids in the group
410                 if { ! [file exists $dir/$group/grids.list] } {
411                     _log_and_puts log "Warning: directory $dir/$group does not contain file grids.list, skipped"
412                     continue
413                 }
414
415                 # read grids.list file and make a list of grids to be executed
416                 set gridlist {}
417                 set fd [open $dir/$group/grids.list]
418                 set nline 0
419                 while { [gets $fd line] >= 0 } {
420                     incr nline
421
422                     # skip comments and empty lines
423                     if { [regexp "\[ \t\]*\#.*" $line] } { continue }
424                     if { [string trim $line] == "" } { continue }
425
426                     # get grid id and name
427                     if { ! [regexp "^\(\[0-9\]+\)\[ \t\]*\(\[A-Za-z0-9_.-\]+\)\$" $line res gridid grid] } {
428                         _log_and_puts log "Warning: cannot recognize line $nline in file $dir/$group/grids.list as \"gridid gridname\"; ignored"
429                         continue
430                     }
431
432                     # check that grid fits into the specified mask
433                     foreach mask $gridmask {
434                         if { $mask == $gridid || [string match $mask $grid] } {
435                             lappend gridlist $grid
436                         }
437                     }
438                 }
439                 close $fd
440
441                 # exclude selected grids from all grids
442                 if { ${exc_grid} > 0 } {
443                     foreach exclude_grid_element ${exclude_grid} {
444                         set exclude_elem [lindex $exclude_grid_element end]
445                         set idx [lsearch $gridlist "${exclude_elem}"]
446                         if { ${idx} != "-1" } {
447                             set gridlist [lreplace $gridlist $idx $idx]
448                         } else {
449                             continue
450                         }
451                     }
452                 }
453
454                 # iterate by all grids
455                 foreach grid $gridlist {
456
457                     # check if this grid is aliased to another one
458                     set griddir $dir/$group/$grid
459                     if { [file exists $griddir/cases.list] } {
460                         set fd [open $griddir/cases.list]
461                         if { [gets $fd line] >= 0 } {
462                             set griddir [file normalize $dir/$group/$grid/[string trim $line]]
463                         }
464                         close $fd
465                     }
466
467                     # check if grid directory actually exists
468                     if { ! [file isdirectory $griddir] } {
469                         _log_and_puts log "Error: tests directory for grid $grid ($griddir) is missing; skipped"
470                         continue
471                     }
472
473                     # create directory for logging test results
474                     if { $logdir != "" } { file mkdir $logdir/$group/$grid }
475
476                     # iterate by all tests in the grid directory
477                     if { [catch {glob -directory $griddir -type f {*}$casemask} testfiles] } { continue }
478
479                     # exclude selected test cases from all testfiles
480                     if { ${exc_case} > 0 } {
481                         foreach exclude_case_element ${exclude_case} {
482                             set exclude_casegroup_elem [lindex $exclude_case_element end-2]
483                             set exclude_casegrid_elem [lindex $exclude_case_element end-1]
484                             set exclude_elem [lindex $exclude_case_element end]
485                             if { ${exclude_casegrid_elem} == "${grid}" } {
486                                 set idx [lsearch $testfiles "${dir}/${exclude_casegroup_elem}/${exclude_casegrid_elem}/${exclude_elem}"]
487                                 if { ${idx} != "-1" } {
488                                     set testfiles [lreplace $testfiles $idx $idx]
489                                 } else {
490                                     continue
491                                 }
492                             }
493                         }
494                     }
495
496                     foreach casefile [lsort -dictionary $testfiles] {
497                         # filter out files with reserved names
498                         set casename [file tail $casefile]
499                         if { $casename == "begin" || $casename == "end" ||
500                              $casename == "parse.rules" } {
501                             continue
502                         }
503
504                         lappend tests_list [list $dir $group $grid $casename $casefile]
505                     }
506                 }
507             }
508         }
509     }
510     if { [llength $tests_list] < 1 } {
511         error "Error: no tests are found, check your input arguments and variable CSF_TestScriptsPath!"
512     } else {
513         puts "Running tests (total [llength $tests_list] test cases)..."
514     }
515
516     ######################################################
517     # run tests
518     ######################################################
519     
520     # log command arguments and environment
521     lappend log "Command: testgrid $args"
522     lappend log "Host: [info hostname]"
523     lappend log "Started on: [clock format [clock seconds] -format {%Y-%m-%d %H:%M:%S}]"
524     catch {lappend log "DRAW build:\n[dversion]" }
525     lappend log "Environment:"
526     foreach envar [lsort [array names env]] {
527         lappend log "$envar=\"$env($envar)\""
528     }
529     lappend log ""
530
531     set refresh_timer [clock seconds]
532     uplevel dchrono _timer reset
533     uplevel dchrono _timer start
534
535     # if parallel execution is requested, allocate thread pool
536     if { $parallel > 0 } {
537         if { ! [info exists tcl_platform(threaded)] || [catch {package require Thread}] } {
538             _log_and_puts log "Warning: Tcl package Thread is not available, running in sequential mode"
539             set parallel 0
540         } else {
541             set worker [tpool::create -minworkers $parallel -maxworkers $parallel]
542             # suspend the pool until all jobs are posted, to prevent blocking of the process
543             # of starting / processing jobs by running threads
544             catch {tpool::suspend $worker}
545             if { $_tests_verbose > 0 } { _log_and_puts log "Executing tests in (up to) $parallel threads" }
546             # limit number of jobs in the queue by reasonable value
547             # to prevent slowdown due to unnecessary queue processing
548             set nbpooled 0
549             set nbpooled_max [expr 10 * $parallel]
550             set nbpooled_ok  [expr  5 * $parallel]
551         }
552     }
553
554     # start test cases
555     set userbreak 0
556     foreach test_def $tests_list {
557         # check for user break
558         if { $userbreak || "[info commands dbreak]" == "dbreak" && [catch dbreak] } {
559             set userbreak 1
560             break
561         }
562
563         set dir       [lindex $test_def 0]
564         set group     [lindex $test_def 1]
565         set grid      [lindex $test_def 2]
566         set casename  [lindex $test_def 3]
567         set casefile  [lindex $test_def 4]
568
569         # command to set tests for generation of image in results directory
570         set imgdir_cmd ""
571         if { $logdir != "" } { set imgdir_cmd "set imagedir $logdir/$group/$grid" }
572
573         # prepare command file for running test case in separate instance of DRAW
574         set fd_cmd [open $logdir/$group/$grid/${casename}.tcl w]
575         puts $fd_cmd "$imgdir_cmd"
576         puts $fd_cmd "set test_image $casename"
577         puts $fd_cmd "_run_test $dir $group $grid $casefile t"
578
579         # use dlog command to obtain complete output of the test when it is absent (i.e. since OCCT 6.6.0)
580         # note: this is not needed if echo is set to 1 in call to _run_test above
581         if { ! [catch {dlog get}] } {
582             puts $fd_cmd "puts \[dlog get\]"
583         } else {
584             # else try to use old-style QA_ variables to get more output...
585             set env(QA_DUMP) 1
586             set env(QA_DUP) 1
587             set env(QA_print_command) 1
588         }
589
590         # final 'exit' is needed when running on Linux under VirtualGl
591         puts $fd_cmd "exit"
592         close $fd_cmd
593
594         # commant to run DRAW with a command file;
595         # note that empty string is passed as standard input to avoid possible 
596         # hang-ups due to waiting for stdin of the launching process
597         set command "exec <<{} DRAWEXE -f $logdir/$group/$grid/${casename}.tcl"
598
599         # alternative method to run without temporary file; disabled as it needs too many backslashes
600         # else {
601         # set command "exec <<\"\" DRAWEXE -c $imgdir_cmd\\\; set test_image $casename\\\; \
602         # _run_test $dir $group $grid $casefile\\\; \
603         # puts \\\[dlog get\\\]\\\; exit"
604         # }
605
606         # run test case, either in parallel or sequentially
607         if { $parallel > 0 } {
608             # parallel execution
609             set job [tpool::post -nowait $worker "catch \"$command\" output; return \$output"]
610             set job_def($job) [list $logdir $dir $group $grid $casename]
611             incr nbpooled
612             if { $nbpooled > $nbpooled_max } {
613                 _testgrid_process_jobs $worker $nbpooled_ok
614             }
615         } else {
616             # sequential execution
617             catch {eval $command} output
618             _log_test_case $output $logdir $dir $group $grid $casename log
619
620             # update summary log with requested period
621             if { $logdir != "" && $refresh > 0 && [expr [clock seconds] - $refresh_timer > $refresh] } {
622                 # update and dump summary
623                 _log_summarize $logdir $log
624                 set refresh_timer [clock seconds]
625             }
626         }
627     }
628
629     # get results of started threads
630     if { $parallel > 0 } {
631         _testgrid_process_jobs $worker
632         # release thread pool
633         if { $nbpooled > 0 } {
634             tpool::cancel $worker [array names job_def]
635         }
636         catch {tpool::resume $worker}
637         tpool::release $worker
638     }
639
640     uplevel dchrono _timer stop
641     set time [lindex [split [uplevel dchrono _timer show] "\n"] 0]
642
643     if { $userbreak } {
644         _log_and_puts log "*********** Stopped by user break ***********"
645         set time "${time} \nNote: the process is not finished, stopped by user break!"
646     }
647
648     ######################################################
649     # output summary logs and exit
650     ######################################################
651
652     _log_summarize $logdir $log $time
653     if { $logdir != "" } {
654         puts "Detailed logs are saved in $logdir"
655     }
656     if { $logdir != "" && $xmlfile != "" } {
657         # XML output file is assumed relative to log dir unless it is absolute
658         if { [ file pathtype $xmlfile] == "relative" } {
659             set xmlfile [file normalize $logdir/$xmlfile]
660         }
661         _log_xml_summary $logdir $xmlfile $log 0
662         puts "XML summary is saved to $xmlfile"
663     }
664     # play sound signal at the end of test
665     if {$signal} {
666         puts "\7\7\7\7"
667     }
668     return
669 }
670
671 # Procedure to regenerate summary log from logs of test cases
672 help testsummarize {
673   Regenerate summary log in the test directory from logs of test cases.
674   This can be necessary if test grids are executed separately (e.g. on
675   different stations) or some grids have been re-executed.
676   Use: testsummarize dir
677 }
678 proc testsummarize {dir} {
679     global _test_case_regexp
680
681     if { ! [file isdirectory $dir] } {
682         error "Error: \"$dir\" is not a directory"
683     }
684
685     # get summary statements from all test cases in one log
686     set log {}
687
688     # to avoid huge listing of logs, first find all subdirectories and iterate
689     # by them, parsing log files in each subdirectory independently 
690     foreach grid [glob -directory $dir -types d -tails */*] {
691         foreach caselog [glob -nocomplain -directory [file join $dir $grid] -types f -tails *.log] {
692             set file [file join $dir $grid $caselog]
693             set nbfound 0
694             set fd [open $file r]
695             while { [gets $fd line] >= 0 } {
696                 if { [regexp $_test_case_regexp $line res grp grd cas status message] } {
697                     if { "[file join $grid $caselog]" != "[file join $grp $grd ${cas}.log]" } { 
698                         puts "Error: $file contains status line for another test case ($line)"
699                     }
700                     lappend log $line
701                     incr nbfound
702                 }
703             }
704             close $fd
705
706             if { $nbfound != 1 } { 
707                 puts "Error: $file contains $nbfound status lines, expected 1"
708             }
709         }
710     }
711
712     _log_summarize $dir $log "Summary regenerated from logs at [clock format [clock seconds]]"
713     return
714 }
715
716 # Procedure to compare results of two runs of test cases
717 help testdiff {
718   Compare results of two executions of tests (CPU times, ...)
719   Use: testdiff dir1 dir2 [groupname [gridname]] [options...]
720   Where dir1 and dir2 are directories containing logs of two test runs.
721   dir1 (A) should point to NEW tests results to be verified and dir2 (B) to REFERENCE results.
722   Allowed options are:
723   -image [filename]: compare only images and save its in specified file (default 
724                    name is <dir1>/diffimage-<dir2>.log)
725   -cpu [filename]: compare only CPU and save it in specified file (default 
726                    name is <dir1>/diffcpu-<dir2>.log)
727   -memory [filename]: compare only memory and save it in specified file (default 
728                    name is <dir1>/diffmemory-<dir2>.log)
729   -save filename: save resulting log in specified file (default name is
730                   <dir1>/diff-<dir2>.log); HTML log is saved with same name
731                   and extension .html
732   -status {same|ok|all}: filter cases for comparing by their status:
733           same - only cases with same status are compared (default)
734           ok   - only cases with OK status in both logs are compared
735           all  - results are compared regardless of status
736   -verbose level: 
737           1 - output only differences 
738           2 - output also list of logs and directories present in one of dirs only
739           3 - (default) output also progress messages 
740   -highlight_percent value: highlight considerable (>value in %) deviations
741                             of CPU and memory (default value is 5%)
742 }
743 proc testdiff {dir1 dir2 args} {
744     if { "$dir1" == "$dir2" } {
745         error "Input directories are the same"
746     }
747
748     ######################################################
749     # check arguments
750     ######################################################
751
752     # treat options
753     set logfile [file join $dir1 "diff-[file tail $dir2].log"]
754     set logfile_image ""
755     set logfile_cpu ""
756     set logfile_memory ""
757     set image false
758     set cpu false
759     set memory false
760     set basename ""
761     set save false
762     set status "same"
763     set verbose 3
764     set highlight_percent 5
765     for {set narg 0} {$narg < [llength $args]} {incr narg} {
766         set arg [lindex $args $narg]
767         # log file name
768         if { $arg == "-save" } {
769             incr narg
770             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
771                 set logfile [lindex $args $narg]
772             } else {
773                 error "Error: Option -save must be followed by log file name"
774             } 
775             set save true
776             continue
777         }
778         
779         # image compared log
780         if { $arg == "-image" } {
781             incr narg
782             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
783                 set logfile_image [lindex $args $narg]
784             } else {
785                 set logfile_image [file join $dir1 "diffimage-[file tail $dir2].log"]
786                 incr narg -1
787             }
788             set image true
789             continue
790         }
791         
792         # CPU compared log
793         if { $arg == "-cpu" } {
794             incr narg
795             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
796                 set logfile_cpu [lindex $args $narg]
797             } else {
798                 set logfile_cpu [file join $dir1 "diffcpu-[file tail $dir2].log"]
799                 incr narg -1
800             }
801             set cpu true
802             continue
803         }
804         
805         # memory compared log
806         if { $arg == "-memory" } {
807             incr narg
808             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
809                 set logfile_memory [lindex $args $narg]
810             } else {
811                 set logfile_memory [file join $dir1 "diffmemory-[file tail $dir2].log"]
812                 incr narg -1
813             }
814             set memory true
815             continue
816         }
817         
818         # status filter
819         if { $arg == "-status" } {
820             incr narg
821             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
822                 set status [lindex $args $narg]
823             } else {
824                 set status ""
825             }
826             if { "$status" != "same" && "$status" != "all" && "$status" != "ok" } {
827                 error "Error: Option -status must be followed by one of \"same\", \"all\", or \"ok\""
828             }
829             continue
830         }
831
832         # verbose level
833         if { $arg == "-verbose" } {
834             incr narg
835             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
836                 set verbose [expr [lindex $args $narg]]
837             } else {
838                 error "Error: Option -verbose must be followed by integer verbose level"
839             }
840             continue
841         }
842
843         # highlight_percent
844         if { $arg == "-highlight_percent" } {
845             incr narg
846             if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } { 
847                 set highlight_percent [expr [lindex $args $narg]]
848             } else {
849                 error "Error: Option -highlight_percent must be followed by integer value"
850             }
851             continue
852         }
853
854         if { [regexp {^-} $arg] } {
855             error "Error: unsupported option \"$arg\""
856         }
857
858         # non-option arguments form a subdirectory path
859         set basename [file join $basename $arg]
860     }
861     
862     if {$image != false || $cpu != false || $memory != false} {
863         if {$save != false} {
864             error "Error: Option -save can not be used with image/cpu/memory options"
865         }
866     }
867
868     # run diff procedure (recursive)
869     _test_diff $dir1 $dir2 $basename $image $cpu $memory $status $verbose log log_image log_cpu log_memory
870     
871     # save result to log file
872     if {$image == false && $cpu == false && $memory == false} {
873         if { "$logfile" != "" } {
874             _log_save $logfile [join $log "\n"]
875             _log_html_diff "[file rootname $logfile].html" $log $dir1 $dir2 ${highlight_percent}
876             puts "Log is saved to $logfile (and .html)"
877         }
878     } else {
879         foreach mode {image cpu memory} {
880             if {"[set logfile_${mode}]" != ""} {
881                 _log_save "[set logfile_${mode}]" [join "[set log_${mode}]" "\n"]
882                 _log_html_diff "[file rootname [set logfile_${mode}]].html" "[set log_${mode}]" $dir1 $dir2 ${highlight_percent}
883                 puts "Log (${mode}) is saved to [set logfile_${mode}] (and .html)"
884             }
885         }
886     }
887     return
888 }
889
890 # Procedure to check data file before adding it to repository
891 help testfile {
892   Checks specified data files for putting them into the test data files repository.
893
894   Use: testfile filelist
895
896   Will report if:
897   - data file (non-binary) is in DOS encoding (CR/LF)
898   - same data file (with same or another name) already exists in the repository
899   - another file with the same name already exists 
900   Note that names are considered to be case-insensitive (for compatibility 
901   with Windows).
902
903   Unless the file is already in the repository, tries to load it, reports
904   the recognized file format, file size, number of faces and edges in the 
905   loaded shape (if any), information contained its triangulation, and makes 
906   snapshot (in the temporary directory).
907
908   Finally it advises whether the file should be put to public section of the 
909   repository.
910
911   Use: testfile -check
912
913   If "-check" is given as an argument, then procedure will check files already 
914   located in the repository (for possible duplicates and for DOS encoding).
915 }
916 proc testfile {filelist} {
917     global env
918
919     # check that CSF_TestDataPath is defined
920     if { ! [info exists env(CSF_TestDataPath)] } {
921         error "Environment variable CSF_TestDataPath must be defined!"
922     }
923
924     set checkrepo f
925     if { "$filelist" == "-check" } { set checkrepo t }
926
927     # build registry of existing data files (name -> path) and (size -> path)
928     puts "Collecting info on test data files repository..."
929     foreach dir [_split_path $env(CSF_TestDataPath)] {
930         while {[llength $dir] != 0} {
931             set curr [lindex $dir 0]
932             set dir [lrange $dir 1 end]
933             eval lappend dir [glob -nocomplain -directory $curr -type d *]
934             foreach file [glob -nocomplain -directory $curr -type f *] {
935                 set name [file tail $file]
936                 set name_lower [string tolower $name]
937                 set size [file size $file]
938
939                 # check that the file is not in DOS encoding
940                 if { $checkrepo } {
941                     if { [_check_dos_encoding $file] } {
942                         puts "Warning: file $file is in DOS encoding; was this intended?"
943                     }
944                     _check_file_format $file
945
946                     # check if file with the same name is present twice or more
947                     if { [info exists names($name_lower)] } {
948                         puts "Error: more than one file with name $name is present in the repository:"
949                         if { [_diff_files $file $names($name_lower)] } {
950                             puts "(files are different by content)"
951                         } else {
952                             puts "(files are same by content)"
953                         }
954                         puts "--> $file"
955                         puts "--> $names($name_lower)"
956                         continue
957                     } 
958                 
959                     # check if file with the same content exists
960                     if { [info exists sizes($size)] } {
961                         foreach other $sizes($size) {
962                             if { ! [_diff_files $file $other] } {
963                                 puts "Warning: two files with the same content found:"
964                                 puts "--> $file"
965                                 puts "--> $other"
966                             }
967                         }
968                     }
969                 }
970
971                 # add the file to the registry
972                 lappend names($name_lower) $file
973                 lappend sizes($size) $file
974             }
975         }
976     }
977     if { $checkrepo || [llength $filelist] <= 0 } { return }
978
979     # check the new files
980     set has_images f
981     puts "Checking new file(s)..."
982     foreach file $filelist {
983         set name [file tail $file]
984         set name_lower [string tolower $name]
985         set found f
986
987         # check for presence of the file with same name
988         if { [info exists names($name_lower)] } {
989             set found f
990             foreach other $names($name_lower) {
991                 # avoid comparing the file with itself
992                 if { [file normalize $file] == [file normalize $other] } {
993                     continue
994                 }
995                 # compare content
996                 if { [_diff_files $file $other] } {
997                     puts "\n* $file: error\n  name is already used by existing file\n  --> $other"
998                 } else {
999                     puts "\n* $file: already present \n  --> $other"
1000                 }
1001                 set found t
1002                 break
1003             }
1004             if { $found } { continue }
1005         }
1006
1007         # get size of the file; if it is in DOS encoding and less than 1 MB,
1008         # estimate also its size in UNIX encoding to be able to find same 
1009         # file if already present but in UNIX encoding
1010         set sizeact [file size $file]
1011         set sizeunx ""
1012         set isdos [_check_dos_encoding $file]
1013         if { $isdos && $sizeact < 10000000 } {
1014             set fd [open $file r]
1015             fconfigure $fd -translation crlf
1016             set sizeunx [string length [read $fd]]
1017             close $fd
1018         }
1019                 
1020         # check if file with the same content exists
1021         foreach size "$sizeact $sizeunx" {
1022           if { [info exists sizes($size)] } {
1023             foreach other $sizes($size) {
1024                 # avoid comparing the file with itself
1025                 if { [file normalize $file] == [file normalize $other] } {
1026                     continue
1027                 }
1028                 # compare content
1029                 if { ! [_diff_files $file $other] } {
1030                     puts "\n* $file: duplicate \n  already present under name [file tail $other]\n  --> $other"
1031                     set found t
1032                     break
1033                 }
1034             }
1035             if { $found } { break }
1036           }
1037         }
1038         if { $found } { continue }
1039
1040         # file is not present yet, so to be analyzed
1041         puts "\n* $file: new file"
1042
1043         # add the file to the registry as if it were added to the repository,
1044         # to report possible duplicates among the currently processed files
1045         lappend names($name_lower) $file
1046         if { "$sizeunx" != "" } {
1047             lappend sizes($sizeunx) $file
1048         } else {
1049             lappend sizes($sizeact) $file
1050         }
1051
1052         # first of all, complain if it is in DOS encoding
1053         if { $isdos } {
1054             puts "  Warning: DOS encoding detected, consider converting to"
1055             puts "           UNIX unless DOS line ends are needed for the test"
1056         }
1057
1058         # try to read the file
1059         set format [_check_file_format $file]
1060         if { [catch {uplevel load_data_file $file $format a}] } {
1061             puts "  Warning: Cannot read as $format file"
1062             continue
1063         }
1064
1065         # warn if shape contains triangulation
1066         pload MODELING
1067         if { "$format" != "STL" &&
1068              [regexp {contains\s+([0-9]+)\s+triangles} [uplevel trinfo a] res nbtriangles] &&
1069              $nbtriangles != 0 } {
1070             puts "  Warning: shape contains triangulation ($nbtriangles triangles),"
1071             puts "           consider removing them unless they are needed for the test!"
1072         }
1073
1074         # get number of faces and edges
1075         set edges 0
1076         set faces 0
1077         set nbs [uplevel nbshapes a]
1078         regexp {EDGE[ \t:]*([0-9]+)} $nbs res edges
1079         regexp {FACE[ \t:]*([0-9]+)} $nbs res faces
1080
1081         # classify; first check file size and number of faces and edges
1082         if { $size < 95000 && $faces < 20 && $edges < 100 } {
1083             set dir public
1084         } else {
1085             set dir private
1086         }
1087
1088         # add stats
1089         puts "  $format size=[expr $size / 1024] KiB, nbfaces=$faces, nbedges=$edges -> $dir"
1090
1091         set tmpdir [_get_temp_dir]
1092         file mkdir $tmpdir/$dir
1093
1094         # make snapshot
1095         pload AISV
1096         uplevel vdisplay a
1097         uplevel vsetdispmode 1
1098         uplevel vfit
1099         uplevel vzfit
1100         uplevel vdump $tmpdir/$dir/[file rootname [file tail $file]].png
1101         set has_images t
1102     }
1103     if { $has_images } {
1104         puts "Snapshots are saved in subdirectory [_get_temp_dir]"
1105     }
1106 }
1107
1108 # Procedure to locate data file for test given its name.
1109 # The search is performed assuming that the function is called
1110 # from the test case script; the search order is:
1111 # - subdirectory "data" of the test script (grid) folder
1112 # - subdirectories in environment variable CSF_TestDataPath
1113 # - subdirectory set by datadir command
1114 # If file is not found, raises Tcl error.
1115 proc locate_data_file {filename} {
1116     global env groupname gridname casename
1117
1118     # check if the file is located in the subdirectory data of the script dir
1119     set scriptfile [info script]
1120     if { "$scriptfile" != "" } {
1121         set path [file join [file dirname "$scriptfile"] data "$filename"]
1122         if { [file exists "$path"] } {
1123             return [file normalize "$path"]
1124         }
1125     }
1126
1127     # check sub-directories in paths indicated by CSF_TestDataPath
1128     if { [info exists env(CSF_TestDataPath)] } {
1129         foreach dir [_split_path $env(CSF_TestDataPath)] {
1130             set dir [list "$dir"]
1131             while {[llength "$dir"] != 0} {
1132                 set name [lindex "$dir" 0]
1133                 set dir  [lrange "$dir" 1 end]
1134
1135                 # skip directories starting with dot
1136                 set aTail [file tail "$name"]
1137                 if { [regexp {^[.]} "$aTail"] } { continue }
1138                 if { [file exists "$name/$filename"] } {
1139                     return [file normalize "$name/$filename"]
1140                 }
1141                 eval lappend dir [glob -nocomplain -directory "$name" -type d *]
1142             }
1143         }
1144     }
1145
1146     # check current datadir
1147     if { [file exists "[uplevel datadir]/$filename"] } {
1148         return [file normalize "[uplevel datadir]/$filename"]
1149     }
1150
1151     # raise error
1152     error [join [list "File $filename could not be found" \
1153                       "(should be in paths indicated by CSF_TestDataPath environment variable, " \
1154                       "or in subfolder data in the script directory)"] "\n"]
1155 }
1156
1157 # Internal procedure to find test case indicated by group, grid, and test case names;
1158 # returns:
1159 # - dir: path to the base directory of the tests group
1160 # - gridname: actual name of the grid
1161 # - casefile: path to the test case script 
1162 # if no such test is found, raises error with appropriate message
1163 proc _get_test {group grid casename _dir _gridname _casefile} {
1164     upvar $_dir dir
1165     upvar $_gridname gridname
1166     upvar $_casefile casefile
1167
1168     global env
1169  
1170     # check that environment variable defining paths to test scripts is defined
1171     if { ! [info exists env(CSF_TestScriptsPath)] || 
1172          [llength $env(CSF_TestScriptsPath)] <= 0 } {
1173         error "Error: Environment variable CSF_TestScriptsPath is not defined"
1174     }
1175
1176     # iterate by all script paths
1177     foreach dir [_split_path $env(CSF_TestScriptsPath)] {
1178         # protection against empty paths
1179         set dir [string trim $dir]
1180         if { $dir == "" } { continue }
1181
1182         # check that directory exists
1183         if { ! [file isdirectory $dir] } {
1184             puts "Warning: directory $dir listed in CSF_TestScriptsPath does not exist, skipped"
1185             continue
1186         }
1187
1188         # check if test group with given name exists in this dir
1189         # if not, continue to the next test dir
1190         if { ! [file isdirectory $dir/$group] } { continue }
1191
1192         # check that grid with given name (possibly alias) exists; stop otherwise
1193         set gridname $grid
1194         if { ! [file isdirectory $dir/$group/$gridname] } {
1195             # check if grid is named by alias rather than by actual name
1196             if { [file exists $dir/$group/grids.list] } {
1197                 set fd [open $dir/$group/grids.list]
1198                 while { [gets $fd line] >= 0 } {
1199                     if { [regexp "\[ \t\]*\#.*" $line] } { continue }
1200                     if { [regexp "^$grid\[ \t\]*\(\[A-Za-z0-9_.-\]+\)\$" $line res gridname] } {
1201                         break
1202                     }
1203                 }
1204                 close $fd
1205             }
1206         }
1207         if { ! [file isdirectory $dir/$group/$gridname] } { continue }
1208
1209         # get actual file name of the script; stop if it cannot be found
1210         set casefile $dir/$group/$gridname/$casename
1211         if { ! [file exists $casefile] } {
1212             # check if this grid is aliased to another one
1213             if { [file exists $dir/$group/$gridname/cases.list] } {
1214                 set fd [open $dir/$group/$gridname/cases.list]
1215                 if { [gets $fd line] >= 0 } {
1216                     set casefile [file normalize $dir/$group/$gridname/[string trim $line]/$casename]
1217                 }
1218                 close $fd
1219             }
1220         }
1221         if { [file exists $casefile] } { 
1222             # normal return
1223             return 
1224         }
1225     }
1226
1227     # coming here means specified test is not found; report error
1228     error [join [list "Error: test case $group / $grid / $casename is not found in paths listed in variable" \
1229                       "CSF_TestScriptsPath (current value is \"$env(CSF_TestScriptsPath)\")"] "\n"]
1230 }
1231
1232 # Internal procedure to run test case indicated by base directory, 
1233 # grid and grid names, and test case file path.
1234 # The log can be obtained by command "dlog get".
1235 proc _run_test {scriptsdir group gridname casefile echo} {
1236     global env
1237
1238     # start timer
1239     uplevel dchrono _timer reset
1240     uplevel dchrono _timer start
1241     catch {uplevel meminfo h} membase
1242
1243     # enable commands logging; switch to old-style mode if dlog command is not present
1244     set dlog_exists 1
1245     if { [catch {dlog reset}] } {
1246         set dlog_exists 0
1247     } elseif { $echo } {
1248         decho on
1249     } else {
1250         dlog reset
1251         dlog on
1252         rename puts puts-saved
1253         proc puts args { 
1254             global _tests_verbose
1255
1256             # log only output to stdout and stderr, not to file!
1257             if {[llength $args] > 1} {
1258                 set optarg [lindex $args end-1]
1259                 if { $optarg == "stdout" || $optarg == "stderr" || $optarg == "-newline" } {
1260                     dlog add [lindex $args end]
1261                 } else {
1262                     eval puts-saved $args
1263                 }
1264             } else {
1265                 dlog add [lindex $args end]
1266             }
1267         }
1268     }
1269
1270     # evaluate test case 
1271     set tmp_imagedir 0
1272     if [catch {
1273         # set variables identifying test case
1274         uplevel set casename [file tail $casefile]
1275         uplevel set groupname $group
1276         uplevel set gridname $gridname
1277         uplevel set dirname  $scriptsdir
1278
1279         # set path for saving of log and images (if not yet set) to temp dir
1280         if { ! [uplevel info exists imagedir] } {
1281             uplevel set test_image \$casename
1282
1283             # create subdirectory in temp named after group and grid with timestamp
1284             set rootlogdir [_get_temp_dir]
1285         
1286             set imagedir "${group}-${gridname}-${::casename}-[clock format [clock seconds] -format {%Y-%m-%dT%Hh%Mm%Ss}]"
1287             set imagedir [file normalize ${rootlogdir}/$imagedir]
1288
1289             if { [catch {file mkdir $imagedir}] || ! [file writable $imagedir] ||
1290                  ! [catch {glob -directory $imagedir *}] } {
1291                  # puts "Warning: Cannot create directory \"$imagedir\", or it is not empty; \"${rootlogdir}\" is used"
1292                 set imagedir $rootlogdir
1293             }
1294
1295             uplevel set imagedir \"$imagedir\"
1296             set tmp_imagedir 1
1297         }
1298
1299         # execute test scripts 
1300         if { [file exists $scriptsdir/$group/begin] } {
1301             puts "Executing $scriptsdir/$group/begin..."; flush stdout
1302             uplevel source -encoding utf-8 $scriptsdir/$group/begin
1303         }
1304         if { [file exists $scriptsdir/$group/$gridname/begin] } {
1305             puts "Executing $scriptsdir/$group/$gridname/begin..."; flush stdout
1306             uplevel source -encoding utf-8 $scriptsdir/$group/$gridname/begin
1307         }
1308
1309         puts "Executing $casefile..."; flush stdout
1310         uplevel source -encoding utf-8 $casefile
1311
1312         if { [file exists $scriptsdir/$group/$gridname/end] } {
1313             puts "Executing $scriptsdir/$group/$gridname/end..."; flush stdout
1314             uplevel source -encoding utf-8 $scriptsdir/$group/$gridname/end
1315         }
1316         if { [file exists $scriptsdir/$group/end] } {
1317             puts "Executing $scriptsdir/$group/end..."; flush stdout
1318             uplevel source -encoding utf-8 $scriptsdir/$group/end
1319         }
1320     } res] {
1321         puts "Tcl Exception: $res"
1322     }
1323
1324     # stop logging
1325     if { $dlog_exists } {
1326         if { $echo } {
1327             decho off
1328         } else {
1329             rename puts {}
1330             rename puts-saved puts
1331             dlog off
1332         }
1333     }
1334
1335     # stop cpulimit killer if armed by the test
1336     cpulimit
1337
1338     # add memory and timing info
1339     set stats ""
1340     if { ! [catch {uplevel meminfo h} memuse] } {
1341         append stats "MEMORY DELTA: [expr ($memuse - $membase) / 1024] KiB\n"
1342     }
1343     uplevel dchrono _timer stop
1344     set time [uplevel dchrono _timer show]
1345     if { [regexp -nocase {CPU user time:[ \t]*([0-9.e-]+)} $time res cpu_usr] } {
1346         append stats "TOTAL CPU TIME: $cpu_usr sec\n"
1347     }
1348     if { $dlog_exists && ! $echo } {
1349         dlog add $stats
1350     } else {
1351         puts $stats
1352     }
1353
1354     # unset global vars
1355     uplevel unset casename groupname gridname dirname
1356     if { $tmp_imagedir } { uplevel unset imagedir test_image }
1357 }
1358
1359 # Internal procedure to check log of test execution and decide if it passed or failed
1360 proc _check_log {dir group gridname casename errors log {_summary {}} {_html_log {}}} {
1361     global env
1362     if { $_summary != "" } { upvar $_summary summary }
1363     if { $_html_log != "" } { upvar $_html_log html_log }
1364     set summary {}
1365     set html_log {}
1366     set errors_log {}
1367
1368     if [catch {
1369
1370         # load definition of 'bad words' indicating test failure
1371         # note that rules are loaded in the order of decreasing priority (grid - group - common),
1372         # thus grid rules will override group ones
1373         set badwords {}
1374         foreach rulesfile [list $dir/$group/$gridname/parse.rules $dir/$group/parse.rules $dir/parse.rules] {
1375             if [catch {set fd [open $rulesfile r]}] { continue }
1376             while { [gets $fd line] >= 0 } {
1377                 # skip comments and empty lines
1378                 if { [regexp "\[ \t\]*\#.*" $line] } { continue }
1379                 if { [string trim $line] == "" } { continue }
1380                 # extract regexp
1381                 if { ! [regexp {^([^/]*)/([^/]*)/(.*)$} $line res status rexp comment] } { 
1382                     puts "Warning: cannot recognize parsing rule \"$line\" in file $rulesfile"
1383                     continue 
1384                 }
1385                 set status [string trim $status]
1386                 if { $comment != "" } { append status " ([string trim $comment])" }
1387                 set rexp [regsub -all {\\b} $rexp {\\y}] ;# convert regexp from Perl to Tcl style
1388                 lappend badwords [list $status $rexp]
1389             }
1390             close $fd
1391         }
1392         if { [llength $badwords] <= 0 } { 
1393             puts "Warning: no definition of error indicators found (check files parse.rules)" 
1394         }
1395
1396         # analyse log line-by-line
1397         set todos {} ;# TODO statements
1398         set requs {} ;# REQUIRED statements
1399         set todo_incomplete -1
1400         set status ""
1401         foreach line [split $log "\n"] {
1402             # check if line defines specific treatment of some messages
1403             if [regexp -nocase {^[ \s]*TODO ([^:]*):(.*)$} $line res platforms pattern] {
1404                 if { ! [regexp -nocase {\mAll\M} $platforms] && 
1405                      ! [regexp -nocase "\\m[checkplatform]\\M" $platforms] } {
1406                     lappend html_log [_html_highlight IGNORE $line]
1407                     continue ;# TODO statement is for another platform
1408                 }
1409
1410                 # record TODOs that mark unstable cases
1411                 if { [regexp {[\?]} $platforms] } {
1412                     set todos_unstable([llength $todos]) 1
1413                 }
1414
1415                 # convert legacy regexps from Perl to Tcl style
1416                 set pattern [regsub -all {\\b} [string trim $pattern] {\\y}]
1417
1418                 # special case: TODO TEST INCOMPLETE
1419                 if { [string trim $pattern] == "TEST INCOMPLETE" } {
1420                     set todo_incomplete [llength $todos]
1421                 }
1422
1423                 lappend todos [list $pattern [llength $html_log] $line]
1424                 lappend html_log [_html_highlight BAD $line]
1425                 continue
1426             }
1427             if [regexp -nocase {^[ \s]*REQUIRED ([^:]*):[ \s]*(.*)$} $line res platforms pattern] {
1428                 if { ! [regexp -nocase {\mAll\M} $platforms] && 
1429                      ! [regexp -nocase "\\m[checkplatform]\\M" $platforms] } {
1430                     lappend html_log [_html_highlight IGNORE $line]
1431                     continue ;# REQUIRED statement is for another platform
1432                 }
1433                 lappend requs [list $pattern [llength $html_log] $line]
1434                 lappend html_log [_html_highlight OK $line]
1435                 continue
1436             }
1437
1438             # check for presence of required messages 
1439             set ismarked 0
1440             for {set i 0} {$i < [llength $requs]} {incr i} {
1441                 set pattern [lindex $requs $i 0]
1442                 if { [regexp $pattern $line] } {
1443                     incr required_count($i)
1444                     lappend html_log [_html_highlight OK $line]
1445                     set ismarked 1
1446                     continue
1447                 }
1448             }
1449             if { $ismarked } {
1450                 continue
1451             }
1452
1453             # check for presence of messages indicating test result
1454             foreach bw $badwords {
1455                 if { [regexp [lindex $bw 1] $line] } { 
1456                     # check if this is known bad case
1457                     set is_known 0
1458                     for {set i 0} {$i < [llength $todos]} {incr i} {
1459                         set pattern [lindex $todos $i 0]
1460                         if { [regexp $pattern $line] } {
1461                             set is_known 1
1462                             incr todo_count($i)
1463                             lappend html_log [_html_highlight BAD $line]
1464                             break
1465                         }
1466                     }
1467
1468                     # if it is not in todo, define status
1469                     if { ! $is_known } {
1470                         set stat [lindex $bw 0 0]
1471                         if {$errors} {
1472                             lappend errors_log $line
1473                         }
1474                         lappend html_log [_html_highlight $stat $line]
1475                         if { $status == "" && $stat != "OK" && ! [regexp -nocase {^IGNOR} $stat] } {
1476                             set status [lindex $bw 0]
1477                         }
1478                     }
1479                     set ismarked 1
1480                     break
1481                 }
1482             }
1483             if { ! $ismarked } { 
1484                lappend html_log $line
1485             }
1486         }
1487
1488         # check for presence of TEST COMPLETED statement
1489         if { $status == "" && ! [regexp {TEST COMPLETED} $log] } {
1490             # check whether absence of TEST COMPLETED is known problem
1491             if { $todo_incomplete >= 0 } {
1492                 incr todo_count($todo_incomplete)
1493             } else {
1494                 set status "FAILED (no final message is found)"
1495             }
1496         }
1497
1498         # report test as failed if it doesn't contain required pattern
1499         if { $status == "" } {
1500             for {set i 0} {$i < [llength $requs]} {incr i} {
1501                 if { ! [info exists required_count($i)] } {
1502                     set linenum [lindex $requs $i 1]
1503                     set html_log [lreplace $html_log $linenum $linenum [_html_highlight FAILED [lindex $requs $i 2]]]
1504                     set status "FAILED (REQUIRED statement no. [expr $i + 1] is not found)"
1505                 }
1506             }
1507         }
1508
1509         # check declared bad cases and diagnose possible improvement 
1510         # (bad case declared but not detected).
1511         # Note that absence of the problem marked by TODO with question mark
1512         # (unstable) is not reported as improvement.
1513         if { $status == "" } {
1514             for {set i 0} {$i < [llength $todos]} {incr i} {
1515                 if { ! [info exists todos_unstable($i)] &&
1516                      (! [info exists todo_count($i)] || $todo_count($i) <= 0) } {
1517                     set linenum [lindex $todos $i 1]
1518                     set html_log [lreplace $html_log $linenum $linenum [_html_highlight IMPROVEMENT [lindex $todos $i 2]]]
1519                     set status "IMPROVEMENT (expected problem TODO no. [expr $i + 1] is not detected)"
1520                     break;
1521                 }
1522             }
1523         }
1524
1525         # report test as known bad if at least one of expected problems is found
1526         if { $status == "" && [llength [array names todo_count]] > 0 } {
1527             set status "BAD (known problem)"
1528         }
1529
1530         # report normal OK
1531         if { $status == "" } {set status "OK" }
1532
1533     } res] {
1534         set status "FAILED ($res)"
1535     }
1536
1537     # put final message
1538     _log_and_puts summary "CASE $group $gridname $casename: $status"
1539     set summary [join $summary "\n"]
1540     if {$errors} {
1541         foreach error $errors_log {
1542             _log_and_puts summary "  $error"
1543         }
1544     }
1545     set html_log "[_html_highlight [lindex $status 0] $summary]\n[join $html_log \n]"
1546 }
1547
1548 # Auxiliary procedure putting message to both cout and log variable (list)
1549 proc _log_and_puts {logvar message} {
1550     if { $logvar != "" } { 
1551         upvar $logvar log
1552         lappend log $message
1553     }
1554     puts $message
1555 }
1556
1557 # Auxiliary procedure to log result on single test case
1558 proc _log_test_case {output logdir dir group grid casename logvar} {
1559     upvar $logvar log
1560     set show_errors 0
1561     # check result and make HTML log
1562     _check_log $dir $group $grid $casename $show_errors $output summary html_log
1563     lappend log $summary
1564
1565     # save log to file
1566     if { $logdir != "" } {
1567         _log_html $logdir/$group/$grid/$casename.html $html_log "Test $group $grid $casename"
1568         _log_save $logdir/$group/$grid/$casename.log "$output\n$summary" "Test $group $grid $casename"
1569     }
1570 }
1571
1572 # Auxiliary procedure to save log to file
1573 proc _log_save {file log {title {}}} {
1574     # create missing directories as needed
1575     catch {file mkdir [file dirname $file]}
1576
1577     # try to open a file
1578     if [catch {set fd [open $file w]} res] {
1579         error "Error saving log file $file: $res"
1580     }
1581     
1582     # dump log and close
1583     puts $fd "$title\n"
1584     puts $fd $log
1585     close $fd
1586     return
1587 }
1588
1589 # Auxiliary procedure to make a (relative if possible) URL to a file for 
1590 # inclusion a reference in HTML log
1591 proc _make_url {htmldir file} {
1592     set htmlpath [file split [file normalize $htmldir]]
1593     set filepath [file split [file normalize $file]]
1594     for {set i 0} {$i < [llength $htmlpath]} {incr i} {
1595         if { "[lindex $htmlpath $i]" != "[lindex $filepath $i]" } {
1596             if { $i == 0 } { break }
1597             return "[string repeat "../" [expr [llength $htmlpath] - $i - 1]][eval file join [lrange $filepath $i end]]"
1598         }
1599     }
1600
1601     # if relative path could not be made, return full file URL
1602     return "file://[file normalize $file]"
1603 }
1604
1605 # Auxiliary procedure to save log to file
1606 proc _log_html {file log {title {}}} {
1607     # create missing directories as needed
1608     catch {file mkdir [file dirname $file]}
1609
1610     # try to open a file
1611     if [catch {set fd [open $file w]} res] {
1612         error "Error saving log file $file: $res"
1613     }
1614     
1615     # print header
1616     puts $fd "<html><head><meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>"
1617     puts $fd "<title>$title</title></head><body><h1>$title</h1>"
1618
1619     # add images if present; these should have either PNG, GIF, or JPG extension,
1620     # and start with name of the test script, with optional suffix separated
1621     # by underscore or dash
1622     set imgbasename [file rootname [file tail $file]]
1623     foreach img [lsort [glob -nocomplain -directory [file dirname $file] -tails \
1624                              ${imgbasename}.gif   ${imgbasename}.png   ${imgbasename}.jpg \
1625                              ${imgbasename}_*.gif ${imgbasename}_*.png ${imgbasename}_*.jpg \
1626                              ${imgbasename}-*.gif ${imgbasename}-*.png ${imgbasename}-*.jpg]] {
1627         puts $fd "<p>[file tail $img]<br><img src=\"$img\"/><p>"
1628     }
1629
1630     # print log body, trying to add HTML links to script files on lines like
1631     # "Executing <filename>..."
1632     puts $fd "<pre>"
1633     foreach line [split $log "\n"] {
1634         if { [regexp {Executing[ \t]+([a-zA-Z0-9._/:-]+[^.])} $line res script] &&
1635              [file exists $script] } {
1636             set line [regsub $script $line "<a href=\"[_make_url $file $script]\">$script</a>"]
1637         }
1638         puts $fd $line
1639     }
1640     puts $fd "</pre></body></html>"
1641
1642     close $fd
1643     return
1644 }
1645
1646 # Auxiliary method to make text with HTML highlighting according to status
1647 proc _html_color {status} {
1648     # choose a color for the cell according to result
1649     if { $status == "OK" } { 
1650         return lightgreen
1651     } elseif { [regexp -nocase {^FAIL} $status] } { 
1652         return ff8080
1653     } elseif { [regexp -nocase {^BAD} $status] } { 
1654         return yellow
1655     } elseif { [regexp -nocase {^IMP} $status] } { 
1656         return orange
1657     } elseif { [regexp -nocase {^SKIP} $status] } { 
1658         return gray
1659     } elseif { [regexp -nocase {^IGNOR} $status] } { 
1660         return gray
1661     } else {
1662         puts "Warning: no color defined for status $status, using red as if FAILED"
1663         return red
1664     }
1665 }
1666
1667 # Format text line in HTML to be colored according to the status
1668 proc _html_highlight {status line} {
1669     return "<table><tr><td bgcolor=\"[_html_color $status]\">$line</td></tr></table>"
1670 }
1671
1672 # Internal procedure to generate HTML page presenting log of the tests
1673 # execution in tabular form, with links to reports on individual cases
1674 proc _log_html_summary {logdir log totals regressions improvements skipped total_time} {
1675     global _test_case_regexp
1676
1677     # create missing directories as needed
1678     file mkdir $logdir
1679
1680     # try to open a file and start HTML
1681     if [catch {set fd [open $logdir/summary.html w]} res] {
1682         error "Error creating log file: $res"
1683     }
1684
1685     # write HRML header, including command to refresh log if still in progress
1686     puts $fd "<html><head><meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>"
1687     puts $fd "<title>Tests summary</title>"
1688     if { $total_time == "" } {
1689         puts $fd "<meta http-equiv=\"refresh\" content=\"10\">"
1690     }
1691     puts $fd "<meta http-equiv=\"pragma\" content=\"NO-CACHE\">"
1692     puts $fd "</head><body>"
1693
1694     # put summary
1695     set legend(OK)          "Test passed OK"
1696     set legend(FAILED)      "Test failed (regression)"
1697     set legend(BAD)         "Known problem"
1698     set legend(IMPROVEMENT) "Possible improvement (expected problem not detected)"
1699     set legend(SKIPPED)     "Test skipped due to lack of data file"
1700     puts $fd "<h1>Summary</h1><table>"
1701     foreach nbstat $totals {
1702         set status [lindex $nbstat 1]
1703         if { [info exists legend($status)] } { 
1704             set comment $legend($status) 
1705         } else {
1706             set comment "User-defined status"
1707         }
1708         puts $fd "<tr><td align=\"right\">[lindex $nbstat 0]</td><td bgcolor=\"[_html_color $status]\">$status</td><td>$comment</td></tr>"
1709     }
1710     puts $fd "</table>"
1711
1712     # time stamp and elapsed time info
1713     if { $total_time != "" } { 
1714         puts $fd "<p>Generated on [clock format [clock seconds] -format {%Y-%m-%d %H:%M:%S}] on [info hostname]\n<p>"
1715         puts $fd [join [split $total_time "\n"] "<p>"]
1716     } else {
1717         puts $fd "<p>NOTE: This is intermediate summary; the tests are still running! This page will refresh automatically until tests are finished."
1718     }
1719    
1720     # print regressions and improvements
1721     foreach featured [list $regressions $improvements $skipped] {
1722         if { [llength $featured] <= 1 } { continue }
1723         set status [string trim [lindex $featured 0] { :}]
1724         puts $fd "<h2>$status</h2>"
1725         puts $fd "<table>"
1726         set groupgrid ""
1727         foreach test [lrange $featured 1 end] {
1728             if { ! [regexp {^(.*)\s+([\w\-.]+)$} $test res gg name] } {
1729                 set gg UNKNOWN
1730                 set name "Error building short list; check details"
1731             }
1732             if { $gg != $groupgrid } {
1733                 if { $groupgrid != "" } { puts $fd "</tr>" }
1734                 set groupgrid $gg
1735                 puts $fd "<tr><td>$gg</td>"
1736             }
1737             puts $fd "<td bgcolor=\"[_html_color $status]\"><a href=\"[regsub -all { } $gg /]/${name}.html\">$name</a></td>"
1738         }
1739         if { $groupgrid != "" } { puts $fd "</tr>" }
1740         puts $fd "</table>"
1741     }
1742
1743     # put detailed log with TOC
1744     puts $fd "<hr><h1>Details</h1>"
1745     puts $fd "<div style=\"float:right; padding: 10px; border-style: solid; border-color: blue; border-width: 2px;\">"
1746
1747     # process log line-by-line
1748     set group {}
1749     set letter {}
1750     set body {}
1751     foreach line [lsort -dictionary $log] {
1752         # check that the line is case report in the form "CASE group grid name: result (explanation)"
1753         if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } {
1754             continue
1755         }
1756
1757         # start new group
1758         if { $grp != $group } {
1759             if { $letter != "" } { lappend body "</tr></table>" }
1760             set letter {}
1761             set group $grp
1762             set grid {}
1763             puts $fd "<a href=\"#$group\">$group</a><br>"
1764             lappend body "<h2><a name=\"$group\">Group $group</a></h2>"
1765         }
1766
1767         # start new grid
1768         if { $grd != $grid } {
1769             if { $letter != "" } { lappend body "</tr></table>" }
1770             set letter {}
1771             set grid $grd
1772             puts $fd "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"#$group-$grid\">$grid</a><br>"
1773             lappend body "<h2><a name=\"$group-$grid\">Grid $group $grid</a></h2>"
1774         }
1775
1776         # check if test case name is <letter><digit>; 
1777         # if not, set alnum to period "." to recognize non-standard test name
1778         if { ! [regexp {\A([A-Za-z]{1,2})([0-9]{1,2})\Z} $casename res alnum number] &&
1779              ! [regexp {\A([A-Za-z0-9]+)_([0-9]+)\Z} $casename res alnum number] } {
1780             set alnum $casename
1781         }
1782
1783         # start new row when letter changes or for non-standard names
1784         if { $alnum != $letter || $alnum == "." } {
1785             if { $letter != "" } { 
1786                 lappend body "</tr><tr>" 
1787             } else {
1788                 lappend body "<table><tr>"
1789             }
1790             set letter $alnum
1791         }    
1792
1793         lappend body "<td bgcolor=\"[_html_color $result]\"><a href=\"$group/$grid/${casename}.html\">$casename</a></td>"
1794     }
1795     puts $fd "</div>\n[join $body "\n"]</tr></table>"
1796
1797     # add remaining lines of log as plain text
1798     puts $fd "<h2>Plain text messages</h2>\n<pre>"
1799     foreach line $log {
1800         if { ! [regexp $_test_case_regexp $line] } {
1801             puts $fd "$line"
1802         }
1803     }
1804     puts $fd "</pre>"
1805
1806     # close file and exit
1807     puts $fd "</body>"
1808     close $fd
1809     return
1810 }
1811
1812 # Procedure to dump summary logs of tests
1813 proc _log_summarize {logdir log {total_time {}}} {
1814
1815     # sort log records alphabetically to have the same behavior on Linux and Windows 
1816     # (also needed if tests are run in parallel)
1817     set loglist [lsort -dictionary $log]
1818
1819     # classify test cases by status
1820     foreach line $loglist {
1821         if { [regexp {^CASE ([^:]*): ([[:alnum:]]+).*$} $line res caseid status] } {
1822             lappend stat($status) $caseid
1823         }
1824     }
1825     set totals {}
1826     set improvements {Improvements:}
1827     set regressions {Failed:}
1828     set skipped {Skipped:}
1829     if { [info exists stat] } {
1830         foreach status [lsort [array names stat]] {
1831             lappend totals [list [llength $stat($status)] $status]
1832
1833             # separately count improvements (status starting with IMP), skipped (status starting with SKIP) and regressions (all except IMP, OK, BAD, and SKIP)
1834             if { [regexp -nocase {^IMP} $status] } {
1835                 eval lappend improvements $stat($status)
1836             } elseif { [regexp -nocase {^SKIP} $status] } {
1837                 eval lappend skipped $stat($status)
1838             } elseif { $status != "OK" && ! [regexp -nocase {^BAD} $status] && ! [regexp -nocase {^SKIP} $status] } {
1839                 eval lappend regressions $stat($status)
1840             }
1841         }
1842     }
1843
1844     # if time is specified, add totals
1845     if { $total_time != "" } {
1846         if { [llength $improvements] > 1 } {
1847             _log_and_puts log [join $improvements "\n  "]
1848         }
1849         if { [llength $regressions] > 1 } {
1850             _log_and_puts log [join $regressions "\n  "]
1851         }
1852         if { [llength $skipped] > 1 } {
1853             _log_and_puts log [join $skipped "\n  "]
1854         }
1855         if { [llength $improvements] == 1 && [llength $regressions] == 1 } {
1856             _log_and_puts log "No regressions"
1857         }
1858         _log_and_puts log "Total cases: [join $totals {, }]"
1859         _log_and_puts log $total_time
1860     }
1861
1862     # save log to files
1863     if { $logdir != "" } {
1864         _log_html_summary $logdir $log $totals $regressions $improvements $skipped $total_time
1865         _log_save $logdir/tests.log [join $log "\n"] "Tests summary"
1866     }
1867
1868     return
1869 }
1870
1871 # Internal procedure to generate XML log in JUnit style, for further
1872 # consumption by Jenkins or similar systems.
1873 #
1874 # The output is intended to conform to XML schema supported by Jenkins found at
1875 # 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
1876 #
1877 # The mapping of the fields is inspired by annotated schema of Apache Ant JUnit XML format found at
1878 # http://windyroad.org/dl/Open%20Source/JUnit.xsd
1879 proc _log_xml_summary {logdir filename log include_cout} {
1880     global _test_case_regexp
1881
1882     catch {file mkdir [file dirname $filename]}
1883
1884     # try to open a file and start XML
1885     if [catch {set fd [open $filename w]} res] {
1886         error "Error creating XML summary file $filename: $res"
1887     }
1888     puts $fd "<?xml version='1.0' encoding='utf-8'?>"
1889     puts $fd "<testsuites>"
1890
1891     # prototype for command to generate test suite tag
1892     set time_and_host "timestamp=\"[clock format [clock seconds] -format {%Y-%m-%dT%H:%M:%S}]\" hostname=\"[info hostname]\""
1893     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"}
1894
1895     # sort log and process it line-by-line
1896     set group {}
1897     foreach line [lsort -dictionary $log] {
1898         # check that the line is case report in the form "CASE group grid name: result (explanation)"
1899         if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } {
1900             continue
1901         }
1902         set message [string trim $message " \t\r\n()"]
1903
1904         # start new testsuite for each grid
1905         if { $grp != $group || $grd != $grid } {
1906
1907             # write previous test suite
1908             if [info exists testcases] { eval $cmd_testsuite }
1909
1910             set testcases {}
1911             set nbtests 0
1912             set nberr 0
1913             set nbfail 0
1914             set nbskip 0
1915             set time 0.
1916
1917             set group $grp
1918             set grid $grd
1919         }
1920
1921         incr nbtests
1922  
1923         # parse test log and get its CPU time
1924         set testout {}
1925         set add_cpu {}
1926         if { [catch {set fdlog [open $logdir/$group/$grid/${casename}.log r]} ret] } { 
1927             puts "Error: cannot open $logdir/$group/$grid/${casename}.log: $ret"
1928         } else {
1929             while { [gets $fdlog logline] >= 0 } {
1930                 if { $include_cout } {
1931                     append testout "$logline\n"
1932                 }
1933                 if [regexp -nocase {TOTAL CPU TIME:\s*([\d.]+)\s*sec} $logline res cpu] {
1934                     set add_cpu " time=\"$cpu\""
1935                     set time [expr $time + $cpu]
1936                 }
1937             }
1938             close $fdlog
1939         }
1940         if { ! $include_cout } {
1941             set testout "$line\n"
1942         }
1943
1944         # record test case with its output and status
1945         # Mapping is: SKIPPED, BAD, and OK to OK, all other to failure
1946         append testcases "\n  <testcase name=\"$casename\"$add_cpu status=\"$result\">\n"
1947         append testcases "\n    <system-out>\n$testout    </system-out>"
1948         if { $result != "OK" } {
1949             if { [regexp -nocase {^SKIP} $result] } {
1950                 incr nberr
1951                 append testcases "\n    <error name=\"$result\" message=\"$message\"/>"
1952             } elseif { [regexp -nocase {^BAD} $result] } {
1953                 incr nbskip
1954                 append testcases "\n    <skipped>$message</skipped>"
1955             } else {
1956                 incr nbfail
1957                 append testcases "\n    <failure name=\"$result\" message=\"$message\"/>"
1958             }
1959         }
1960         append testcases "\n  </testcase>"
1961     }
1962
1963     # write last test suite
1964     if [info exists testcases] { eval $cmd_testsuite }
1965
1966     # the end
1967     puts $fd "</testsuites>"
1968     close $fd
1969     return
1970 }
1971
1972 # Auxiliary procedure to split path specification (usually defined by
1973 # environment variable) into list of directories or files
1974 proc _split_path {pathspec} {
1975     global tcl_platform
1976
1977     # first replace all \ (which might occur on Windows) by /  
1978     regsub -all "\\\\" $pathspec "/" pathspec
1979
1980     # split path by platform-specific separator
1981     return [split $pathspec [_path_separator]]
1982 }
1983
1984 # Auxiliary procedure to define platform-specific separator for directories in
1985 # path specification
1986 proc _path_separator {} {
1987     global tcl_platform
1988
1989     # split path by platform-specific separator
1990     if { $tcl_platform(platform) == "windows" } {
1991         return ";"
1992     } else {
1993         return ":"
1994     }
1995 }
1996
1997 # Procedure to make a diff and common of two lists
1998 proc _list_diff {list1 list2 _in1 _in2 _common} {
1999     upvar $_in1 in1
2000     upvar $_in2 in2
2001     upvar $_common common
2002
2003     set in1 {}
2004     set in2 {}
2005     set common {}
2006     foreach item $list1 {
2007         if { [lsearch -exact $list2 $item] >= 0 } {
2008             lappend common $item
2009         } else {
2010             lappend in1 $item
2011         }
2012     }
2013     foreach item $list2 {
2014         if { [lsearch -exact $common $item] < 0 } {
2015             lappend in2 $item
2016         }
2017     }
2018     return
2019 }
2020
2021 # procedure to load a file to Tcl string
2022 proc _read_file {filename} {
2023     set fd [open $filename r]
2024     set result [read -nonewline $fd]
2025     close $fd
2026     return $result
2027 }
2028
2029 # procedure to construct name for the mage diff file
2030 proc _diff_img_name {dir1 dir2 casepath imgfile} {
2031     return [file join $dir1 $casepath "diff-[file tail $dir2]-$imgfile"]
2032 }
2033
2034 # auxiliary procedure to produce string comparing two values
2035 proc _diff_show_ratio {value1 value2} {
2036     if {[expr double ($value2)] == 0.} {
2037         return "$value1 / $value2"
2038     } else {
2039         return "$value1 / $value2 \[[format "%+5.2f%%" [expr 100 * ($value1 - $value2) / double($value2)]]\]"
2040     }
2041 }
2042
2043 # procedure to check cpu user time
2044 proc _check_time {regexp_msg} {
2045     upvar log log
2046     upvar log1 log1
2047     upvar log2 log2
2048     upvar log_cpu log_cpu
2049     upvar cpu cpu
2050     upvar basename basename
2051     upvar casename casename
2052     set time1_list [dict create]
2053     set time2_list [dict create]
2054     set cpu_find UNDEFINED
2055
2056     foreach line1 [split $log1 "\n"] {
2057         if { [regexp "${regexp_msg}" $line1 dump chronometer_name cpu_find] } {
2058             dict set time1_list "${chronometer_name}" "${cpu_find}"
2059         }
2060     }
2061
2062     foreach line2 [split $log2 "\n"] {
2063         if { [regexp "${regexp_msg}" $line2 dump chronometer_name cpu_find] } {
2064             dict set time2_list "${chronometer_name}" "${cpu_find}"
2065         }
2066     }
2067
2068     if { [llength [dict keys $time1_list]] != [llength [dict keys $time2_list]] } {
2069         puts "Error: number of dchrono/chrono COUNTER are different in the same test cases"
2070     } else {
2071         foreach key [dict keys $time1_list] {
2072             set time1 [dict get $time1_list $key]
2073             set time2 [dict get $time2_list $key]
2074
2075             # compare CPU user time with 10% precision (but not less 0.5 sec)
2076             if { [expr abs ($time1 - $time2) > 0.5 + 0.05 * abs ($time1 + $time2)] } {
2077                 if {$cpu != false} {
2078                     _log_and_puts log_cpu "COUNTER $key: [split $basename /] $casename: [_diff_show_ratio $time1 $time2]"
2079                 } else {
2080                     _log_and_puts log "COUNTER $key: [split $basename /] $casename: [_diff_show_ratio $time1 $time2]"
2081                 }
2082             }
2083         }
2084     }
2085 }
2086
2087 # Procedure to compare results of two runs of test cases
2088 proc _test_diff {dir1 dir2 basename image cpu memory status verbose _logvar _logimage _logcpu _logmemory {_statvar ""}} {
2089     upvar $_logvar log
2090     upvar $_logimage log_image
2091     upvar $_logcpu log_cpu
2092     upvar $_logmemory log_memory
2093
2094     # make sure to load diffimage command
2095     uplevel pload VISUALIZATION
2096
2097     # prepare variable (array) for collecting statistics
2098     if { "$_statvar" != "" } {
2099         upvar $_statvar stat
2100     } else {
2101         set stat(cpu1) 0
2102         set stat(cpu2) 0
2103         set stat(mem1) 0
2104         set stat(mem2) 0
2105         set log {}
2106         set log_image {}
2107         set log_cpu {}
2108         set log_memory {}
2109     }
2110
2111     # first check subdirectories
2112     set path1 [file join $dir1 $basename]
2113     set path2 [file join $dir2 $basename]
2114     set list1 [glob -directory $path1 -types d -tails -nocomplain *]
2115     set list2 [glob -directory $path2 -types d -tails -nocomplain *]
2116     if { [llength $list1] >0 || [llength $list2] > 0 } {
2117         _list_diff $list1 $list2 in1 in2 common
2118         if { "$verbose" > 1 } {
2119             if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" }
2120             if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" }
2121         }
2122         foreach subdir $common {
2123             if { "$verbose" > 2 } {
2124                 _log_and_puts log "Checking [file join $basename $subdir]"
2125             }
2126             _test_diff $dir1 $dir2 [file join $basename $subdir] $image $cpu $memory $status $verbose log log_image log_cpu log_memory stat
2127         }
2128     } else {
2129         # check log files (only if directory has no subdirs)
2130         set list1 [glob -directory $path1 -types f -tails -nocomplain *.log]
2131         set list2 [glob -directory $path2 -types f -tails -nocomplain *.log]
2132         _list_diff $list1 $list2 in1 in2 common
2133         if { "$verbose" > 1 } {
2134             if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" }
2135             if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" }
2136         }
2137         set gcpu1 0
2138         set gcpu2 0
2139         set gmem1 0
2140         set gmem2 0
2141         foreach logfile $common {
2142             # load two logs
2143             set log1 [_read_file [file join $dir1 $basename $logfile]]
2144             set log2 [_read_file [file join $dir2 $basename $logfile]]
2145             set casename [file rootname $logfile]
2146             
2147             # check execution statuses
2148             if {$image == false && $cpu == false && $memory == false} {
2149                 set status1 UNDEFINED
2150                 set status2 UNDEFINED
2151                 if { ! [regexp {CASE [^:]*:\s*([\w]+)} $log1 res1 status1] ||
2152                     ! [regexp {CASE [^:]*:\s*([\w]+)} $log2 res2 status2] ||
2153                     "$status1" != "$status2" } {
2154                     _log_and_puts log "STATUS [split $basename /] $casename: $status1 / $status2"
2155                     # if test statuses are different, further comparison makes 
2156                     # no sense unless explicitly requested
2157                     if { "$status" != "all" } {
2158                         continue
2159                     }
2160                 }
2161                 if { "$status" == "ok" && "$status1" != "OK" } { 
2162                     continue
2163                 }
2164             }
2165
2166             if { ! $image } {
2167                 # check CPU user time in test cases
2168                 set checkCPURegexp "COUNTER (.+): (\[-0-9.+eE\]+)"
2169                 if { [regexp "${checkCPURegexp}" $log1] &&
2170                      [regexp "${checkCPURegexp}" $log2] } {
2171                   _check_time "${checkCPURegexp}"
2172                 }
2173             }
2174             
2175             # check CPU times
2176             if {$cpu != false || ($image == false && $cpu == false && $memory == false)} {
2177                 set cpu1 UNDEFINED
2178                 set cpu2 UNDEFINED
2179                 if { [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log1 res1 cpu1] &&
2180                      [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log2 res1 cpu2] } {
2181                     set stat(cpu1) [expr $stat(cpu1) + $cpu1]
2182                     set stat(cpu2) [expr $stat(cpu2) + $cpu2]
2183                     set gcpu1 [expr $gcpu1 + $cpu1]
2184                     set gcpu2 [expr $gcpu2 + $cpu2]
2185
2186                     # compare CPU times with 10% precision (but not less 0.5 sec)
2187                     if { [expr abs ($cpu1 - $cpu2) > 0.5 + 0.05 * abs ($cpu1 + $cpu2)] } {
2188                         if {$cpu != false} {
2189                             _log_and_puts log_cpu "CPU [split $basename /] $casename: [_diff_show_ratio $cpu1 $cpu2]"
2190                         } else {
2191                             _log_and_puts log "CPU [split $basename /] $casename: [_diff_show_ratio $cpu1 $cpu2]"
2192                         }
2193                     }
2194                 }
2195             }
2196
2197             # check memory delta
2198             if {$memory != false || ($image == false && $cpu == false && $memory == false)} {
2199                 set mem1 UNDEFINED
2200                 set mem2 UNDEFINED
2201                 if { [regexp {MEMORY DELTA:\s*([\d.]+)} $log1 res1 mem1] &&
2202                      [regexp {MEMORY DELTA:\s*([\d.]+)} $log2 res1 mem2] } {
2203                     set stat(mem1) [expr $stat(mem1) + $mem1]
2204                     set stat(mem2) [expr $stat(mem2) + $mem2]
2205                     set gmem1 [expr $gmem1 + $mem1]
2206                     set gmem2 [expr $gmem2 + $mem2]
2207
2208                     # compare memory usage with 10% precision (but not less 16 KiB)
2209                     if { [expr abs ($mem1 - $mem2) > 16 + 0.05 * abs ($mem1 + $mem2)] } {
2210                         if {$memory != false} {
2211                             _log_and_puts log_memory "MEMORY [split $basename /] $casename: [_diff_show_ratio $mem1 $mem2]"
2212                         } else {
2213                             _log_and_puts log "MEMORY [split $basename /] $casename: [_diff_show_ratio $mem1 $mem2]"
2214                         }
2215                     }
2216                 }
2217             }
2218
2219             # check images
2220             if {$image != false || ($image == false && $cpu == false && $memory == false)} {
2221                 set aCaseDiffColorTol 0
2222                 if { [regexp {IMAGE_COLOR_TOLERANCE:\s*([\d.]+)} $log1 res1 imgtol1] } { set aCaseDiffColorTol $imgtol1 }
2223                 set imglist1 [glob -directory $path1 -types f -tails -nocomplain ${casename}.{png,gif} ${casename}-*.{png,gif} ${casename}_*.{png,gif}]
2224                 set imglist2 [glob -directory $path2 -types f -tails -nocomplain ${casename}.{png,gif} ${casename}-*.{png,gif} ${casename}_*.{png,gif}]
2225                 _list_diff $imglist1 $imglist2 imgin1 imgin2 imgcommon
2226                 if { "$verbose" > 1 } {
2227                     if { [llength $imgin1] > 0 } {
2228                         if {$image != false} {
2229                             _log_and_puts log_image "Only in $path1: $imgin1"
2230                         } else {
2231                             _log_and_puts log "Only in $path1: $imgin1"
2232                         }
2233                     }
2234                     if { [llength $imgin2] > 0 } {
2235                         if {$image != false} {
2236                             _log_and_puts log_image "Only in $path2: $imgin2"
2237                         } else {
2238                             _log_and_puts log "Only in $path2: $imgin2"
2239                         }
2240                     }
2241                 }
2242                 foreach imgfile $imgcommon {
2243                     # if { $verbose > 1 } { _log_and_puts log "Checking [split basename /] $casename: $imgfile" }
2244                     set diffile [_diff_img_name $dir1 $dir2 $basename $imgfile]
2245                     if { [catch {diffimage [file join $dir1 $basename $imgfile] \
2246                                            [file join $dir2 $basename $imgfile] \
2247                                            -toleranceOfColor 0.0 -blackWhite off -borderFilter off $diffile} diff] } {
2248                         if {$image != false} {
2249                             _log_and_puts log_image "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
2250                         } else {
2251                             _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
2252                         }
2253                         file delete -force $diffile ;# clean possible previous result of diffimage
2254                     } elseif { $diff != 0 } {
2255                         set diff [string trimright $diff \n]
2256                         if {$aCaseDiffColorTol != 0} {
2257                             # retry with color tolerance
2258                             if { [catch {diffimage [file join $dir1 $basename $imgfile] \
2259                                                    [file join $dir2 $basename $imgfile] \
2260                                                    -toleranceOfColor $aCaseDiffColorTol -blackWhite off -borderFilter off $diffile} diff2] } {
2261                                 if {$image != false} {
2262                                     _log_and_puts log_image "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
2263                                 } else {
2264                                     _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
2265                                 }
2266                                 continue
2267                             } elseif { $diff2 == 0 } {
2268                                 # exclude image diff within tolerance but still keep info in the log
2269                                 set toLogImageCase false
2270                                 file delete -force $diffile
2271                                 if {$image != false} {
2272                                     _log_and_puts log_image "IMAGE [split $basename /] $casename: $imgfile is similar \[$diff different pixels\]"
2273                                 } else {
2274                                     _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile is similar \[$diff different pixels\]"
2275                                 }
2276                                 continue
2277                             }
2278                         }
2279
2280                         if {$image != false} {
2281                             _log_and_puts log_image "IMAGE [split $basename /] $casename: $imgfile differs \[$diff different pixels\]"
2282                         } else {
2283                             _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile differs \[$diff different pixels\]"
2284                         }
2285                     } else {
2286                         file delete -force $diffile ;# clean useless artifact of diffimage
2287                     }
2288                 }
2289             }
2290         }
2291         
2292         # report CPU and memory difference in group if it is greater than 10%
2293         if {$cpu != false || ($image == false && $cpu == false && $memory == false)} {
2294             if { [expr abs ($gcpu1 - $gcpu2) > 0.5 + 0.005 * abs ($gcpu1 + $gcpu2)] } {
2295                 if {$cpu != false} {
2296                     _log_and_puts log_cpu "CPU [split $basename /]: [_diff_show_ratio $gcpu1 $gcpu2]"
2297                 } else {
2298                     _log_and_puts log "CPU [split $basename /]: [_diff_show_ratio $gcpu1 $gcpu2]"
2299                 }
2300             }
2301         }
2302         if {$memory != false || ($image == false && $cpu == false && $memory == false)} {
2303             if { [expr abs ($gmem1 - $gmem2) > 16 + 0.005 * abs ($gmem1 + $gmem2)] } {
2304                 if {$memory != false} {
2305                     _log_and_puts log_memory "MEMORY [split $basename /]: [_diff_show_ratio $gmem1 $gmem2]"
2306                 } else {
2307                     _log_and_puts log "MEMORY [split $basename /]: [_diff_show_ratio $gmem1 $gmem2]"
2308                 }
2309             }
2310         }
2311     }
2312
2313     if { "$_statvar" == "" } {
2314         if {$memory != false || ($image == false && $cpu == false && $memory == false)} {
2315             if {$memory != false} {
2316                 _log_and_puts log_memory "Total MEMORY difference: [_diff_show_ratio $stat(mem1) $stat(mem2)]"
2317             } else {
2318                 _log_and_puts log "Total MEMORY difference: [_diff_show_ratio $stat(mem1) $stat(mem2)]"
2319             }
2320         }
2321         if {$cpu != false || ($image == false && $cpu == false && $memory == false)} {
2322             if {$cpu != false} {
2323                 _log_and_puts log_cpu "Total CPU difference: [_diff_show_ratio $stat(cpu1) $stat(cpu2)]"
2324             } else {
2325                 _log_and_puts log "Total CPU difference: [_diff_show_ratio $stat(cpu1) $stat(cpu2)]"
2326             }
2327         }
2328     }
2329 }
2330
2331 # Auxiliary procedure to save log of results comparison to file
2332 proc _log_html_diff {file log dir1 dir2 highlight_percent} {
2333     # create missing directories as needed
2334     catch {file mkdir [file dirname $file]}
2335
2336     # try to open a file
2337     if [catch {set fd [open $file w]} res] {
2338         error "Error saving log file $file: $res"
2339     }
2340     
2341     # print header
2342     puts $fd "<html><head><meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>"
2343     puts $fd "<title>Diff $dir1 vs. $dir2</title></head><body>"
2344     puts $fd "<h1>Comparison of test results:</h1>"
2345     puts $fd "<h2>Version A \[NEW\] - $dir1</h2>"
2346     puts $fd "<h2>Version B \[REF\] - $dir2</h2>"
2347
2348     # add script for switching between images on click
2349     puts $fd ""
2350     puts $fd "<script type=\"text/javascript\">"
2351     puts $fd "  function diffimage_toggle(img,url1,url2)"
2352     puts $fd "  {"
2353     puts $fd "    if (img.show2nd) { img.src = url1; img.show2nd = false; }"
2354     puts $fd "    else { img.src = url2; img.show2nd = true; }"
2355     puts $fd "  }"
2356     puts $fd "  function diffimage_reset(img,url) { img.src = url; img.show2nd = true; }"
2357     puts $fd "</script>"
2358     puts $fd ""
2359
2360     # print log body
2361     puts $fd "<pre>"
2362     set logpath [file split [file normalize $file]]
2363     foreach line $log {
2364         # put a line; highlight considerable (> ${highlight_percent}%) deviations of CPU and memory
2365         if { [regexp "\[\\\[](\[0-9.e+-]+)%\[\]]" $line res value] && 
2366              [expr abs($value)] > ${highlight_percent} } {
2367             puts $fd "<table><tr><td bgcolor=\"[expr $value > 0 ? \"ff8080\" : \"lightgreen\"]\">$line</td></tr></table>"
2368         } elseif { [regexp {IMAGE[ \t]+([^:]+):[ \t]+([A-Za-z0-9_.-]+) is similar} $line res case img] } {
2369             if { [catch {eval file join "" [lrange $case 0 end-1]} gridpath] } {
2370                 # note: special handler for the case if test grid directoried are compared directly
2371                 set gridpath ""
2372             }
2373             set aCaseName [lindex $case end]
2374             puts $fd "<table><tr><td bgcolor=\"orange\"><a href=\"[_make_url $file [file join $dir1 $gridpath $aCaseName.html]]\">$line</a></td></tr></table>"
2375         } elseif { [regexp {IMAGE[ \t]+([^:]+):[ \t]+([A-Za-z0-9_.-]+)} $line res case img] } {
2376             # add images
2377             puts $fd $line
2378             if { [catch {eval file join "" [lrange $case 0 end-1]} gridpath] } {
2379                 # note: special handler for the case if test grid directoried are compared directly
2380                 set gridpath ""
2381             }
2382             set aCaseName [lindex $case end]
2383             set img1url [_make_url $file [file join $dir1 $gridpath $img]]
2384             set img2url [_make_url $file [file join $dir2 $gridpath $img]]
2385             set img1 "<a href=\"[_make_url $file [file join $dir1 $gridpath $aCaseName.html]]\"><img src=\"$img1url\"></a>"
2386             set img2 "<a href=\"[_make_url $file [file join $dir2 $gridpath $aCaseName.html]]\"><img src=\"$img2url\"></a>"
2387
2388             set difffile [_diff_img_name $dir1 $dir2 $gridpath $img]
2389             set imgdurl [_make_url $file $difffile]
2390             if { [file exists $difffile] } {
2391                 set imgd "<img src=\"$imgdurl\" onmouseout=diffimage_reset(this,\"$imgdurl\") onclick=diffimage_toggle(this,\"$img1url\",\"$img2url\")>"
2392             } else {
2393                 set imgd "N/A"
2394             }
2395
2396             puts $fd "<table><tr><th><abbr title=\"$dir1\">Version A</abbr></th><th><abbr title=\"$dir2\">Version B</abbr></th><th>Diff (click to toggle)</th></tr>"
2397             puts $fd "<tr><td>$img1</td><td>$img2</td><td>$imgd</td></tr></table>"
2398         } else {
2399             puts $fd $line
2400         }
2401     }
2402     puts $fd "</pre></body></html>"
2403
2404     close $fd
2405     return
2406 }
2407
2408 # get number of CPUs on the system
2409 proc _get_nb_cpus {} {
2410     global tcl_platform env
2411
2412     if { "$tcl_platform(platform)" == "windows" } {
2413         # on Windows, take the value of the environment variable 
2414         if { [info exists env(NUMBER_OF_PROCESSORS)] &&
2415              ! [catch {expr $env(NUMBER_OF_PROCESSORS) > 0} res] && $res >= 0 } {
2416             return $env(NUMBER_OF_PROCESSORS)
2417         }
2418     } elseif { "$tcl_platform(os)" == "Linux" } {
2419         # on Linux, take number of logical processors listed in /proc/cpuinfo
2420         if { [catch {open "/proc/cpuinfo" r} fd] } { 
2421             return 0 ;# should never happen, but...
2422         }
2423         set nb 0
2424         while { [gets $fd line] >= 0 } {
2425             if { [regexp {^processor[ \t]*:} $line] } {
2426                 incr nb
2427             }
2428         }
2429         close $fd
2430         return $nb
2431     } elseif { "$tcl_platform(os)" == "Darwin" } {
2432         # on MacOS X, call sysctl command
2433         if { ! [catch {exec sysctl hw.ncpu} ret] && 
2434              [regexp {^hw[.]ncpu[ \t]*:[ \t]*([0-9]+)} $ret res nb] } {
2435             return $nb
2436         }
2437     }
2438
2439     # if cannot get good value, return 0 as default
2440     return 0
2441 }
2442
2443 # check two files for difference
2444 proc _diff_files {file1 file2} {
2445     set fd1 [open $file1 "r"]
2446     set fd2 [open $file2 "r"]
2447
2448     set differ f
2449     while {! $differ} {
2450         set nb1 [gets $fd1 line1]
2451         set nb2 [gets $fd2 line2]
2452         if { $nb1 != $nb2 } { set differ t; break }
2453         if { $nb1 < 0 } { break }
2454         if { [string compare $line1 $line2] } {
2455             set differ t
2456         }
2457     }
2458
2459     close $fd1
2460     close $fd2
2461
2462     return $differ
2463 }
2464
2465 # Check if file is in DOS encoding.
2466 # This check is done by presence of \r\n combination at the end of the first 
2467 # line (i.e. prior to any other \n symbol).
2468 # Note that presence of non-ascii symbols typically used for recognition
2469 # of binary files is not suitable since some IGES and STEP files contain
2470 # non-ascii symbols.
2471 # Special check is added for PNG files which contain \r\n in the beginning.
2472 proc _check_dos_encoding {file} {
2473     set fd [open $file rb]
2474     set isdos f
2475     if { [gets $fd line] && [regexp {.*\r$} $line] && 
2476          ! [regexp {^.PNG} $line] } {
2477         set isdos t
2478     }
2479     close $fd
2480     return $isdos
2481 }
2482
2483 # procedure to recognize format of a data file by its first symbols (for OCCT 
2484 # BREP and geometry DRAW formats, IGES, and STEP) and extension (all others)
2485 proc _check_file_format {file} {
2486     set fd [open $file rb]
2487     set line [read $fd 1024]
2488     close $fd
2489
2490     set warn f
2491     set ext [file extension $file]
2492     set format unknown
2493     if { [regexp {^DBRep_DrawableShape} $line] } {
2494         set format BREP
2495         if { "$ext" != ".brep" && "$ext" != ".rle" && 
2496              "$ext" != ".draw" && "$ext" != "" } {
2497             set warn t
2498         }
2499     } elseif { [regexp {^DrawTrSurf_} $line] } {
2500         set format DRAW
2501         if { "$ext" != ".rle" && 
2502              "$ext" != ".draw" && "$ext" != "" } {
2503             set warn t
2504         }
2505     } elseif { [regexp {^[ \t]*ISO-10303-21} $line] } {
2506         set format STEP
2507         if { "$ext" != ".step" && "$ext" != ".stp" } {
2508             set warn t
2509         }
2510     } elseif { [regexp {^.\{72\}S[0 ]\{6\}1} $line] } {
2511         set format IGES
2512         if { "$ext" != ".iges" && "$ext" != ".igs" } {
2513             set warn t
2514         }
2515     } elseif { "$ext" == ".igs" } {
2516         set format IGES
2517     } elseif { "$ext" == ".stp" } {
2518         set format STEP
2519     } else {
2520         set format [string toupper [string range $ext 1 end]]
2521     }
2522     
2523     if { $warn } {
2524         puts "$file: Warning: extension ($ext) does not match format ($format)"
2525     }
2526
2527     return $format
2528 }
2529
2530 # procedure to load file knowing its format
2531 proc load_data_file {file format shape} {
2532     switch $format {
2533         BREP { uplevel restore $file $shape }
2534         DRAW { uplevel restore $file $shape }
2535         IGES { pload XSDRAW; uplevel igesbrep $file $shape * }
2536         STEP { pload XSDRAW; uplevel stepread $file __a *; uplevel renamevar __a_1 $shape }
2537         STL  { pload XSDRAW; uplevel readstl $shape $file triangulation }
2538         default { error "Cannot read $format file $file" }
2539     }
2540 }
2541
2542 # procedure to get name of temporary directory,
2543 # ensuring it is existing and writeable 
2544 proc _get_temp_dir {} {
2545     global env tcl_platform
2546
2547     # check typical environment variables 
2548     foreach var {TempDir Temp Tmp} {
2549         # check different case
2550         foreach name [list [string toupper $var] $var [string tolower $var]] {
2551             if { [info exists env($name)] && [file isdirectory $env($name)] &&
2552                  [file writable $env($name)] } {
2553                 return [regsub -all {\\} $env($name) /]
2554             }
2555         }
2556     }
2557
2558     # check platform-specific locations
2559     set fallback tmp
2560     if { "$tcl_platform(platform)" == "windows" } {
2561         set paths "c:/TEMP c:/TMP /TEMP /TMP"
2562         if { [info exists env(HOMEDRIVE)] && [info exists env(HOMEPATH)] } {
2563             set fallback [regsub -all {\\} "$env(HOMEDRIVE)$env(HOMEPATH)/tmp" /]
2564         }
2565     } else {
2566         set paths "/tmp /var/tmp /usr/tmp"
2567         if { [info exists env(HOME)] } {
2568             set fallback "$env(HOME)/tmp"
2569         }
2570     }
2571     foreach dir $paths {
2572         if { [file isdirectory $dir] && [file writable $dir] } {
2573             return $dir
2574         }
2575     }
2576
2577     # fallback case: use subdir /tmp of home or current dir
2578     file mkdir $fallback
2579     return $fallback
2580 }
2581
2582 # extract of code from testgrid command used to process jobs running in 
2583 # parallel until number of jobs in the queue becomes equal or less than 
2584 # specified value
2585 proc _testgrid_process_jobs {worker {nb_ok 0}} {
2586     # bind local vars to variables of the caller procedure
2587     upvar log log
2588     upvar logdir logdir
2589     upvar job_def job_def
2590     upvar nbpooled nbpooled
2591     upvar userbreak userbreak
2592     upvar refresh refresh
2593     upvar refresh_timer refresh_timer
2594
2595     catch {tpool::resume $worker}
2596     while { ! $userbreak && $nbpooled > $nb_ok } {
2597         foreach job [tpool::wait $worker [array names job_def]] {
2598             eval _log_test_case \[tpool::get $worker $job\] $job_def($job) log
2599             unset job_def($job)
2600             incr nbpooled -1
2601         }
2602
2603         # check for user break
2604         if { "[info commands dbreak]" == "dbreak" && [catch dbreak] } {
2605             set userbreak 1
2606         }
2607
2608         # update summary log with requested period
2609         if { $logdir != "" && $refresh > 0 && [clock seconds] > $refresh_timer + $refresh } {
2610             _log_summarize $logdir $log
2611             set refresh_timer [clock seconds]
2612         }
2613     }
2614     catch {tpool::suspend $worker}
2615 }
2616
2617 help checkcolor {
2618   Check pixel color.
2619   Use: checkcolor x y red green blue
2620   x y - pixel coordinates
2621   red green blue - expected pixel color (values from 0 to 1)
2622   Function check color with tolerance (5x5 area)
2623 }
2624 # Procedure to check color using command vreadpixel with tolerance
2625 proc checkcolor { coord_x coord_y rd_get gr_get bl_get } {
2626     puts "Coordinate x = $coord_x"
2627     puts "Coordinate y = $coord_y"
2628     puts "RED color of RGB is $rd_get"
2629     puts "GREEN color of RGB is $gr_get"
2630     puts "BLUE color of RGB is $bl_get"
2631
2632     if { $coord_x <= 1 || $coord_y <= 1 } {
2633         puts "Error : minimal coordinate is x = 2, y = 2. But we have x = $coord_x y = $coord_y"
2634         return -1
2635     }
2636
2637     set color ""
2638     catch { [set color "[vreadpixel ${coord_x} ${coord_y} rgb]"] }
2639     if {"$color" == ""} {
2640         puts "Error : Pixel coordinates (${position_x}; ${position_y}) are out of view"
2641     }
2642     set rd [lindex $color 0]
2643     set gr [lindex $color 1]
2644     set bl [lindex $color 2]
2645     set rd_int [expr int($rd * 1.e+05)]
2646     set gr_int [expr int($gr * 1.e+05)]
2647     set bl_int [expr int($bl * 1.e+05)]
2648     set rd_ch [expr int($rd_get * 1.e+05)]
2649     set gr_ch [expr int($gr_get * 1.e+05)]
2650     set bl_ch [expr int($bl_get * 1.e+05)]
2651
2652     if { $rd_ch != 0 } {
2653         set tol_rd [expr abs($rd_ch - $rd_int)/$rd_ch]
2654     } else {
2655         set tol_rd $rd_int
2656     }
2657     if { $gr_ch != 0 } {
2658         set tol_gr [expr abs($gr_ch - $gr_int)/$gr_ch]
2659     } else {
2660         set tol_gr $gr_int
2661     }
2662     if { $bl_ch != 0 } {
2663         set tol_bl [expr abs($bl_ch - $bl_int)/$bl_ch]
2664     } else {
2665         set tol_bl $bl_int
2666     }
2667
2668     set status 0
2669     if { $tol_rd > 0.2 } {
2670         puts "Warning : RED light of additive color model RGB is invalid"
2671         set status 1
2672     }
2673     if { $tol_gr > 0.2 } {
2674         puts "Warning : GREEN light of additive color model RGB is invalid"
2675         set status 1
2676     }
2677     if { $tol_bl > 0.2 } {
2678         puts "Warning : BLUE light of additive color model RGB is invalid"
2679         set status 1
2680     }
2681
2682     if { $status != 0 } {
2683         puts "Warning : Colors of default coordinate are not equal"
2684     }
2685
2686     global stat
2687     if { $tol_rd > 0.2 || $tol_gr > 0.2 || $tol_bl > 0.2 } {
2688         set info [_checkpoint $coord_x $coord_y $rd_ch $gr_ch $bl_ch]
2689         set stat [lindex $info end]
2690         if { ${stat} != 1 } {
2691             puts "Error : Colors are not equal in default coordinate and in the near coordinates too"
2692             return $stat
2693         } else {
2694             puts "Point with valid color was found"
2695             return $stat
2696         }
2697     } else {
2698         set stat 1
2699     }
2700 }
2701
2702 # Procedure to check color in the point near default coordinate
2703 proc _checkpoint {coord_x coord_y rd_ch gr_ch bl_ch} {
2704     set x_start [expr ${coord_x} - 2]
2705     set y_start [expr ${coord_y} - 2]
2706     set mistake 0
2707     set i 0
2708     while { $mistake != 1 && $i <= 5 } {
2709         set j 0
2710         while { $mistake != 1 && $j <= 5 } {
2711             set position_x [expr ${x_start} + $j]
2712             set position_y [expr ${y_start} + $i]
2713             puts $position_x
2714             puts $position_y
2715
2716             set color ""
2717             catch { [set color "[vreadpixel ${position_x} ${position_y} rgb]"] }
2718             if {"$color" == ""} {
2719                 puts "Warning : Pixel coordinates (${position_x}; ${position_y}) are out of view"
2720                 incr j
2721                 continue
2722             }
2723             set rd [lindex $color 0]
2724             set gr [lindex $color 1]
2725             set bl [lindex $color 2]
2726             set rd_int [expr int($rd * 1.e+05)]
2727             set gr_int [expr int($gr * 1.e+05)]
2728             set bl_int [expr int($bl * 1.e+05)]
2729
2730             if { $rd_ch != 0 } {
2731                 set tol_rd [expr abs($rd_ch - $rd_int)/$rd_ch]
2732             } else {
2733                 set tol_rd $rd_int
2734             }
2735             if { $gr_ch != 0 } {
2736                 set tol_gr [expr abs($gr_ch - $gr_int)/$gr_ch]
2737             } else {
2738                 set tol_gr $gr_int
2739             }
2740             if { $bl_ch != 0 } {
2741                 set tol_bl [expr abs($bl_ch - $bl_int)/$bl_ch]
2742             } else {
2743                 set tol_bl $bl_int
2744             }
2745
2746             if { $tol_rd > 0.2 || $tol_gr > 0.2 || $tol_bl > 0.2 } {
2747                 puts "Warning : Point with true color was not found near default coordinates"
2748                 set mistake 0
2749             } else {
2750                 set mistake 1
2751             }
2752             incr j
2753         }
2754         incr i
2755     }
2756     return $mistake
2757 }
2758
2759 # Procedure to check if sequence of values in listval follows linear trend
2760 # adding the same delta on each step.
2761 #
2762 # The function does statistical estimation of the mean variation of the
2763 # values of the sequence, and dispersion, and returns true only if both 
2764 # dispersion and deviation of the mean from expected delta are within 
2765 # specified tolerance.
2766 #
2767 # If mean variation differs from expected delta on more than two dispersions,
2768 # the check fails and procedure raises error with specified message.
2769 #
2770 # Otherwise the procedure returns false meaning that more iterations are needed.
2771 # Note that false is returned in any case if length of listval is less than 3.
2772 #
2773 # See example of use to check memory leaks in bugs/caf/bug23489
2774 #
2775 proc checktrend {listval delta tolerance message} {
2776     set nbval [llength $listval]
2777     if { $nbval < 3} {
2778         return 0
2779     }
2780
2781     # calculate mean value
2782     set mean 0.
2783     set prev [lindex $listval 0]
2784     foreach val [lrange $listval 1 end] {
2785         set mean [expr $mean + ($val - $prev)]
2786         set prev $val
2787     }
2788     set mean [expr $mean / ($nbval - 1)]
2789
2790     # calculate dispersion
2791     set sigma 0.
2792     set prev [lindex $listval 0]
2793     foreach val [lrange $listval 1 end] {
2794         set d [expr ($val - $prev) - $mean]
2795         set sigma [expr $sigma + $d * $d]
2796         set prev $val
2797     }
2798     set sigma [expr sqrt ($sigma / ($nbval - 2))]
2799
2800     puts "Checking trend: nb = $nbval, mean delta = $mean, sigma = $sigma"
2801
2802     # check if deviation is definitely too big
2803     if { abs ($mean - $delta) > $tolerance + 2. * $sigma } {
2804         puts "Checking trend failed: mean delta per step = $mean, sigma = $sigma, expected delta = $delta"
2805         error "$message"
2806     }
2807
2808     # check if deviation is clearly within a range
2809     return [expr abs ($mean - $delta) <= $sigma && $sigma <= $tolerance]
2810 }