2,257
edits
Changes
→Test's .desc file
This page describes the API one ''should'' use to write new test in ZDTM.
This page describes the API one ''should'' use to write new test in ZDTM.
== Overview ==
The ZDTM test-suite is the automated suite that launches individual subtests as processes, waits for them to get prepared, then dumps the process(es) started, then restores them and asks to check whether the restored state is what test thinks to be proper. In order to write more subtests developer should use the API declared below. Tests themselves live in one of <code>test/zdtm/</code> sub-directory. The full-cycle suite is the <code>test/zdtm.py</code> script.
== API for test itself ==
== API for test itself ==
=== Test body ===
The test should clearly describe 3 stages:
The test should clearly describe 3 stages:
; Preparations
;Preparations
: These are actions that test does before the process(es) get checkpointed
: These are actions that test does before the process(es) get checkpointed
;Checks
;Checks
: After restore test should verify whether everything is OK or not
: After restore test should verify whether everything is OK or not and report the result
This is achieved by using the following API calls:
;<code>test_init(argc, argv)</code>
:Just initializes the test subsystem. After this call the preparations stage starts.
;<code>test_daemon()</code>
:This one says that we finished preparations and ready to get dumped at any time. I.e. -- the ''actions'' begin.
;<code>test_go()</code>
:This routine checks whether the process was dumped and restored or not yet, i.e. the ''actions'' stage still goes on.
;<code>test_waitsig()</code>
:Calling this blocks the task till it's restored. After this the ''checks'' stage starts.
;<code>pass()</code>
:Calling this marks test as PASSED
;<code>fail(message)</code>
:Calling this would report test failure. The ''message'' argument will be written into logs
;<code>err(message)</code>
:Use this function to mark the test as being unable to work at all.
;<code>test_msg(message)</code>
:This is for logging.
From the code perspective this looks like this:
From the code perspective this looks like this:
test_init(argc, argv);
test_init(argc, argv);
/* preparations */
/* Preparations */
test_daemon();
test_daemon();
/* actions */
#if test want to act and get c/r-ed unexpectedly
while (test_go()) {
/* Actions go here */
}
#else test just want to wait for c/r to happen
/* Actions go here. */
test_waitsig();
test_waitsig();
#endif
/* checks */
/* checks */
if (test_passed())
pass();
else
fail("Something went wrong");
return 0;
return 0;
</pre>
</pre>
== Adding test to automatic suite ==
=== Options ===
Sometimes a test might need an option to work. E.g. a file or directory to work with or some string to operate on. This can be done by declaring the options.
<pre>
TEST_OPTION(name, type, description);
</pre>
The ''name'' is some name for the option. The variable of the same name should be declared and the <code>--$name</code> CLI argument would be passed upon test start (this option would be parsed by <code>test_init()</code> call, so nothing more should be done to have the option available).
The ''type'' is data type. Currently supported types are ''string'', ''bool'', ''int'', ''uint'', ''long'' and ''ulong''.
Description is just arbitrary text.
=== Building and launching ===
Then the test should be added into Makefile. There are several sections where simple tests can be added to.
;<code>TST_NOFILE</code>
:Add your test to this list if the test accepts no options.
;<code>TST_FILE</code>
:Tests here will be started with the <code>--filename $some_name</code> option. The file will ''not'' be created by launcher, test should take care of it itself.
;<code>TST_DIR</code>
:These will be started with the <code>--dirname $some_name</code> option. The directory will ''not'' be created by launcher, test should take care of it itself.
;<code>TST</code>
:These are tests with custom options. For those one should also declare the starting rule in the Makefile like this
<pre>
test.pid: test
$(<D)/$(<F) --pidfile=$@ --outfile=$<.out --OPTIONS-HERE
</pre>
=== Checking test works ===
To make sure test itself works do these steps:
<pre>
make cleanout # to clean the directory from old stuff
make $test # to build the test
make $test.pid # to start the test
make $test.out # to stop the test and ask it for "checking" stage and results
</pre>
All logs from test, including the pass/fail status would be in the <code>$test.out</code> file.
== Test's .desc file ==
Put the <code>${test_name}.desc</code> next to the test's .c file to configure the test. The .desc file can have the following fields in JSON format:
; 'flavor'
: Add space-separated 'h', 'ns' or 'uns' list here to limit the test by host, namespaces or (namespaces and user namespaces) run.
; 'flags'
: Space-separated values. <code>suid</code>: test needs root prio to run. <code>noauto</code>: test is excluded from <code>--all</code> run of zdtm.py. <code>crfail</code>: dump should fail for this test. <code>nouser</code>: test cannot be checkpointed in [[user-mode]]. <code>excl</code>: test should not be run in parallel with any other test. <code>samens</code>: no <code>--join-ns</code> testing.
; 'opts'
: Any test-specific options for criu dump/restore actions should go here
; 'feature'
: The feature that should be [[Checking the kernel|checked]] before running the test.
; 'arch'
: The test checks architecture-specific thing (regs/TLS/etc.) and should only be run on the arch specified.
== See also ==
[[ZDTM Test Suite]]
[[Category: Development]]
[[Category: Development]]
[[Category: Testing]]