RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity
630b14b322
RIOT/sys/include/embUnit.h

71 lines
2.0 KiB
C
Raw Normal View History

unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
/*
doc: Add mail address where it is missing
2015-02-08 19:19:22 +01:00
* Copyright (C) 2014 Martine Lenders <mlenders@inf.fu-berlin.de>
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
*
fix license headers in non-.c files
2014-08-23 15:43:13 +02:00
* 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.
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
*/
/**
sys/embunit: fix doxygen declaration
2015-02-10 15:38:54 +01:00
* @defgroup unittests Unittests
* @ingroup sys
sys: fix doxygen grouping of tsrb und embUnit
2017-07-03 19:52:24 +02:00
* @brief RIOT Unittests based on the EmbUnit Framework
sys/embunit: add wiki link
2015-02-10 15:40:44 +01:00
*
sys/embUnit: fix broken links
2020-03-04 13:28:24 +01:00
* @see https://sourceforge.net/projects/embunit
sys: fix doxygen grouping of tsrb und embUnit
2017-07-03 19:52:24 +02:00
*
* @note Please refer to https://github.com/RIOT-OS/RIOT/wiki/Testing-RIOT
pkg/fff: Add fake functions framework package
2021-10-28 16:48:00 +02:00
* @note If mocking would be helpful for your unit test, you can also have a look at @ref pkg_fff.
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
*
tests: make embUnit a normal sys module There is nothing quite special about embUnit. This PR makes it a normal sys module, so that you can use it in any application / test.
2014-11-27 22:30:14 +01:00
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
*/
cleanup: apply headerguard script output
2017-05-23 18:19:52 +02:00
#ifndef EMBUNIT_H
#define EMBUNIT_H
c++: tests: add `extern "C"` in header files, i.e. only present in `./unittests`
2014-10-10 08:03:06 +02:00
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
#include "embUnit/embUnit.h"
#ifdef OUTPUT
Added a colored outputter to embUnit. The outputter is called ColorTextOutputter and can be enabled by defining OUTPUT=COLORTEXT. The colored outputter behaves just like the TextOutputter, but displays successful tests in GREEN and failed tests in RED. The summary message is also in GREEN/RED, but is slightly different from the TextOutputter. Also: * Added fancy simple none-verbose color-outputter for EmbUnit. The outputter outputs a simple statistics line in GREEN or RED, according to the test success or failure. (Also, the ColorTextOutputter was adjusted to use the statistics output of this new ColorOutputter.) The new outputter can be activated with OUTPUT=COLOR. * Added a single character "." output for the simple color outputter and replaced the color codes by macros.
2015-03-07 22:29:56 +01:00
# define OUTPUT_XML (1)
# define OUTPUT_TEXT (2)
# define OUTPUT_COMPILER (4)
# define OUTPUT_COLORTEXT (8)
# define OUTPUT_COLOR (16)
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
# if (OUTPUT==OUTPUT_XML)
tests: make embUnit a normal sys module There is nothing quite special about embUnit. This PR makes it a normal sys module, so that you can use it in any application / test.
2014-11-27 22:30:14 +01:00
# include "embUnit/XMLOutputter.h"
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
# define OUTPUTTER (XMLOutputter_outputter())
# elif (OUTPUT==OUTPUT_TEXT)
tests: make embUnit a normal sys module There is nothing quite special about embUnit. This PR makes it a normal sys module, so that you can use it in any application / test.
2014-11-27 22:30:14 +01:00
# include "embUnit/TextOutputter.h"
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
# define OUTPUTTER (TextOutputter_outputter())
# elif (OUTPUT==OUTPUT_COMPILER)
tests: make embUnit a normal sys module There is nothing quite special about embUnit. This PR makes it a normal sys module, so that you can use it in any application / test.
2014-11-27 22:30:14 +01:00
# include "embUnit/CompilerOutputter.h"
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
# define OUTPUTTER (CompilerOutputter_outputter())
Added a colored outputter to embUnit. The outputter is called ColorTextOutputter and can be enabled by defining OUTPUT=COLORTEXT. The colored outputter behaves just like the TextOutputter, but displays successful tests in GREEN and failed tests in RED. The summary message is also in GREEN/RED, but is slightly different from the TextOutputter. Also: * Added fancy simple none-verbose color-outputter for EmbUnit. The outputter outputs a simple statistics line in GREEN or RED, according to the test success or failure. (Also, the ColorTextOutputter was adjusted to use the statistics output of this new ColorOutputter.) The new outputter can be activated with OUTPUT=COLOR. * Added a single character "." output for the simple color outputter and replaced the color codes by macros.
2015-03-07 22:29:56 +01:00
# elif (OUTPUT==OUTPUT_COLORTEXT)
# include "embUnit/ColorTextOutputter.h"
# define OUTPUTTER (ColorTextOutputter_outputter())
# elif (OUTPUT==OUTPUT_COLOR)
# include "embUnit/ColorOutputter.h"
# define OUTPUTTER (ColorOutputter_outputter())
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
# endif
tests: make embUnit a normal sys module There is nothing quite special about embUnit. This PR makes it a normal sys module, so that you can use it in any application / test.
2014-11-27 22:30:14 +01:00
# include "embUnit/TextUIRunner.h"
unittests: use subfolders for different tests Unittests for e.g. different libraries can be put into `tests/unittests/tests-XXX`, where `XXX` is your test suite. If `unittests` is made with `make all` (or any explicit argument), then all test suites get built. If you use `make tests-XXX tests-YYY …` then only the test suites `XXX` and `YYY` get built.
2014-05-14 11:13:53 +02:00
# define TESTS_START() TextUIRunner_start()
# define TESTS_RUN(t) TextUIRunner_runTest(t)
# define TESTS_END() TextUIRunner_end()
#else
# define TESTS_START() TestRunner_start()
# define TESTS_RUN(t) TestRunner_runTest(t)
# define TESTS_END() TestRunner_end()
#endif
tests: make embUnit a normal sys module There is nothing quite special about embUnit. This PR makes it a normal sys module, so that you can use it in any application / test.
2014-11-27 22:30:14 +01:00
#ifdef __cplusplus
extern "C" {
#endif
c++: tests: add `extern "C"` in header files, i.e. only present in `./unittests`
2014-10-10 08:03:06 +02:00
#ifdef __cplusplus
}
#endif
cleanup: apply headerguard script output
2017-05-23 18:19:52 +02:00
#endif /* EMBUNIT_H */
Copy Permalink