diff --git a/README.md b/README.md index 4c8b726dbbdc93ed0737e17b4888986d94d52d8c..fdd2186adfff174c256a8481273682f8cf3ea955 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,25 @@ It some special printf commands that are passed by the test suite #define TEST_REPORT(desc, value, scale, unit) printf("TEST:REPORT:%s:%lu:%lu:%s\n", (desc), ((uint32_t)value), ((uint32_t)scale), (unit)) #define TEST_RESULT(desc, value) printf("TEST:RESULT:%s:%s\n", (desc), (value)) ``` + +In the `test/example_configs` there are some simple examples how to configure testcases, the test-suite, and how to tell the suite which devices are how/where connected. + +`test/test.py` is the executable, it takes the following parameters: +``` +optional arguments: + -h, --help show this help message and exit + -l, --list only list what tests/devices are defined + -d, --dirty don't clean the projects + -r, --reset-only don't build and upload + -s SUITE_CONFIGFILE, --suite-config SUITE_CONFIGFILE + where to read the test suite config from + -t TEST_CONFIGFILE, --test-config TEST_CONFIGFILE + where to read the test config from + -n NODE_CONFIGFILE, --node-config NODE_CONFIGFILE + where to read the executing nodes config from + -x XMLREPORT, --xml XMLREPORT + output the test reports in XML (for easy parsing with + jenkins), takes path to XML-report-dir as argument + --only-tests ONLY_TESTS + only run the tests defined on the commandline +```