0030575: Tests - v3d/materials unstable image screenshots of alpha-blending on GeForc...
[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             while {[llength $dir] != 0} { 
1131                 set name [lindex $dir 0]
1132                 set dir [lrange $dir 1 end]
1133
1134                 # skip directories starting with dot
1135                 set aTail [file tail $name]
1136                 if { [regexp {^[.]} $aTail] } { continue }
1137                 if { [file exists $name/$filename] } {
1138                     return [file normalize $name/$filename]
1139                 }
1140                 eval lappend dir [glob -nocomplain -directory $name -type d *]
1141             }
1142         }
1143     }
1144
1145     # check current datadir
1146     if { [file exists [uplevel datadir]/$filename] } {
1147         return [file normalize [uplevel datadir]/$filename]
1148     }
1149
1150     # raise error
1151     error [join [list "File $filename could not be found" \
1152                       "(should be in paths indicated by CSF_TestDataPath environment variable, " \
1153                       "or in subfolder data in the script directory)"] "\n"]
1154 }
1155
1156 # Internal procedure to find test case indicated by group, grid, and test case names;
1157 # returns:
1158 # - dir: path to the base directory of the tests group
1159 # - gridname: actual name of the grid
1160 # - casefile: path to the test case script 
1161 # if no such test is found, raises error with appropriate message
1162 proc _get_test {group grid casename _dir _gridname _casefile} {
1163     upvar $_dir dir
1164     upvar $_gridname gridname
1165     upvar $_casefile casefile
1166
1167     global env
1168  
1169     # check that environment variable defining paths to test scripts is defined
1170     if { ! [info exists env(CSF_TestScriptsPath)] || 
1171          [llength $env(CSF_TestScriptsPath)] <= 0 } {
1172         error "Error: Environment variable CSF_TestScriptsPath is not defined"
1173     }
1174
1175     # iterate by all script paths
1176     foreach dir [_split_path $env(CSF_TestScriptsPath)] {
1177         # protection against empty paths
1178         set dir [string trim $dir]
1179         if { $dir == "" } { continue }
1180
1181         # check that directory exists
1182         if { ! [file isdirectory $dir] } {
1183             puts "Warning: directory $dir listed in CSF_TestScriptsPath does not exist, skipped"
1184             continue
1185         }
1186
1187         # check if test group with given name exists in this dir
1188         # if not, continue to the next test dir
1189         if { ! [file isdirectory $dir/$group] } { continue }
1190
1191         # check that grid with given name (possibly alias) exists; stop otherwise
1192         set gridname $grid
1193         if { ! [file isdirectory $dir/$group/$gridname] } {
1194             # check if grid is named by alias rather than by actual name
1195             if { [file exists $dir/$group/grids.list] } {
1196                 set fd [open $dir/$group/grids.list]
1197                 while { [gets $fd line] >= 0 } {
1198                     if { [regexp "\[ \t\]*\#.*" $line] } { continue }
1199                     if { [regexp "^$grid\[ \t\]*\(\[A-Za-z0-9_.-\]+\)\$" $line res gridname] } {
1200                         break
1201                     }
1202                 }
1203                 close $fd
1204             }
1205         }
1206         if { ! [file isdirectory $dir/$group/$gridname] } { continue }
1207
1208         # get actual file name of the script; stop if it cannot be found
1209         set casefile $dir/$group/$gridname/$casename
1210         if { ! [file exists $casefile] } {
1211             # check if this grid is aliased to another one
1212             if { [file exists $dir/$group/$gridname/cases.list] } {
1213                 set fd [open $dir/$group/$gridname/cases.list]
1214                 if { [gets $fd line] >= 0 } {
1215                     set casefile [file normalize $dir/$group/$gridname/[string trim $line]/$casename]
1216                 }
1217                 close $fd
1218             }
1219         }
1220         if { [file exists $casefile] } { 
1221             # normal return
1222             return 
1223         }
1224     }
1225
1226     # coming here means specified test is not found; report error
1227     error [join [list "Error: test case $group / $grid / $casename is not found in paths listed in variable" \
1228                       "CSF_TestScriptsPath (current value is \"$env(CSF_TestScriptsPath)\")"] "\n"]
1229 }
1230
1231 # Internal procedure to run test case indicated by base directory, 
1232 # grid and grid names, and test case file path.
1233 # The log can be obtained by command "dlog get".
1234 proc _run_test {scriptsdir group gridname casefile echo} {
1235     global env
1236
1237     # start timer
1238     uplevel dchrono _timer reset
1239     uplevel dchrono _timer start
1240     catch {uplevel meminfo h} membase
1241
1242     # enable commands logging; switch to old-style mode if dlog command is not present
1243     set dlog_exists 1
1244     if { [catch {dlog reset}] } {
1245         set dlog_exists 0
1246     } elseif { $echo } {
1247         decho on
1248     } else {
1249         dlog reset
1250         dlog on
1251         rename puts puts-saved
1252         proc puts args { 
1253             global _tests_verbose
1254
1255             # log only output to stdout and stderr, not to file!
1256             if {[llength $args] > 1} {
1257                 set optarg [lindex $args end-1]
1258                 if { $optarg == "stdout" || $optarg == "stderr" || $optarg == "-newline" } {
1259                     dlog add [lindex $args end]
1260                 } else {
1261                     eval puts-saved $args
1262                 }
1263             } else {
1264                 dlog add [lindex $args end]
1265             }
1266         }
1267     }
1268
1269     # evaluate test case 
1270     set tmp_imagedir 0
1271     if [catch {
1272         # set variables identifying test case
1273         uplevel set casename [file tail $casefile]
1274         uplevel set groupname $group
1275         uplevel set gridname $gridname
1276         uplevel set dirname  $scriptsdir
1277
1278         # set path for saving of log and images (if not yet set) to temp dir
1279         if { ! [uplevel info exists imagedir] } {
1280             uplevel set test_image \$casename
1281
1282             # create subdirectory in temp named after group and grid with timestamp
1283             set rootlogdir [_get_temp_dir]
1284         
1285             set imagedir "${group}-${gridname}-${::casename}-[clock format [clock seconds] -format {%Y-%m-%dT%Hh%Mm%Ss}]"
1286             set imagedir [file normalize ${rootlogdir}/$imagedir]
1287
1288             if { [catch {file mkdir $imagedir}] || ! [file writable $imagedir] ||
1289                  ! [catch {glob -directory $imagedir *}] } {
1290                  # puts "Warning: Cannot create directory \"$imagedir\", or it is not empty; \"${rootlogdir}\" is used"
1291                 set imagedir $rootlogdir
1292             }
1293
1294             uplevel set imagedir \"$imagedir\"
1295             set tmp_imagedir 1
1296         }
1297
1298         # execute test scripts 
1299         if { [file exists $scriptsdir/$group/begin] } {
1300             puts "Executing $scriptsdir/$group/begin..."; flush stdout
1301             uplevel source $scriptsdir/$group/begin
1302         }
1303         if { [file exists $scriptsdir/$group/$gridname/begin] } {
1304             puts "Executing $scriptsdir/$group/$gridname/begin..."; flush stdout
1305             uplevel source $scriptsdir/$group/$gridname/begin
1306         }
1307
1308         puts "Executing $casefile..."; flush stdout
1309         uplevel source $casefile
1310
1311         if { [file exists $scriptsdir/$group/$gridname/end] } {
1312             puts "Executing $scriptsdir/$group/$gridname/end..."; flush stdout
1313             uplevel source $scriptsdir/$group/$gridname/end
1314         }
1315         if { [file exists $scriptsdir/$group/end] } {
1316             puts "Executing $scriptsdir/$group/end..."; flush stdout
1317             uplevel source $scriptsdir/$group/end
1318         }
1319     } res] {
1320         puts "Tcl Exception: $res"
1321     }
1322
1323     # stop logging
1324     if { $dlog_exists } {
1325         if { $echo } {
1326             decho off
1327         } else {
1328             rename puts {}
1329             rename puts-saved puts
1330             dlog off
1331         }
1332     }
1333
1334     # stop cpulimit killer if armed by the test
1335     cpulimit
1336
1337     # add memory and timing info
1338     set stats ""
1339     if { ! [catch {uplevel meminfo h} memuse] } {
1340         append stats "MEMORY DELTA: [expr ($memuse - $membase) / 1024] KiB\n"
1341     }
1342     uplevel dchrono _timer stop
1343     set time [uplevel dchrono _timer show]
1344     if { [regexp -nocase {CPU user time:[ \t]*([0-9.e-]+)} $time res cpu_usr] } {
1345         append stats "TOTAL CPU TIME: $cpu_usr sec\n"
1346     }
1347     if { $dlog_exists && ! $echo } {
1348         dlog add $stats
1349     } else {
1350         puts $stats
1351     }
1352
1353     # unset global vars
1354     uplevel unset casename groupname gridname dirname
1355     if { $tmp_imagedir } { uplevel unset imagedir test_image }
1356 }
1357
1358 # Internal procedure to check log of test execution and decide if it passed or failed
1359 proc _check_log {dir group gridname casename errors log {_summary {}} {_html_log {}}} {
1360     global env
1361     if { $_summary != "" } { upvar $_summary summary }
1362     if { $_html_log != "" } { upvar $_html_log html_log }
1363     set summary {}
1364     set html_log {}
1365     set errors_log {}
1366
1367     if [catch {
1368
1369         # load definition of 'bad words' indicating test failure
1370         # note that rules are loaded in the order of decreasing priority (grid - group - common),
1371         # thus grid rules will override group ones
1372         set badwords {}
1373         foreach rulesfile [list $dir/$group/$gridname/parse.rules $dir/$group/parse.rules $dir/parse.rules] {
1374             if [catch {set fd [open $rulesfile r]}] { continue }
1375             while { [gets $fd line] >= 0 } {
1376                 # skip comments and empty lines
1377                 if { [regexp "\[ \t\]*\#.*" $line] } { continue }
1378                 if { [string trim $line] == "" } { continue }
1379                 # extract regexp
1380                 if { ! [regexp {^([^/]*)/([^/]*)/(.*)$} $line res status rexp comment] } { 
1381                     puts "Warning: cannot recognize parsing rule \"$line\" in file $rulesfile"
1382                     continue 
1383                 }
1384                 set status [string trim $status]
1385                 if { $comment != "" } { append status " ([string trim $comment])" }
1386                 set rexp [regsub -all {\\b} $rexp {\\y}] ;# convert regexp from Perl to Tcl style
1387                 lappend badwords [list $status $rexp]
1388             }
1389             close $fd
1390         }
1391         if { [llength $badwords] <= 0 } { 
1392             puts "Warning: no definition of error indicators found (check files parse.rules)" 
1393         }
1394
1395         # analyse log line-by-line
1396         set todos {} ;# TODO statements
1397         set requs {} ;# REQUIRED statements
1398         set todo_incomplete -1
1399         set status ""
1400         foreach line [split $log "\n"] {
1401             # check if line defines specific treatment of some messages
1402             if [regexp -nocase {^[ \s]*TODO ([^:]*):(.*)$} $line res platforms pattern] {
1403                 if { ! [regexp -nocase {\mAll\M} $platforms] && 
1404                      ! [regexp -nocase "\\m[checkplatform]\\M" $platforms] } {
1405                     lappend html_log [_html_highlight IGNORE $line]
1406                     continue ;# TODO statement is for another platform
1407                 }
1408
1409                 # record TODOs that mark unstable cases
1410                 if { [regexp {[\?]} $platforms] } {
1411                     set todos_unstable([llength $todos]) 1
1412                 }
1413
1414                 # convert legacy regexps from Perl to Tcl style
1415                 set pattern [regsub -all {\\b} [string trim $pattern] {\\y}]
1416
1417                 # special case: TODO TEST INCOMPLETE
1418                 if { [string trim $pattern] == "TEST INCOMPLETE" } {
1419                     set todo_incomplete [llength $todos]
1420                 }
1421
1422                 lappend todos [list $pattern [llength $html_log] $line]
1423                 lappend html_log [_html_highlight BAD $line]
1424                 continue
1425             }
1426             if [regexp -nocase {^[ \s]*REQUIRED ([^:]*):[ \s]*(.*)$} $line res platforms pattern] {
1427                 if { ! [regexp -nocase {\mAll\M} $platforms] && 
1428                      ! [regexp -nocase "\\m[checkplatform]\\M" $platforms] } {
1429                     lappend html_log [_html_highlight IGNORE $line]
1430                     continue ;# REQUIRED statement is for another platform
1431                 }
1432                 lappend requs [list $pattern [llength $html_log] $line]
1433                 lappend html_log [_html_highlight OK $line]
1434                 continue
1435             }
1436
1437             # check for presence of required messages 
1438             set ismarked 0
1439             for {set i 0} {$i < [llength $requs]} {incr i} {
1440                 set pattern [lindex $requs $i 0]
1441                 if { [regexp $pattern $line] } {
1442                     incr required_count($i)
1443                     lappend html_log [_html_highlight OK $line]
1444                     set ismarked 1
1445                     continue
1446                 }
1447             }
1448             if { $ismarked } {
1449                 continue
1450             }
1451
1452             # check for presence of messages indicating test result
1453             foreach bw $badwords {
1454                 if { [regexp [lindex $bw 1] $line] } { 
1455                     # check if this is known bad case
1456                     set is_known 0
1457                     for {set i 0} {$i < [llength $todos]} {incr i} {
1458                         set pattern [lindex $todos $i 0]
1459                         if { [regexp $pattern $line] } {
1460                             set is_known 1
1461                             incr todo_count($i)
1462                             lappend html_log [_html_highlight BAD $line]
1463                             break
1464                         }
1465                     }
1466
1467                     # if it is not in todo, define status
1468                     if { ! $is_known } {
1469                         set stat [lindex $bw 0 0]
1470                         if {$errors} {
1471                             lappend errors_log $line
1472                         }
1473                         lappend html_log [_html_highlight $stat $line]
1474                         if { $status == "" && $stat != "OK" && ! [regexp -nocase {^IGNOR} $stat] } {
1475                             set status [lindex $bw 0]
1476                         }
1477                     }
1478                     set ismarked 1
1479                     break
1480                 }
1481             }
1482             if { ! $ismarked } { 
1483                lappend html_log $line
1484             }
1485         }
1486
1487         # check for presence of TEST COMPLETED statement
1488         if { $status == "" && ! [regexp {TEST COMPLETED} $log] } {
1489             # check whether absence of TEST COMPLETED is known problem
1490             if { $todo_incomplete >= 0 } {
1491                 incr todo_count($todo_incomplete)
1492             } else {
1493                 set status "FAILED (no final message is found)"
1494             }
1495         }
1496
1497         # report test as failed if it doesn't contain required pattern
1498         if { $status == "" } {
1499             for {set i 0} {$i < [llength $requs]} {incr i} {
1500                 if { ! [info exists required_count($i)] } {
1501                     set linenum [lindex $requs $i 1]
1502                     set html_log [lreplace $html_log $linenum $linenum [_html_highlight FAILED [lindex $requs $i 2]]]
1503                     set status "FAILED (REQUIRED statement no. [expr $i + 1] is not found)"
1504                 }
1505             }
1506         }
1507
1508         # check declared bad cases and diagnose possible improvement 
1509         # (bad case declared but not detected).
1510         # Note that absence of the problem marked by TODO with question mark
1511         # (unstable) is not reported as improvement.
1512         if { $status == "" } {
1513             for {set i 0} {$i < [llength $todos]} {incr i} {
1514                 if { ! [info exists todos_unstable($i)] &&
1515                      (! [info exists todo_count($i)] || $todo_count($i) <= 0) } {
1516                     set linenum [lindex $todos $i 1]
1517                     set html_log [lreplace $html_log $linenum $linenum [_html_highlight IMPROVEMENT [lindex $todos $i 2]]]
1518                     set status "IMPROVEMENT (expected problem TODO no. [expr $i + 1] is not detected)"
1519                     break;
1520                 }
1521             }
1522         }
1523
1524         # report test as known bad if at least one of expected problems is found
1525         if { $status == "" && [llength [array names todo_count]] > 0 } {
1526             set status "BAD (known problem)"
1527         }
1528
1529         # report normal OK
1530         if { $status == "" } {set status "OK" }
1531
1532     } res] {
1533         set status "FAILED ($res)"
1534     }
1535
1536     # put final message
1537     _log_and_puts summary "CASE $group $gridname $casename: $status"
1538     set summary [join $summary "\n"]
1539     if {$errors} {
1540         foreach error $errors_log {
1541             _log_and_puts summary "  $error"
1542         }
1543     }
1544     set html_log "[_html_highlight [lindex $status 0] $summary]\n[join $html_log \n]"
1545 }
1546
1547 # Auxiliary procedure putting message to both cout and log variable (list)
1548 proc _log_and_puts {logvar message} {
1549     if { $logvar != "" } { 
1550         upvar $logvar log
1551         lappend log $message
1552     }
1553     puts $message
1554 }
1555
1556 # Auxiliary procedure to log result on single test case
1557 proc _log_test_case {output logdir dir group grid casename logvar} {
1558     upvar $logvar log
1559     set show_errors 0
1560     # check result and make HTML log
1561     _check_log $dir $group $grid $casename $show_errors $output summary html_log
1562     lappend log $summary
1563
1564     # save log to file
1565     if { $logdir != "" } {
1566         _log_html $logdir/$group/$grid/$casename.html $html_log "Test $group $grid $casename"
1567         _log_save $logdir/$group/$grid/$casename.log "$output\n$summary" "Test $group $grid $casename"
1568     }
1569 }
1570
1571 # Auxiliary procedure to save log to file
1572 proc _log_save {file log {title {}}} {
1573     # create missing directories as needed
1574     catch {file mkdir [file dirname $file]}
1575
1576     # try to open a file
1577     if [catch {set fd [open $file w]} res] {
1578         error "Error saving log file $file: $res"
1579     }
1580     
1581     # dump log and close
1582     puts $fd "$title\n"
1583     puts $fd $log
1584     close $fd
1585     return
1586 }
1587
1588 # Auxiliary procedure to make a (relative if possible) URL to a file for 
1589 # inclusion a reference in HTML log
1590 proc _make_url {htmldir file} {
1591     set htmlpath [file split [file normalize $htmldir]]
1592     set filepath [file split [file normalize $file]]
1593     for {set i 0} {$i < [llength $htmlpath]} {incr i} {
1594         if { "[lindex $htmlpath $i]" != "[lindex $filepath $i]" } {
1595             if { $i == 0 } { break }
1596             return "[string repeat "../" [expr [llength $htmlpath] - $i - 1]][eval file join [lrange $filepath $i end]]"
1597         }
1598     }
1599
1600     # if relative path could not be made, return full file URL
1601     return "file://[file normalize $file]"
1602 }
1603
1604 # Auxiliary procedure to save log to file
1605 proc _log_html {file log {title {}}} {
1606     # create missing directories as needed
1607     catch {file mkdir [file dirname $file]}
1608
1609     # try to open a file
1610     if [catch {set fd [open $file w]} res] {
1611         error "Error saving log file $file: $res"
1612     }
1613     
1614     # print header
1615     puts $fd "<html><head><title>$title</title></head><body><h1>$title</h1>"
1616
1617     # add images if present; these should have either PNG, GIF, or JPG extension,
1618     # and start with name of the test script, with optional suffix separated
1619     # by underscore or dash
1620     set imgbasename [file rootname [file tail $file]]
1621     foreach img [lsort [glob -nocomplain -directory [file dirname $file] -tails \
1622                              ${imgbasename}.gif   ${imgbasename}.png   ${imgbasename}.jpg \
1623                              ${imgbasename}_*.gif ${imgbasename}_*.png ${imgbasename}_*.jpg \
1624                              ${imgbasename}-*.gif ${imgbasename}-*.png ${imgbasename}-*.jpg]] {
1625         puts $fd "<p>[file tail $img]<br><img src=\"$img\"/><p>"
1626     }
1627
1628     # print log body, trying to add HTML links to script files on lines like
1629     # "Executing <filename>..."
1630     puts $fd "<pre>"
1631     foreach line [split $log "\n"] {
1632         if { [regexp {Executing[ \t]+([a-zA-Z0-9._/:-]+[^.])} $line res script] &&
1633              [file exists $script] } {
1634             set line [regsub $script $line "<a href=\"[_make_url $file $script]\">$script</a>"]
1635         }
1636         puts $fd $line
1637     }
1638     puts $fd "</pre></body></html>"
1639
1640     close $fd
1641     return
1642 }
1643
1644 # Auxiliary method to make text with HTML highlighting according to status
1645 proc _html_color {status} {
1646     # choose a color for the cell according to result
1647     if { $status == "OK" } { 
1648         return lightgreen
1649     } elseif { [regexp -nocase {^FAIL} $status] } { 
1650         return ff8080
1651     } elseif { [regexp -nocase {^BAD} $status] } { 
1652         return yellow
1653     } elseif { [regexp -nocase {^IMP} $status] } { 
1654         return orange
1655     } elseif { [regexp -nocase {^SKIP} $status] } { 
1656         return gray
1657     } elseif { [regexp -nocase {^IGNOR} $status] } { 
1658         return gray
1659     } else {
1660         puts "Warning: no color defined for status $status, using red as if FAILED"
1661         return red
1662     }
1663 }
1664
1665 # Format text line in HTML to be colored according to the status
1666 proc _html_highlight {status line} {
1667     return "<table><tr><td bgcolor=\"[_html_color $status]\">$line</td></tr></table>"
1668 }
1669
1670 # Internal procedure to generate HTML page presenting log of the tests
1671 # execution in tabular form, with links to reports on individual cases
1672 proc _log_html_summary {logdir log totals regressions improvements skipped total_time} {
1673     global _test_case_regexp
1674
1675     # create missing directories as needed
1676     file mkdir $logdir
1677
1678     # try to open a file and start HTML
1679     if [catch {set fd [open $logdir/summary.html w]} res] {
1680         error "Error creating log file: $res"
1681     }
1682
1683     # write HRML header, including command to refresh log if still in progress
1684     puts $fd "<html><head>"
1685     puts $fd "<title>Tests summary</title>"
1686     if { $total_time == "" } {
1687         puts $fd "<meta http-equiv=\"refresh\" content=\"10\">"
1688     }
1689     puts $fd "<meta http-equiv=\"pragma\" content=\"NO-CACHE\">"
1690     puts $fd "</head><body>"
1691
1692     # put summary
1693     set legend(OK)          "Test passed OK"
1694     set legend(FAILED)      "Test failed (regression)"
1695     set legend(BAD)         "Known problem"
1696     set legend(IMPROVEMENT) "Possible improvement (expected problem not detected)"
1697     set legend(SKIPPED)     "Test skipped due to lack of data file"
1698     puts $fd "<h1>Summary</h1><table>"
1699     foreach nbstat $totals {
1700         set status [lindex $nbstat 1]
1701         if { [info exists legend($status)] } { 
1702             set comment $legend($status) 
1703         } else {
1704             set comment "User-defined status"
1705         }
1706         puts $fd "<tr><td align=\"right\">[lindex $nbstat 0]</td><td bgcolor=\"[_html_color $status]\">$status</td><td>$comment</td></tr>"
1707     }
1708     puts $fd "</table>"
1709
1710     # time stamp and elapsed time info
1711     if { $total_time != "" } { 
1712         puts $fd "<p>Generated on [clock format [clock seconds] -format {%Y-%m-%d %H:%M:%S}] on [info hostname]\n<p>"
1713         puts $fd [join [split $total_time "\n"] "<p>"]
1714     } else {
1715         puts $fd "<p>NOTE: This is intermediate summary; the tests are still running! This page will refresh automatically until tests are finished."
1716     }
1717    
1718     # print regressions and improvements
1719     foreach featured [list $regressions $improvements $skipped] {
1720         if { [llength $featured] <= 1 } { continue }
1721         set status [string trim [lindex $featured 0] { :}]
1722         puts $fd "<h2>$status</h2>"
1723         puts $fd "<table>"
1724         set groupgrid ""
1725         foreach test [lrange $featured 1 end] {
1726             if { ! [regexp {^(.*)\s+([\w\-.]+)$} $test res gg name] } {
1727                 set gg UNKNOWN
1728                 set name "Error building short list; check details"
1729             }
1730             if { $gg != $groupgrid } {
1731                 if { $groupgrid != "" } { puts $fd "</tr>" }
1732                 set groupgrid $gg
1733                 puts $fd "<tr><td>$gg</td>"
1734             }
1735             puts $fd "<td bgcolor=\"[_html_color $status]\"><a href=\"[regsub -all { } $gg /]/${name}.html\">$name</a></td>"
1736         }
1737         if { $groupgrid != "" } { puts $fd "</tr>" }
1738         puts $fd "</table>"
1739     }
1740
1741     # put detailed log with TOC
1742     puts $fd "<hr><h1>Details</h1>"
1743     puts $fd "<div style=\"float:right; padding: 10px; border-style: solid; border-color: blue; border-width: 2px;\">"
1744
1745     # process log line-by-line
1746     set group {}
1747     set letter {}
1748     set body {}
1749     foreach line [lsort -dictionary $log] {
1750         # check that the line is case report in the form "CASE group grid name: result (explanation)"
1751         if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } {
1752             continue
1753         }
1754
1755         # start new group
1756         if { $grp != $group } {
1757             if { $letter != "" } { lappend body "</tr></table>" }
1758             set letter {}
1759             set group $grp
1760             set grid {}
1761             puts $fd "<a href=\"#$group\">$group</a><br>"
1762             lappend body "<h2><a name=\"$group\">Group $group</a></h2>"
1763         }
1764
1765         # start new grid
1766         if { $grd != $grid } {
1767             if { $letter != "" } { lappend body "</tr></table>" }
1768             set letter {}
1769             set grid $grd
1770             puts $fd "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"#$group-$grid\">$grid</a><br>"
1771             lappend body "<h2><a name=\"$group-$grid\">Grid $group $grid</a></h2>"
1772         }
1773
1774         # check if test case name is <letter><digit>; 
1775         # if not, set alnum to period "." to recognize non-standard test name
1776         if { ! [regexp {\A([A-Za-z]{1,2})([0-9]{1,2})\Z} $casename res alnum number] &&
1777              ! [regexp {\A([A-Za-z0-9]+)_([0-9]+)\Z} $casename res alnum number] } {
1778             set alnum $casename
1779         }
1780
1781         # start new row when letter changes or for non-standard names
1782         if { $alnum != $letter || $alnum == "." } {
1783             if { $letter != "" } { 
1784                 lappend body "</tr><tr>" 
1785             } else {
1786                 lappend body "<table><tr>"
1787             }
1788             set letter $alnum
1789         }    
1790
1791         lappend body "<td bgcolor=\"[_html_color $result]\"><a href=\"$group/$grid/${casename}.html\">$casename</a></td>"
1792     }
1793     puts $fd "</div>\n[join $body "\n"]</tr></table>"
1794
1795     # add remaining lines of log as plain text
1796     puts $fd "<h2>Plain text messages</h2>\n<pre>"
1797     foreach line $log {
1798         if { ! [regexp $_test_case_regexp $line] } {
1799             puts $fd "$line"
1800         }
1801     }
1802     puts $fd "</pre>"
1803
1804     # close file and exit
1805     puts $fd "</body>"
1806     close $fd
1807     return
1808 }
1809
1810 # Procedure to dump summary logs of tests
1811 proc _log_summarize {logdir log {total_time {}}} {
1812
1813     # sort log records alphabetically to have the same behavior on Linux and Windows 
1814     # (also needed if tests are run in parallel)
1815     set loglist [lsort -dictionary $log]
1816
1817     # classify test cases by status
1818     foreach line $loglist {
1819         if { [regexp {^CASE ([^:]*): ([[:alnum:]]+).*$} $line res caseid status] } {
1820             lappend stat($status) $caseid
1821         }
1822     }
1823     set totals {}
1824     set improvements {Improvements:}
1825     set regressions {Failed:}
1826     set skipped {Skipped:}
1827     if { [info exists stat] } {
1828         foreach status [lsort [array names stat]] {
1829             lappend totals [list [llength $stat($status)] $status]
1830
1831             # separately count improvements (status starting with IMP), skipped (status starting with SKIP) and regressions (all except IMP, OK, BAD, and SKIP)
1832             if { [regexp -nocase {^IMP} $status] } {
1833                 eval lappend improvements $stat($status)
1834             } elseif { [regexp -nocase {^SKIP} $status] } {
1835                 eval lappend skipped $stat($status)
1836             } elseif { $status != "OK" && ! [regexp -nocase {^BAD} $status] && ! [regexp -nocase {^SKIP} $status] } {
1837                 eval lappend regressions $stat($status)
1838             }
1839         }
1840     }
1841
1842     # if time is specified, add totals
1843     if { $total_time != "" } {
1844         if { [llength $improvements] > 1 } {
1845             _log_and_puts log [join $improvements "\n  "]
1846         }
1847         if { [llength $regressions] > 1 } {
1848             _log_and_puts log [join $regressions "\n  "]
1849         }
1850         if { [llength $skipped] > 1 } {
1851             _log_and_puts log [join $skipped "\n  "]
1852         }
1853         if { [llength $improvements] == 1 && [llength $regressions] == 1 } {
1854             _log_and_puts log "No regressions"
1855         }
1856         _log_and_puts log "Total cases: [join $totals {, }]"
1857         _log_and_puts log $total_time
1858     }
1859
1860     # save log to files
1861     if { $logdir != "" } {
1862         _log_html_summary $logdir $log $totals $regressions $improvements $skipped $total_time
1863         _log_save $logdir/tests.log [join $log "\n"] "Tests summary"
1864     }
1865
1866     return
1867 }
1868
1869 # Internal procedure to generate XML log in JUnit style, for further
1870 # consumption by Jenkins or similar systems.
1871 #
1872 # The output is intended to conform to XML schema supported by Jenkins found at
1873 # 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
1874 #
1875 # The mapping of the fields is inspired by annotated schema of Apache Ant JUnit XML format found at
1876 # http://windyroad.org/dl/Open%20Source/JUnit.xsd
1877 proc _log_xml_summary {logdir filename log include_cout} {
1878     global _test_case_regexp
1879
1880     catch {file mkdir [file dirname $filename]}
1881
1882     # try to open a file and start XML
1883     if [catch {set fd [open $filename w]} res] {
1884         error "Error creating XML summary file $filename: $res"
1885     }
1886     puts $fd "<?xml version='1.0' encoding='utf-8'?>"
1887     puts $fd "<testsuites>"
1888
1889     # prototype for command to generate test suite tag
1890     set time_and_host "timestamp=\"[clock format [clock seconds] -format {%Y-%m-%dT%H:%M:%S}]\" hostname=\"[info hostname]\""
1891     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"}
1892
1893     # sort log and process it line-by-line
1894     set group {}
1895     foreach line [lsort -dictionary $log] {
1896         # check that the line is case report in the form "CASE group grid name: result (explanation)"
1897         if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } {
1898             continue
1899         }
1900         set message [string trim $message " \t\r\n()"]
1901
1902         # start new testsuite for each grid
1903         if { $grp != $group || $grd != $grid } {
1904
1905             # write previous test suite
1906             if [info exists testcases] { eval $cmd_testsuite }
1907
1908             set testcases {}
1909             set nbtests 0
1910             set nberr 0
1911             set nbfail 0
1912             set nbskip 0
1913             set time 0.
1914
1915             set group $grp
1916             set grid $grd
1917         }
1918
1919         incr nbtests
1920  
1921         # parse test log and get its CPU time
1922         set testout {}
1923         set add_cpu {}
1924         if { [catch {set fdlog [open $logdir/$group/$grid/${casename}.log r]} ret] } { 
1925             puts "Error: cannot open $logdir/$group/$grid/${casename}.log: $ret"
1926         } else {
1927             while { [gets $fdlog logline] >= 0 } {
1928                 if { $include_cout } {
1929                     append testout "$logline\n"
1930                 }
1931                 if [regexp -nocase {TOTAL CPU TIME:\s*([\d.]+)\s*sec} $logline res cpu] {
1932                     set add_cpu " time=\"$cpu\""
1933                     set time [expr $time + $cpu]
1934                 }
1935             }
1936             close $fdlog
1937         }
1938         if { ! $include_cout } {
1939             set testout "$line\n"
1940         }
1941
1942         # record test case with its output and status
1943         # Mapping is: SKIPPED, BAD, and OK to OK, all other to failure
1944         append testcases "\n  <testcase name=\"$casename\"$add_cpu status=\"$result\">\n"
1945         append testcases "\n    <system-out>\n$testout    </system-out>"
1946         if { $result != "OK" } {
1947             if { [regexp -nocase {^SKIP} $result] } {
1948                 incr nberr
1949                 append testcases "\n    <error name=\"$result\" message=\"$message\"/>"
1950             } elseif { [regexp -nocase {^BAD} $result] } {
1951                 incr nbskip
1952                 append testcases "\n    <skipped>$message</skipped>"
1953             } else {
1954                 incr nbfail
1955                 append testcases "\n    <failure name=\"$result\" message=\"$message\"/>"
1956             }
1957         }
1958         append testcases "\n  </testcase>"
1959     }
1960
1961     # write last test suite
1962     if [info exists testcases] { eval $cmd_testsuite }
1963
1964     # the end
1965     puts $fd "</testsuites>"
1966     close $fd
1967     return
1968 }
1969
1970 # Auxiliary procedure to split path specification (usually defined by
1971 # environment variable) into list of directories or files
1972 proc _split_path {pathspec} {
1973     global tcl_platform
1974
1975     # first replace all \ (which might occur on Windows) by /  
1976     regsub -all "\\\\" $pathspec "/" pathspec
1977
1978     # split path by platform-specific separator
1979     return [split $pathspec [_path_separator]]
1980 }
1981
1982 # Auxiliary procedure to define platform-specific separator for directories in
1983 # path specification
1984 proc _path_separator {} {
1985     global tcl_platform
1986
1987     # split path by platform-specific separator
1988     if { $tcl_platform(platform) == "windows" } {
1989         return ";"
1990     } else {
1991         return ":"
1992     }
1993 }
1994
1995 # Procedure to make a diff and common of two lists
1996 proc _list_diff {list1 list2 _in1 _in2 _common} {
1997     upvar $_in1 in1
1998     upvar $_in2 in2
1999     upvar $_common common
2000
2001     set in1 {}
2002     set in2 {}
2003     set common {}
2004     foreach item $list1 {
2005         if { [lsearch -exact $list2 $item] >= 0 } {
2006             lappend common $item
2007         } else {
2008             lappend in1 $item
2009         }
2010     }
2011     foreach item $list2 {
2012         if { [lsearch -exact $common $item] < 0 } {
2013             lappend in2 $item
2014         }
2015     }
2016     return
2017 }
2018
2019 # procedure to load a file to Tcl string
2020 proc _read_file {filename} {
2021     set fd [open $filename r]
2022     set result [read -nonewline $fd]
2023     close $fd
2024     return $result
2025 }
2026
2027 # procedure to construct name for the mage diff file
2028 proc _diff_img_name {dir1 dir2 casepath imgfile} {
2029     return [file join $dir1 $casepath "diff-[file tail $dir2]-$imgfile"]
2030 }
2031
2032 # auxiliary procedure to produce string comparing two values
2033 proc _diff_show_ratio {value1 value2} {
2034     if {[expr double ($value2)] == 0.} {
2035         return "$value1 / $value2"
2036     } else {
2037         return "$value1 / $value2 \[[format "%+5.2f%%" [expr 100 * ($value1 - $value2) / double($value2)]]\]"
2038     }
2039 }
2040
2041 # procedure to check cpu user time
2042 proc _check_time {regexp_msg} {
2043     upvar log log
2044     upvar log1 log1
2045     upvar log2 log2
2046     upvar log_cpu log_cpu
2047     upvar cpu cpu
2048     upvar basename basename
2049     upvar casename casename
2050     set time1_list [dict create]
2051     set time2_list [dict create]
2052     set cpu_find UNDEFINED
2053
2054     foreach line1 [split $log1 "\n"] {
2055         if { [regexp "${regexp_msg}" $line1 dump chronometer_name cpu_find] } {
2056             dict set time1_list "${chronometer_name}" "${cpu_find}"
2057         }
2058     }
2059
2060     foreach line2 [split $log2 "\n"] {
2061         if { [regexp "${regexp_msg}" $line2 dump chronometer_name cpu_find] } {
2062             dict set time2_list "${chronometer_name}" "${cpu_find}"
2063         }
2064     }
2065
2066     if { [llength [dict keys $time1_list]] != [llength [dict keys $time2_list]] } {
2067         puts "Error: number of dchrono/chrono COUNTER are different in the same test cases"
2068     } else {
2069         foreach key [dict keys $time1_list] {
2070             set time1 [dict get $time1_list $key]
2071             set time2 [dict get $time2_list $key]
2072
2073             # compare CPU user time with 10% precision (but not less 0.5 sec)
2074             if { [expr abs ($time1 - $time2) > 0.5 + 0.05 * abs ($time1 + $time2)] } {
2075                 if {$cpu != false} {
2076                     _log_and_puts log_cpu "COUNTER $key: [split $basename /] $casename: [_diff_show_ratio $time1 $time2]"
2077                 } else {
2078                     _log_and_puts log "COUNTER $key: [split $basename /] $casename: [_diff_show_ratio $time1 $time2]"
2079                 }
2080             }
2081         }
2082     }
2083 }
2084
2085 # Procedure to compare results of two runs of test cases
2086 proc _test_diff {dir1 dir2 basename image cpu memory status verbose _logvar _logimage _logcpu _logmemory {_statvar ""}} {
2087     upvar $_logvar log
2088     upvar $_logimage log_image
2089     upvar $_logcpu log_cpu
2090     upvar $_logmemory log_memory
2091
2092     # make sure to load diffimage command
2093     uplevel pload VISUALIZATION
2094
2095     # prepare variable (array) for collecting statistics
2096     if { "$_statvar" != "" } {
2097         upvar $_statvar stat
2098     } else {
2099         set stat(cpu1) 0
2100         set stat(cpu2) 0
2101         set stat(mem1) 0
2102         set stat(mem2) 0
2103         set log {}
2104         set log_image {}
2105         set log_cpu {}
2106         set log_memory {}
2107     }
2108
2109     # first check subdirectories
2110     set path1 [file join $dir1 $basename]
2111     set path2 [file join $dir2 $basename]
2112     set list1 [glob -directory $path1 -types d -tails -nocomplain *]
2113     set list2 [glob -directory $path2 -types d -tails -nocomplain *]
2114     if { [llength $list1] >0 || [llength $list2] > 0 } {
2115         _list_diff $list1 $list2 in1 in2 common
2116         if { "$verbose" > 1 } {
2117             if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" }
2118             if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" }
2119         }
2120         foreach subdir $common {
2121             if { "$verbose" > 2 } {
2122                 _log_and_puts log "Checking [file join $basename $subdir]"
2123             }
2124             _test_diff $dir1 $dir2 [file join $basename $subdir] $image $cpu $memory $status $verbose log log_image log_cpu log_memory stat
2125         }
2126     } else {
2127         # check log files (only if directory has no subdirs)
2128         set list1 [glob -directory $path1 -types f -tails -nocomplain *.log]
2129         set list2 [glob -directory $path2 -types f -tails -nocomplain *.log]
2130         _list_diff $list1 $list2 in1 in2 common
2131         if { "$verbose" > 1 } {
2132             if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" }
2133             if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" }
2134         }
2135         set gcpu1 0
2136         set gcpu2 0
2137         set gmem1 0
2138         set gmem2 0
2139         foreach logfile $common {
2140             # load two logs
2141             set log1 [_read_file [file join $dir1 $basename $logfile]]
2142             set log2 [_read_file [file join $dir2 $basename $logfile]]
2143             set casename [file rootname $logfile]
2144             
2145             # check execution statuses
2146             if {$image == false && $cpu == false && $memory == false} {
2147                 set status1 UNDEFINED
2148                 set status2 UNDEFINED
2149                 if { ! [regexp {CASE [^:]*:\s*([\w]+)} $log1 res1 status1] ||
2150                     ! [regexp {CASE [^:]*:\s*([\w]+)} $log2 res2 status2] ||
2151                     "$status1" != "$status2" } {
2152                     _log_and_puts log "STATUS [split $basename /] $casename: $status1 / $status2"
2153                     # if test statuses are different, further comparison makes 
2154                     # no sense unless explicitly requested
2155                     if { "$status" != "all" } {
2156                         continue
2157                     }
2158                 }
2159                 if { "$status" == "ok" && "$status1" != "OK" } { 
2160                     continue
2161                 }
2162             }
2163
2164             if { ! $image } {
2165                 # check CPU user time in test cases
2166                 set checkCPURegexp "COUNTER (.+): (\[-0-9.+eE\]+)"
2167                 if { [regexp "${checkCPURegexp}" $log1] &&
2168                      [regexp "${checkCPURegexp}" $log2] } {
2169                   _check_time "${checkCPURegexp}"
2170                 }
2171             }
2172             
2173             # check CPU times
2174             if {$cpu != false || ($image == false && $cpu == false && $memory == false)} {
2175                 set cpu1 UNDEFINED
2176                 set cpu2 UNDEFINED
2177                 if { [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log1 res1 cpu1] &&
2178                      [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log2 res1 cpu2] } {
2179                     set stat(cpu1) [expr $stat(cpu1) + $cpu1]
2180                     set stat(cpu2) [expr $stat(cpu2) + $cpu2]
2181                     set gcpu1 [expr $gcpu1 + $cpu1]
2182                     set gcpu2 [expr $gcpu2 + $cpu2]
2183
2184                     # compare CPU times with 10% precision (but not less 0.5 sec)
2185                     if { [expr abs ($cpu1 - $cpu2) > 0.5 + 0.05 * abs ($cpu1 + $cpu2)] } {
2186                         if {$cpu != false} {
2187                             _log_and_puts log_cpu "CPU [split $basename /] $casename: [_diff_show_ratio $cpu1 $cpu2]"
2188                         } else {
2189                             _log_and_puts log "CPU [split $basename /] $casename: [_diff_show_ratio $cpu1 $cpu2]"
2190                         }
2191                     }
2192                 }
2193             }
2194
2195             # check memory delta
2196             if {$memory != false || ($image == false && $cpu == false && $memory == false)} {
2197                 set mem1 UNDEFINED
2198                 set mem2 UNDEFINED
2199                 if { [regexp {MEMORY DELTA:\s*([\d.]+)} $log1 res1 mem1] &&
2200                      [regexp {MEMORY DELTA:\s*([\d.]+)} $log2 res1 mem2] } {
2201                     set stat(mem1) [expr $stat(mem1) + $mem1]
2202                     set stat(mem2) [expr $stat(mem2) + $mem2]
2203                     set gmem1 [expr $gmem1 + $mem1]
2204                     set gmem2 [expr $gmem2 + $mem2]
2205
2206                     # compare memory usage with 10% precision (but not less 16 KiB)
2207                     if { [expr abs ($mem1 - $mem2) > 16 + 0.05 * abs ($mem1 + $mem2)] } {
2208                         if {$memory != false} {
2209                             _log_and_puts log_memory "MEMORY [split $basename /] $casename: [_diff_show_ratio $mem1 $mem2]"
2210                         } else {
2211                             _log_and_puts log "MEMORY [split $basename /] $casename: [_diff_show_ratio $mem1 $mem2]"
2212                         }
2213                     }
2214                 }
2215             }
2216
2217             # check images
2218             if {$image != false || ($image == false && $cpu == false && $memory == false)} {
2219                 set aCaseDiffColorTol 0
2220                 if { [regexp {IMAGE_COLOR_TOLERANCE:\s*([\d.]+)} $log1 res1 imgtol1] } { set aCaseDiffColorTol $imgtol1 }
2221                 set imglist1 [glob -directory $path1 -types f -tails -nocomplain ${casename}.{png,gif} ${casename}-*.{png,gif} ${casename}_*.{png,gif}]
2222                 set imglist2 [glob -directory $path2 -types f -tails -nocomplain ${casename}.{png,gif} ${casename}-*.{png,gif} ${casename}_*.{png,gif}]
2223                 _list_diff $imglist1 $imglist2 imgin1 imgin2 imgcommon
2224                 if { "$verbose" > 1 } {
2225                     if { [llength $imgin1] > 0 } {
2226                         if {$image != false} {
2227                             _log_and_puts log_image "Only in $path1: $imgin1"
2228                         } else {
2229                             _log_and_puts log "Only in $path1: $imgin1"
2230                         }
2231                     }
2232                     if { [llength $imgin2] > 0 } {
2233                         if {$image != false} {
2234                             _log_and_puts log_image "Only in $path2: $imgin2"
2235                         } else {
2236                             _log_and_puts log "Only in $path2: $imgin2"
2237                         }
2238                     }
2239                 }
2240                 foreach imgfile $imgcommon {
2241                     # if { $verbose > 1 } { _log_and_puts log "Checking [split basename /] $casename: $imgfile" }
2242                     set diffile [_diff_img_name $dir1 $dir2 $basename $imgfile]
2243                     if { [catch {diffimage [file join $dir1 $basename $imgfile] \
2244                                            [file join $dir2 $basename $imgfile] \
2245                                            -toleranceOfColor 0.0 -blackWhite off -borderFilter off $diffile} diff] } {
2246                         if {$image != false} {
2247                             _log_and_puts log_image "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
2248                         } else {
2249                             _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
2250                         }
2251                         file delete -force $diffile ;# clean possible previous result of diffimage
2252                     } elseif { $diff != 0 } {
2253                         set diff [string trimright $diff \n]
2254                         if {$aCaseDiffColorTol != 0} {
2255                             # retry with color tolerance
2256                             if { [catch {diffimage [file join $dir1 $basename $imgfile] \
2257                                                    [file join $dir2 $basename $imgfile] \
2258                                                    -toleranceOfColor $aCaseDiffColorTol -blackWhite off -borderFilter off $diffile} diff2] } {
2259                                 if {$image != false} {
2260                                     _log_and_puts log_image "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
2261                                 } else {
2262                                     _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
2263                                 }
2264                                 continue
2265                             } elseif { $diff2 == 0 } {
2266                                 # exclude image diff within tolerance but still keep info in the log
2267                                 set toLogImageCase false
2268                                 file delete -force $diffile
2269                                 if {$image != false} {
2270                                     _log_and_puts log_image "IMAGE [split $basename /] $casename: $imgfile is similar \[$diff different pixels\]"
2271                                 } else {
2272                                     _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile is similar \[$diff different pixels\]"
2273                                 }
2274                                 continue
2275                             }
2276                         }
2277
2278                         if {$image != false} {
2279                             _log_and_puts log_image "IMAGE [split $basename /] $casename: $imgfile differs \[$diff different pixels\]"
2280                         } else {
2281                             _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile differs \[$diff different pixels\]"
2282                         }
2283                     } else {
2284                         file delete -force $diffile ;# clean useless artifact of diffimage
2285                     }
2286                 }
2287             }
2288         }
2289         
2290         # report CPU and memory difference in group if it is greater than 10%
2291         if {$cpu != false || ($image == false && $cpu == false && $memory == false)} {
2292             if { [expr abs ($gcpu1 - $gcpu2) > 0.5 + 0.005 * abs ($gcpu1 + $gcpu2)] } {
2293                 if {$cpu != false} {
2294                     _log_and_puts log_cpu "CPU [split $basename /]: [_diff_show_ratio $gcpu1 $gcpu2]"
2295                 } else {
2296                     _log_and_puts log "CPU [split $basename /]: [_diff_show_ratio $gcpu1 $gcpu2]"
2297                 }
2298             }
2299         }
2300         if {$memory != false || ($image == false && $cpu == false && $memory == false)} {
2301             if { [expr abs ($gmem1 - $gmem2) > 16 + 0.005 * abs ($gmem1 + $gmem2)] } {
2302                 if {$memory != false} {
2303                     _log_and_puts log_memory "MEMORY [split $basename /]: [_diff_show_ratio $gmem1 $gmem2]"
2304                 } else {
2305                     _log_and_puts log "MEMORY [split $basename /]: [_diff_show_ratio $gmem1 $gmem2]"
2306                 }
2307             }
2308         }
2309     }
2310
2311     if { "$_statvar" == "" } {
2312         if {$memory != false || ($image == false && $cpu == false && $memory == false)} {
2313             if {$memory != false} {
2314                 _log_and_puts log_memory "Total MEMORY difference: [_diff_show_ratio $stat(mem1) $stat(mem2)]"
2315             } else {
2316                 _log_and_puts log "Total MEMORY difference: [_diff_show_ratio $stat(mem1) $stat(mem2)]"
2317             }
2318         }
2319         if {$cpu != false || ($image == false && $cpu == false && $memory == false)} {
2320             if {$cpu != false} {
2321                 _log_and_puts log_cpu "Total CPU difference: [_diff_show_ratio $stat(cpu1) $stat(cpu2)]"
2322             } else {
2323                 _log_and_puts log "Total CPU difference: [_diff_show_ratio $stat(cpu1) $stat(cpu2)]"
2324             }
2325         }
2326     }
2327 }
2328
2329 # Auxiliary procedure to save log of results comparison to file
2330 proc _log_html_diff {file log dir1 dir2 highlight_percent} {
2331     # create missing directories as needed
2332     catch {file mkdir [file dirname $file]}
2333
2334     # try to open a file
2335     if [catch {set fd [open $file w]} res] {
2336         error "Error saving log file $file: $res"
2337     }
2338     
2339     # print header
2340     puts $fd "<html><head><title>Diff $dir1 vs. $dir2</title></head><body>"
2341     puts $fd "<h1>Comparison of test results:</h1>"
2342     puts $fd "<h2>Version A \[NEW\] - $dir1</h2>"
2343     puts $fd "<h2>Version B \[REF\] - $dir2</h2>"
2344
2345     # add script for switching between images on click
2346     puts $fd ""
2347     puts $fd "<script type=\"text/javascript\">"
2348     puts $fd "  function diffimage_toggle(img,url1,url2)"
2349     puts $fd "  {"
2350     puts $fd "    if (img.show2nd) { img.src = url1; img.show2nd = false; }"
2351     puts $fd "    else { img.src = url2; img.show2nd = true; }"
2352     puts $fd "  }"
2353     puts $fd "  function diffimage_reset(img,url) { img.src = url; img.show2nd = true; }"
2354     puts $fd "</script>"
2355     puts $fd ""
2356
2357     # print log body
2358     puts $fd "<pre>"
2359     set logpath [file split [file normalize $file]]
2360     foreach line $log {
2361         # put a line; highlight considerable (> ${highlight_percent}%) deviations of CPU and memory
2362         if { [regexp "\[\\\[](\[0-9.e+-]+)%\[\]]" $line res value] && 
2363              [expr abs($value)] > ${highlight_percent} } {
2364             puts $fd "<table><tr><td bgcolor=\"[expr $value > 0 ? \"ff8080\" : \"lightgreen\"]\">$line</td></tr></table>"
2365         } elseif { [regexp {IMAGE[ \t]+([^:]+):[ \t]+([A-Za-z0-9_.-]+) is similar} $line res case img] } {
2366             if { [catch {eval file join "" [lrange $case 0 end-1]} gridpath] } {
2367                 # note: special handler for the case if test grid directoried are compared directly
2368                 set gridpath ""
2369             }
2370             set aCaseName [lindex $case end]
2371             puts $fd "<table><tr><td bgcolor=\"orange\"><a href=\"[_make_url $file [file join $dir1 $gridpath $aCaseName.html]]\">$line</a></td></tr></table>"
2372         } elseif { [regexp {IMAGE[ \t]+([^:]+):[ \t]+([A-Za-z0-9_.-]+)} $line res case img] } {
2373             # add images
2374             puts $fd $line
2375             if { [catch {eval file join "" [lrange $case 0 end-1]} gridpath] } {
2376                 # note: special handler for the case if test grid directoried are compared directly
2377                 set gridpath ""
2378             }
2379             set aCaseName [lindex $case end]
2380             set img1url [_make_url $file [file join $dir1 $gridpath $img]]
2381             set img2url [_make_url $file [file join $dir2 $gridpath $img]]
2382             set img1 "<a href=\"[_make_url $file [file join $dir1 $gridpath $aCaseName.html]]\"><img src=\"$img1url\"></a>"
2383             set img2 "<a href=\"[_make_url $file [file join $dir2 $gridpath $aCaseName.html]]\"><img src=\"$img2url\"></a>"
2384
2385             set difffile [_diff_img_name $dir1 $dir2 $gridpath $img]
2386             set imgdurl [_make_url $file $difffile]
2387             if { [file exists $difffile] } {
2388                 set imgd "<img src=\"$imgdurl\" onmouseout=diffimage_reset(this,\"$imgdurl\") onclick=diffimage_toggle(this,\"$img1url\",\"$img2url\")>"
2389             } else {
2390                 set imgd "N/A"
2391             }
2392
2393             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>"
2394             puts $fd "<tr><td>$img1</td><td>$img2</td><td>$imgd</td></tr></table>"
2395         } else {
2396             puts $fd $line
2397         }
2398     }
2399     puts $fd "</pre></body></html>"
2400
2401     close $fd
2402     return
2403 }
2404
2405 # get number of CPUs on the system
2406 proc _get_nb_cpus {} {
2407     global tcl_platform env
2408
2409     if { "$tcl_platform(platform)" == "windows" } {
2410         # on Windows, take the value of the environment variable 
2411         if { [info exists env(NUMBER_OF_PROCESSORS)] &&
2412              ! [catch {expr $env(NUMBER_OF_PROCESSORS) > 0} res] && $res >= 0 } {
2413             return $env(NUMBER_OF_PROCESSORS)
2414         }
2415     } elseif { "$tcl_platform(os)" == "Linux" } {
2416         # on Linux, take number of logical processors listed in /proc/cpuinfo
2417         if { [catch {open "/proc/cpuinfo" r} fd] } { 
2418             return 0 ;# should never happen, but...
2419         }
2420         set nb 0
2421         while { [gets $fd line] >= 0 } {
2422             if { [regexp {^processor[ \t]*:} $line] } {
2423                 incr nb
2424             }
2425         }
2426         close $fd
2427         return $nb
2428     } elseif { "$tcl_platform(os)" == "Darwin" } {
2429         # on MacOS X, call sysctl command
2430         if { ! [catch {exec sysctl hw.ncpu} ret] && 
2431              [regexp {^hw[.]ncpu[ \t]*:[ \t]*([0-9]+)} $ret res nb] } {
2432             return $nb
2433         }
2434     }
2435
2436     # if cannot get good value, return 0 as default
2437     return 0
2438 }
2439
2440 # check two files for difference
2441 proc _diff_files {file1 file2} {
2442     set fd1 [open $file1 "r"]
2443     set fd2 [open $file2 "r"]
2444
2445     set differ f
2446     while {! $differ} {
2447         set nb1 [gets $fd1 line1]
2448         set nb2 [gets $fd2 line2]
2449         if { $nb1 != $nb2 } { set differ t; break }
2450         if { $nb1 < 0 } { break }
2451         if { [string compare $line1 $line2] } {
2452             set differ t
2453         }
2454     }
2455
2456     close $fd1
2457     close $fd2
2458
2459     return $differ
2460 }
2461
2462 # Check if file is in DOS encoding.
2463 # This check is done by presence of \r\n combination at the end of the first 
2464 # line (i.e. prior to any other \n symbol).
2465 # Note that presence of non-ascii symbols typically used for recognition
2466 # of binary files is not suitable since some IGES and STEP files contain
2467 # non-ascii symbols.
2468 # Special check is added for PNG files which contain \r\n in the beginning.
2469 proc _check_dos_encoding {file} {
2470     set fd [open $file rb]
2471     set isdos f
2472     if { [gets $fd line] && [regexp {.*\r$} $line] && 
2473          ! [regexp {^.PNG} $line] } {
2474         set isdos t
2475     }
2476     close $fd
2477     return $isdos
2478 }
2479
2480 # procedure to recognize format of a data file by its first symbols (for OCCT 
2481 # BREP and geometry DRAW formats, IGES, and STEP) and extension (all others)
2482 proc _check_file_format {file} {
2483     set fd [open $file rb]
2484     set line [read $fd 1024]
2485     close $fd
2486
2487     set warn f
2488     set ext [file extension $file]
2489     set format unknown
2490     if { [regexp {^DBRep_DrawableShape} $line] } {
2491         set format BREP
2492         if { "$ext" != ".brep" && "$ext" != ".rle" && 
2493              "$ext" != ".draw" && "$ext" != "" } {
2494             set warn t
2495         }
2496     } elseif { [regexp {^DrawTrSurf_} $line] } {
2497         set format DRAW
2498         if { "$ext" != ".rle" && 
2499              "$ext" != ".draw" && "$ext" != "" } {
2500             set warn t
2501         }
2502     } elseif { [regexp {^[ \t]*ISO-10303-21} $line] } {
2503         set format STEP
2504         if { "$ext" != ".step" && "$ext" != ".stp" } {
2505             set warn t
2506         }
2507     } elseif { [regexp {^.\{72\}S[0 ]\{6\}1} $line] } {
2508         set format IGES
2509         if { "$ext" != ".iges" && "$ext" != ".igs" } {
2510             set warn t
2511         }
2512     } elseif { "$ext" == ".igs" } {
2513         set format IGES
2514     } elseif { "$ext" == ".stp" } {
2515         set format STEP
2516     } else {
2517         set format [string toupper [string range $ext 1 end]]
2518     }
2519     
2520     if { $warn } {
2521         puts "$file: Warning: extension ($ext) does not match format ($format)"
2522     }
2523
2524     return $format
2525 }
2526
2527 # procedure to load file knowing its format
2528 proc load_data_file {file format shape} {
2529     switch $format {
2530         BREP { uplevel restore $file $shape }
2531         DRAW { uplevel restore $file $shape }
2532         IGES { pload XSDRAW; uplevel igesbrep $file $shape * }
2533         STEP { pload XSDRAW; uplevel stepread $file __a *; uplevel renamevar __a_1 $shape }
2534         STL  { pload XSDRAW; uplevel readstl $shape $file triangulation }
2535         default { error "Cannot read $format file $file" }
2536     }
2537 }
2538
2539 # procedure to get name of temporary directory,
2540 # ensuring it is existing and writeable 
2541 proc _get_temp_dir {} {
2542     global env tcl_platform
2543
2544     # check typical environment variables 
2545     foreach var {TempDir Temp Tmp} {
2546         # check different case
2547         foreach name [list [string toupper $var] $var [string tolower $var]] {
2548             if { [info exists env($name)] && [file isdirectory $env($name)] &&
2549                  [file writable $env($name)] } {
2550                 return [regsub -all {\\} $env($name) /]
2551             }
2552         }
2553     }
2554
2555     # check platform-specific locations
2556     set fallback tmp
2557     if { "$tcl_platform(platform)" == "windows" } {
2558         set paths "c:/TEMP c:/TMP /TEMP /TMP"
2559         if { [info exists env(HOMEDRIVE)] && [info exists env(HOMEPATH)] } {
2560             set fallback [regsub -all {\\} "$env(HOMEDRIVE)$env(HOMEPATH)/tmp" /]
2561         }
2562     } else {
2563         set paths "/tmp /var/tmp /usr/tmp"
2564         if { [info exists env(HOME)] } {
2565             set fallback "$env(HOME)/tmp"
2566         }
2567     }
2568     foreach dir $paths {
2569         if { [file isdirectory $dir] && [file writable $dir] } {
2570             return $dir
2571         }
2572     }
2573
2574     # fallback case: use subdir /tmp of home or current dir
2575     file mkdir $fallback
2576     return $fallback
2577 }
2578
2579 # extract of code from testgrid command used to process jobs running in 
2580 # parallel until number of jobs in the queue becomes equal or less than 
2581 # specified value
2582 proc _testgrid_process_jobs {worker {nb_ok 0}} {
2583     # bind local vars to variables of the caller procedure
2584     upvar log log
2585     upvar logdir logdir
2586     upvar job_def job_def
2587     upvar nbpooled nbpooled
2588     upvar userbreak userbreak
2589     upvar refresh refresh
2590     upvar refresh_timer refresh_timer
2591
2592     catch {tpool::resume $worker}
2593     while { ! $userbreak && $nbpooled > $nb_ok } {
2594         foreach job [tpool::wait $worker [array names job_def]] {
2595             eval _log_test_case \[tpool::get $worker $job\] $job_def($job) log
2596             unset job_def($job)
2597             incr nbpooled -1
2598         }
2599
2600         # check for user break
2601         if { "[info commands dbreak]" == "dbreak" && [catch dbreak] } {
2602             set userbreak 1
2603         }
2604
2605         # update summary log with requested period
2606         if { $logdir != "" && $refresh > 0 && [clock seconds] > $refresh_timer + $refresh } {
2607             _log_summarize $logdir $log
2608             set refresh_timer [clock seconds]
2609         }
2610     }
2611     catch {tpool::suspend $worker}
2612 }
2613
2614 help checkcolor {
2615   Check pixel color.
2616   Use: checkcolor x y red green blue
2617   x y - pixel coordinates
2618   red green blue - expected pixel color (values from 0 to 1)
2619   Function check color with tolerance (5x5 area)
2620 }
2621 # Procedure to check color using command vreadpixel with tolerance
2622 proc checkcolor { coord_x coord_y rd_get gr_get bl_get } {
2623     puts "Coordinate x = $coord_x"
2624     puts "Coordinate y = $coord_y"
2625     puts "RED color of RGB is $rd_get"
2626     puts "GREEN color of RGB is $gr_get"
2627     puts "BLUE color of RGB is $bl_get"
2628
2629     if { $coord_x <= 1 || $coord_y <= 1 } {
2630         puts "Error : minimal coordinate is x = 2, y = 2. But we have x = $coord_x y = $coord_y"
2631         return -1
2632     }
2633
2634     set color ""
2635     catch { [set color "[vreadpixel ${coord_x} ${coord_y} rgb]"] }
2636     if {"$color" == ""} {
2637         puts "Error : Pixel coordinates (${position_x}; ${position_y}) are out of view"
2638     }
2639     set rd [lindex $color 0]
2640     set gr [lindex $color 1]
2641     set bl [lindex $color 2]
2642     set rd_int [expr int($rd * 1.e+05)]
2643     set gr_int [expr int($gr * 1.e+05)]
2644     set bl_int [expr int($bl * 1.e+05)]
2645     set rd_ch [expr int($rd_get * 1.e+05)]
2646     set gr_ch [expr int($gr_get * 1.e+05)]
2647     set bl_ch [expr int($bl_get * 1.e+05)]
2648
2649     if { $rd_ch != 0 } {
2650         set tol_rd [expr abs($rd_ch - $rd_int)/$rd_ch]
2651     } else {
2652         set tol_rd $rd_int
2653     }
2654     if { $gr_ch != 0 } {
2655         set tol_gr [expr abs($gr_ch - $gr_int)/$gr_ch]
2656     } else {
2657         set tol_gr $gr_int
2658     }
2659     if { $bl_ch != 0 } {
2660         set tol_bl [expr abs($bl_ch - $bl_int)/$bl_ch]
2661     } else {
2662         set tol_bl $bl_int
2663     }
2664
2665     set status 0
2666     if { $tol_rd > 0.2 } {
2667         puts "Warning : RED light of additive color model RGB is invalid"
2668         set status 1
2669     }
2670     if { $tol_gr > 0.2 } {
2671         puts "Warning : GREEN light of additive color model RGB is invalid"
2672         set status 1
2673     }
2674     if { $tol_bl > 0.2 } {
2675         puts "Warning : BLUE light of additive color model RGB is invalid"
2676         set status 1
2677     }
2678
2679     if { $status != 0 } {
2680         puts "Warning : Colors of default coordinate are not equal"
2681     }
2682
2683     global stat
2684     if { $tol_rd > 0.2 || $tol_gr > 0.2 || $tol_bl > 0.2 } {
2685         set info [_checkpoint $coord_x $coord_y $rd_ch $gr_ch $bl_ch]
2686         set stat [lindex $info end]
2687         if { ${stat} != 1 } {
2688             puts "Error : Colors are not equal in default coordinate and in the near coordinates too"
2689             return $stat
2690         } else {
2691             puts "Point with valid color was found"
2692             return $stat
2693         }
2694     } else {
2695         set stat 1
2696     }
2697 }
2698
2699 # Procedure to check color in the point near default coordinate
2700 proc _checkpoint {coord_x coord_y rd_ch gr_ch bl_ch} {
2701     set x_start [expr ${coord_x} - 2]
2702     set y_start [expr ${coord_y} - 2]
2703     set mistake 0
2704     set i 0
2705     while { $mistake != 1 && $i <= 5 } {
2706         set j 0
2707         while { $mistake != 1 && $j <= 5 } {
2708             set position_x [expr ${x_start} + $j]
2709             set position_y [expr ${y_start} + $i]
2710             puts $position_x
2711             puts $position_y
2712
2713             set color ""
2714             catch { [set color "[vreadpixel ${position_x} ${position_y} rgb]"] }
2715             if {"$color" == ""} {
2716                 puts "Warning : Pixel coordinates (${position_x}; ${position_y}) are out of view"
2717                 incr j
2718                 continue
2719             }
2720             set rd [lindex $color 0]
2721             set gr [lindex $color 1]
2722             set bl [lindex $color 2]
2723             set rd_int [expr int($rd * 1.e+05)]
2724             set gr_int [expr int($gr * 1.e+05)]
2725             set bl_int [expr int($bl * 1.e+05)]
2726
2727             if { $rd_ch != 0 } {
2728                 set tol_rd [expr abs($rd_ch - $rd_int)/$rd_ch]
2729             } else {
2730                 set tol_rd $rd_int
2731             }
2732             if { $gr_ch != 0 } {
2733                 set tol_gr [expr abs($gr_ch - $gr_int)/$gr_ch]
2734             } else {
2735                 set tol_gr $gr_int
2736             }
2737             if { $bl_ch != 0 } {
2738                 set tol_bl [expr abs($bl_ch - $bl_int)/$bl_ch]
2739             } else {
2740                 set tol_bl $bl_int
2741             }
2742
2743             if { $tol_rd > 0.2 || $tol_gr > 0.2 || $tol_bl > 0.2 } {
2744                 puts "Warning : Point with true color was not found near default coordinates"
2745                 set mistake 0
2746             } else {
2747                 set mistake 1
2748             }
2749             incr j
2750         }
2751         incr i
2752     }
2753     return $mistake
2754 }
2755
2756 # Procedure to check if sequence of values in listval follows linear trend
2757 # adding the same delta on each step.
2758 #
2759 # The function does statistical estimation of the mean variation of the
2760 # values of the sequence, and dispersion, and returns true only if both 
2761 # dispersion and deviation of the mean from expected delta are within 
2762 # specified tolerance.
2763 #
2764 # If mean variation differs from expected delta on more than two dispersions,
2765 # the check fails and procedure raises error with specified message.
2766 #
2767 # Otherwise the procedure returns false meaning that more iterations are needed.
2768 # Note that false is returned in any case if length of listval is less than 3.
2769 #
2770 # See example of use to check memory leaks in bugs/caf/bug23489
2771 #
2772 proc checktrend {listval delta tolerance message} {
2773     set nbval [llength $listval]
2774     if { $nbval < 3} {
2775         return 0
2776     }
2777
2778     # calculate mean value
2779     set mean 0.
2780     set prev [lindex $listval 0]
2781     foreach val [lrange $listval 1 end] {
2782         set mean [expr $mean + ($val - $prev)]
2783         set prev $val
2784     }
2785     set mean [expr $mean / ($nbval - 1)]
2786
2787     # calculate dispersion
2788     set sigma 0.
2789     set prev [lindex $listval 0]
2790     foreach val [lrange $listval 1 end] {
2791         set d [expr ($val - $prev) - $mean]
2792         set sigma [expr $sigma + $d * $d]
2793         set prev $val
2794     }
2795     set sigma [expr sqrt ($sigma / ($nbval - 2))]
2796
2797     puts "Checking trend: nb = $nbval, mean delta = $mean, sigma = $sigma"
2798
2799     # check if deviation is definitely too big
2800     if { abs ($mean - $delta) > $tolerance + 2. * $sigma } {
2801         puts "Checking trend failed: mean delta per step = $mean, sigma = $sigma, expected delta = $delta"
2802         error "$message"
2803     }
2804
2805     # check if deviation is clearly within a range
2806     return [expr abs ($mean - $delta) <= $sigma && $sigma <= $tolerance]
2807 }