brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update the test-related documentation

Browse Source 
The test suite layout and usage have been changed, so the documentation
needs to be updated to reflect the change.
This commit is contained in:
Emmanuele Bassi 2014-01-17 12:07:58 +00:00
parent 857f53f42d
commit e20c8dede6
2 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.in
View File

@ -291,9 +291,9 @@ if possible, add new unit tests for the conformance test suite in case of new
features. Ensure you run the conformance test suite every for every patch you
wish to submit, by using:
cd tests/conform && make test
make -C tests/conform check
and verifying that the test suite passes.
and verifying that the whole test suite passes.
RELEASE NOTES
-------------------------------------------------------------------------------

18
tests/README
View File

@ -1,8 +1,9 @@
Outline of test categories:
The conform/ tests should be non-interactive unit-tests that verify a single
feature is behaving as documented. See conform/ADDING_NEW_TESTS for more
details.
feature is behaving as documented. Use the GLib and Clutter test API and macros
to write the test units. The conformance test suites are meant to be used with
continuous integration builds.
The performance/ tests are performance tests, both focused tests testing single
metrics and larger tests. These tests are used to report one or more
@ -17,24 +18,21 @@ do fps reporting.
The interactive/ tests are any tests whose status can not be determined without
a user looking at some visual output, or providing some manual input etc. This
covers most of the original Clutter tests. Ideally some of these tests will be
migrated into the conformance/ directory so they can be used in automated
nightly tests.
migrated into the conform/ directory.
The accessibility/ tests are tests created to test the accessibility support of
clutter, testing some of the atk interfaces.
The data/ directory contains optional data (like images and ClutterScript
definitions) that can be referenced by a test.
Other notes:
• All tests should ideally include a detailed description in the source
explaining exactly what the test is for, how the test was designed to work,
and possibly a rationale for the approach taken for testing.
and possibly a rationale for the approach taken for testing. Tests for specific
bugs should reference the bug report URL or number.
• When running tests under Valgrind, you should follow the instructions
available here:
http://live.gnome.org/Valgrind
https://wiki.gnome.org/Valgrind
and also use the suppression file available inside the data/ directory.
and also use the suppression file available in the Git repository.