mutter/tests/conform/ADDING_NEW_TESTS


How:
----

You should including the following at the top of your new unit test:
#include "test-conform-common.h"

Instead of a main () function add an entry point with a prototype as follows:

void
test_blah (TestConformSimpleFixture *fixture,
           gconstpointer data)
{

}

Add a TEST_CONFORM_SIMPLE() entry in test-conform-main.c


Notes:
------

NB: A test fails if it exits. (regardless of the exit status)

Don't call clutter_init since that is handled in test-conform-common.c

Make sure you clean up *everything* you create. Noteable things you might miss
include timelines, behaviours, and all actors you add to the stage. This is important because otherwise you can cause cascading failures in other tests.

Be aware that to help avoid tests causing cascading side effects for other tests all children of the default stage are destroyed between tests.
Bug 1162 - Re-works the tests/ to use the glib-2.16 unit testing framework * configure.ac: * tests/*: The tests have been reorganised into different categories: conformance, interactive and micro benchmarks. - conformance tests can be run as part of automated tests - interactive tests are basically all the existing tests - micro benchmarks focus on a single performance metric I converted the timeline tests to conformance tests and also added some tests from Neil Roberts and Ebassi. Note: currently only the conformance tests use the glib test APIs, though the micro benchmarks should too. The other change is to make the unit tests link into monolithic binaries which makes the build time for unit tests considerably faster. To deal with the extra complexity this adds to debugging individual tests I have added some sugar to the makefiles so all the tests can be run directly via a symlink and when an individual test is run this way, then a note is printed to the terminal explaining exactly how that test may be debugged using GDB. There is a convenience make rule: 'make test-report', that will run all the conformance tests and hopefully even open the results in your web browser. It skips some of the slower timeline tests, but you can run those using 'make full-report' 2008-11-07 14:32:28 -05:00
			`How:`
			`----`

			`You should including the following at the top of your new unit test:`
			`#include "test-conform-common.h"`

			`Instead of a main () function add an entry point with a prototype as follows:`

			`void`
			`test_blah (TestConformSimpleFixture *fixture,`
			`gconstpointer data)`
			`{`

			`}`

			`Add a TEST_CONFORM_SIMPLE() entry in test-conform-main.c`


			`Notes:`
			`------`

* tests/conform/Makefile.am: * tests/conform/wrapper.sh: * tests/conform/test-conform-main.c: * tests/conform/test-timeline.c: Adds Neil's updates to test-timeline.c so it now works with the new unit testing infrastructure. Also some fixes to ensure wrappers get setup correctly for the timeline tests. * tests/interactive/test-main.c: cast the symbol return pointer as (gpointer ) to avoid warning tests/conform/test-pick.c: g_assert that the test passes, instead of using exit() * test/conform/ADDING_NEW_TESTS: Fixes a silly typo 2008-11-10 06:48:00 -05:00			`NB: A test fails if it exits. (regardless of the exit status)`
Bug 1162 - Re-works the tests/ to use the glib-2.16 unit testing framework * configure.ac: * tests/*: The tests have been reorganised into different categories: conformance, interactive and micro benchmarks. - conformance tests can be run as part of automated tests - interactive tests are basically all the existing tests - micro benchmarks focus on a single performance metric I converted the timeline tests to conformance tests and also added some tests from Neil Roberts and Ebassi. Note: currently only the conformance tests use the glib test APIs, though the micro benchmarks should too. The other change is to make the unit tests link into monolithic binaries which makes the build time for unit tests considerably faster. To deal with the extra complexity this adds to debugging individual tests I have added some sugar to the makefiles so all the tests can be run directly via a symlink and when an individual test is run this way, then a note is printed to the terminal explaining exactly how that test may be debugged using GDB. There is a convenience make rule: 'make test-report', that will run all the conformance tests and hopefully even open the results in your web browser. It skips some of the slower timeline tests, but you can run those using 'make full-report' 2008-11-07 14:32:28 -05:00
			`Don't call clutter_init since that is handled in test-conform-common.c`

			`Make sure you clean up everything you create. Noteable things you might miss`
			`include timelines, behaviours, and all actors you add to the stage. This is important because otherwise you can cause cascading failures in other tests.`

* tests/conform/ADDING_NEW_TESTS * tests/conform/test-conform-common.c * tests/conform/test-pick.c: Instead of using clutter_stage_new /clutter_actor_destroy as a way to avoid cascading side effects between unit tests, due to left over actors, we now destroy all children of the default stage between tests instead. * tests/conform/wrapper.sh: Adds a convenience note about how to run valgrind for an individual unit test 2008-11-10 13:52:50 -05:00			`Be aware that to help avoid tests causing cascading side effects for other tests all children of the default stage are destroyed between tests.`
Bug 1162 - Re-works the tests/ to use the glib-2.16 unit testing framework * configure.ac: * tests/*: The tests have been reorganised into different categories: conformance, interactive and micro benchmarks. - conformance tests can be run as part of automated tests - interactive tests are basically all the existing tests - micro benchmarks focus on a single performance metric I converted the timeline tests to conformance tests and also added some tests from Neil Roberts and Ebassi. Note: currently only the conformance tests use the glib test APIs, though the micro benchmarks should too. The other change is to make the unit tests link into monolithic binaries which makes the build time for unit tests considerably faster. To deal with the extra complexity this adds to debugging individual tests I have added some sugar to the makefiles so all the tests can be run directly via a symlink and when an individual test is run this way, then a note is printed to the terminal explaining exactly how that test may be debugged using GDB. There is a convenience make rule: 'make test-report', that will run all the conformance tests and hopefully even open the results in your web browser. It skips some of the slower timeline tests, but you can run those using 'make full-report' 2008-11-07 14:32:28 -05:00