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