1 Automated Testing System {#occt_dev_guides__tests}
2 ======================================
6 @section testmanual_intro Introduction
8 This document provides OCCT developers and contributors with an overview and practical guidelines for work with OCCT automatic testing system.
10 Reading the Introduction should be sufficient for developers to use the test system to control non-regression of the modifications they implement in OCCT. Other sections provide a more in-depth description of the test system, required for modifying the tests and adding new test cases.
12 @subsection testmanual_intro_basic Basic Information
14 OCCT automatic testing system is organized around @ref occt_user_guides__test_harness "DRAW Test Harness", a console application based on Tcl (a scripting language) interpreter extended by OCCT-related commands.
16 Standard OCCT tests are included with OCCT sources and are located in subdirectory *tests* of the OCCT root folder. Other test folders can be included in the test system, e.g. for testing applications based on OCCT.
18 The tests are organized in three levels:
20 * Group: a group of related test grids, usually testing a particular OCCT functionality (e.g. blend);
21 * Grid: a set of test cases within a group, usually aimed at testing some particular aspect or mode of execution of the relevant functionality (e.g. buildevol);
22 * Test case: a script implementing an individual test (e.g. K4).
24 See @ref testmanual_5_1 "Test Groups" chapter for the current list of available test groups and grids.
26 Some tests involve data files (typically CAD models) which are located separately and are not included with OCCT code. The archive with publicly available test data files should be downloaded and installed independently on OCCT sources (see http://dev.opencascade.org).
28 @subsection testmanual_1_2 Intended Use of Automatic Tests
30 Each modification made in OCCT code must be checked for non-regression
31 by running the whole set of tests. The developer who makes the modification
32 is responsible for running and ensuring non-regression for the tests available to him.
34 Note that many tests are based on data files that are confidential and thus available only at OPEN CASCADE.
35 The official certification testing of each change before its integration to master branch of official OCCT Git repository (and finally to the official release) is performed by OPEN CASCADE to ensure non-regression on all existing test cases and supported platforms.
37 Each new non-trivial modification (improvement, bug fix, new feature) in OCCT should be accompanied by a relevant test case suitable for verifying that modification. This test case is to be added by the developer who provides the modification.
39 If a modification affects the result of an existing test case, either the modification should be corrected (if it causes regression) or the affected test cases should be updated to account for the modification.
41 The modifications made in the OCCT code and related test scripts should be included in the same integration to the master branch.
43 @subsection testmanual_1_3 Quick Start
45 @subsubsection testmanual_1_3_1 Setup
47 Before running tests, make sure to define environment variable *CSF_TestDataPath* pointing to the directory containing test data files.
49 For this it is recommended to add a file *DrawAppliInit* in the directory which is current at the moment of starting DRAWEXE (normally it is OCCT root directory, <i>$CASROOT </i>). This file is evaluated automatically at the DRAW start.
54 set env(CSF_TestDataPath) $env(CSF_TestDataPath)\;d:/occt/test-data
57 Note that variable *CSF_TestDataPath* is set to default value at DRAW start, pointing at the folder <i>$CASROOT/data</i>.
58 In this example, subdirectory <i>d:/occt/test-data</i> is added to this path. Similar code could be used on Linux and Mac OS X except that on non-Windows platforms colon ":" should be used as path separator instead of semicolon ";".
60 All tests are run from DRAW command prompt (run *draw.bat* or *draw.sh* to start it).
62 @subsubsection testmanual_1_3_2 Running Tests
64 To run all tests, type command *testgrid*
72 To run only a subset of test cases, give masks for group, grid, and test case names to be executed.
73 Each argument is a list of file masks separated with commas or spaces; by default "*" is assumed.
78 Draw[]> testgrid bugs caf,moddata*,xde
81 As the tests progress, the result of each test case is reported.
82 At the end of the log a summary of test cases is output,
83 including the list of detected regressions and improvements, if any.
88 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
91 CASE 3rdparty export A1: OK
93 CASE pipe standard B1: BAD (known problem)
94 CASE pipe standard C1: OK
96 Total cases: 208 BAD, 31 SKIPPED, 3 IMPROVEMENT, 1791 OK
97 Elapsed time: 1 Hours 14 Minutes 33.7384512019 Seconds
98 Detailed logs are saved in D:/occt/results_2012-06-04T0919
99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101 The tests are considered as non-regressive if only OK, BAD (i.e. known problem), and SKIPPED (i.e. not executed, typically because of lack of a data file) statuses are reported. See @ref testmanual_details_results "Interpretation of test results" for details.
103 The results and detailed logs of the tests are saved by default to a new subdirectory of the subdirectory *results* in the current folder, whose name is generated automatically using the current date and time, prefixed by Git branch name (if Git is available and current sources are managed by Git).
104 If necessary, a non-default output directory can be specified using option <i> -outdir</i> followed by a path to the directory. This directory should be new or empty; use option <i>-overwrite</i> to allow writing results in the existing non-empty directory.
108 Draw[]> testgrid -outdir d:/occt/last_results -overwrite
110 In the output directory, a cumulative HTML report <i>summary.html</i> provides links to reports on each test case. An additional report in JUnit-style XML format can be output for use in Jenkins or other continuous integration system.
112 To re-run test cases which were detected as regressions on previous run, option <i>-regress dirname</i> should be used.
113 <i>dirname</i> is path to directory containing results of previous run. Only test cases with *FAILED* and *IMPROVEMENT* statuses will be tested.
117 Draw[]> testgrid -regress d:/occt/last_results
120 Type <i>help testgrid</i> in DRAW prompt to get help on options supported by *testgrid* command:
123 Draw[3]> help testgrid
124 testgrid: Run all tests, or specified group, or one grid
125 Use: testgrid [groupmask [gridmask [casemask]]] [options...]
127 -parallel N: run N parallel processes (default is number of CPUs, 0 to disable)
128 -refresh N: save summary logs every N seconds (default 60, minimal 1, 0 to disable)
129 -outdir dirname: set log directory (should be empty or non-existing)
130 -overwrite: force writing logs in existing non-empty directory
131 -xml filename: write XML report for Jenkins (in JUnit-like format)
132 -beep: play sound signal at the end of the tests
133 -regress dirname: re-run only a set of tests that have been detected as regressions on some previous run.
134 Here "dirname" is path to directory containing results of previous run.
135 Groups, grids, and test cases to be executed can be specified by list of file
136 masks, separated by spaces or comma; default is all (*).
139 @subsubsection testmanual_1_3_3 Running a Single Test
141 To run a single test, type command *test* followed by names of group, grid, and test case.
145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
146 Draw[1]> test blend simple A1
147 CASE blend simple A1: OK
149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 Note that normally an intermediate output of the script is not shown. The detailed log of the test can be obtained after the test execution by running command <i>"dlog get"</i>.
153 To see intermediate commands and their output during the test execution, add one more argument
154 <i>"echo"</i> at the end of the command line. Note that with this option the log is not collected and summary is not produced.
156 Type <i>help test</i> in DRAW prompt to get help on options supported by *test* command:
160 test: Run specified test case
161 Use: test group grid casename [options...]
163 -echo: all commands and results are echoed immediately,
164 but log is not saved and summary is not produced
165 It is also possible to use "1" instead of "-echo"
166 If echo is OFF, log is stored in memory and only summary
167 is output (the log can be obtained with command "dlog get")
168 -outfile filename: set log file (should be non-existing),
169 it is possible to save log file in text file or
170 in html file(with snapshot), for that "filename"
171 should have ".html" extension
172 -overwrite: force writing log in existing file
173 -beep: play sound signal at the end of the test
174 -errors: show all lines from the log report that are recognized as errors
175 This key will be ignored if the "-echo" key is already set.
178 @subsubsection testmanual_intro_quick_create Creating a New Test
180 The detailed rules of creation of new tests are given in @ref testmanual_3 "Creation and modification of tests" chapter. The following short description covers the most typical situations:
182 Use prefix <i>bug</i> followed by Mantis issue ID and, if necessary, additional suffixes, for naming the test script, data files, and DRAW commands specific for this test case.
184 1. If the test requires C++ code, add it as new DRAW command(s) in one of files in *QABugs* package.
185 2. Add script(s) for the test case in the subfolder corresponding to the relevant OCCT module of the group *bugs* <i>($CASROOT/tests/bugs)</i>. See @ref testmanual_5_2 "the correspondence map".
186 3. In the test script:
187 * Load all necessary DRAW modules by command *pload*.
188 * Use command *locate_data_file* to get a path to data files used by test script. (Make sure to have this command not inside catch statement if it is used.)
189 * Use DRAW commands to reproduce the situation being tested.
190 * Make sure that in case of failure the test produces message containing word "Error" or other recognized by test system as error (add new error patterns in file parse.rules if necessary).
191 * If test case reports error due to existing problem and the fix is not available, add @ref testmanual_3_6 "TODO" statement for each error to mark it as known problem. The TODO statements must be specific so as to match the actually generated messages but not all similar errors.
192 * To check expected output which should be obtained as a result of a test, add @ref testmanual_3_7 "REQUIRED" statement for each line of output to mark it as required.
193 * If 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.
194 4. If the test uses data file(s) not yet present in the test database, these can be put to (sub)directory pointed out by *CSF_TestDataPath* variable for running test. The files should be attached to Mantis issue corresponding to the modification being tested.
195 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 to Git branch created for the issue.
203 A tests/bugs/heal/data/bug210_a.brep
204 A tests/bugs/heal/data/bug210_b.brep
205 A tests/bugs/heal/bug210_1
206 A tests/bugs/heal/bug210_2
212 puts "OCC210 (case 1): Improve FixShape for touching wires"
214 restore [locate_data_file bug210_a.brep] a
216 fixshape result a 0.01 0.01
220 @section testmanual_2 Organization of Test Scripts
222 @subsection testmanual_2_1 General Layout
224 Standard OCCT tests are located in subdirectory tests of the OCCT root folder ($CASROOT).
226 Additional test folders can be added to the test system by defining environment variable *CSF_TestScriptsPath*. This should be list of paths separated by semicolons (*;*) on Windows
227 or colons (*:*) on Linux or Mac. Upon DRAW launch, path to *tests* subfolder of OCCT is added at the end of this variable automatically.
229 Each test folder is expected to contain:
230 * Optional file *parse.rules* defining patterns for interpretation of test results, common for all groups in this folder
231 * One or several test group directories.
233 Each group directory contains:
235 * File *grids.list* that identifies this test group and defines list of test grids in it.
236 * Test grids (sub-directories), each containing set of scripts for test cases, and optional files *cases.list*, *parse.rules*, *begin* and *end*.
237 * Optional sub-directory data
239 By convention, names of test groups, grids, and cases should contain no spaces and be lower-case.
240 The names *begin, end, data, parse.rules, grids.list* and *cases.list* are reserved.
242 General layout of test scripts is shown in Figure 1.
244 @image html /dev_guides/tests/images/tests_image001.png "Layout of tests folder"
245 @image latex /dev_guides/tests/images/tests_image001.png "Layout of tests folder"
248 @subsection testmanual_2_2 Test Groups
250 @subsubsection testmanual_2_2_1 Group Names
252 The names of directories of test groups containing systematic test grids correspond to the functionality tested by each group.
262 Test group *bugs* is used to collect the tests coming from bug reports. Group *demo* collects tests of the test system, DRAW, samples, etc.
264 @subsubsection testmanual_2_2_2 File "grids.list"
266 This test group contains file *grids.list*, which defines an ordered list of grids in this group in the following format:
282 @subsubsection testmanual_2_2_3 File "begin"
284 This file is a Tcl script. It is executed before every test in the current group.
285 Usually it loads necessary Draw commands, sets common parameters and defines
286 additional Tcl functions used in test scripts.
290 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
291 pload TOPTEST ;# load topological command
292 set cpulimit 300 ;# set maximum time allowed for script execution
293 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
295 @subsubsection testmanual_2_2_4 File "end"
297 This file is a TCL script. It is executed after every test in the current group. Usually it checks the results of script work, makes a snap-shot of the viewer and writes *TEST COMPLETED* to the output.
299 Note: *TEST COMPLETED* string should be present in the output to indicate that the test is finished without crash.
301 See @ref testmanual_3 "Creation and modification of tests" chapter for more information.
305 if { [isdraw result] } {
308 puts "Error: The result shape can not be built"
310 puts "TEST COMPLETED"
313 @subsubsection testmanual_2_2_5 File "parse.rules"
315 The test group may contain *parse.rules* file. This file defines patterns used for analysis of the test execution log and deciding the status of the test run.
317 Each line in the file should specify a status (single word), followed by a regular expression delimited by slashes (*/*) that will be matched against lines in the test output log to check if it corresponds to this status.
319 The regular expressions should follow <a href="http://www.tcl.tk/man/tcl/TclCmd/re_syntax.htm">Tcl syntax</a>, with special exception that "\b" is considered as word limit (Perl-style), in addition to "\y" used in Tcl.
321 The rest of the line can contain a comment message, which will be added to the test report when this status is detected.
326 FAILED /\b[Ee]xception\b/ exception
327 FAILED /\bError\b/ error
328 SKIPPED /Cannot open file for reading/ data file is missing
329 SKIPPED /Could not read file .*, abandon/ data file is missing
332 Lines starting with a *#* character and blank lines are ignored to allow comments and spacing.
334 See @ref testmanual_details_results "Interpretation of test results" chapter for details.
336 If a line matches several rules, the first one applies. Rules defined in the grid are checked first, then rules in the group, then rules in the test root directory. This allows defining some rules on the grid level with status *IGNORE* to ignore messages that would otherwise be treated as errors due to the group level rules.
340 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
341 FAILED /\\bFaulty\\b/ bad shape
342 IGNORE /^Error [23]d = [\d.-]+/ debug output of blend command
343 IGNORE /^Tcl Exception: tolerance ang : [\d.-]+/ blend failure
344 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
346 @subsubsection testmanual_2_2_6 Directory "data"
347 The test group may contain subdirectory *data*, where test scripts shared by different test grids can be put. See also @ref testmanual_2_3_5 "Directory data".
349 @subsection testmanual_2_3 Test Grids
351 @subsubsection testmanual_2_3_1 Grid Names
353 The folder of a test group can have several sub-directories (Grid 1… Grid N) defining test grids.
354 Each directory contains a set of related test cases. The name of a directory should correspond to its contents.
365 Here *caf* is the name of the test group and *basic*, *bugs*, *presentation*, etc. are the names of grids.
367 @subsubsection testmanual_2_3_2 File "begin"
369 This file is a TCL script executed before every test in the current grid.
371 Usually it sets variables specific for the current grid.
375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
376 set command bopfuse ;# command tested in this grid
377 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
379 @subsubsection testmanual_2_3_3 File "end"
381 This file is a TCL script executed after every test in current grid.
383 Usually it executes a specific sequence of commands common for all tests in the grid.
387 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
388 vdump $imagedir/${casename}.png ;# makes a snap-shot of AIS viewer
389 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
391 @subsubsection testmanual_2_3_4 File "cases.list"
393 The grid directory can contain an optional file cases.list
394 defining an alternative location of the test cases.
395 This file should contain a single line defining the relative path to the collection of test cases.
403 This option is used for creation of several grids of tests with the same data files and operations but performed with differing parameters. The common scripts are usually located place in the common
404 subdirectory of the test group, <i>data/simple</i> for example.
406 If file *cases.list* exists, the grid directory should not contain any test cases.
407 The specific parameters and pre- and post-processing commands
408 for test execution in this grid should be defined in the files *begin* and *end*.
411 @subsubsection testmanual_2_3_5 Directory "data"
413 The test grid may contain subdirectory *data*, containing data files used in tests (BREP, IGES, STEP, etc.) of this grid.
415 @subsection testmanual_2_4 Test Cases
417 The test case is a TCL script, which performs some operations using DRAW commands
418 and produces meaningful messages that can be used to check the validity of the result.
422 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
423 pcylinder c1 10 20 ;# create first cylinder
424 pcylinder c2 5 20 ;# create second cylinder
425 ttranslate c2 5 0 10 ;# translate second cylinder to x,y,z
426 bsection result c1 c2 ;# create a section of two cylinders
427 checksection result ;# will output error message if result is bad
428 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
430 The test case can have any name (except for the reserved names *begin, end, data, cases.list* and *parse.rules*).
431 For systematic grids it is usually a capital English letter followed by a number.
442 Such naming facilitates compact representation of tests execution results in tabular format within HTML reports.
445 @section testmanual_3 Creation And Modification Of Tests
447 This section describes how to add new tests and update existing ones.
449 @subsection testmanual_3_1 Choosing Group, Grid, and Test Case Name
451 The new tests are usually added in the frame of processing issues in OCCT Mantis tracker.
452 Such tests in general should be added to group bugs, in the grid
453 corresponding to the affected OCCT functionality. See @ref testmanual_5_2 "Mapping of OCCT functionality to grid names in group bugs".
455 New grids can be added as necessary to contain tests for the functionality not yet covered by existing test grids.
456 The test case name in the bugs group should be prefixed by the ID of the corresponding issue in Mantis (without leading zeroes) with prefix *bug*. It is recommended to add a suffix providing a hint on the tested situation. If more than one test is added for a bug, they should be distinguished by suffixes; either meaningful or just ordinal numbers.
460 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.tcl}
462 bug12345_orthogonal_1
463 bug12345_orthogonal_2
464 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
466 If the new test corresponds to a functionality already covered by the existing systematic test grid (e.g. group *mesh* for *BRepMesh* issues), this test can be added (or moved later by OCC team) to that grid.
468 @subsection testmanual_3_2 Adding Data Files Required for a Test
470 It is advisable to make self-contained test scripts whenever possible, so as they could be used in the environments where data files are not available. For that simple geometric objects and shapes can be created using DRAW commands in the test script itself.
472 If the test requires a data file, it should be put to the directory listed in environment variable *CSF_TestDataPath*.
473 Alternatively, it can be put to subdirectory *data* of the test grid.
474 It is recommended to prefix the data file with the corresponding issue id prefixed by *bug*, e.g. *bug12345_face1.brep*, to avoid possible conflicts with names of existing data files.
476 Note that when the test is integrated to the master branch, OCC team will move the data file to the data files repository, to keep OCCT sources repository clean from data files.
478 When you prepare a test script, try to minimize the size of involved data model. For instance, if the problem detected on a big shape can be reproduced on a single face extracted from that shape, use only that face in the test.
481 @subsection testmanual_3_3 Adding new DRAW commands
483 If the test cannot be implemented using available DRAW commands, consider the following possibilities:
484 * If the existing DRAW command can be extended to enable possibility required for a test in a natural way (e.g. by adding an option to activate a specific mode of the algorithm), this way is recommended. This change should be appropriately documented in a relevant Mantis issue.
485 * If the new command is needed to access OCCT functionality not exposed to DRAW previously, and this command can be potentially reused (for other tests), it should be added to the package where similar commands are implemented (use *getsource* DRAW command to get the package name). The name and arguments of the new command should be chosen to keep similarity with the existing commands. This change should be documented in a relevant Mantis issue.
486 * Otherwise the new command implementing the actions needed for this particular test should be added in *QABugs* package. The command name should be formed by the Mantis issue ID prefixed by *bug*, e.g. *bug12345*.
488 Note that a DRAW command is expected to return 0 in case of a normal completion, and 1 (Tcl exception) if it is incorrectly used (e.g. a wrong number of input arguments). Thus if the new command needs to report a test error, this should be done by outputting an appropriate error message rather than by returning a non-zero value.
489 File names must be encoded in the script rather than in the DRAW command and passed to the DRAW command as an argument.
491 @subsection testmanual_3_4 Script Implementation
493 The test should run commands necessary to perform the tested operations, in general assuming a clean DRAW session. The required DRAW modules should be loaded by *pload* command, if it is not done by *begin* script. The messages produced by commands in a standard output should include identifiable messages on the discovered problems if any.
495 Usually the script represents a set of commands that a person would run interactively to perform the operation and see its results, with additional comments to explain what happens.
499 # Simple test of fusing box and sphere
506 Make sure that file *parse.rules* in the grid or group directory contains a regular expression to catch possible messages indicating the failure of the test.
508 For instance, for catching errors reported by *checkshape* command relevant grids define a rule to recognize its report by the word *Faulty*:
511 FAILED /\bFaulty\b/ bad shape
514 For the messages generated in the script it is recommended to use the word 'Error' in the error message.
519 set expected_length 11
520 if { [expr $actual_length - $expected_length] > 0.001 } {
521 puts "Error: The length of the edge should be $expected_length"
525 At the end, the test script should output *TEST COMPLETED* string to mark a successful completion of the script. This is often done by the *end* script in the grid.
527 When the test script requires a data file, use Tcl procedure *locate_data_file* to get a path to it, instead of putting the path explicitly. This will allow easy move of the data file from OCCT sources repository to the data files repository without the need to update the test script.
532 stepread [locate_data_file CAROSKI_COUPELLE.step] a *
535 When the test needs to produce some snapshots or other artefacts, use Tcl variable *imagedir* as the location where such files should be put.
536 * Command *testgrid* sets this variable to the subdirectory of the results folder corresponding to the grid.
537 * Command *test* by default creates a dedicated temporary directory in the system temporary folder (normally the one specified by environment variable *TempDir*, *TEMP*, or *TMP*) for each execution, and sets *imagedir* to that location.
539 However if variable *imagedir* is defined on the top level of Tcl interpretor, command *test* will use it instead of creating a new directory.
541 Use Tcl variable *casename* to prefix all files produced by the test.
542 This variable is set to the name of the test case.
544 The test system can recognize an image file (snapshot) and include it in HTML log and differences if its name starts with the name of the test case (use variable *casename*), optionally followed by underscore or dash and arbitrary suffix.
546 The image format (defined by extension) should be *png*.
550 xwd $imagedir/${casename}.png
551 vdisplay result; vfit
552 vdump $imagedir/${casename}-axo.png
554 vdump $imagedir/${casename}-front.png
564 Note that OCCT must be built with FreeImage support to be able to produce usable images.
566 Other Tcl variables defined during the test execution are:
567 - *groupname*: name of the test group;
568 - *gridname*: name of the test grid;
569 - *dirname*: path to the root directory of the current set of test scripts.
571 In order to ensure that the test works as expected in different environments, observe the following additional rules:
572 * Avoid using external commands such as *grep, rm,* etc., as these commands can be absent on another system (e.g. on Windows); use facilities provided by Tcl instead.
573 * Do not put call to *locate_data_file* in catch statement -- this can prevent correct interpretation of the missing data file by the test system.
574 * Do not use commands *decho* and *dlog* in the test script, to avoid interference with use of these commands by the test system.
576 @subsection testmanual_details_results Interpretation of test results
578 The result of the test is evaluated by checking its output against patterns defined in the files *parse.rules* of the grid and group.
580 The OCCT test system recognizes five statuses of the test execution:
581 * SKIPPED: reported if a line matching SKIPPED pattern is found (prior to any FAILED pattern). This indicates that the test cannot be run in the current environment; the most typical case is the absence of the required data file.
582 * FAILED: reported if a line matching pattern with status FAILED is found (unless it is masked by the preceding IGNORE pattern or a TODO or REQUIRED statement), or if message TEST COMPLETED or at least one of REQUIRED patterns is not found. This indicates that the test has produced a bad or unexpected result, and usually means a regression.
583 * BAD: reported if the test script output contains one or several TODO statements and the corresponding number of matching lines in the log. This indicates a known problem. The lines matching TODO statements are not checked against other patterns and thus will not cause a FAILED status.
584 * IMPROVEMENT: reported if the test script output contains a TODO statement for which no corresponding line is found. This is a possible indication of improvement (a known problem has disappeared).
585 * OK: reported if none of the above statuses have been assigned. This means that the test has passed without problems.
587 Other statuses can be specified in *parse.rules* files, these will be classified as FAILED.
589 For integration of the change to OCCT repository, all tests should return either OK or BAD status.
590 The new test created for an unsolved problem should return BAD. The new test created for a fixed problem should return FAILED without the fix, and OK with the fix.
592 @subsection testmanual_3_6 Marking BAD cases
594 If the test produces an invalid result at a certain moment then the corresponding bug should be created in the OCCT issue tracker located at http://tracker.dev.opencascade.org, and the problem should be marked as TODO in the test script.
596 The following statement should be added to such a test script:
598 puts "TODO BugNumber ListOfPlatforms: RegularExpression"
602 * *BugNumber* is the bug ID in the tracker. For example: #12345.
603 * *ListOfPlatforms* is a list of platforms, at which the bug is reproduced (Linux, Windows, MacOS, or All). Note that the platform name is custom for the OCCT test system; it corresponds to the value of environment variable *os_type* defined in DRAW.
607 Draw[2]> puts $env(os_type)
611 * RegularExpression is a regular expression, which should be matched against the line indicating the problem in the script output.
615 puts "TODO #22622 Mandriva2008: Abort .* an exception was raised"
618 The parser checks the test output and if an output line matches the *RegularExpression* then it will be assigned a BAD status instead of FAILED.
620 A separate TODO line must be added for each output line matching an error expression to mark the test as BAD. If not all TODO messages are found in the test log, the test will be considered as possible improvement.
622 To mark the test as BAD for an incomplete case (when the final *TEST COMPLETE* message is missing) the expression *TEST INCOMPLETE* should be used instead of the regular expression.
627 puts "TODO OCC22817 All: exception.+There are no suitable edges"
628 puts "TODO OCC22817 All: \\*\\* Exception \\*\\*"
629 puts "TODO OCC22817 All: TEST INCOMPLETE"
632 @subsection testmanual_3_7 Marking required output
634 To check expected output which must be obtained as a result of a test for it to be considered correct, add REQUIRED statement for each specific message.
635 For that, the following statement should be added to such a test script:
638 puts "REQUIRED ListOfPlatforms: RegularExpression"
641 Here *ListOfPlatforms* and *RegularExpression* have the same meaning as in TODO statements described above.
643 The REQUIRED statement can also be used to mask message that would normally be interpreted as error (according to rules defined in *parse.rules*) but should not be considered as such within current test.
647 puts "REQUIRED Linux: Faulty shapes in variables faulty_1 to faulty_5"
650 This statement notifies test system that errors reported by *checkshape* command are expected in that test case, and test should be considered as OK if this message appears, despite of presence of general rule stating that 'Faulty' signals failure.
652 If output does not contain required statement, test case will be marked as FAILED.
654 @section testmanual_4 Advanced Use
656 @subsection testmanual_4_1 Running Tests on Older Versions of OCCT
658 Sometimes it might be necessary to run tests on the previous versions of OCCT (<= 6.5.4) that do not include this test system. This can be done by adding DRAW configuration file *DrawAppliInit* in the directory, which is current by the moment of DRAW start-up, to load test commands and to define the necessary environment.
660 Note: in OCCT 6.5.3, file *DrawAppliInit* already exists in <i>$CASROOT/src/DrawResources</i>, new commands should be added to this file instead of a new one in the current directory.
662 For example, let us assume that *d:/occt* contains an up-to-date version of OCCT sources with tests, and the test data archive is unpacked to *d:/test-data*):
665 set env(CASROOT) d:/occt
666 set env(CSF_TestScriptsPath) $env(CASROOT)/tests
667 source $env(CASROOT)/src/DrawResources/TestCommands.tcl
668 set env(CSF_TestDataPath) $env(CASROOT)/data;d:/test-data
672 Note that on older versions of OCCT the tests are run in compatibility mode and thus not all output of the test command can be captured; this can lead to absence of some error messages (can be reported as either a failure or an improvement).
674 @subsection testmanual_4_2 Adding custom tests
676 You can extend the test system by adding your own tests. For that it is necessary to add paths to the directory where these tests are located, and one or more additional data directories, to the environment variables *CSF_TestScriptsPath* and *CSF_TestDataPath*. The recommended way for doing this is using DRAW configuration file *DrawAppliInit* located in the directory which is current by the moment of DRAW start-up.
678 Use Tcl command <i>_path_separator</i> to insert a platform-dependent separator to the path list.
682 set env(CSF_TestScriptsPath) \
683 $env(TestScriptsPath)[_path_separator]d:/MyOCCTProject/tests
684 set env(CSF_TestDataPath) \
685 d:/occt/test-data[_path_separator]d:/MyOCCTProject/data
686 return ;# this is to avoid an echo of the last command above in cout
689 @subsection testmanual_4_3 Parallel execution of tests
691 For better efficiency, on computers with multiple CPUs the tests can be run in parallel mode. This is default behavior for command *testgrid* : the tests are executed in parallel processes (their number is equal to the number of CPUs available on the system). In order to change this behavior, use option parallel followed by the number of processes to be used (1 or 0 to run sequentially).
693 Note that the parallel execution is only possible if Tcl extension package *Thread* is installed.
694 If this package is not available, *testgrid* command will output a warning message.
696 @subsection testmanual_4_4 Checking non-regression of performance, memory, and visualization
698 Some test results are very dependent on the characteristics of the workstation, where they are performed, and thus cannot be checked by comparison with some predefined values. These results can be checked for non-regression (after a change in OCCT code) by comparing them with the results produced by the version without this change. The most typical case is comparing the result obtained in a branch created for integration of a fix (CR***) with the results obtained on the master branch before that change is made.
700 OCCT test system provides a dedicated command *testdiff* for comparing CPU time of execution, memory usage, and images produced by the tests.
703 testdiff dir1 dir2 [groupname [gridname]] [options...]
705 Here *dir1* and *dir2* are directories containing logs of two test runs.
707 Possible options are:
708 * <i>-save \<filename\> </i> -- saves the resulting log in a specified file (<i>$dir1/diff-$dir2.log</i> by default). HTML log is saved with the same name and extension .html;
709 * <i>-status {same|ok|all}</i> -- allows filtering compared cases by their status:
710 * *same* -- only cases with same status are compared (default);
711 * *ok* -- only cases with OK status in both logs are compared;
712 * *all* -- results are compared regardless of status;
713 * <i>-verbose \<level\> </i> -- defines the scope of output data:
714 * 1 -- outputs only differences;
715 * 2 -- additionally outputs the list of logs and directories present in one of directories only;
716 * 3 -- (by default) additionally outputs progress messages;
721 Draw[]> testdiff results-CR12345-2012-10-10T08:00 results-master-2012-10-09T21:20
724 @section testmanual_5 APPENDIX
726 @subsection testmanual_5_1 Test groups
728 @subsubsection testmanual_5_1_1 3rdparty
730 This group allows testing the interaction of OCCT and 3rdparty products.
732 DRAW module: VISUALIZATION.
734 | Grid | Commands | Functionality |
735 | :---- | :----- | :------- |
736 | export | vexport | export of images to different formats |
737 | fonts | vtrihedron, vcolorscale, vdrawtext | display of fonts |
740 @subsubsection testmanual_5_1_2 blend
742 This group allows testing blends (fillets) and related operations.
744 DRAW module: MODELING.
746 | Grid | Commands | Functionality |
747 | :---- | :----- | :------- |
748 | simple | blend | fillets on simple shapes |
749 | complex | blend | fillets on complex shapes, non-trivial geometry |
750 | tolblend_simple | tolblend, blend | |
751 | buildevol | buildevol | |
752 | tolblend_buildvol | tolblend, buildevol | use of additional command tolblend |
753 | bfuseblend | bfuseblend | |
754 | encoderegularity | encoderegularity | |
756 @subsubsection testmanual_5_1_3 boolean
758 This group allows testing Boolean operations.
760 DRAW module: MODELING (packages *BOPTest* and *BRepTest*).
762 Grids names are based on name of the command used, with suffixes:
763 * <i>_2d</i> -- for tests operating with 2d objects (wires, wires, 3d objects, etc.);
764 * <i>_simple</i> -- for tests operating on simple shapes (boxes, cylinders, toruses, etc.);
765 * <i>_complex</i> -- for tests dealing with complex shapes.
767 | Grid | Commands | Functionality |
768 | :---- | :----- | :------- |
769 | bcommon_2d | bcommon | Common operation (old algorithm), 2d |
770 | bcommon_complex | bcommon | Common operation (old algorithm), complex shapes |
771 | bcommon_simple | bcommon | Common operation (old algorithm), simple shapes |
772 | bcut_2d | bcut | Cut operation (old algorithm), 2d |
773 | bcut_complex | bcut | Cut operation (old algorithm), complex shapes |
774 | bcut_simple | bcut | Cut operation (old algorithm), simple shapes |
775 | bcutblend | bcutblend | |
776 | bfuse_2d | bfuse | Fuse operation (old algorithm), 2d |
777 | bfuse_complex | bfuse | Fuse operation (old algorithm), complex shapes |
778 | bfuse_simple | bfuse | Fuse operation (old algorithm), simple shapes |
779 | bopcommon_2d | bopcommon | Common operation, 2d |
780 | bopcommon_complex | bopcommon | Common operation, complex shapes |
781 | bopcommon_simple | bopcommon | Common operation, simple shapes |
782 | bopcut_2d | bopcut | Cut operation, 2d |
783 | bopcut_complex | bopcut | Cut operation, complex shapes |
784 | bopcut_simple | bopcut | Cut operation, simple shapes |
785 | bopfuse_2d | bopfuse | Fuse operation, 2d |
786 | bopfuse_complex | bopfuse | Fuse operation, complex shapes |
787 | bopfuse_simple | bopfuse | Fuse operation, simple shapes |
788 | bopsection | bopsection | Section |
789 | boptuc_2d | boptuc | |
790 | boptuc_complex | boptuc | |
791 | boptuc_simple | boptuc | |
792 | bsection | bsection | Section (old algorithm) |
794 @subsubsection testmanual_5_1_4 bugs
796 This group allows testing cases coming from Mantis issues.
798 The grids are organized following OCCT module and category set for the issue in the Mantis tracker.
799 See @ref testmanual_5_2 "Mapping of OCCT functionality to grid names in group bugs" chapter for details.
801 @subsubsection testmanual_5_1_5 caf
803 This group allows testing OCAF functionality.
805 DRAW module: OCAFKERNEL.
807 | Grid | Commands | Functionality |
808 | :---- | :----- | :------- |
809 | basic | | Basic attributes |
810 | bugs | | Saving and restoring of document |
811 | driver | | OCAF drivers |
812 | named_shape | | *TNaming_NamedShape* attribute |
813 | presentation | | *AISPresentation* attributes |
814 | tree | | Tree construction attributes |
815 | xlink | | XLink attributes |
817 @subsubsection testmanual_5_1_6 chamfer
819 This group allows testing chamfer operations.
821 DRAW module: MODELING.
823 The test grid name is constructed depending on the type of the tested chamfers. Additional suffix <i>_complex</i> is used for test cases involving complex geometry (e.g. intersections of edges forming a chamfer); suffix <i>_sequence</i> is used for grids where chamfers are computed sequentially.
825 | Grid | Commands | Functionality |
826 | :---- | :----- | :------- |
827 | equal_dist | | Equal distances from edge |
828 | equal_dist_complex | | Equal distances from edge, complex shapes |
829 | equal_dist_sequence | | Equal distances from edge, sequential operations |
830 | dist_dist | | Two distances from edge |
831 | dist_dist_complex | | Two distances from edge, complex shapes |
832 | dist_dist_sequence | | Two distances from edge, sequential operations |
833 | dist_angle | | Distance from edge and given angle |
834 | dist_angle_complex | | Distance from edge and given angle |
835 | dist_angle_sequence | | Distance from edge and given angle |
837 @subsubsection testmanual_5_1_7 demo
839 This group allows demonstrating how testing cases are created, and testing DRAW commands and the test system as a whole.
841 | Grid | Commands | Functionality |
842 | :---- | :----- | :------- |
843 | draw | getsource, restore | Basic DRAW commands |
844 | testsystem | | Testing system |
845 | samples | | OCCT samples |
848 @subsubsection testmanual_5_1_8 draft
850 This group allows testing draft operations.
852 DRAW module: MODELING.
854 | Grid | Commands | Functionality |
855 | :---- | :----- | :------- |
856 | Angle | depouille | Drafts with angle (inclined walls) |
859 @subsubsection testmanual_5_1_9 feat
861 This group allows testing creation of features on a shape.
863 DRAW module: MODELING (package *BRepTest*).
865 | Grid | Commands | Functionality |
866 | :---- | :----- | :------- |
873 @subsubsection testmanual_5_1_10 heal
875 This group allows testing the functionality provided by *ShapeHealing* toolkit.
879 | Grid | Commands | Functionality |
880 | :---- | :----- | :------- |
881 | fix_shape | fixshape | Shape healing |
882 | fix_gaps | fixwgaps | Fixing gaps between edges on a wire |
883 | same_parameter | sameparameter | Fixing non-sameparameter edges |
884 | fix_face_size | DT_ApplySeq | Removal of small faces |
885 | elementary_to_revolution | DT_ApplySeq | Conversion of elementary surfaces to revolution |
886 | direct_faces | directfaces | Correction of axis of elementary surfaces |
887 | drop_small_edges | fixsmall | Removal of small edges |
888 | split_angle | DT_SplitAngle | Splitting periodic surfaces by angle |
889 | split_angle_advanced | DT_SplitAngle | Splitting periodic surfaces by angle |
890 | split_angle_standard | DT_SplitAngle | Splitting periodic surfaces by angle |
891 | split_closed_faces | DT_ClosedSplit | Splitting of closed faces |
892 | surface_to_bspline | DT_ToBspl | Conversion of surfaces to b-splines |
893 | surface_to_bezier | DT_ShapeConvert | Conversion of surfaces to bezier |
894 | split_continuity | DT_ShapeDivide | Split surfaces by continuity criterion |
895 | split_continuity_advanced | DT_ShapeDivide | Split surfaces by continuity criterion |
896 | split_continuity_standard | DT_ShapeDivide | Split surfaces by continuity criterion |
897 | surface_to_revolution_advanced | DT_ShapeConvertRev | Convert elementary surfaces to revolutions, complex cases |
898 | surface_to_revolution_standard | DT_ShapeConvertRev | Convert elementary surfaces to revolutions, simple cases |
900 @subsubsection testmanual_5_1_11 mesh
902 This group allows testing shape tessellation (*BRepMesh*) and shading.
904 DRAW modules: MODELING (package *MeshTest*), VISUALIZATION (package *ViewerTest*)
906 | Grid | Commands | Functionality |
907 | :---- | :----- | :------- |
908 | advanced_shading | vdisplay | Shading, complex shapes |
909 | standard_shading | vdisplay | Shading, simple shapes |
910 | advanced_mesh | mesh | Meshing of complex shapes |
911 | standard_mesh | mesh | Meshing of simple shapes |
912 | advanced_incmesh | incmesh | Meshing of complex shapes |
913 | standard_incmesh | incmesh | Meshing of simple shapes |
914 | advanced_incmesh_parallel | incmesh | Meshing of complex shapes, parallel mode |
915 | standard_incmesh_parallel | incmesh | Meshing of simple shapes, parallel mode |
917 @subsubsection testmanual_5_1_12 mkface
919 This group allows testing creation of simple surfaces.
921 DRAW module: MODELING (package *BRepTest*)
923 | Grid | Commands | Functionality |
924 | :---- | :----- | :------- |
925 | after_trim | mkface | |
926 | after_offset | mkface | |
927 | after_extsurf_and_offset | mkface | |
928 | after_extsurf_and_trim | mkface | |
929 | after_revsurf_and_offset | mkface | |
930 | mkplane | mkplane | |
932 @subsubsection testmanual_5_1_13 nproject
934 This group allows testing normal projection of edges and wires onto a face.
936 DRAW module: MODELING (package *BRepTest*)
938 | Grid | Commands | Functionality |
939 | :---- | :----- | :------- |
940 | Base | nproject | |
942 @subsubsection testmanual_5_1_14 offset
944 This group allows testing offset functionality for curves and surfaces.
946 DRAW module: MODELING (package *BRepTest*)
948 | Grid | Commands | Functionality |
949 | :---- | :----- | :------- |
950 | compshape | offsetcompshape | Offset of shapes with removal of some faces |
951 | faces_type_a | offsetparameter, offsetload, offsetperform | Offset on a subset of faces with a fillet |
952 | faces_type_i | offsetparameter, offsetload, offsetperform | Offset on a subset of faces with a sharp edge |
953 | shape_type_a | offsetparameter, offsetload, offsetperform | Offset on a whole shape with a fillet |
954 | shape_type_i | offsetparameter, offsetload, offsetperform | Offset on a whole shape with a fillet |
955 | shape | offsetshape | |
956 | wire_closed_outside_0_005, wire_closed_outside_0_025, wire_closed_outside_0_075, wire_closed_inside_0_005, wire_closed_inside_0_025, wire_closed_inside_0_075, wire_unclosed_outside_0_005, wire_unclosed_outside_0_025, wire_unclosed_outside_0_075 | mkoffset | 2d offset of closed and unclosed planar wires with different offset step and directions of offset ( inside / outside ) |
958 @subsubsection testmanual_5_1_15 pipe
960 This group allows testing construction of pipes (sweeping of a contour along profile).
962 DRAW module: MODELING (package *BRepTest*)
964 | Grid | Commands | Functionality |
965 | :---- | :----- | :------- |
966 | Standard | pipe | |
968 @subsubsection testmanual_5_1_16 prism
970 This group allows testing construction of prisms.
972 DRAW module: MODELING (package *BRepTest*)
974 | Grid | Commands | Functionality |
975 | :---- | :----- | :------- |
978 @subsubsection testmanual_5_1_17 sewing
980 This group allows testing sewing of faces by connecting edges.
982 DRAW module: MODELING (package *BRepTest*)
984 | Grid | Commands | Functionality |
985 | :---- | :----- | :------- |
986 | tol_0_01 | sewing | Sewing faces with tolerance 0.01 |
987 | tol_1 | sewing | Sewing faces with tolerance 1 |
988 | tol_100 | sewing | Sewing faces with tolerance 100 |
990 @subsubsection testmanual_5_1_18 thrusection
992 This group allows testing construction of shell or a solid passing through a set of sections in a given sequence (loft).
994 | Grid | Commands | Functionality |
995 | :---- | :----- | :------- |
996 | solids | thrusection | Lofting with resulting solid |
997 | not_solids | thrusection | Lofting with resulting shell or face |
999 @subsubsection testmanual_5_1_19 xcaf
1001 This group allows testing extended data exchange packages.
1003 | Grid | Commands | Functionality |
1004 | :---- | :----- | :------- |
1005 | dxc, dxc_add_ACL, dxc_add_CL, igs_to_dxc, igs_add_ACL, brep_to_igs_add_CL, stp_to_dxc, stp_add_ACL, brep_to_stp_add_CL, brep_to_dxc, add_ACL_brep, brep_add_CL | | Subgroups are divided by format of source file, by format of result file and by type of document modification. For example, *brep_to_igs* means that the source shape in brep format was added to the document, which was saved into igs format after that. The postfix *add_CL* means that colors and layers were initialized in the document before saving and the postfix *add_ACL* corresponds to the creation of assembly and initialization of colors and layers in a document before saving. |
1008 @subsection testmanual_5_2 Mapping of OCCT functionality to grid names in group *bugs*
1010 | OCCT Module / Mantis category | Toolkits | Test grid in group bugs |
1011 | :---------- | :--------- | :---------- |
1012 | Application Framework | PTKernel, TKPShape, TKCDF, TKLCAF, TKCAF, TKBinL, TKXmlL, TKShapeSchema, TKPLCAF, TKBin, TKXml, TKPCAF, FWOSPlugin, TKStdLSchema, TKStdSchema, TKTObj, TKBinTObj, TKXmlTObj | caf |
1013 | Draw | TKDraw, TKTopTest, TKViewerTest, TKXSDRAW, TKDCAF, TKXDEDRAW, TKTObjDRAW, TKQADraw, DRAWEXE, Problems of testing system | draw |
1014 | Shape Healing | TKShHealing | heal |
1015 | Mesh | TKMesh, TKXMesh | mesh |
1016 | Data Exchange | TKIGES | iges |
1017 | Data Exchange | TKSTEPBase, TKSTEPAttr, TKSTEP209, TKSTEP | step |
1018 | Data Exchange | TKSTL, TKVRML | stlvrml |
1019 | Data Exchange | TKXSBase, TKXCAF, TKXCAFSchema, TKXDEIGES, TKXDESTEP, TKXmlXCAF, TKBinXCAF | xde |
1020 | Foundation Classes | TKernel, TKMath | fclasses |
1021 | Modeling_algorithms | TKGeomAlgo, TKTopAlgo, TKPrim, TKBO, TKBool, TKHLR, TKFillet, TKOffset, TKFeat, TKXMesh | modalg |
1022 | Modeling Data | TKG2d, TKG3d, TKGeomBase, TKBRep | moddata |
1023 | Visualization | TKService, TKV2d, TKV3d, TKOpenGl, TKMeshVS, TKNIS | vis |
1026 @subsection testmanual_5_3 Recommended approaches to checking test results
1028 @subsubsection testmanual_5_3_1 Shape validity
1030 Run command *checkshape* on the result (or intermediate) shape and make sure that *parse.rules* of the test grid or group reports bad shapes (usually recognized by word "Faulty") as error.
1037 To check the number of faults in the shape command *checkfaults* can be used.
1039 Use: checkfaults shape source_shape [ref_value=0]
1041 The default syntax of *checkfaults* command:
1043 checkfaults results a_1
1046 The command will check the number of faults in the source shape (*a_1*) and compare it
1047 with number of faults in the resulting shape (*result*). If shape *result* contains
1048 more faults, you will get an error:
1050 checkfaults results a_1
1051 Error : Number of faults is 5
1053 It is possible to set the reference value for comparison (reference value is 4):
1056 checkfaults results a_1 4
1059 If number of faults in the resulting shape is unstable, reference value should be set to "-1".
1060 As a result command *checkfaults* will return the following error:
1063 checkfaults results a_1 -1
1064 Error : Number of faults is UNSTABLE
1067 @subsubsection testmanual_5_3_2 Shape tolerance
1068 The maximal tolerance of sub-shapes of each kind of the resulting shape can be extracted from output of tolerance command as follows:
1071 set tolerance [tolerance result]
1072 regexp { *FACE +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_face
1073 regexp { *EDGE +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_edgee
1074 regexp { *VERTEX +: +MAX=([-0-9.+eE]+)} $tolerance dummy max_vertex
1077 It is possible to use command *checkmaxtol* to check maximal tolerance of shape and compare it with reference value.
1079 Use: checkmaxtol shape [options...]
1081 Allowed options are:
1082 * -ref: reference value of maximum tolerance
1083 * -source: list of shapes to compare with
1084 * -min_tol: minimum tolerance for comparison
1085 * -multi_tol: tolerance multiplier
1087 The default syntax of *checkmaxtol* command for comparison with the reference value:
1089 checkmaxtol result -ref 0.00001
1092 There is an opportunity to compare max tolerance of resulting shape with max tolerance of source shape.
1093 In the following example command *checkmaxtol* gets max tolerance among objects *a_1* and *a_2*.
1094 Then it chooses the maximum value between founded tolerance and value -min_tol (0.000001)
1095 and multiply it on the coefficient -multi_tol (i.e. 2):
1098 checkmaxtol result -source {a_1 a_2} -min_tol 0.000001 -multi_tol 2
1101 If the value of maximum tolerance more than founded tolerance for comparison, the command will return an error.
1103 Also, command *checkmaxtol* can be used to get max tolerance of the shape:
1106 set maxtol [checkmaxtol result]
1109 @subsubsection testmanual_5_3_3 Shape volume, area, or length
1111 Use command *vprops, sprops,* or *lprops* to correspondingly measure volume, area, or length of the shape produced by the test. The value can be extracted from the result of the command by *regexp*.
1115 # check area of shape result with 1% tolerance
1116 regexp {Mass +: +([-0-9.+eE]+)} [sprops result] dummy area
1117 if { abs($area - $expected) > 0.1 + 0.01 * abs ($area) } {
1118 puts "Error: The area of result shape is $area, while expected $expected"
1122 @subsubsection testmanual_5_3_4 Memory leaks
1124 The test system measures the amount of memory used by each test case, and considerable deviations (as well as overall difference) comparing with reference results will be reported by *testdiff* command.
1126 The typical approach to checking memory leak on a particular operation is to run this operation in cycle measuring memory consumption at each step and comparing it with some threshold value. Note that file begin in group bugs defines command *checktrend* that can be used to analyze a sequence of memory measurements to get statistically based evaluation of the leak presence.
1131 for {set i 1} {$i < 100} {incr i} {
1132 # run suspect operation
1134 # check memory usage (with tolerance equal to half page size)
1135 lappend listmem [expr [meminfo w] / 1024]
1136 if { [checktrend $listmem 0 256 "Memory leak detected"] } {
1137 puts "No memory leak, $i iterations"
1143 @subsubsection testmanual_5_3_5 Visualization
1145 Take a snapshot of the viewer, give it the name of the test case, and save in the directory indicated by Tcl variable *imagedir*.
1154 vdump $imagedir/${casename}_shading.png
1157 This image will be included in the HTML log produced by *testgrid* command and will be checked for non-regression through comparison of images by command *testdiff*.
1159 Also it is possible to use command *checkview* to make a snapshot of the viewer.
1161 Use: checkview [options...]
1162 Allowed options are:
1163 * -display shapename: display shape with name 'shapename'
1164 * -3d: display shape in 3d viewer
1165 * -2d [ v2d / smallview ]: display shape in 2d viewer (default viewer is a 'smallview')
1166 * -path PATH: location of saved screenshot of viewer
1167 * -vdispmode N: it is possible to set vdispmode for 3d viewer (default value is 1)
1168 * -screenshot: procedure will try to make screenshot of already created viewer
1169 * Procedure can check some property of shape (length, area or volume) and compare it with some value N:
1173 * If current property is equal to value N, shape is marked as valid in procedure.
1174 * If value N is not given procedure will mark shape as valid if current property is non-zero.
1175 * -with {a b c}: display shapes 'a' 'b' 'c' together with 'shape' (if shape is valid)
1176 * -otherwise {d e f}: display shapes 'd' 'e' 'f' instead of 'shape' (if shape is NOT valid)
1178 Note that one of two options -2d/-3d is required.
1182 checkview -display result -2d -path ${imagedir}/${test_image}.png
1183 checkview -display result -3d -path ${imagedir}/${test_image}.png
1184 checkview -display result_2d -2d v2d -path ${imagedir}/${test_image}.png
1188 box b 5 5 5 10 10 10
1190 set result_vertices [explode result v]
1191 checkview -display result -2d -with ${result_vertices} -otherwise { a b } -l -path ${imagedir}/${test_image}.png
1195 box b 5 5 5 10 10 10
1200 checkview -screenshot -3d -path ${imagedir}/${test_image}.png
1203 @subsubsection testmanual_5_3_6 Number of free edges
1205 To check the number of free edges run the command *checkfreebounds*.
1207 It compares number of free edges with reference value.
1209 Use: checkfreebounds shape ref_value [options...]
1211 Allowed options are:
1212 * -tol N: used tolerance (default -0.01)
1213 * -type N: used type, possible values are "closed" and "opened" (default "closed")
1216 checkfreebounds result 13
1219 Option -tol N is used to set tolerance for command *freebounds*, which is used within command *checkfreebounds*.
1221 Option -type N is used to select the type of counted free edges - closed or opened.
1223 If the number of free edges in the resulting shape is unstable, reference value should be set to "-1".
1224 As a result command *checkfreebounds* will return the following error:
1227 checkfreebounds result -1
1228 Error : Number of free edges is UNSTABLE
1231 @subsubsection testmanual_5_3_7 Compare numbers
1233 Procedure to check equality of two reals with some tolerance (relative and absolute)
1235 Use: checkreal name value expected tol_abs tol_rel
1238 checkreal "Some important value" $value 5 0.0001 0.01
1241 @subsubsection testmanual_5_3_8 Check number of sub-shapes
1243 Compare number of sub-shapes in "shape" with given reference data
1245 Use: checknbshapes shape [options...]
1246 Allowed options are:
1256 * -t: compare the number of sub-shapes in "shape" counting
1257 the same sub-shapes with different location as different sub-shapes.
1258 * -m msg: print "msg" in case of error
1261 checknbshapes result -vertex 8 -edge 4
1264 @subsubsection testmanual_5_3_9 Check pixel color
1266 To check pixel color command *checkcolor* can be used.
1268 Use: checkcolor x y red green blue
1270 x, y -- pixel coordinates
1272 red green blue -- expected pixel color (values from 0 to 1)
1274 This procedure checks color with tolerance (5x5 area)
1276 Next example will compare color of point with coordinates x=100 y=100 with RGB color R=1 G=0 B=0.
1277 If colors are not equal, procedure will check the nearest ones points (5x5 area)
1279 checkcolor 100 100 1 0 0
1282 @subsubsection testmanual_5_3_10 Compute length, area and volume of input shape
1284 Procedure *checkprops* computes length, area and volume of input shape.
1286 Use: checkprops shapename [options...]
1288 Allowed options are:
1289 * -l LENGTH: command lprops, computes the mass properties of all edges in the shape with a linear density of 1
1290 * -s AREA: command sprops, computes the mass properties of all faces with a surface density of 1
1291 * -v VOLUME: command vprops, computes the mass properties of all solids with a density of 1
1292 * -eps EPSILON: the epsilon defines relative precision of computation
1293 * -equal SHAPE: compare area\volume\length of input shapes. Puts error if its are not equal
1294 * -notequal SHAPE: compare area\volume\length of input shapes. Puts error if its are equal
1296 Options -l, -s and -v are independent and can be used in any order. Tolerance epsilon is the same for all options.
1299 checkprops result -s 6265.68
1300 checkprops result -s -equal FaceBrep
1303 @subsubsection testmanual_5_3_11 Parse output dump and compare it with reference values
1305 Procedure *checkdump* is used to parse output dump and compare it with reference values.
1307 Use: checkdump shapename [options...]
1309 Allowed options are:
1310 * -name NAME: list of parsing parameters (e.g. Center, Axis, etc)
1311 * -ref VALUE: list of reference values for each parameter in NAME
1312 * -eps EPSILON: the epsilon defines relative precision of computation
1315 checkdump result -name {Center Axis XAxis YAxis Radii} -ref {{-70 0} {-1 -0} {-1 -0} {0 -1} {20 10}} -eps 0.01
1318 @subsubsection testmanual_5_3_12 Compute length of input curve
1320 Procedure *checklength* computes length of input curve.
1322 Use: checklength curvename [options...]
1324 Allowed options are:
1325 * -l LENGTH: command length, computes the length of input curve with precision of computation
1326 * -eps EPSILON: the epsilon defines relative precision of computation
1327 * -equal CURVE: compare length of input curves. Puts error if its are not equal
1328 * -notequal CURVE: compare length of input curves. Puts error if its are equal
1331 checklength cp1 -l 7.278
1332 checklength res -l -equal ext_1
1334 @subsubsection testmanual_5_3_13 Check maximum deflection, number of triangles and nodes in mesh
1336 To check maximum deflection, number of nodes and triangles in mesh command *checktrinfo* can be used.
1338 Use: checktrinfo shapename [options...]
1340 Allowed options are:
1341 * -tri [N]: compare current number of triangles in "shapename" mesh with given reference data.
1342 If reference value N is not given and current number of triangles is equal to 0
1343 procedure checktrinfo will print an error.
1344 * -nod [N]: compare current number of nodes in "shapename" mesh with given reference data.
1345 If reference value N is not givenand current number of nodes is equal to 0
1346 procedure checktrinfo will print an error.
1347 * -defl [N]: compare current value of maximum deflection in "shapename" mesh with given reference data
1348 If reference value N is not given and current maximum deflection is equal to 0
1349 procedure checktrinfo will print an error.
1350 * -max_defl N: compare current value of maximum deflection in "shapename" mesh with max possible value
1351 * -tol_abs_tri N: absolute tolerance for comparison of number of triangles (default value 0)
1352 * -tol_rel_tri N: relative tolerance for comparison of number of triangles (default value 0)
1353 * -tol_abs_nod N: absolute tolerance for comparison of number of nodes (default value 0)
1354 * -tol_rel_nod N: relative tolerance for comparison of number of nodes (default value 0)
1355 * -tol_abs_defl N: absolute tolerance for deflection comparison (default value 0)
1356 * -tol_rel_defl N: relative tolerance for deflection comparison (default value 0)
1357 * -ref [trinfo a]: compare deflection, number of triangles and nodes in "shapename" and in "a"
1359 Note that options -tri, -nod, -defl do not work together with option -ref.
1363 comparison with some reference values
1365 checktrinfo result -tri 129 -nod 131 -defl 0.01
1368 comparison with another mesh
1370 checktrinfo result -ref [tringo a]
1373 comparison of deflection with max possible value
1375 checktrinfo result -max_defl 1
1378 to make sure that current values are not equal to zero
1380 checktrinfo result -tri -nod -defl
1383 to make sure that number of triangles and number of nodes are not equal to some specific values
1385 checktrinfo result -tri !10 -nod !8
1388 it is possible to compare current values with reference values with some tolerances.
1389 Use options -tol_\* for that.
1391 checktrinfo result -defl 1 -tol_abs_defl 0.001