Doc: Add best-practices-info about initialization and clean-up

From https://wiki.qt.io/Writing_Unit_Tests

Change-Id: I20027066640ca797a2330f6daa81468f03921a69
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
bb10
Leena Miettinen 2019-10-15 15:58:39 +02:00
parent 58f5695084
commit 949fc2860e
1 changed files with 14 additions and 0 deletions

View File

@ -102,6 +102,20 @@
\li \c{cleanup()} will be called after every test function.
\endlist
Use \c initTestCase() for preparing the test. Every test should leave the
system in a usable state, so it can be run repeatedly. Cleanup operations
should be handled in \c cleanupTestCase(), so they get run even if the test
fails.
Use \c init() for preparing a test function. Every test function should
leave the system in a usable state, so it can be run repeatedly. Cleanup
operations should be handled in \c cleanup(), so they get run even if the
test function fails and exits early.
Alternatively, you can use RAII (resource acquisition is initialization),
with cleanup operations called in destructors, to ensure they happen when
the test function returns and the object moves out of scope.
If \c{initTestCase()} fails, no test function will be executed. If \c{init()} fails,
the following test function will not be executed, the test will proceed to the next
test function.