From 7bd633a8b28adc2a4899695bc2e6716f7108debc Mon Sep 17 00:00:00 2001 From: MrKevinWeiss Date: Sat, 23 Mar 2019 18:43:18 +0100 Subject: [PATCH] tests/doc: Add intial how to test doc This commit adds a README.md to the testing folder. It explains the basic about how to run a test with testrunner. It adds a reference so it will be displayed on the doxygen docs. There currently is not obvious documentation for running tests. --- doc/doxygen/riot.doxyfile | 1 + tests/README.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 tests/README.md diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 7e7bde2cd8..d81a0c94f5 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -765,6 +765,7 @@ INPUT = ../../doc.txt \ src/creating-modules.md \ src/creating-an-application.md \ src/getting-started.md \ + ../../tests/README.md \ src/advanced-build-system-tricks.md \ src/changelog.md \ ../../LOSTANDFOUND.md diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000000..a760cd1769 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,22 @@ +Running and creating tests {#running-and-creating-tests} +========================== + +There are a number of tests included in RIOT. They are located in the +[tests folder](https://github.com/RIOT-OS/RIOT/tree/master/tests). These tests +allow basic functionality to be verified as well as provide an example of +usage. + + +Running automated tests +----------------------- + +Some tests can be performed automatically. The test automation scripts are +defined in the `/tests/` folder. They are written in python +and interact through the uart with the test application code running on a +board to do the validation. It is recommended to flash the board with the +test just before running it because some platforms cannot be reset while +testing. + +From the test application directory run: + + BOARD= make flash test