0024992: missing implementation for GeomConvert_CompCurveToBSplineCurve::Clear()
[occt.git] / src / DrawResources / TestCommands.tcl
CommitLineData
d5f74e42 1# Copyright (c) 2013-2014 OPEN CASCADE SAS
40093367 2#
973c2be1 3# This file is part of Open CASCADE Technology software library.
40093367 4#
d5f74e42 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
973c2be1 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.
40093367 10#
973c2be1 11# Alternatively, this file may be used under the terms of Open CASCADE
12# commercial license or contractual agreement.
40093367 13
14############################################################################
15# This file defines scripts for execution of OCCT tests.
16# It should be loaded automatically when DRAW is started, and provides
351bbcba 17# top-level commands starting with 'test'. Type 'help test' to get their
18# synopsys.
40093367 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
26set _tests_verbose 0
27
28# regexp for parsing test case results in summary log
29set _test_case_regexp {^CASE\s+([\w.-]+)\s+([\w.-]+)\s+([\w.-]+)\s*:\s*([\w]+)(.*)}
30
31# Basic command to run indicated test case in DRAW
b725d7c5 32help test {
33 Run specified test case
34 Use: test group grid casename [echo=0]
35 - If echo is set to 0 (default), log is stored in memory and only summary
36 is output (the log can be obtained with command "dlog get")
37 - If echo is set to 1 or "-echo", all commands and results are echoed
38 immediately, but log is not saved and summary is not produced
39}
5df3a117 40proc test {group grid casename {echo 0}} {
40093367 41 # get test case paths (will raise error if input is invalid)
42 _get_test $group $grid $casename dir gridname casefile
43
b725d7c5 44 # if echo specified as "-echo", convert it to bool
45 if { "$echo" == "-echo" } { set echo t }
46
40093367 47 # run test
c97067ad 48 uplevel _run_test $dir $group $gridname $casefile $echo
40093367 49
50 # check log
5df3a117 51 if { ! $echo } {
52 _check_log $dir $group $gridname $casename [dlog get]
53 }
40093367 54
55 return
56}
57
58# Basic command to run indicated test case in DRAW
b725d7c5 59help testgrid {
60 Run all tests, or specified group, or one grid
87f42a3f 61 Use: testgrid [groupmask [gridmask [casemask]]] [options...]
b725d7c5 62 Allowed options are:
63 -parallel N: run N parallel processes (default is number of CPUs, 0 to disable)
9753e6de 64 -refresh N: save summary logs every N seconds (default 600, minimal 1, 0 to disable)
b725d7c5 65 -outdir dirname: set log directory (should be empty or non-existing)
66 -overwrite: force writing logs in existing non-empty directory
67 -xml filename: write XML report for Jenkins (in JUnit-like format)
87f42a3f 68 Groups, grids, and test cases to be executed can be specified by list of file
69 masks, separated by spaces or comma; default is all (*).
40093367 70}
b725d7c5 71proc testgrid {args} {
40093367 72 global env tcl_platform _tests_verbose
73
74 ######################################################
75 # check arguments
76 ######################################################
77
78 # check that environment variable defining paths to test scripts is defined
79 if { ! [info exists env(CSF_TestScriptsPath)] ||
80 [llength $env(CSF_TestScriptsPath)] <= 0 } {
81 error "Error: Environment variable CSF_TestScriptsPath is not defined"
82 }
83
84 # treat options
b725d7c5 85 set parallel [_get_nb_cpus]
40093367 86 set refresh 60
b725d7c5 87 set logdir ""
40093367 88 set overwrite 0
89 set xmlfile ""
90 for {set narg 0} {$narg < [llength $args]} {incr narg} {
91 set arg [lindex $args $narg]
92
93 # parallel execution
94 if { $arg == "-parallel" } {
95 incr narg
b725d7c5 96 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
40093367 97 set parallel [expr [lindex $args $narg]]
98 } else {
b725d7c5 99 error "Option -parallel requires argument"
40093367 100 }
101 continue
102 }
103
104 # refresh logs time
105 if { $arg == "-refresh" } {
106 incr narg
b725d7c5 107 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
40093367 108 set refresh [expr [lindex $args $narg]]
109 } else {
b725d7c5 110 error "Option -refresh requires argument"
111 }
112 continue
113 }
114
115 # output directory
116 if { $arg == "-outdir" } {
117 incr narg
118 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
119 set logdir [lindex $args $narg]
120 } else {
121 error "Option -outdir requires argument"
40093367 122 }
123 continue
124 }
125
126 # allow overwrite logs
127 if { $arg == "-overwrite" } {
128 set overwrite 1
129 continue
130 }
131
132 # refresh logs time
133 if { $arg == "-xml" } {
134 incr narg
b725d7c5 135 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
40093367 136 set xmlfile [lindex $args $narg]
137 }
138 if { $xmlfile == "" } {
139 set xmlfile TESTS-summary.xml
140 }
141 continue
142 }
143
144 # unsupported option
145 if { [regexp {^-} $arg] } {
146 error "Error: unsupported option \"$arg\""
147 }
148
149 # treat arguments not recognized as options as group and grid names
87f42a3f 150 if { ! [info exists groupmask] } {
151 set groupmask [split $arg ,]
152 } elseif { ! [info exists gridmask] } {
153 set gridmask [split $arg ,]
154 } elseif { ! [info exists casemask] } {
155 set casemask [split $arg ,]
40093367 156 } else {
87f42a3f 157 error "Error: cannot interpret argument $narg ($arg)"
40093367 158 }
159 }
160
161 # check that target log directory is empty or does not exist
162 set logdir [file normalize [string trim $logdir]]
163 if { $logdir == "" } {
b725d7c5 164 # if specified logdir is empty string, generate unique name like
165 # results_<branch>_<timestamp>
166 set prefix "results"
167 if { ! [catch {exec git branch} gitout] &&
168 [regexp {[*] ([\w]+)} $gitout res branch] } {
169 set prefix "${prefix}_$branch"
170 }
171 set logdir "${prefix}_[clock format [clock seconds] -format {%Y-%m-%dT%H%M}]"
40093367 172 set logdir [file normalize $logdir]
173 }
174 if { [file isdirectory $logdir] && ! $overwrite && ! [catch {glob -directory $logdir *}] } {
175 error "Error: Specified log directory \"$logdir\" is not empty; please clean it before running tests"
176 }
177 if { [catch {file mkdir $logdir}] || ! [file writable $logdir] } {
178 error "Error: Cannot create directory \"$logdir\", or it is not writable"
179 }
180
87f42a3f 181 # masks for search of test groups, grids, and cases
182 if { ! [info exists groupmask] } { set groupmask * }
183 if { ! [info exists gridmask ] } { set gridmask * }
184 if { ! [info exists casemask ] } { set casemask * }
185
40093367 186 ######################################################
187 # prepare list of tests to be performed
188 ######################################################
189
190 # list of tests, each defined by a list of:
191 # test scripts directory
192 # group (subfolder) name
193 # grid (subfolder) name
194 # test case name
195 # path to test case file
196 set tests_list {}
197
198 # iterate by all script paths
199 foreach dir [_split_path $env(CSF_TestScriptsPath)] {
200 # protection against empty paths
201 set dir [string trim $dir]
202 if { $dir == "" } { continue }
203
204 if { $_tests_verbose > 0 } { _log_and_puts log "Examining tests directory $dir" }
205
206 # check that directory exists
207 if { ! [file isdirectory $dir] } {
208 _log_and_puts log "Warning: directory $dir listed in CSF_TestScriptsPath does not exist, skipped"
209 continue
210 }
211
87f42a3f 212 # search all directories in the current dir with specified mask
213 if [catch {glob -directory $dir -tail -types d {*}$groupmask} groups] { continue }
40093367 214
215 # iterate by groups
216 if { $_tests_verbose > 0 } { _log_and_puts log "Groups to be executed: $groups" }
217 foreach group [lsort -dictionary $groups] {
218 if { $_tests_verbose > 0 } { _log_and_puts log "Examining group directory $group" }
219
220 # file grids.list must exist: it defines sequence of grids in the group
221 if { ! [file exists $dir/$group/grids.list] } {
222 _log_and_puts log "Warning: directory $dir/$group does not contain file grids.list, skipped"
223 continue
224 }
225
226 # read grids.list file and make a list of grids to be executed
227 set gridlist {}
228 set fd [open $dir/$group/grids.list]
229 set nline 0
230 while { [gets $fd line] >= 0 } {
231 incr nline
232
233 # skip comments and empty lines
234 if { [regexp "\[ \t\]*\#.*" $line] } { continue }
235 if { [string trim $line] == "" } { continue }
236
237 # get grid id and name
238 if { ! [regexp "^\(\[0-9\]+\)\[ \t\]*\(\[A-Za-z0-9_.-\]+\)\$" $line res gridid grid] } {
239 _log_and_puts log "Warning: cannot recognize line $nline in file $dir/$group/grids.list as \"gridid gridname\"; ignored"
240 continue
241 }
242
87f42a3f 243 # check that grid fits into the specified mask
244 foreach mask $gridmask {
245 if { $mask == $gridid || [string match $mask $grid] } {
246 lappend gridlist $grid
247 }
40093367 248 }
249 }
250 close $fd
251
252 # iterate by all grids
253 foreach grid $gridlist {
254
255 # check if this grid is aliased to another one
256 set griddir $dir/$group/$grid
257 if { [file exists $griddir/cases.list] } {
258 set fd [open $griddir/cases.list]
259 if { [gets $fd line] >= 0 } {
260 set griddir [file normalize $dir/$group/$grid/[string trim $line]]
261 }
262 close $fd
263 }
264
265 # check if grid directory actually exists
266 if { ! [file isdirectory $griddir] } {
267 _log_and_puts log "Error: tests directory for grid $grid ($griddir) is missing; skipped"
268 continue
269 }
270
271 # create directory for logging test results
272 if { $logdir != "" } { file mkdir $logdir/$group/$grid }
273
274 # iterate by all tests in the grid directory
87f42a3f 275 if { [catch {glob -directory $griddir -type f {*}$casemask} testfiles] } { continue }
40093367 276 foreach casefile [lsort -dictionary $testfiles] {
87f42a3f 277 # filter out files with reserved names
40093367 278 set casename [file tail $casefile]
87f42a3f 279 if { $casename == "begin" || $casename == "end" ||
280 $casename == "parse.rules" } {
281 continue
282 }
40093367 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
9753e6de 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:"
8a262fa1 303 foreach envar [lsort [array names env]] {
9753e6de 304 lappend log "$envar=\"$env($envar)\""
40093367 305 }
9753e6de 306 lappend log ""
40093367 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
b725d7c5 321 catch {tpool::suspend $worker}
40093367 322 if { $_tests_verbose > 0 } { _log_and_puts log "Executing tests in (up to) $parallel threads" }
9753e6de 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]
40093367 328 }
329 }
330
331 # start test cases
8a262fa1 332 set userbreak 0
40093367 333 foreach test_def $tests_list {
8a262fa1 334 # check for user break
9753e6de 335 if { $userbreak || "[info commands dbreak]" == "dbreak" && [catch dbreak] } {
8a262fa1 336 set userbreak 1
337 break
338 }
339
40093367 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"
b725d7c5 354 puts $fd_cmd "_run_test $dir $group $grid $casefile t"
5df3a117 355
40093367 356 # use dlog command to obtain complete output of the test when it is absent (i.e. since OCCT 6.6.0)
5df3a117 357 # note: this is not needed if echo is set to 1 in call to _run_test above
40093367 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 }
5df3a117 366
40093367 367 # final 'exit' is needed when running on Linux under VirtualGl
368 puts $fd_cmd "exit"
369 close $fd_cmd
8418c617 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
40093367 376 # alternative method to run without temporary file; disabled as it needs too many backslashes
377# else {
8418c617 378# set command "exec <<\"\" DRAWEXE -c $imgdir_cmd\\\; set test_image $casename\\\; \
40093367 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]
9753e6de 388 incr nbpooled
389 if { $nbpooled > $nbpooled_max } {
390 _testgrid_process_jobs $worker $nbpooled_ok
391 }
40093367 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 } {
9753e6de 408 _testgrid_process_jobs $worker
40093367 409 # release thread pool
9753e6de 410 if { $nbpooled > 0 } {
411 tpool::cancel $worker [array names job_def]
412 }
413 catch {tpool::resume $worker}
40093367 414 tpool::release $worker
415 }
416
417 uplevel dchrono _timer stop
418 set time [lindex [split [uplevel dchrono _timer show] "\n"] 0]
419
8a262fa1 420 if { $userbreak } {
9753e6de 421 _log_and_puts log "*********** Stopped by user break ***********"
8a262fa1 422 set time "${time} \nNote: the process is not finished, stopped by user break!"
423 }
424
40093367 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
22db40eb 445# Procedure to regenerate summary log from logs of test cases
446help 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}
452proc 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
9753e6de 460 set log {}
22db40eb 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 }
9753e6de 474 lappend log $line
22db40eb 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
cc6a292d 490# Procedure to compare results of two runs of test cases
b725d7c5 491help testdiff {
492 Compare results of two executions of tests (CPU times, ...)
22db40eb 493 Use: testdiff dir1 dir2 [groupname [gridname]] [options...]
b725d7c5 494 Where dir1 and dir2 are directories containing logs of two test runs.
495 Allowed options are:
22db40eb 496 -save filename: save resulting log in specified file (default name is
60874ff8 497 <dir1>/diff-<dir2>.log); HTML log is saved with same name
22db40eb 498 and extension .html
b725d7c5 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
22db40eb 505 2 - output also list of logs and directories present in one of dirs only
506 3 - (default) output also progress messages
cc6a292d 507}
508proc 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
22db40eb 518 set logfile [file join $dir1 "diff-[file tail $dir2].log"]
cc6a292d 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
22db40eb 528 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
cc6a292d 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
cc6a292d 536 # status filter
537 if { $arg == "-status" } {
538 incr narg
22db40eb 539 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
cc6a292d 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
22db40eb 551 if { $narg < [llength $args] && ! [regexp {^-} [lindex $args $narg]] } {
cc6a292d 552 set verbose [expr [lindex $args $narg]]
22db40eb 553 } else {
554 error "Error: Option -verbose must be followed by integer verbose level"
cc6a292d 555 }
556 continue
557 }
558
22db40eb 559 if { [regexp {^-} $arg] } {
cc6a292d 560 error "Error: unsupported option \"$arg\""
22db40eb 561 }
562
563 # non-option arguments form a subdirectory path
564 set basename [file join $basename $arg]
cc6a292d 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" != "" } {
9753e6de 572 _log_save $logfile [join $log "\n"]
22db40eb 573 _log_html_diff "[file rootname $logfile].html" $log $dir1 $dir2
574 puts "Log is saved to $logfile (and .html)"
cc6a292d 575 }
576
577 return
578}
579
351bbcba 580# Procedure to check data file before adding it to repository
581help 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
60874ff8 593 loaded shape (if any), and makes snapshot (in the temporary directory).
351bbcba 594 Finally it advises whether the file should be put to public section of the
595 repository.
596}
597proc 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
60874ff8 721 set tmpdir [_get_temp_dir]
722 file mkdir $tmpdir/$dir
351bbcba 723
724 # make snapshot
725 pload AISV
726 uplevel vdisplay a
727 uplevel vfit
728 uplevel vzfit
60874ff8 729 uplevel vdump $tmpdir/$dir/[file rootname [file tail $file]].png
351bbcba 730 set has_images t
731 }
732 if { $has_images } {
60874ff8 733 puts "Snapshots are saved in subdirectory [_get_temp_dir]"
351bbcba 734 }
735}
736
22db40eb 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.
744proc 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]
80482e01 762 # skip directories starting with dot
763 if { [regexp {^[.]} $name] } { continue }
22db40eb 764 if { [file exists $name/$filename] } {
765 return [file normalize $name/$filename]
766 }
80482e01 767 eval lappend dir [glob -nocomplain -directory $name -type d *]
22db40eb 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
c97067ad 778 error [join [list "File $filename could not be found" \
22db40eb 779 "(should be in paths indicated by CSF_TestDataPath environment variable, " \
780 "or in subfolder data in the script directory)"] "\n"]
781}
782
40093367 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
789proc _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".
5df3a117 861proc _run_test {scriptsdir group gridname casefile echo} {
40093367 862 global env
863
864 # start timer
865 uplevel dchrono _timer reset
866 uplevel dchrono _timer start
22db40eb 867 catch {uplevel meminfo w} membase
40093367 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
5df3a117 873 } elseif { $echo } {
874 decho on
40093367 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} {
d33dea30
PK
884 set optarg [lindex $args end-1]
885 if { $optarg == "stdout" || $optarg == "stderr" || $optarg == "-newline" } {
40093367 886 dlog add [lindex $args end]
c97067ad 887 } else {
888 eval puts-saved $args
40093367 889 }
890 } else {
891 dlog add [lindex $args end]
892 }
40093367 893 }
894 }
895
40093367 896 # evaluate test case
897 if [catch {
60874ff8 898 # set variables identifying test case
40093367 899 uplevel set casename [file tail $casefile]
8418c617 900 uplevel set groupname $group
901 uplevel set gridname $gridname
c97067ad 902 uplevel set dirname $scriptsdir
40093367 903
a3ef6605 904 # set path for saving of log and images (if not yet set) to temp dir
60874ff8 905 if { ! [uplevel info exists imagedir] } {
60874ff8 906 uplevel set test_image \$casename
a3ef6605 907
908 # create subdirectory in temp named after group and grid with timestamp
909 set rootlogdir [_get_temp_dir]
910
911 set imagedir "${group}-${gridname}-${::casename}-[clock format [clock seconds] -format {%Y-%m-%dT%Hh%Mm%Ss}]"
912 set imagedir [file normalize ${rootlogdir}/$imagedir]
913
914 if { [catch {file mkdir $imagedir}] || ! [file writable $imagedir] ||
915 ! [catch {glob -directory $imagedir *}] } {
916# puts "Warning: Cannot create directory \"$imagedir\", or it is not empty; \"${rootlogdir}\" is used"
917 set imagedir $rootlogdir
918 }
919
d16b64f1 920 uplevel set imagedir \"$imagedir\"
60874ff8 921 }
922
923 # execute test scripts
40093367 924 if { [file exists $scriptsdir/$group/begin] } {
925 puts "Executing $scriptsdir/$group/begin..."; flush stdout
926 uplevel source $scriptsdir/$group/begin
927 }
928 if { [file exists $scriptsdir/$group/$gridname/begin] } {
929 puts "Executing $scriptsdir/$group/$gridname/begin..."; flush stdout
930 uplevel source $scriptsdir/$group/$gridname/begin
931 }
932
933 puts "Executing $casefile..."; flush stdout
934 uplevel source $casefile
935
936 if { [file exists $scriptsdir/$group/$gridname/end] } {
937 puts "Executing $scriptsdir/$group/$gridname/end..."; flush stdout
938 uplevel source $scriptsdir/$group/$gridname/end
939 }
940 if { [file exists $scriptsdir/$group/end] } {
941 puts "Executing $scriptsdir/$group/end..."; flush stdout
942 uplevel source $scriptsdir/$group/end
943 }
944 } res] {
945 puts "Tcl Exception: $res"
946 }
947
40093367 948 # stop logging
949 if { $dlog_exists } {
5df3a117 950 if { $echo } {
951 decho off
952 } else {
953 rename puts {}
954 rename puts-saved puts
955 dlog off
956 }
40093367 957 }
958
8418c617 959 # stop cpulimit killer if armed by the test
960 cpulimit
961
22db40eb 962 # add memory and timing info
963 set stats ""
964 if { ! [catch {uplevel meminfo w} memuse] } {
965 set stats "MEMORY DELTA: [expr ($memuse - $membase) / 1024] KiB\n"
966 }
40093367 967 uplevel dchrono _timer stop
968 set time [uplevel dchrono _timer show]
969 if [regexp -nocase {CPU user time:[ \t]*([0-9.e-]+)} $time res cpu] {
22db40eb 970 set stats "${stats}TOTAL CPU TIME: $cpu sec\n"
971 }
972 if { $dlog_exists && ! $echo } {
973 dlog add $stats
974 } else {
975 puts $stats
40093367 976 }
977}
978
979# Internal procedure to check log of test execution and decide if it passed or failed
980proc _check_log {dir group gridname casename log {_summary {}} {_html_log {}}} {
981 global env
982 if { $_summary != "" } { upvar $_summary summary }
983 if { $_html_log != "" } { upvar $_html_log html_log }
9753e6de 984 set summary {}
985 set html_log {}
40093367 986
987if [catch {
988
989 # load definition of 'bad words' indicating test failure
990 # note that rules are loaded in the order of decreasing priority (grid - group - common),
991 # thus grid rules will override group ones
992 set badwords {}
993 foreach rulesfile [list $dir/$group/$gridname/parse.rules $dir/$group/parse.rules $dir/parse.rules] {
994 if [catch {set fd [open $rulesfile r]}] { continue }
995 while { [gets $fd line] >= 0 } {
996 # skip comments and empty lines
997 if { [regexp "\[ \t\]*\#.*" $line] } { continue }
998 if { [string trim $line] == "" } { continue }
999 # extract regexp
1000 if { ! [regexp {^([^/]*)/([^/]*)/(.*)$} $line res status rexp comment] } {
1001 puts "Warning: cannot recognize parsing rule \"$line\" in file $rulesfile"
1002 continue
1003 }
1004 set status [string trim $status]
1005 if { $comment != "" } { set status "$status ([string trim $comment])" }
1006 set rexp [regsub -all {\\b} $rexp {\\y}] ;# convert regexp from Perl to Tcl style
1007 lappend badwords [list $status $rexp]
1008 }
1009 close $fd
1010 }
1011 if { [llength $badwords] <= 0 } {
1012 puts "Warning: no definition of error indicators found (check files parse.rules)"
1013 }
1014
1015 # analyse log line-by-line
1016 set todos {}
1017 set status ""
1018 foreach line [split $log "\n"] {
1019 # check if line defines specific treatment of some messages
b58dfc5e 1020 set deb_info [dversion]
1021 if [regexp -nocase {^[ \s]*TODO ([^:]*):(.*)$} $line res platforms pattern] {
1022 if { [regexp {DEBUG_} $platforms] != 1 } {
1023 if { ! [regexp -nocase {\mAll\M} $platforms] &&
1024 ! [regexp -nocase "\\m$env(os_type)\\M" $platforms] } {
1025 lappend html_log $line
1026 continue ;# TODO statement is for another platform
1027 }
1028
1029 # record TODOs that mark unstable cases
1030 if { [regexp {[\?]} $platforms] } {
1031 set todos_unstable([llength $todos]) 1
1032 }
1033
1034 lappend todos [regsub -all {\\b} [string trim $pattern] {\\y}] ;# convert regexp from Perl to Tcl style
1035 lappend html_log [_html_highlight BAD $line]
1036 continue
1037 }
1038
1039 if { [regexp "Debug mode" $deb_info] != 1 && [regexp {DEBUG_} $platforms] == 1 } {
1040 continue
40093367 1041 }
1042
b58dfc5e 1043 if { [regexp "Debug mode" $deb_info] == 1 && [regexp {DEBUG_} $platforms] == 1 } {
1044 if { ! [regexp -nocase {\mAll\M} $platforms] &&
1045 ! [regexp -nocase "\\m$env(os_type)\\M" $platforms] } {
1046 lappend html_log $line
1047 continue ;# TODO statement is for another platform
1048 }
40093367 1049
b58dfc5e 1050 # record TODOs that mark unstable cases
1051 if { [regexp {[\?]} $platforms] } {
1052 set todos_unstable([llength $todos]) 1
1053 }
1054
1055 lappend todos [regsub -all {\\b} [string trim $pattern] {\\y}] ;# convert regexp from Perl to Tcl style
1056 lappend html_log [_html_highlight BAD $line]
1057 continue
1058 }
40093367 1059 }
b58dfc5e 1060
40093367 1061 # check for presence of messages indicating test result
1062 set ismarked 0
1063 foreach bw $badwords {
1064 if { [regexp [lindex $bw 1] $line] } {
1065 # check if this is known bad case
1066 set is_known 0
1067 for {set i 0} {$i < [llength $todos]} {incr i} {
1068 if { [regexp [lindex $todos $i] $line] } {
1069 set is_known 1
1070 incr todo_count($i)
9753e6de 1071 lappend html_log [_html_highlight BAD $line]
40093367 1072 break
1073 }
1074 }
1075
1076 # if it is not in todo, define status
1077 if { ! $is_known } {
1078 set stat [lindex $bw 0 0]
9753e6de 1079 lappend html_log [_html_highlight $stat $line]
40093367 1080 if { $status == "" && $stat != "OK" && ! [regexp -nocase {^IGNOR} $stat] } {
1081 set status [lindex $bw 0]
1082 }
1083 }
1084 set ismarked 1
1085 break
1086 }
1087 }
1088 if { ! $ismarked } {
9753e6de 1089 lappend html_log $line
40093367 1090 }
1091 }
1092
1093 # check for presence of TEST COMPLETED statement
1094 if { $status == "" && ! [regexp {TEST COMPLETED} $log] } {
1095 # check whether absence of TEST COMPLETED is known problem
1096 set i [lsearch $todos "TEST INCOMPLETE"]
1097 if { $i >= 0 } {
1098 incr todo_count($i)
1099 } else {
1100 set status "FAILED (no final message is found)"
1101 }
1102 }
1103
1104 # check declared bad cases and diagnose possible improvement
1105 # (bad case declared but not detected).
1106 # Note that absence of the problem marked by TODO with question mark
1107 # (unstable) is not reported as improvement.
1108 if { $status == "" } {
1109 for {set i 0} {$i < [llength $todos]} {incr i} {
1110 if { ! [info exists todos_unstable($i)] &&
1111 (! [info exists todo_count($i)] || $todo_count($i) <= 0) } {
1112 set status "IMPROVEMENT (expected problem TODO no. [expr $i + 1] is not detected)"
1113 break;
1114 }
1115 }
1116 }
1117
1118 # report test as known bad if at least one of expected problems is found
1119 if { $status == "" && [llength [array names todo_count]] > 0 } {
1120 set status "BAD (known problem)"
1121 }
1122
1123 # report normal OK
1124 if { $status == "" } {set status "OK" }
1125
1126} res] {
1127 set status "FAILED ($res)"
1128}
1129
1130 # put final message
1131 _log_and_puts summary "CASE $group $gridname $casename: $status"
9753e6de 1132 set summary [join $summary "\n"]
1133 set html_log "[_html_highlight [lindex $status 0] $summary]\n[join $html_log \n]"
40093367 1134}
1135
1136# Auxiliary procedure putting message to both cout and log variable (list)
1137proc _log_and_puts {logvar message} {
1138 if { $logvar != "" } {
1139 upvar $logvar log
9753e6de 1140 lappend log $message
40093367 1141 }
1142 puts $message
1143}
1144
1145# Auxiliary procedure to log result on single test case
1146proc _log_test_case {output logdir dir group grid casename logvar} {
1147 upvar $logvar log
1148
1149 # check result and make HTML log
1150 _check_log $dir $group $grid $casename $output summary html_log
9753e6de 1151 lappend log $summary
40093367 1152
1153 # save log to file
1154 if { $logdir != "" } {
1155 _log_html $logdir/$group/$grid/$casename.html $html_log "Test $group $grid $casename"
1156 _log_save $logdir/$group/$grid/$casename.log "$output\n$summary" "Test $group $grid $casename"
1157 }
1158}
1159
1160# Auxiliary procedure to save log to file
1161proc _log_save {file log {title {}}} {
1162 # create missing directories as needed
1163 catch {file mkdir [file dirname $file]}
1164
1165 # try to open a file
1166 if [catch {set fd [open $file w]} res] {
1167 error "Error saving log file $file: $res"
1168 }
1169
1170 # dump log and close
1171 puts $fd "$title\n"
1172 puts $fd $log
1173 close $fd
1174 return
1175}
1176
22db40eb 1177# Auxiliary procedure to make a (relative if possible) URL to a file for
1178# inclusion a reference in HTML log
1179proc _make_url {htmldir file} {
1180 set htmlpath [file split [file normalize $htmldir]]
1181 set filepath [file split [file normalize $file]]
1182 for {set i 0} {$i < [llength $htmlpath]} {incr i} {
1183 if { "[lindex $htmlpath $i]" != "[lindex $filepath $i]" } {
1184 if { $i == 0 } { break }
1185 return "[string repeat "../" [expr [llength $htmlpath] - $i - 1]][eval file join [lrange $filepath $i end]]"
1186 }
1187 }
1188
1189 # if relative path could not be made, return full file URL
1190 return "file://[file normalize $file]"
1191}
1192
40093367 1193# Auxiliary procedure to save log to file
1194proc _log_html {file log {title {}}} {
1195 # create missing directories as needed
1196 catch {file mkdir [file dirname $file]}
1197
1198 # try to open a file
1199 if [catch {set fd [open $file w]} res] {
1200 error "Error saving log file $file: $res"
1201 }
1202
1203 # print header
22db40eb 1204 puts $fd "<html><head><title>$title</title></head><body><h1>$title</h1>"
40093367 1205
1206 # add images if present
1207 set imgbasename [file rootname [file tail $file]]
1208 foreach img [lsort [glob -nocomplain -directory [file dirname $file] -tails ${imgbasename}*.gif ${imgbasename}*.png ${imgbasename}*.jpg]] {
3b21f8ae 1209 puts $fd "<p>[file tail $img]<br><img src=\"$img\"/><p>"
40093367 1210 }
1211
b725d7c5 1212 # print log body, trying to add HTML links to script files on lines like
1213 # "Executing <filename>..."
40093367 1214 puts $fd "<pre>"
b725d7c5 1215 foreach line [split $log "\n"] {
1216 if { [regexp {Executing[ \t]+([a-zA-Z0-9._/:-]+[^.])} $line res script] &&
1217 [file exists $script] } {
22db40eb 1218 set line [regsub $script $line "<a href=\"[_make_url $file $script]\">$script</a>"]
b725d7c5 1219 }
1220 puts $fd $line
1221 }
40093367 1222 puts $fd "</pre></body></html>"
1223
1224 close $fd
1225 return
1226}
1227
1228# Auxiliary method to make text with HTML highlighting according to status
1229proc _html_color {status} {
1230 # choose a color for the cell according to result
1231 if { $status == "OK" } {
1232 return lightgreen
1233 } elseif { [regexp -nocase {^FAIL} $status] } {
1234 return red
1235 } elseif { [regexp -nocase {^BAD} $status] } {
1236 return yellow
1237 } elseif { [regexp -nocase {^IMP} $status] } {
1238 return orange
1239 } elseif { [regexp -nocase {^SKIP} $status] } {
1240 return gray
1241 } elseif { [regexp -nocase {^IGNOR} $status] } {
1242 return gray
1243 } else {
1244 puts "Warning: no color defined for status $status, using red as if FAILED"
1245 return red
1246 }
1247}
1248
1249# Format text line in HTML to be colored according to the status
1250proc _html_highlight {status line} {
1251 return "<table><tr><td bgcolor=\"[_html_color $status]\">$line</td></tr></table>"
1252}
1253
1254# Internal procedure to generate HTML page presenting log of the tests
1255# execution in tabular form, with links to reports on individual cases
1256proc _log_html_summary {logdir log totals regressions improvements total_time} {
1257 global _test_case_regexp
1258
9753e6de 1259 # create missing directories as needed
1260 file mkdir $logdir
40093367 1261
1262 # try to open a file and start HTML
1263 if [catch {set fd [open $logdir/summary.html w]} res] {
1264 error "Error creating log file: $res"
1265 }
1266
1267 # write HRML header, including command to refresh log if still in progress
1268 puts $fd "<html><head>"
1269 puts $fd "<title>Tests summary</title>"
1270 if { $total_time == "" } {
1271 puts $fd "<meta http-equiv=\"refresh\" content=\"10\">"
1272 }
1273 puts $fd "<meta http-equiv=\"pragma\" content=\"NO-CACHE\">"
1274 puts $fd "</head><body>"
1275
1276 # put summary
1277 set legend(OK) "Test passed OK"
1278 set legend(FAILED) "Test failed (regression)"
1279 set legend(BAD) "Known problem"
1280 set legend(IMPROVEMENT) "Possible improvement (expected problem not detected)"
1281 set legend(SKIPPED) "Test skipped due to lack of data file"
1282 puts $fd "<h1>Summary</h1><table>"
1283 foreach nbstat $totals {
1284 set status [lindex $nbstat 1]
1285 if { [info exists legend($status)] } {
1286 set comment $legend($status)
1287 } else {
1288 set comment "User-defined status"
1289 }
1290 puts $fd "<tr><td align=\"right\">[lindex $nbstat 0]</td><td bgcolor=\"[_html_color $status]\">$status</td><td>$comment</td></tr>"
1291 }
1292 puts $fd "</table>"
1293
1294 # time stamp and elapsed time info
1295 if { $total_time != "" } {
8a262fa1 1296 puts $fd "<p>Generated on [clock format [clock seconds] -format {%Y-%m-%d %H:%M:%S}] on [info hostname]\n<p>"
1297 puts $fd [join [split $total_time "\n"] "<p>"]
40093367 1298 } else {
1299 puts $fd "<p>NOTE: This is intermediate summary; the tests are still running! This page will refresh automatically until tests are finished."
1300 }
1301
1302 # print regressions and improvements
1303 foreach featured [list $regressions $improvements] {
1304 if { [llength $featured] <= 1 } { continue }
1305 set status [string trim [lindex $featured 0] { :}]
1306 puts $fd "<h2>$status</h2>"
1307 puts $fd "<table>"
1308 set groupgrid ""
1309 foreach test [lrange $featured 1 end] {
1310 if { ! [regexp {^(.*)\s+([\w.]+)$} $test res gg name] } {
1311 set gg UNKNOWN
1312 set name "Error building short list; check details"
1313 }
1314 if { $gg != $groupgrid } {
1315 if { $groupgrid != "" } { puts $fd "</tr>" }
1316 set groupgrid $gg
1317 puts $fd "<tr><td>$gg</td>"
1318 }
1319 puts $fd "<td bgcolor=\"[_html_color $status]\"><a href=\"[regsub -all { } $gg /]/${name}.html\">$name</a></td>"
1320 }
1321 if { $groupgrid != "" } { puts $fd "</tr>" }
1322 puts $fd "</table>"
1323 }
1324
9753e6de 1325 # put detailed log with TOC
1326 puts $fd "<hr><h1>Details</h1>"
1327 puts $fd "<div style=\"float:right; padding: 10px; border-style: solid; border-color: blue; border-width: 2px;\">"
40093367 1328
1329 # process log line-by-line
1330 set group {}
1331 set letter {}
9753e6de 1332 set body {}
1333 foreach line [lsort -dictionary $log] {
40093367 1334 # check that the line is case report in the form "CASE group grid name: result (explanation)"
1335 if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } {
1336 continue
1337 }
1338
1339 # start new group
1340 if { $grp != $group } {
9753e6de 1341 if { $letter != "" } { lappend body "</tr></table>" }
40093367 1342 set letter {}
1343 set group $grp
1344 set grid {}
9753e6de 1345 puts $fd "<a href=\"#$group\">$group</a><br>"
1346 lappend body "<h2><a name=\"$group\">Group $group</a></h2>"
40093367 1347 }
1348
1349 # start new grid
1350 if { $grd != $grid } {
9753e6de 1351 if { $letter != "" } { lappend body "</tr></table>" }
40093367 1352 set letter {}
1353 set grid $grd
9753e6de 1354 puts $fd "&nbsp;&nbsp;&nbsp;&nbsp;<a href=\"#$group-$grid\">$grid</a><br>"
1355 lappend body "<h2><a name=\"$group-$grid\">Grid $group $grid</a></h2>"
40093367 1356 }
1357
1358 # check if test case name is <letter><digit>;
1359 # if not, set alnum to period "." to recognize non-standard test name
9753e6de 1360 if { ! [regexp {\A([A-Za-z]{1,2})([0-9]{1,2})\Z} $casename res alnum number] &&
1361 ! [regexp {\A([A-Za-z0-9]+)_([0-9]+)\Z} $casename res alnum number] } {
1362 set alnum $casename
40093367 1363 }
1364
1365 # start new row when letter changes or for non-standard names
1366 if { $alnum != $letter || $alnum == "." } {
1367 if { $letter != "" } {
9753e6de 1368 lappend body "</tr><tr>"
40093367 1369 } else {
9753e6de 1370 lappend body "<table><tr>"
40093367 1371 }
1372 set letter $alnum
1373 }
1374
9753e6de 1375 lappend body "<td bgcolor=\"[_html_color $result]\"><a href=\"$group/$grid/${casename}.html\">$casename</a></td>"
40093367 1376 }
9753e6de 1377 puts $fd "</div>\n[join $body "\n"]</tr></table>"
40093367 1378
1379 # add remaining lines of log as plain text
1380 puts $fd "<h2>Plain text messages</h2>\n<pre>"
9753e6de 1381 foreach line $log {
40093367 1382 if { ! [regexp $_test_case_regexp $line] } {
1383 puts $fd "$line"
1384 }
1385 }
1386 puts $fd "</pre>"
1387
1388 # close file and exit
1389 puts $fd "</body>"
1390 close $fd
1391 return
1392}
1393
1394# Procedure to dump summary logs of tests
1395proc _log_summarize {logdir log {total_time {}}} {
1396
1397 # sort log records alphabetically to have the same behavior on Linux and Windows
1398 # (also needed if tests are run in parallel)
9753e6de 1399 set loglist [lsort -dictionary $log]
40093367 1400
1401 # classify test cases by status
1402 foreach line $loglist {
1403 if { [regexp {^CASE ([^:]*): ([[:alnum:]]+).*$} $line res caseid status] } {
1404 lappend stat($status) $caseid
1405 }
1406 }
1407 set totals {}
1408 set improvements {Improvements:}
1409 set regressions {Failed:}
1410 if { [info exists stat] } {
1411 foreach status [lsort [array names stat]] {
1412 lappend totals [list [llength $stat($status)] $status]
1413
1414 # separately count improvements (status starting with IMP) and regressions (all except IMP, OK, BAD, and SKIP)
1415 if { [regexp -nocase {^IMP} $status] } {
1416 eval lappend improvements $stat($status)
1417 } elseif { $status != "OK" && ! [regexp -nocase {^BAD} $status] && ! [regexp -nocase {^SKIP} $status] } {
1418 eval lappend regressions $stat($status)
1419 }
1420 }
1421 }
1422
1423 # if time is specified, add totals
1424 if { $total_time != "" } {
1425 if { [llength $improvements] > 1 } {
1426 _log_and_puts log [join $improvements "\n "]
1427 }
1428 if { [llength $regressions] > 1 } {
1429 _log_and_puts log [join $regressions "\n "]
1430 }
1431 if { [llength $improvements] == 1 && [llength $regressions] == 1 } {
1432 _log_and_puts log "No regressions"
1433 }
1434 _log_and_puts log "Total cases: [join $totals {, }]"
1435 _log_and_puts log $total_time
1436 }
1437
1438 # save log to files
1439 if { $logdir != "" } {
1440 _log_html_summary $logdir $log $totals $regressions $improvements $total_time
9753e6de 1441 _log_save $logdir/tests.log [join $log "\n"] "Tests summary"
40093367 1442 }
1443
1444 return
1445}
1446
1447# Internal procedure to generate XML log in JUnit style, for further
1448# consumption by Jenkins or similar systems.
1449#
1450# The output is intended to conform to XML schema supported by Jenkins found at
1451# 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
1452#
1453# The mapping of the fields is inspired by annotated schema of Apache Ant JUnit XML format found at
1454# http://windyroad.org/dl/Open%20Source/JUnit.xsd
1455proc _log_xml_summary {logdir filename log include_cout} {
1456 global _test_case_regexp
1457
1458 catch {file mkdir [file dirname $filename]}
1459
1460 # try to open a file and start XML
1461 if [catch {set fd [open $filename w]} res] {
1462 error "Error creating XML summary file $filename: $res"
1463 }
1464 puts $fd "<?xml version='1.0' encoding='utf-8'?>"
1465 puts $fd "<testsuites>"
1466
1467 # prototype for command to generate test suite tag
1468 set time_and_host "timestamp=\"[clock format [clock seconds] -format {%Y-%m-%dT%H:%M:%S}]\" hostname=\"[info hostname]\""
1469 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"}
1470
1471 # sort log and process it line-by-line
1472 set group {}
9753e6de 1473 foreach line [lsort -dictionary $log] {
40093367 1474 # check that the line is case report in the form "CASE group grid name: result (explanation)"
1475 if { ! [regexp $_test_case_regexp $line res grp grd casename result message] } {
1476 continue
1477 }
1478 set message [string trim $message " \t\r\n()"]
1479
1480 # start new testsuite for each grid
1481 if { $grp != $group || $grd != $grid } {
1482
1483 # write previous test suite
1484 if [info exists testcases] { eval $cmd_testsuite }
1485
1486 set testcases {}
1487 set nbtests 0
1488 set nberr 0
1489 set nbfail 0
1490 set nbskip 0
1491 set time 0.
1492
1493 set group $grp
1494 set grid $grd
1495 }
1496
1497 incr nbtests
1498
1499 # parse test log and get its CPU time
1500 set testout {}
1501 set add_cpu {}
1502 if { [catch {set fdlog [open $logdir/$group/$grid/${casename}.log r]} ret] } {
1503 puts "Error: cannot open $logdir/$group/$grid/${casename}.log: $ret"
1504 } else {
1505 while { [gets $fdlog logline] >= 0 } {
1506 if { $include_cout } {
1507 set testout "$testout$logline\n"
1508 }
1509 if [regexp -nocase {TOTAL CPU TIME:\s*([\d.]+)\s*sec} $logline res cpu] {
1510 set add_cpu " time=\"$cpu\""
1511 set time [expr $time + $cpu]
1512 }
1513 }
1514 close $fdlog
1515 }
1516 if { ! $include_cout } {
1517 set testout "$line\n"
1518 }
1519
1520 # record test case with its output and status
1521 # Mapping is: SKIPPED, BAD, and OK to OK, all other to failure
1522 set testcases "$testcases\n <testcase name=\"$casename\"$add_cpu status=\"$result\">\n"
1523 set testcases "$testcases\n <system-out>\n$testout </system-out>"
1524 if { $result != "OK" } {
1525 if { [regexp -nocase {^SKIP} $result] } {
1526 incr nberr
1527 set testcases "$testcases\n <error name=\"$result\" message=\"$message\"/>"
1528 } elseif { [regexp -nocase {^BAD} $result] } {
1529 incr nbskip
1530 set testcases "$testcases\n <skipped>$message</skipped>"
1531 } else {
1532 incr nbfail
1533 set testcases "$testcases\n <failure name=\"$result\" message=\"$message\"/>"
1534 }
1535 }
1536 set testcases "$testcases\n </testcase>"
1537 }
1538
1539 # write last test suite
1540 if [info exists testcases] { eval $cmd_testsuite }
1541
1542 # the end
1543 puts $fd "</testsuites>"
1544 close $fd
1545 return
1546}
1547
1548# define custom platform name
1549proc _tests_platform_def {} {
1550 global env tcl_platform
1551
1552 if [info exists env(os_type)] { return }
1553
1554 set env(os_type) $tcl_platform(platform)
1555
1556 # use detailed mapping for various versions of Lunix
1557 # (note that mapping is rather non-uniform, for historical reasons)
d9e8bb08 1558 if { $tcl_platform(os) == "Linux" && ! [catch {exec cat /etc/issue} issue] } {
40093367 1559 if { [regexp {Mandriva[ \tA-Za-z]+([0-9]+)} $issue res num] } {
1560 set env(os_type) Mandriva$num
1561 } elseif { [regexp {Red Hat[ \tA-Za-z]+([0-9]+)} $issue res num] } {
1562 set env(os_type) RedHat$num
1563 } elseif { [regexp {Debian[ \tA-Za-z/]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } {
1564 set env(os_type) Debian$num$subnum
1565 } elseif { [regexp {CentOS[ \tA-Za-z]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } {
1566 set env(os_type) CentOS$num$subnum
1567 } elseif { [regexp {Scientific[ \tA-Za-z]+([0-9]+)[.]([0-9]+)} $issue res num subnum] } {
1568 set env(os_type) SL$num$subnum
1569 } elseif { [regexp {Fedora Core[ \tA-Za-z]+([0-9]+)} $issue res num] } {
1570 set env(os_type) FedoraCore$num
1571 }
1572 if { [exec uname -m] == "x86_64" } {
1573 set env(os_type) "$env(os_type)-64"
1574 }
d9e8bb08 1575 } elseif { $tcl_platform(os) == "Darwin" } {
1576 set env(os_type) MacOS
40093367 1577 }
1578}
1579_tests_platform_def
1580
1581# Auxiliary procedure to split path specification (usually defined by
1582# environment variable) into list of directories or files
1583proc _split_path {pathspec} {
1584 global tcl_platform
1585
1586 # first replace all \ (which might occur on Windows) by /
1587 regsub -all "\\\\" $pathspec "/" pathspec
1588
1589 # split path by platform-specific separator
1590 return [split $pathspec [_path_separator]]
1591}
1592
1593# Auxiliary procedure to define platform-specific separator for directories in
1594# path specification
1595proc _path_separator {} {
1596 global tcl_platform
1597
1598 # split path by platform-specific separator
1599 if { $tcl_platform(platform) == "windows" } {
1600 return ";"
1601 } else {
1602 return ":"
1603 }
1604}
1605
cc6a292d 1606# Procedure to make a diff and common of two lists
1607proc _list_diff {list1 list2 _in1 _in2 _common} {
1608 upvar $_in1 in1
1609 upvar $_in2 in2
1610 upvar $_common common
1611
1612 set in1 {}
1613 set in2 {}
1614 set common {}
1615 foreach item $list1 {
1616 if { [lsearch -exact $list2 $item] >= 0 } {
1617 lappend common $item
1618 } else {
1619 lappend in1 $item
1620 }
1621 }
1622 foreach item $list2 {
1623 if { [lsearch -exact $common $item] < 0 } {
1624 lappend in2 $item
1625 }
1626 }
1627 return
1628}
1629
1630# procedure to load a file to Tcl string
1631proc _read_file {filename} {
1632 set fd [open $filename r]
1633 set result [read -nonewline $fd]
1634 close $fd
1635 return $result
1636}
1637
22db40eb 1638# procedure to construct name for the mage diff file
1639proc _diff_img_name {dir1 dir2 casepath imgfile} {
1640 return [file join $dir1 $casepath "diff-[file tail $dir2]-$imgfile"]
1641}
1642
cc6a292d 1643# Procedure to compare results of two runs of test cases
1644proc _test_diff {dir1 dir2 basename status verbose _logvar {_statvar ""}} {
1645 upvar $_logvar log
1646
22db40eb 1647 # make sure to load diffimage command
1648 uplevel pload VISUALIZATION
1649
cc6a292d 1650 # prepare variable (array) for collecting statistics
1651 if { "$_statvar" != "" } {
1652 upvar $_statvar stat
1653 } else {
1654 set stat(cpu1) 0
1655 set stat(cpu2) 0
22db40eb 1656 set stat(mem1) 0
1657 set stat(mem2) 0
cc6a292d 1658 set log {}
1659 }
1660
1661 # first check subdirectories
1662 set path1 [file join $dir1 $basename]
1663 set path2 [file join $dir2 $basename]
1664 set list1 [glob -directory $path1 -types d -tails -nocomplain *]
1665 set list2 [glob -directory $path2 -types d -tails -nocomplain *]
1666 if { [llength $list1] >0 || [llength $list2] > 0 } {
1667 _list_diff $list1 $list2 in1 in2 common
1668 if { "$verbose" > 1 } {
1669 if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" }
1670 if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" }
1671 }
1672 foreach subdir $common {
1673 if { "$verbose" > 2 } {
1674 _log_and_puts log "Checking [file join $basename $subdir]"
1675 }
1676 _test_diff $dir1 $dir2 [file join $basename $subdir] $status $verbose log stat
1677 }
1678 } else {
1679 # check log files (only if directory has no subdirs)
1680 set list1 [glob -directory $path1 -types f -tails -nocomplain *.log]
1681 set list2 [glob -directory $path2 -types f -tails -nocomplain *.log]
1682 _list_diff $list1 $list2 in1 in2 common
1683 if { "$verbose" > 1 } {
1684 if { [llength $in1] > 0 } { _log_and_puts log "Only in $path1: $in1" }
1685 if { [llength $in2] > 0 } { _log_and_puts log "Only in $path2: $in2" }
1686 }
1687 foreach logfile $common {
1688 # load two logs
1689 set log1 [_read_file [file join $dir1 $basename $logfile]]
1690 set log2 [_read_file [file join $dir2 $basename $logfile]]
22db40eb 1691 set casename [file rootname $logfile]
cc6a292d 1692
1693 # check execution statuses
1694 set status1 UNDEFINED
1695 set status2 UNDEFINED
1696 if { ! [regexp {CASE [^:]*:\s*([\w]+)} $log1 res1 status1] ||
1697 ! [regexp {CASE [^:]*:\s*([\w]+)} $log2 res2 status2] ||
1698 "$status1" != "$status2" } {
22db40eb 1699 _log_and_puts log "STATUS [split $basename /] $casename: $status1 / $status2"
cc6a292d 1700
1701 # if test statuses are different, further comparison makes
1702 # no sense unless explicitly requested
1703 if { "$status" != "all" } {
1704 continue
1705 }
1706 }
1707 if { "$status" == "ok" && "$status1" != "OK" } {
1708 continue
1709 }
1710
1711 # check CPU times
1712 set cpu1 UNDEFINED
1713 set cpu2 UNDEFINED
1714 if { [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log1 res1 cpu1] &&
1715 [regexp {TOTAL CPU TIME:\s*([\d.]+)} $log2 res1 cpu2] } {
1716 set stat(cpu1) [expr $stat(cpu1) + $cpu1]
1717 set stat(cpu2) [expr $stat(cpu2) + $cpu2]
1718
1719 # compare CPU times with 10% precision (but not less 0.5 sec)
1720 if { [expr abs ($cpu1 - $cpu2) > 0.5 + 0.05 * abs ($cpu1 + $cpu2)] } {
22db40eb 1721 _log_and_puts log "CPU [split $basename /] $casename: $cpu1 / $cpu2"
cc6a292d 1722 }
1723 }
22db40eb 1724
1725 # check memory delta
1726 set mem1 UNDEFINED
1727 set mem2 UNDEFINED
1728 if { [regexp {MEMORY DELTA:\s*([\d.]+)} $log1 res1 mem1] &&
1729 [regexp {MEMORY DELTA:\s*([\d.]+)} $log2 res1 mem2] } {
1730 set stat(mem1) [expr $stat(mem1) + $mem1]
1731 set stat(mem2) [expr $stat(mem2) + $mem2]
1732
1733 # compare memory usage with 10% precision (but not less 16 KiB)
1734 if { [expr abs ($mem1 - $mem2) > 16 + 0.05 * abs ($mem1 + $mem2)] } {
1735 _log_and_puts log "MEMORY [split $basename /] $casename: $mem1 / $mem2"
1736 }
1737 }
1738
1739 # check images
1740 set imglist1 [glob -directory $path1 -types f -tails -nocomplain $casename*.{png,gif}]
1741 set imglist2 [glob -directory $path2 -types f -tails -nocomplain $casename*.{png,gif}]
1742 _list_diff $imglist1 $imglist2 imgin1 imgin2 imgcommon
1743 if { "$verbose" > 1 } {
1744 if { [llength $imgin1] > 0 } { _log_and_puts log "Only in $path1: $imgin1" }
1745 if { [llength $imgin2] > 0 } { _log_and_puts log "Only in $path2: $imgin2" }
1746 }
1747 foreach imgfile $imgcommon {
1748# if { $verbose > 1 } { _log_and_puts log "Checking [split basename /] $casename: $imgfile" }
1749 set diffile [_diff_img_name $dir1 $dir2 $basename $imgfile]
1750 if { [catch {diffimage [file join $dir1 $basename $imgfile] \
1751 [file join $dir2 $basename $imgfile] \
1752 0 0 0 $diffile} diff] } {
1753 _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile cannot be compared"
1754 file delete -force $diffile ;# clean possible previous result of diffimage
1755 } elseif { $diff != 0 } {
1756 _log_and_puts log "IMAGE [split $basename /] $casename: $imgfile differs"
1757 } else {
1758 file delete -force $diffile ;# clean useless artifact of diffimage
1759 }
1760 }
cc6a292d 1761 }
1762 }
1763
1764 if { "$_statvar" == "" } {
22db40eb 1765 _log_and_puts log "Total MEMORY difference: $stat(mem1) / $stat(mem2)"
cc6a292d 1766 _log_and_puts log "Total CPU difference: $stat(cpu1) / $stat(cpu2)"
1767 }
1768}
b725d7c5 1769
22db40eb 1770# Auxiliary procedure to save log of results comparison to file
1771proc _log_html_diff {file log dir1 dir2} {
1772 # create missing directories as needed
1773 catch {file mkdir [file dirname $file]}
1774
1775 # try to open a file
1776 if [catch {set fd [open $file w]} res] {
1777 error "Error saving log file $file: $res"
1778 }
1779
1780 # print header
1781 puts $fd "<html><head><title>Diff $dir1 vs. $dir2</title></head><body>"
1782 puts $fd "<h1>Comparison of test results: $dir1 vs. $dir2</h1>"
1783
1784 # print log body, trying to add HTML links to script files on lines like
1785 # "Executing <filename>..."
1786 puts $fd "<pre>"
1787 set logpath [file split [file normalize $file]]
9753e6de 1788 foreach line $log {
22db40eb 1789 puts $fd $line
1790
1791 if { [regexp {IMAGE[ \t]+([^:]+):[ \t]+([A-Za-z0-9_.-]+)} $line res case img] } {
1792 if { [catch {eval file join "" [lrange $case 0 end-1]} gridpath] } {
1793 # note: special handler for the case if test grid directoried are compared directly
1794 set gridpath ""
1795 }
1796 set img1 "<img src=\"[_make_url $file [file join $dir1 $gridpath $img]]\">"
1797 set img2 "<img src=\"[_make_url $file [file join $dir2 $gridpath $img]]\">"
1798
1799 set difffile [_diff_img_name $dir1 $dir2 $gridpath $img]
1800 if { [file exists $difffile] } {
1801 set imgd "<img src=\"[_make_url $file $difffile]\">"
1802 } else {
1803 set imgd "N/A"
1804 }
1805
1806 puts $fd "<table><tr><th>[file tail $dir1]</th><th>[file tail $dir2]</th><th>Different pixels</th></tr>"
1807 puts $fd "<tr><td>$img1</td><td>$img2</td><td>$imgd</td></tr></table>"
1808 }
1809 }
1810 puts $fd "</pre></body></html>"
1811
1812 close $fd
1813 return
1814}
1815
b725d7c5 1816# get number of CPUs on the system
1817proc _get_nb_cpus {} {
1818 global tcl_platform env
1819
1820 if { "$tcl_platform(platform)" == "windows" } {
1821 # on Windows, take the value of the environment variable
1822 if { [info exists env(NUMBER_OF_PROCESSORS)] &&
1823 ! [catch {expr $env(NUMBER_OF_PROCESSORS) > 0} res] && $res >= 0 } {
1824 return $env(NUMBER_OF_PROCESSORS)
1825 }
1826 } elseif { "$tcl_platform(os)" == "Linux" } {
1827 # on Linux, take number of logical processors listed in /proc/cpuinfo
1828 if { [catch {open "/proc/cpuinfo" r} fd] } {
1829 return 0 ;# should never happen, but...
1830 }
1831 set nb 0
1832 while { [gets $fd line] >= 0 } {
1833 if { [regexp {^processor[ \t]*:} $line] } {
1834 incr nb
1835 }
1836 }
1837 close $fd
1838 return $nb
1839 } elseif { "$tcl_platform(os)" == "Darwin" } {
1840 # on MacOS X, call sysctl command
1841 if { ! [catch {exec sysctl hw.ncpu} ret] &&
1842 [regexp {^hw[.]ncpu[ \t]*:[ \t]*([0-9]+)} $ret res nb] } {
1843 return $nb
1844 }
1845 }
1846
1847 # if cannot get good value, return 0 as default
1848 return 0
1849}
351bbcba 1850
1851# check two files for difference
1852proc _diff_files {file1 file2} {
1853 set fd1 [open $file1 "r"]
1854 set fd2 [open $file2 "r"]
1855
1856 set differ f
1857 while {! $differ} {
1858 set nb1 [gets $fd1 line1]
1859 set nb2 [gets $fd2 line2]
1860 if { $nb1 != $nb2 } { set differ t; break }
1861 if { $nb1 < 0 } { break }
1862 if { [string compare $line1 $line2] } {
1863 set differ t
1864 }
1865 }
1866
1867 close $fd1
1868 close $fd2
1869
1870 return $differ
1871}
1872
1873# Check if file is in DOS encoding.
1874# This check is done by presence of \r\n combination at the end of the first
1875# line (i.e. prior to any other \n symbol).
1876# Note that presence of non-ascii symbols typically used for recognition
1877# of binary files is not suitable since some IGES and STEP files contain
1878# non-ascii symbols.
1879# Special check is added for PNG files which contain \r\n in the beginning.
1880proc _check_dos_encoding {file} {
1881 set fd [open $file rb]
1882 set isdos f
1883 if { [gets $fd line] && [regexp {.*\r$} $line] &&
1884 ! [regexp {^.PNG} $line] } {
1885 set isdos t
1886 }
1887 close $fd
1888 return $isdos
1889}
1890
1891# procedure to recognize format of a data file by its first symbols (for OCCT
1892# BREP and geometry DRAW formats, IGES, and STEP) and extension (all others)
1893proc _check_file_format {file} {
1894 set fd [open $file rb]
1895 set line [read $fd 1024]
1896 close $fd
1897
1898 set warn f
1899 set ext [file extension $file]
1900 set format unknown
1901 if { [regexp {^DBRep_DrawableShape} $line] } {
1902 set format BREP
1903 if { "$ext" != ".brep" && "$ext" != ".rle" &&
1904 "$ext" != ".draw" && "$ext" != "" } {
1905 set warn t
1906 }
1907 } elseif { [regexp {^DrawTrSurf_} $line] } {
1908 set format DRAW
1909 if { "$ext" != ".rle" &&
1910 "$ext" != ".draw" && "$ext" != "" } {
1911 set warn t
1912 }
1913 } elseif { [regexp {^[ \t]*ISO-10303-21} $line] } {
1914 set format STEP
1915 if { "$ext" != ".step" && "$ext" != ".stp" } {
1916 set warn t
1917 }
1918 } elseif { [regexp {^.\{72\}S[0 ]\{6\}1} $line] } {
1919 set format IGES
1920 if { "$ext" != ".iges" && "$ext" != ".igs" } {
1921 set warn t
1922 }
1923 } elseif { "$ext" == ".igs" } {
1924 set format IGES
1925 } elseif { "$ext" == ".stp" } {
1926 set format STEP
1927 } else {
1928 set format [string toupper [string range $ext 1 end]]
1929 }
1930
1931 if { $warn } {
1932 puts "$file: Warning: extension ($ext) does not match format ($format)"
1933 }
1934
1935 return $format
1936}
1937
1938# procedure to load file knowing its format
1939proc load_data_file {file format shape} {
1940 switch $format {
1941 BREP { uplevel restore $file $shape }
808b3f9f 1942 DRAW { uplevel restore $file $shape }
351bbcba 1943 IGES { pload XSDRAW; uplevel igesbrep $file $shape * }
1944 STEP { pload XSDRAW; uplevel stepread $file __a *; uplevel renamevar __a_1 $shape }
1945 STL { pload XSDRAW; uplevel readstl $shape $file }
1946 default { error "Cannot read $format file $file" }
1947 }
1948}
60874ff8 1949
1950# procedure to get name of temporary directory,
1951# ensuring it is existing and writeable
1952proc _get_temp_dir {} {
723754e2 1953 global env tcl_platform
60874ff8 1954
1955 # check typical environment variables
1956 foreach var {TempDir Temp Tmp} {
1957 # check different case
1958 foreach name [list [string toupper $var] $var [string tolower $var]] {
1959 if { [info exists env($name)] && [file isdirectory $env($name)] &&
1960 [file writable $env($name)] } {
1961 return [regsub -all {\\} $env($name) /]
1962 }
1963 }
1964 }
1965
1966 # check platform-specific locations
1967 set fallback tmp
1968 if { "$tcl_platform(platform)" == "windows" } {
1969 set paths "c:/TEMP c:/TMP /TEMP /TMP"
1970 if { [info exists env(HOMEDRIVE)] && [info exists env(HOMEPATH)] } {
1971 set fallback [regsub -all {\\} "$env(HOMEDRIVE)$(HOMEPATH)/tmp" /]
1972 }
1973 } else {
1974 set paths "/tmp /var/tmp /usr/tmp"
1975 if { [info exists env(HOME)] } {
1976 set fallback "$env(HOME)/tmp"
1977 }
1978 }
1979 foreach dir $paths {
723754e2 1980 if { [file isdirectory $dir] && [file writable $dir] } {
60874ff8 1981 return $dir
1982 }
1983 }
1984
1985 # fallback case: use subdir /tmp of home or current dir
1986 file mkdir $fallback
1987 return $fallback
1988}
9753e6de 1989
1990# extract of code from testgrid command used to process jobs running in
1991# parallel until number of jobs in the queue becomes equal or less than
1992# specified value
1993proc _testgrid_process_jobs {worker {nb_ok 0}} {
1994 # bind local vars to variables of the caller procedure
1995 upvar log log
1996 upvar logdir logdir
1997 upvar job_def job_def
1998 upvar nbpooled nbpooled
1999 upvar userbreak userbreak
2000 upvar refresh refresh
2001 upvar refresh_timer refresh_timer
2002
2003 catch {tpool::resume $worker}
2004 while { ! $userbreak && $nbpooled > $nb_ok } {
2005 foreach job [tpool::wait $worker [array names job_def]] {
2006 eval _log_test_case \[tpool::get $worker $job\] $job_def($job) log
2007 unset job_def($job)
2008 incr nbpooled -1
2009 }
2010
2011 # check for user break
2012 if { "[info commands dbreak]" == "dbreak" && [catch dbreak] } {
2013 set userbreak 1
2014 }
2015
2016 # update summary log with requested period
2017 if { $logdir != "" && $refresh > 0 && [clock seconds] > $refresh_timer + $refresh } {
2018 _log_summarize $logdir $log
2019 set refresh_timer [clock seconds]
2020 }
2021 }
2022 catch {tpool::suspend $worker}
2023}