OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-03 17:56:21 +03:00
Code Packages Releases Activity

0029077: Tests - improve command testfile

Browse Source 
Command testfile is improved to be more usable by developers for checking data files used by the new test cases before their integration to the test data base:

1. Do not check and do not report problems found in the repo when checking new files -- this check is done only when argument is "-check"

2. Can check a file located in a directory listed in CSF_TestDataPath as new one without it being considered as already in the data base

3. For new BREP files, reports warning if the file contains triangulation, suggesting that it can be removed to minimize the size

4. Can identify the same (by content) file in the data base for the new files in DOS encoding (less than 1 MB)

5. Can detect duplicates among the input files

6. Outputs result in more clear form

7. When loading STL files, uses option "triangulation" to be efficient

Automated Testing System guide is updated to describe command testfile.

Added test demo testsystem testfile
This commit is contained in:
abv 2017-09-04 13:40:25 +03:00 committed by bugmaster
parent e3368235ea
commit 4eb6e8f464
4 changed files with 1124 additions and 1694 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2562
data/occ/hammer.brep
View File

File diff suppressed because one or more lines are too long

33
dox/dev_guides/tests/tests.md
View File

@ -192,7 +192,11 @@ Use prefix <i>bug</i> followed by Mantis issue ID and, if necessary, additional
* If the test case reports error due to an existing problem and the fix is not available, add @ref testmanual_3_6 "TODO" statement for each error to mark it as a known problem. The TODO statements must be specific so as to match the actually generated messages but not all similar errors.
* To check expected output which should be obtained as the test result, add @ref testmanual_3_7 "REQUIRED" statement for each line of output to mark it as required.
* If the test case produces error messages (contained in parse.rules), which are expected in that test and should not be considered as its failure (e.g. test for *checkshape* command), add REQUIRED statement for each error to mark it as required output.
4. If the test uses data file(s) that are not yet present in the test database, it is possible to put them to (sub)directory pointed out by *CSF_TestDataPath* variable for running test. The files should be attached to the Mantis issue corresponding to the tested modification.
4. To check whether the data files needed for the test are already present in the database, use DRAW command *testfile* (see below).
If the data file is already present, use it for new test instead of adding a duplicate.
If the data file(s) are not yet present in the test database, put them to some folder and add it to the environment variable *CSF_TestDataPath* to be found by the test system.
Information on where the data files can be accessed by OCC team for putting to official database should be provided in comment to Mantis issue, clearly indicating how names of the files used by the test script match the actual names of the files.
The simplest way is to attach the data files to the Mantis issue, with the same names as used by the test script.
5. Check that the test case runs as expected (test for fix: OK with the fix, FAILED without the fix; test for existing problem: BAD), and integrate it to the Git branch created for the issue.
Example:
@ -218,6 +222,33 @@ fixshape result a 0.01 0.01
checkshape result
~~~~~
DRAW command testfile should be used to check the data files being used by the test for possible duplication of content or names.
The command accepts list of paths to files being checked as single argument, and will give conclusion on each of the files, for instance:
~~~~~
Draw[1]> testfile [glob /my/data/path/bug12345*]
Collecting info on test data files repository...
Checking new file(s)...
* /my/data/path/bug12345.brep: duplicate
already present under name bug28773_1.brep
--> //server/occt_tests_data/public/brep/bug28773_1.brep
* /my/data/path/cadso.brep: new file
Warning: DOS encoding detected, consider converting to
UNIX unless DOS line ends are needed for the test
Warning: shape contains triangulation (946 triangles),
consider removing them unless they are needed for the test!
BREP size=201 KiB, nbfaces=33, nbedges=94 -> private
* /my/data/path/case_8_wire3.brep: already present
--> //server/occt_tests_data/public/brep/case_8_wire3.brep
* /my/data/path/case_8_wire4.brep: error
name is already used by existing file
--> //server/occt_tests_data/public/brep/case_8_wire4.brep
~~~~~
@section testmanual_2 Organization of Test Scripts
@subsection testmanual_2_1 General Layout

171
src/DrawResources/TestCommands.tcl
View File

@ -800,20 +800,29 @@ proc testdiff {dir1 dir2 args} {
# Procedure to check data file before adding it to repository
help testfile {
Check data file and prepare it for putting to test data files repository.
Use: testfile [filelist]
Checks specified data files for putting them into the test data files repository.
Use: testfile filelist
Will report if:
- data file (non-binary) is in DOS encoding (CR/LF)
- same data file (with same or another name) already exists in the repository
- another file with the same name already exists
Note that names are assumed to be case-insensitive (for Windows).
Note that names are considered to be case-insensitive (for compatibility
with Windows).
Unless the file is already in the repository, tries to load it, reports
the recognized file format, file size, number of faces and edges in the
loaded shape (if any), and makes snapshot (in the temporary directory).
loaded shape (if any), information contained its triangulation, and makes
snapshot (in the temporary directory).
Finally it advises whether the file should be put to public section of the
repository.
Use: testfile -check
If "-check" is given as an argument, then procedure will check files already
located in the repository (for possible duplicates and for DOS encoding).
}
proc testfile {filelist} {
global env
@ -823,8 +832,11 @@ proc testfile {filelist} {
error "Environment variable CSF_TestDataPath must be defined!"
}
set checkrepo f
if { "$filelist" == "-check" } { set checkrepo t }
# build registry of existing data files (name -> path) and (size -> path)
puts "Checking available test data files..."
puts "Collecting info on test data files repository..."
foreach dir [_split_path $env(CSF_TestDataPath)] {
while {[llength $dir] != 0} {
set curr [lindex $dir 0]
@ -833,89 +845,143 @@ proc testfile {filelist} {
foreach file [glob -nocomplain -directory $curr -type f *] {
set name [file tail $file]
set name_lower [string tolower $name]
set size [file size $file]
# check that the file is not in DOS encoding
if { [_check_dos_encoding $file] } {
puts "Warning: file $file is in DOS encoding; was this intended?"
}
_check_file_format $file
# check if file with the same name is present twice or more
if { [info exists names($name_lower)] } {
puts "Error: more than one file with name $name is present in the repository:"
if { [_diff_files $file $names($name_lower)] } {
puts "(files are different by content)"
} else {
puts "(files are same by content)"
if { $checkrepo } {
if { [_check_dos_encoding $file] } {
puts "Warning: file $file is in DOS encoding; was this intended?"
}
puts "--> $file"
puts "--> $names($name_lower)"
continue
}
_check_file_format $file
# check if file with the same name is present twice or more
if { [info exists names($name_lower)] } {
puts "Error: more than one file with name $name is present in the repository:"
if { [_diff_files $file $names($name_lower)] } {
puts "(files are different by content)"
} else {
puts "(files are same by content)"
}
puts "--> $file"
puts "--> $names($name_lower)"
continue
}
# check if file with the same content exists
set size [file size $file]
if { [info exists sizes($size)] } {
foreach other $sizes($size) {
if { ! [_diff_files $file $other] } {
puts "Warning: two files with the same content found:"
puts "--> $file"
puts "--> $other"
# check if file with the same content exists
if { [info exists sizes($size)] } {
foreach other $sizes($size) {
if { ! [_diff_files $file $other] } {
puts "Warning: two files with the same content found:"
puts "--> $file"
puts "--> $other"
}
}
}
}
# add the file to the registry
set names($name_lower) $file
lappend names($name_lower) $file
lappend sizes($size) $file
}
}
}
if { [llength $filelist] <= 0 } { return }
if { $checkrepo || [llength $filelist] <= 0 } { return }
# check the new files
set has_images f
puts "Checking new file(s)..."
foreach file $filelist {
# check for DOS encoding
if { [_check_dos_encoding $file] } {
puts "$file: Warning: DOS encoding detected"
}
set name [file tail $file]
set name_lower [string tolower $name]
set found f
# check for presence of the file with same name
if { [info exists names($name_lower)] } {
if { [_diff_files $file $names($name_lower)] } {
puts "$file: Error: name is already used by existing file\n--> $names($name_lower)"
} else {
puts "$file: OK: already in the repository \n--> $names($name_lower)"
continue
set found f
foreach other $names($name_lower) {
# avoid comparing the file with itself
if { [file normalize $file] == [file normalize $other] } {
continue
}
# compare content
if { [_diff_files $file $other] } {
puts "\n* $file: error\n name is already used by existing file\n --> $other"
} else {
puts "\n* $file: already present \n --> $other"
}
set found t
break
}
if { $found } { continue }
}
# get size of the file; if it is in DOS encoding and less than 1 MB,
# estimate also its size in UNIX encoding to be able to find same
# file if already present but in UNIX encoding
set sizeact [file size $file]
set sizeunx ""
set isdos [_check_dos_encoding $file]
if { $isdos && $sizeact < 10000000 } {
set fd [open $file r]
fconfigure $fd -translation crlf
set sizeunx [string length [read $fd]]
close $fd
}
# check if file with the same content exists
set size [file size $file]
if { [info exists sizes($size)] } {
set found f
foreach size "$sizeact $sizeunx" {
if { [info exists sizes($size)] } {
foreach other $sizes($size) {
# avoid comparing the file with itself
if { [file normalize $file] == [file normalize $other] } {
continue
}
# compare content
if { ! [_diff_files $file $other] } {
puts "$file: OK: the same file is already present under name [file tail $other]\n--> $other"
puts "\n* $file: duplicate \n already present under name [file tail $other]\n --> $other"
set found t
break
}
}
if { $found } { continue }
if { $found } { break }
}
}
if { $found } { continue }
# file is not present yet, so to be analyzed
puts "\n* $file: new file"
# add the file to the registry as if it were added to the repository,
# to report possible duplicates among the currently processed files
lappend names($name_lower) $file
if { "$sizeunx" != "" } {
lappend sizes($sizeunx) $file
} else {
lappend sizes($sizeact) $file
}
# first of all, complain if it is in DOS encoding
if { $isdos } {
puts " Warning: DOS encoding detected, consider converting to"
puts " UNIX unless DOS line ends are needed for the test"
}
# try to read the file
set format [_check_file_format $file]
if { [catch {uplevel load_data_file $file $format a}] } {
puts "$file: Error: Cannot read as $format file"
puts " Warning: Cannot read as $format file"
continue
}
# warn if shape contains triangulation
pload MODELING
if { "$format" != "STL" &&
[regexp {contains\s+([0-9]+)\s+triangles} [uplevel trinfo a] res nbtriangles] &&
$nbtriangles != 0 } {
puts " Warning: shape contains triangulation ($nbtriangles triangles),"
puts " consider removing them unless they are needed for the test!"
}
# get number of faces and edges
set edges 0
set faces 0
@ -928,16 +994,10 @@ proc testfile {filelist} {
set dir public
} else {
set dir private
# check if one of names of that file corresponds to typical name for
# MDTV bugs or has extension .rle, this should be old model
if { [regexp -nocase {.*(cts|ats|pro|buc|ger|fra|usa|uki)[0-9]+.*} $name] ||
[regexp -nocase {[.]rle\y} $name] } {
set dir old
}
}
# add stats
puts "$file: $format size=[expr $size / 1024] KiB, nbfaces=$faces, nbedges=$edges -> $dir"
puts " $format size=[expr $size / 1024] KiB, nbfaces=$faces, nbedges=$edges -> $dir"
set tmpdir [_get_temp_dir]
file mkdir $tmpdir/$dir
@ -945,6 +1005,7 @@ proc testfile {filelist} {
# make snapshot
pload AISV
uplevel vdisplay a
uplevel vsetdispmode 1
uplevel vfit
uplevel vzfit
uplevel vdump $tmpdir/$dir/[file rootname [file tail $file]].png
@ -2346,7 +2407,7 @@ proc load_data_file {file format shape} {
DRAW { uplevel restore $file $shape }
IGES { pload XSDRAW; uplevel igesbrep $file $shape * }
STEP { pload XSDRAW; uplevel stepread $file __a *; uplevel renamevar __a_1 $shape }
STL { pload XSDRAW; uplevel readstl $shape $file }
STL { pload XSDRAW; uplevel readstl $shape $file triangulation }
default { error "Cannot read $format file $file" }
}
}

52
tests/demo/testsystem/testfile Normal file
View File

@ -0,0 +1,52 @@
puts "# This test is for command testfile, used to check new data files "
puts "# before adding to the data base:"
puts "# - bottle.brep should be reported as already in data base"
puts "# - hammer_copy.igs should be reported as duplicate"
puts "# - square.brep should be reported as new, with warnings on DOS encoding"
puts "# and presence of triangulation"
puts ""
puts "# Preparing test data files..."
# find reference data files (they should be present, otherwise test is meaningless)
set bottle [locate_data_file bottle.brep]
set hammer [locate_data_file hammer.iges]
# bottle is simply copied
file copy -force $bottle ${imagedir}/bottle.brep
# hammer is copied with different name and DOS encoding
set fd [open $hammer r]
set hammer_content [read $fd]
close $fd
set fd [open ${imagedir}/_hammer_copy.igs w]
fconfigure $fd -translation crlf
puts -nonewline $fd $hammer_content
close $fd
# square is created anew
pload MODELING
box b 11.1 11.1 11.1
explode b f
tcopy b_1 f
incmesh f 0.01
save f ${imagedir}/_square.brep
set fd [open ${imagedir}/_square.brep r]
set square_content [read $fd]
close $fd
set fd [open ${imagedir}/_square.brep w]
fconfigure $fd -translation crlf
puts -nonewline $fd $square_content
close $fd
puts ""
puts "REQUIRED ALL: bottle.brep: already present"
puts "REQUIRED ALL: hammer_copy.igs: duplicate"
puts "REQUIRED ALL: square.brep: new file"
puts "REQUIRED ALL: Warning: DOS encoding detected"
puts "REQUIRED ALL: Warning: shape contains triangulation"
testfile [list ${imagedir}/bottle.brep ${imagedir}/_hammer_copy.igs ${imagedir}/_square.brep]
puts "TEST COMPLETED"