| 1 |
Outline of test categories: |
| 2 |
|
| 3 |
The conform/ tests should be non-interactive unit-tests that verify a single |
| 4 |
feature is behaving as documented. Use the GLib and Clutter test API and macros |
| 5 |
to write the test units. The conformance test suites are meant to be used with |
| 6 |
continuous integration builds. |
| 7 |
|
| 8 |
The performance/ tests are performance tests, both focused tests testing single |
| 9 |
metrics and larger tests. These tests are used to report one or more |
| 10 |
performance markers for the build of Clutter. Each performance marker is picked |
| 11 |
up from the standard output of running the tests from strings having the form |
| 12 |
"\n@ marker-name: 42.23" where 'marker-name' and '42.23' are the key/value pairs |
| 13 |
of a single metric. Each test can provide multiple key/value pairs. Note that |
| 14 |
if framerate is the feedback metric the test should forcibly enable FPS |
| 15 |
debugging itself. The file test-common.h contains utility function helping to |
| 16 |
do fps reporting. |
| 17 |
|
| 18 |
The interactive/ tests are any tests whose status can not be determined without |
| 19 |
a user looking at some visual output, or providing some manual input etc. This |
| 20 |
covers most of the original Clutter tests. Ideally some of these tests will be |
| 21 |
migrated into the conform/ directory. |
| 22 |
|
| 23 |
The accessibility/ tests are tests created to test the accessibility support of |
| 24 |
clutter, testing some of the atk interfaces. |
| 25 |
|
| 26 |
Other notes: |
| 27 |
|
| 28 |
• All tests should ideally include a detailed description in the source |
| 29 |
explaining exactly what the test is for, how the test was designed to work, |
| 30 |
and possibly a rationale for the approach taken for testing. Tests for specific |
| 31 |
bugs should reference the bug report URL or number. |
| 32 |
|
| 33 |
• When running tests under Valgrind, you should follow the instructions |
| 34 |
available here: |
| 35 |
|
| 36 |
https://wiki.gnome.org/Valgrind |
| 37 |
|
| 38 |
and also use the suppression file available in the Git repository. |