You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Hauke Petersen cc23481d55 tests: adapted to renamed THREAD_FLAGS 7 years ago
..
common unittests: fix length of test data strings 8 years ago
tests-base64 everything: Remove filename from @file Doxygen command 8 years ago
tests-bitfield tests: unittests: add some bitfield unit tests 8 years ago
tests-bloom unittests/tests-bloom: use static memory for bloom 7 years ago
tests-cbor cbor: compare asserted lengths in unit test 7 years ago
tests-core tests: adapted to renamed THREAD_FLAGS 7 years ago
tests-crypto Unified Cipher API and Block cipher operation modes 7 years ago
tests-div sys: div: remove div_u32_by_10() 7 years ago
tests-ecc Add 256 byte block hamming code implementation 7 years ago
tests-fib net/fib: Added network prefix flag to indicate a network destination 7 years ago
tests-fib_sr fib: initial source route support 7 years ago
tests-fmt sys: fmt: add basic unittests for fmt 7 years ago
tests-gnrc_ipv6_hdr gnrc: make all gnrc modules sub-modules of gnrc 7 years ago
tests-hash_string everything: Remove filename from @file Doxygen command 8 years ago
tests-hashes tests/unittest: added tests for MD5 8 years ago
tests-inet_csum Add unit tests for inet_csum_slice() 7 years ago
tests-ipv4_addr tests: add unittests for ipv4_addr 7 years ago
tests-ipv6_addr ipv6-tests_addr: add test for ipv6_addr_init_iid 7 years ago
tests-ipv6_hdr gnrc: make all gnrc modules sub-modules of gnrc 7 years ago
tests-ipv6_nc unittests: add an netif before performing nc tests 7 years ago
tests-ipv6_netif unittests: adapt netif tests to 1461675 7 years ago
tests-netif tests: unittests for gnrc_netif_exist 7 years ago
tests-netopt tests: unittests: add netopt module unit tests 7 years ago
tests-netreg gnrc: make all gnrc modules sub-modules of gnrc 7 years ago
tests-pkt gnrc: make all gnrc modules sub-modules of gnrc 7 years ago
tests-pktbuf tests: unittests: provide test for fix 7 years ago
tests-pktqueue gnrc: make all gnrc modules sub-modules of gnrc 7 years ago
tests-seq tests/unittests/tests-seq: unittests for Serial Number Arithmetic 7 years ago
tests-sixlowpan_ctx gnrc: make all gnrc modules sub-modules of gnrc 7 years ago
tests-timex unittests: add test for timex_to_str() 7 years ago
tests-ubjson tests: adapted to renamed THREAD_FLAGS 7 years ago
Makefile make: Blacklisted the board 'weio' for some test due to insufficient 7 years ago
README.md Merge pull request #3639 from OlegHahm/unittest-color-output 7 years ago
main.c unittests: initialize xtimer if present 7 years ago
map.h unittests: fix and unify header guards 8 years ago

README.md

Unittests

Building and running tests

Tests can be built by calling:

cd tests/unittests
make

If there are tests for a module you even can build tests specifically for this module:

make tests-<module>
# e.g.
make tests-core

You then can run the tests by calling

make term

or flash them to your board as you would flash any RIOT application to the board (see board documentation).

Other output formats

Other output formats using embUnit's textui library are available by setting the environment variable OUTPUT:

  • Compiler: OUTPUT="COMPILER"
  • Text: OUTPUT="TEXT"
  • XML: OUTPUT="XML"
  • Color: OUTPUT="COLOR" (like default, but with red/green output)
  • Colored-Text: OUTPUT="COLORTEXT" (like TEXT, but with red/green output)

Compile example

OUTPUT="COMPILER" make tests-core
make term

(only outputs in case of test failures)

Text example

OUTPUT="TEXT" make tests-core
make term
- core_bitarithm_tests
1) OK test_SETBIT_null_null
2) OK test_SETBIT_null_limit
3) ...
- core_clist_tests
25) ...
- ...

OK (... tests)

XML example

OUTPUT="XML" make tests-core
make term
<?xml version="1.0" encoding='shift_jis' standalone='yes' ?>
<TestRun>
<core_bitarithm_tests>
<Test id="1">
<Name>test_SETBIT_null_null</Name>
</Test>
<Test id="2">
<Name>test_SETBIT_null_limit</Name>
</Test>
...
</core_bitarithm_tests>
<core_clist_tests>
<Test id="25">
<Name>test_clist_add_one</Name>
</Test>
...
</core_clist_tests>
<Statistics>
<Tests>...</Tests>
</Statistics>
</TestRun>

Writing unit tests

File struture

RIOT uses embUnit for unit testing. All unit tests are organized in tests/unittests and can be build module-wise, if needed. For each module there exists a tests-<modulename>/tests-<modulename>.h file, at least one C file in tests-<modulename>/ and a tests-<modulename>/Makefile. It is recommended to add a C file named tests-<modulename>/tests-<modulename>-<headername>.c for every header file that defines functions (or macros) implemented in the module. If there is only one such header file tests-<modulename>/tests-<modulename>.c should suffice.

Each *.c file should implement a function defined in tests-<modulename>/tests-<modulename>.h, named like

Test *tests_<modulename>_<headername>_tests(void);

/* or respectively */

Test *tests_<modulename>_tests(void);

Testing a module

To write new tests for a module you need to do three things:

  1. Create a Makefile: add a file tests-<modulename>/Makefile
  2. Define a test header: add a file tests-<modulename>/tests-<modulename>.h
  3. Implement tests: for each header file, that defines a function or macro implemented or related to the module, add a file tests-<modulename>/tests-<modulename>-<headername>.c or tests-<modulename>/tests-<modulename>.c if there is only one header.

Create a Makefile

The Makefile should have the following content:

include $(RIOTBASE)/Makefile.base

Define a test header.

The test header tests-<modulename>/tests-<module>.h of a module you add to tests/unittests/ should have the following structure

/*
 * Copyright (C) <year> <author>
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @addtogroup  unittests
 * @{
 *
 * @file
 * @brief       Unittests for the ``module`` module
 *
 * @author      <author>
 */
#ifndef TESTS_<MODULE>_H_
#define TESTS_<MODULE>_H_
#include "embUnit/embUnit.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief   Generates tests for <header1>.h
 *
 * @return  embUnit tests if successful, NULL if not.
 */
Test *tests_<module>_<header1>_tests(void);

/**
 * @brief   Generates tests for <header2>.h
 *
 * @return  embUnit tests if successful, NULL if not.
 */
Test *tests_<module>_<header2>_tests(void);

/* ... */

#ifdef __cplusplus
}
#endif

#endif /* TESTS_<MODULE>_H_ */
/** @} */

Implement tests

Every tests-<modulename>/tests-<module>*.c file you add to tests/unittests/ should have the following structure:

/*
 * Copyright (C) <year> <author>
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/* clib includes */

#include "embUnit/embUnit.h"

#include "<header>.h"

#include "tests-<module>.h"

/* your macros */

/* your global variables */

static void set_up(void)
{
    /* omit if not needed */
}

static void tear_down(void)
{
    /* omit if not needed */
}

static void test_<function1>_<what1>(void) {
    /* ... */

    TEST_ASSERT(/* ... */);
}

static void test_<function1>_<what2>(void) {
    /* ... */

    TEST_ASSERT(/* ... */);
}

/* ... */

static void test_<function2>_<what1>(void) {
    /* ... */

    TEST_ASSERT(/* ... */);
}

static void test_<function2>_<what2>(void) {
    /* ... */

    TEST_ASSERT(/* ... */);
}

/* ... */

Test *tests_<module>_<header>_tests(void)
{
    EMB_UNIT_TESTFIXTURES(fixtures) {
        new_TestFixture(test_<function1>_<what1>),
        new_TestFixture(test_<function1>_<what2>),
        new_TestFixture(test_<function2>_<what1>),
        new_TestFixture(test_<function2>_<what2>),
        /* ... */
    };

    EMB_UNIT_TESTCALLER(<module>_<header>_tests, "<module>_<header>_tests",
                        tests_<module>_<header>_set_up,
                        tests_<module>_<header>_tear_down, fixtures);
    /* set up and tear down function can be NULL if omitted */

    return (Test *)&<module>_<header>;
}

The following assertion macros are available via embUnit

Assertion Description
TEST_ASSERT_EQUAL_STRING(expected,actual) Assert that strings actual and expected are equivalent
TEST_ASSERT_EQUAL_INT(expected,actual) Assert that integers actual and expected are equivalent
TEST_ASSERT_NULL(pointer) Assert that pointer == NULL
TEST_ASSERT_NOT_NULL(pointer) Assert that pointer != NULL
TEST_ASSERT_MESSAGE(condition, message) Assert that condition is TRUE (non-zero) or output customized message on failure.
TEST_ASSERT(condition) Assert that condition is TRUE (non-zero)
TEST_FAIL(message) Register a failed assertion with the specified message. No logical test is performed.