luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-23 01:18:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

gtestdbus: Use markdown for sections

Browse Source
This commit is contained in:
Matthias Clasen
2014-02-01 10:48:36 -05:00
parent eb69bc6aa4
commit 4ab94a2683
1 changed files with 57 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

125
gio/gtestdbus.c
View File

@@ -321,87 +321,76 @@ _g_test_watcher_remove_pid (GPid pid)
* A helper class for testing code which uses D-Bus without touching the user's * A helper class for testing code which uses D-Bus without touching the user's
* session bus. * session bus.
* *
* Note that #GTestDBus modifies the user’s environment, calling setenv(). This * Note that #GTestDBus modifies the user’s environment, calling setenv().
* is not thread-safe, so all #GTestDBus calls should be completed before * This is not thread-safe, so all #GTestDBus calls should be completed before
* threads are spawned, or should have appropriate locking to ensure no access * threads are spawned, or should have appropriate locking to ensure no access
* conflicts to environment variables shared between #GTestDBus and other * conflicts to environment variables shared between #GTestDBus and other
* threads. * threads.
* *
* <refsect2 id="gio-D-Bus-Test-Scaffolding"> * ## Creating unit tests using GTestDBus
* <title>Creating unit tests using GTestDBus</title> *
* <para> * Testing of D-Bus services can be tricky because normally we only ever run
* Testing of D-Bus services can be tricky because normally we only ever run * D-Bus services over an existing instance of the D-Bus daemon thus we
* D-Bus services over an existing instance of the D-Bus daemon thus we * usually don't activate D-Bus services that are not yet installed into the
* usually don't activate D-Bus services that are not yet installed into the * target system. The #GTestDBus object makes this easier for us by taking care
* target system. The #GTestDBus object makes this easier for us by taking care * of the lower level tasks such as running a private D-Bus daemon and looking
* of the lower level tasks such as running a private D-Bus daemon and looking * up uninstalled services in customizable locations, typically in your source
* up uninstalled services in customizable locations, typically in your source code tree. * code tree.
* </para> *
* <para> * The first thing you will need is a separate service description file for the
* The first thing you will need is a separate service description file for the * D-Bus daemon. Typically a <filename>services</filename> subdirectory of
* D-Bus daemon. Typically a <filename>services</filename> subdirectory of * your <filename>tests</filename> directory is a good place to put this file.
* your <filename>tests</filename> directory *
* is a good place to put this file. * The service file should list your service along with an absolute path to the
* </para> * uninstalled service executable in your source tree. Using autotools we would
* <para> * achieve this by adding a file such as <filename>my-server.service.in</filename>
* The service file should list your service along with an absolute path to the * in the services directory and have it processed by configure.
* uninstalled service executable in your source tree. Using autotools we would * |[
* achieve this by adding a file such as <filename>my-server.service.in</filename>
* in the services directory and have it processed by configure.
* |[
* [D-BUS Service] * [D-BUS Service]
* Name=org.gtk.GDBus.Examples.ObjectManager * Name=org.gtk.GDBus.Examples.ObjectManager
* Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server * Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server
* ]| * ]|
* You will also need to indicate this service directory in your test * You will also need to indicate this service directory in your test
* fixtures, so you will need to pass the path while compiling your * fixtures, so you will need to pass the path while compiling your
* test cases. Typically this is done with autotools with an added * test cases. Typically this is done with autotools with an added
* preprocessor flag specified to compile your tests such as: * preprocessor flag specified to compile your tests such as:
* |[ * |[
* -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\" * -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\"
* ]| * ]|
* </para>
* <para>
* Once you have a service definition file which is local to your source tree, * Once you have a service definition file which is local to your source tree,
* you can proceed to set up a GTest fixture using the #GTestDBus scaffolding. * you can proceed to set up a GTest fixture using the #GTestDBus scaffolding.
* <example> *
* <title>Test Fixture for D-Bus services</title> * Here is an example of a test fixture for D-Bus services:
* <programlisting> * <programlisting>
* <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-test-fixture.c"> * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-test-fixture.c">
* <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback> * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
* </xi:include> * </xi:include>
* </programlisting> * </programlisting>
* </example> *
* </para> * Note that these examples only deal with isolating the D-Bus aspect of your
* <para> * service. To successfully run isolated unit tests on your service you may need
* Note that these examples only deal with isolating the D-Bus aspect of your * some additional modifications to your test case fixture. For example; if your
* service. To successfully run isolated unit tests on your service you may need * service uses GSettings and installs a schema then it is important that your test service
* some additional modifications to your test case fixture. For example; if your * not load the schema in the ordinary installed location (chances are that your service
* service uses GSettings and installs a schema then it is important that your test service * and schema files are not yet installed, or worse; there is an older version of the
* not load the schema in the ordinary installed location (chances are that your service * schema file sitting in the install location).
* and schema files are not yet installed, or worse; there is an older version of the *
* schema file sitting in the install location). * Most of the time we can work around these obstacles using the environment. Since the
* </para> * environment is inherited by the D-Bus daemon created by #GTestDBus and then in turn
* <para> * inherited by any services the D-Bus daemon activates, using the setup routine for your
* Most of the time we can work around these obstacles using the environment. Since the * fixture is a practical place to help sandbox your runtime environment. For the rather
* environment is inherited by the D-Bus daemon created by #GTestDBus and then in turn * typical GSettings case we can work around this by setting <envar>GSETTINGS_SCHEMA_DIR</envar> to the
* inherited by any services the D-Bus daemon activates, using the setup routine for your * in tree directory holding your schemas in the above fixture_setup() routine.
* fixture is a practical place to help sandbox your runtime environment. For the rather *
* typical GSettings case we can work around this by setting <envar>GSETTINGS_SCHEMA_DIR</envar> to the * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
* in tree directory holding your schemas in the above fixture_setup() routine. * by compiling the schemas locally as a step before running test cases, an autotools setup might
* </para> * do the following in the directory holding schemas:
* <para> * |[
* The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
* by compiling the schemas locally as a step before running test cases, an autotools setup might
* do the following in the directory holding schemas:
* |[
* all-am: * all-am:
* $(GLIB_COMPILE_SCHEMAS) . * $(GLIB_COMPILE_SCHEMAS) .
* *
* CLEANFILES += gschemas.compiled * CLEANFILES += gschemas.compiled
* ]| * ]|
* </para>
* </refsect2>
*/ */
typedef struct _GTestDBusClass GTestDBusClass; typedef struct _GTestDBusClass GTestDBusClass;