src/DrawResources/TestCommands.tcl

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