Actions
UnitTesting » History » Revision 11
« Previous |
Revision 11/12
(diff)
| Next »
Davide Pesavento, 03/25/2019 09:06 PM
Unit Testing¶
NFD requires unit testing for most modules.
NFD uses Boost Unit Test Framework.
Learning Resources for Boost Unit Test Framework¶
- Boost Unit Test Framework documentation
- After compiling the test binary (or binaries), it is possible at run time to select which tests to run and what kind of output is desired.
Use--help
command line option to get more information about the available options.
Testing Code Guidelines¶
- The test suite for
.../folder/module-name.hpp
should be placed intests/.../folder/module-name.t.cpp
.- For example, test suite for
daemon/fw/forwarder.hpp
should be place intests/daemon/fw/forwarder.t.cpp
.
- For example, test suite for
- The test suite should be named
TestModuleName
, and nested under test suites named after directories.- For example, test suite for
security/transform/base64-decode.hpp
is namedSecurity/Transform/TestBase64Decode
.
- For example, test suite for
- The test suite should be declared inside the same namespace of the tested type plus additional
tests
namespace.- For example, test suite for
nfd::Forwarder
is declared innfd::tests
, test suite fornfd::cs::Cs
is declared innfd::cs
. - If needed, parent
tests
sub-namespace can be imported withusing namespace
directive.
- For example, test suite for
- All test suites for the
nfd
binary itself (i.e., for translation units located underdaemon/
subdir) should use theGlobalIoFixture
fixture, to get automatic setup and teardown of the globalio_service
instance. Other test suites (e.g., for translation units undertools/
subdir) must not useGlobalIoFixture
.- Similarly, if a custom fixture is needed for a test suite or test case in
daemon/
, that fixture should derive, directly or indirectly, fromGlobalIoFixture
. KeyChainFixture
should be used if a test case needs to create identities in KeyChain.ClockFixture
orGlobalIoTimeFixture
can be used if mocked clocks are desired.
- Similarly, if a custom fixture is needed for a test suite or test case in
Testing Helpers¶
tests/daemon/limited-io.hpp
provides operation count and time limittests/daemon/face/dummy-face.hpp
provides aFace
that doesn't depend on a sockettests/daemon/fw/strategy-tester.hpp
provides a facade to test a forwarding strategytests/daemon/fw/topology-tester.hpp
provides facilities to test forwarder and strategy in a virtual topology
Updated by Davide Pesavento over 5 years ago · 12 revisions