API Sanity Autotest Options
Contents |
Information Options
- -h|-help
Print this help.
- -info
Print complete information.
- -v|-version
Print version.
- -dumpversion
Print the tool version and don't do anything else.
General Options
- -l|-lib|-library <name>
- -d|-descriptor <path>
1. XML-descriptor,
2. Directory with headers and libraries:
perl api-sanity-autotest.pl -lib NAME -d DIR1.0/ -gen -build -run
3. Comma separated list of headers and libraries:
perl api-sanity-autotest.pl -lib NAME -d HEADER.h,LIB.so -gen -build -runIf you are using an alternative descriptor type
then you should specify a version number with -vnum <ver> option too.
- -gen|-generate
To generate test for the particular function use it with -f option.
Exit code: number of test cases failed to build.
- -build|-make
To build test for the particular function use it with -f option.
Exit code: number of test cases failed to generate.
- -run
To run test for the particular function use it with -f option.
Exit code: number of failed test cases.
- -clean
To clean test for the particular function use it with -f option.
- -vnum
- -f|-function|-s|-symbol|-i|-interface <name>
- -functions-list|-symbols-list|-interfaces-list <path>
(one per line, mangled/symbol names in C++) that should be tested,
other library interfaces will not be tested.
- -header <name>
by providing a header file name in which they are declared. This option
was introduced for step-by-step tests development.
- -xvfb
- -t2c|-template2code
- -splint-specs
- -strict-gen
error code '1' if cannot generate at least one test case.
- -strict-build
error code '1' if cannot build at least one test case.
- -strict-run
error code '1' if at least one test case failed.
- -strict
Extra Options
- -d-tmpl|-descriptor-template
Create library descriptor template 'lib_ver.xml' in the current directory.
- -s-tmpl|-specialized-type-template
Create specialized type template 'spectypes.xml' in the current directory.
- -r|-random
Random tests generating mode.
- -min
Generate minimun code (as far as possible).
- -max
Generate maximum code (as far as possible).
- -show-retval
Show the function return type in the report.
- -check-retval
Insert requirements on return values (retval!=NULL) for each called interface.
- -st|-specialized-types <path>
Path to the collection of specialized types.
- -td|-test-data <path>
Path to the directory with test data.
- -headers-only
- -isolated
or by the group devision in the descriptor.
- -view-only
Remove all files from the test suite except *.html files. This option allows to
create a lightweight html-index for all tests in the test suite.
- -disable-default-values
Disable usage of default values for function parameters.
- -p|-params <path>
improving generated tests if the library header files don't contain
parameter names.
File format:
func2;param1;param2;param3 ...
...
- -library-full-name <name>
- -relpath|-reldir <path>
- -debug
Other Options
- -test
Run internal tests (create artificial library and run API-Sanity-Autotest on it).
- -time
Show expend time for generating, building and runnind tests.
- -check-stdcxx-symbols
Enable checking of stdc++ interfaces from the library (for C++ libraries).
- -disable-variable-reuse
Disable reusing of previously created variables.
- -long-variable-names
Enable long (complex) variable names instead of short names (by default).