source: rtems/testsuites/README.testdata @ 16d5e394

Last change on this file since 16d5e394 was 18f63c0, checked in by Chris Johns <chrisj@…>, on Apr 15, 2017 at 11:51:57 PM

testsuite: Fix rtems-test-check not excluding tests.

The include file handling was broken.

Add a test configuration data README.

Closes #2981.

  • Property mode set to 100644
File size: 2.4 KB
Line 
1RTEMS Testsuite Configuration
2=============================
3
4The RTEMS Testsuite lets you configure the tests for a BSP. Every BSP can have
5a test configuration data file and this file is read when building the
6tests. The test configuration data can control what tests are build and now the
7tests are built.
8
9The test configuration data files have a `.tcfg` file extension. You can
10include other test configuration data files reducing repeated test
11sequences. There is also a global test configuration data file for global
12configurations.
13
14Command
15-------
16
17The build system invokes the test check tool to determine what it does.
18
19 rtems-test-check mode bsp testconfig includepaths test[s]
20
21Mode (mode)
22~~~~~~~~~~~
23
24The check command modes are:
25
26 1. `exclude`: The input list of tests is checked against the excluded tests
27    and the tests that are not excluded are printed.
28
29 2. `flags': The test build flags are returned. These flags can enumerate a
30    test in a specific way.
31
32BSP (bsp)
33~~~~~~~~~
34
35The name of the BSP.
36
37Test Configuration (testconfig)
38~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39
40The path to the BSP's test configration file. If the file does not exist the
41input list of tests is returned and there are no special build flags.
42
43Include Paths (inputpaths)
44~~~~~~~~~~~~~~~~~~~~~~~~~~
45
46A colon (`:`) separated list of paths test configuration files are search
47for.
48
49Tests (test[s])
50~~~~~~~~~~~~~~~
51
52If the mode is `exclude` this argument is a list of tests to be checked. If the
53mode is `flags` a single test is required and the flags for the test are returned.
54
55File Format
56-----------
57
58The file is an ASCII text file of lines. And text after and including the `#`
59character is removed. Empty lines are ignored.
60
61A line is either the `include` directive or a test state. The states are:
62
63 exclude       : Exclude the test from being built.
64 expected-fail : The test is built but expected to fail.
65 user-input    : The test requires user input and may be aborted when running
66                 the tests.
67 indeterminate : The test result is indeterminate. This means the test may pass
68                 or may fail therefore it cannot be included in the regression
69                 results.
70 benchmark     : The test is a benchmark and maybe is aborted when running the
71                 tests because of the load and time the test may take to run.
72                 Performance changes are currently not viewed as a regression.
Note: See TracBrowser for help on using the repository browser.