gio/gtestdbus.c

   1 /* GIO testing utilities
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  * Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General
  17  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  18  *
  19  * Authors: David Zeuthen <davidz@redhat.com>
  20  *          Xavier Claessens <xavier.claessens@collabora.co.uk>
  21  */
  22
  23 #include "config.h"
  24
  25 #include <stdlib.h>
  26 #include <stdio.h>
  27 #include <gstdio.h>
  28 #ifdef G_OS_UNIX
  29 #include <unistd.h>
  30 #endif
  31 #ifdef G_OS_WIN32
  32 #include <io.h>
  33 #endif
  34
  35 #include <glib.h>
  36
  37 #include "gdbusconnection.h"
  38 #include "gdbusprivate.h"
  39 #include "gfile.h"
  40 #include "gioenumtypes.h"
  41 #include "gtestdbus.h"
  42
  43 #include "glibintl.h"
  44
  45 #ifdef G_OS_WIN32
  46 #include <windows.h>
  47 #endif
  48
  49 /* -------------------------------------------------------------------------- */
  50 /* Utility: Wait until object has a single ref  */
  51
  52 typedef struct
  53 {
  54   GMainLoop *loop;
  55   gboolean   timed_out;
  56 } WeakNotifyData;
  57
  58 static gboolean
  59 on_weak_notify_timeout (gpointer user_data)
  60 {
  61   WeakNotifyData *data = user_data;
  62   data->timed_out = TRUE;
  63   g_main_loop_quit (data->loop);
  64   return FALSE;
  65 }
  66
  67 static gboolean
  68 dispose_on_idle (gpointer object)
  69 {
  70   g_object_run_dispose (object);
  71   g_object_unref (object);
  72   return FALSE;
  73 }
  74
  75 static gboolean
  76 _g_object_dispose_and_wait_weak_notify (gpointer object)
  77 {
  78   WeakNotifyData data;
  79   guint timeout_id;
  80
  81   data.loop = g_main_loop_new (NULL, FALSE);
  82   data.timed_out = FALSE;
  83
  84   g_object_weak_ref (object, (GWeakNotify) g_main_loop_quit, data.loop);
  85
  86   /* Drop the ref in an idle callback, this is to make sure the mainloop
  87    * is already running when weak notify happens */
  88   g_idle_add (dispose_on_idle, object);
  89
  90   /* Make sure we don't block forever */
  91   timeout_id = g_timeout_add (30 * 1000, on_weak_notify_timeout, &data);
  92
  93   g_main_loop_run (data.loop);
  94
  95   if (data.timed_out)
  96     {
  97       g_warning ("Weak notify timeout, object ref_count=%d\n",
  98           G_OBJECT (object)->ref_count);
  99     }
 100   else
 101     {
 102       g_source_remove (timeout_id);
 103     }
 104
 105   g_main_loop_unref (data.loop);
 106   return data.timed_out;
 107 }
 108
 109 /* -------------------------------------------------------------------------- */
 110 /* Utilities to cleanup the mess in the case unit test process crash */
 111
 112 #ifdef G_OS_WIN32
 113
 114 /* This could be interesting to expose in public API */
 115 static void
 116 _g_test_watcher_add_pid (GPid pid)
 117 {
 118   static gsize started = 0;
 119   HANDLE job;
 120
 121   if (g_once_init_enter (&started))
 122     {
 123       JOBOBJECT_EXTENDED_LIMIT_INFORMATION info;
 124
 125       job = CreateJobObjectW (NULL, NULL);
 126       memset (&info, 0, sizeof (info));
 127       info.BasicLimitInformation.LimitFlags = 0x2000 /* JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE */;
 128
 129       if (!SetInformationJobObject(job, JobObjectExtendedLimitInformation, &info, sizeof (info)))
 130         g_warning ("Can't enable JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE: %s", g_win32_error_message (GetLastError()));
 131
 132       g_once_init_leave (&started,(gsize)job);
 133     }
 134
 135   job = (HANDLE)started;
 136
 137   if (!AssignProcessToJobObject(job, pid))
 138     g_warning ("Can't assign process to job: %s", g_win32_error_message (GetLastError()));
 139 }
 140
 141 static void
 142 _g_test_watcher_remove_pid (GPid pid)
 143 {
 144   /* No need to unassign the process from the job object as the process
 145      will be killed anyway */
 146 }
 147
 148 #else
 149
 150 #define ADD_PID_FORMAT "add pid %d\n"
 151 #define REMOVE_PID_FORMAT "remove pid %d\n"
 152
 153 static void
 154 watch_parent (gint fd)
 155 {
 156   GIOChannel *channel;
 157   GPollFD fds[1];
 158   GArray *pids_to_kill;
 159
 160   channel = g_io_channel_unix_new (fd);
 161
 162   fds[0].fd = fd;
 163   fds[0].events = G_IO_HUP | G_IO_IN;
 164   fds[0].revents = 0;
 165
 166   pids_to_kill = g_array_new (FALSE, FALSE, sizeof (guint));
 167
 168   do
 169     {
 170       gint num_events;
 171       gchar *command = NULL;
 172       guint pid;
 173       guint n;
 174       GError *error = NULL;
 175
 176       num_events = g_poll (fds, 1, -1);
 177       if (num_events == 0)
 178         continue;
 179
 180       if (fds[0].revents == G_IO_HUP)
 181         {
 182           /* Parent quit, cleanup the mess and exit */
 183           for (n = 0; n < pids_to_kill->len; n++)
 184             {
 185               pid = g_array_index (pids_to_kill, guint, n);
 186               g_print ("cleaning up pid %d\n", pid);
 187               kill (pid, SIGTERM);
 188             }
 189
 190           g_array_unref (pids_to_kill);
 191           g_io_channel_shutdown (channel, FALSE, &error);
 192           g_assert_no_error (error);
 193           g_io_channel_unref (channel);
 194
 195           exit (0);
 196         }
 197
 198       /* Read the command from the input */
 199       g_io_channel_read_line (channel, &command, NULL, NULL, &error);
 200       g_assert_no_error (error);
 201
 202       /* Check for known commands */
 203       if (sscanf (command, ADD_PID_FORMAT, &pid) == 1)
 204         {
 205           g_array_append_val (pids_to_kill, pid);
 206         }
 207       else if (sscanf (command, REMOVE_PID_FORMAT, &pid) == 1)
 208         {
 209           for (n = 0; n < pids_to_kill->len; n++)
 210             {
 211               if (g_array_index (pids_to_kill, guint, n) == pid)
 212                 {
 213                   g_array_remove_index (pids_to_kill, n);
 214                   pid = 0;
 215                   break;
 216                 }
 217             }
 218           if (pid != 0)
 219             {
 220               g_warning ("unknown pid %d to remove", pid);
 221             }
 222         }
 223       else
 224         {
 225           g_warning ("unknown command from parent '%s'", command);
 226         }
 227
 228       g_free (command);
 229     }
 230   while (TRUE);
 231 }
 232
 233 static GIOChannel *
 234 watcher_init (void)
 235 {
 236   static gsize started = 0;
 237   static GIOChannel *channel = NULL;
 238
 239   if (g_once_init_enter (&started))
 240     {
 241       gint pipe_fds[2];
 242
 243       /* fork a child to clean up when we are killed */
 244       if (pipe (pipe_fds) != 0)
 245         {
 246           g_warning ("pipe() failed: %m");
 247           g_assert_not_reached ();
 248         }
 249
 250       switch (fork ())
 251         {
 252         case -1:
 253           g_warning ("fork() failed: %m");
 254           g_assert_not_reached ();
 255           break;
 256
 257         case 0:
 258           /* child */
 259           close (pipe_fds[1]);
 260           watch_parent (pipe_fds[0]);
 261           break;
 262
 263         default:
 264           /* parent */
 265           close (pipe_fds[0]);
 266           channel = g_io_channel_unix_new (pipe_fds[1]);
 267         }
 268
 269       g_once_init_leave (&started, 1);
 270     }
 271
 272   return channel;
 273 }
 274
 275 static void
 276 watcher_send_command (const gchar *command)
 277 {
 278   GIOChannel *channel;
 279   GError *error = NULL;
 280
 281   channel = watcher_init ();
 282
 283   g_io_channel_write_chars (channel, command, -1, NULL, &error);
 284   g_assert_no_error (error);
 285
 286   g_io_channel_flush (channel, &error);
 287   g_assert_no_error (error);
 288 }
 289
 290 /* This could be interesting to expose in public API */
 291 static void
 292 _g_test_watcher_add_pid (GPid pid)
 293 {
 294   gchar *command;
 295
 296   command = g_strdup_printf (ADD_PID_FORMAT, (guint) pid);
 297   watcher_send_command (command);
 298   g_free (command);
 299 }
 300
 301 static void
 302 _g_test_watcher_remove_pid (GPid pid)
 303 {
 304   gchar *command;
 305
 306   command = g_strdup_printf (REMOVE_PID_FORMAT, (guint) pid);
 307   watcher_send_command (command);
 308   g_free (command);
 309 }
 310
 311 #endif
 312
 313 /* -------------------------------------------------------------------------- */
 314 /* GTestDBus object implementation */
 315
 316 /**
 317  * SECTION:gtestdbus
 318  * @short_description: D-Bus testing helper
 319  * @include: gio/gio.h
 320  *
 321  * A helper class for testing code which uses D-Bus without touching the user's
 322  * session bus.
 323  *
 324  * Note that #GTestDBus modifies the user’s environment, calling setenv().
 325  * This is not thread-safe, so all #GTestDBus calls should be completed before
 326  * threads are spawned, or should have appropriate locking to ensure no access
 327  * conflicts to environment variables shared between #GTestDBus and other
 328  * threads.
 329  *
 330  * ## Creating unit tests using GTestDBus
 331  *
 332  * Testing of D-Bus services can be tricky because normally we only ever run
 333  * D-Bus services over an existing instance of the D-Bus daemon thus we
 334  * usually don't activate D-Bus services that are not yet installed into the
 335  * target system. The #GTestDBus object makes this easier for us by taking care
 336  * of the lower level tasks such as running a private D-Bus daemon and looking
 337  * up uninstalled services in customizable locations, typically in your source
 338  * code tree.
 339  *
 340  * The first thing you will need is a separate service description file for the
 341  * D-Bus daemon. Typically a <filename>services</filename> subdirectory of
 342  * your <filename>tests</filename> directory is a good place to put this file.
 343  *
 344  * The service file should list your service along with an absolute path to the
 345  * uninstalled service executable in your source tree. Using autotools we would
 346  * achieve this by adding a file such as <filename>my-server.service.in</filename>
 347  * in the services directory and have it processed by configure.
 348  * |[
 349  *     [D-BUS Service]
 350  *     Name=org.gtk.GDBus.Examples.ObjectManager
 351  *     Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server
 352  * ]|
 353  * You will also need to indicate this service directory in your test
 354  * fixtures, so you will need to pass the path while compiling your
 355  * test cases. Typically this is done with autotools with an added
 356  * preprocessor flag specified to compile your tests such as:
 357  * |[
 358  *     -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\"
 359  * ]|
 360  *     Once you have a service definition file which is local to your source tree,
 361  * you can proceed to set up a GTest fixture using the #GTestDBus scaffolding.
 362  *
 363  * An example of a test fixture for D-Bus services can be found
 364  * here: <ulink url="https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-test-fixture.c">gdbus-test-fixture.c</ulink>
 365  *
 366  * Note that these examples only deal with isolating the D-Bus aspect of your
 367  * service. To successfully run isolated unit tests on your service you may need
 368  * some additional modifications to your test case fixture. For example; if your
 369  * service uses GSettings and installs a schema then it is important that your test service
 370  * not load the schema in the ordinary installed location (chances are that your service
 371  * and schema files are not yet installed, or worse; there is an older version of the
 372  * schema file sitting in the install location).
 373  *
 374  * Most of the time we can work around these obstacles using the
 375  * environment. Since the environment is inherited by the D-Bus daemon
 376  * created by #GTestDBus and then in turn inherited by any services the
 377  * D-Bus daemon activates, using the setup routine for your fixture is
 378  * a practical place to help sandbox your runtime environment. For the
 379  * rather typical GSettings case we can work around this by setting
 380  * `GSETTINGS_SCHEMA_DIR` to the in tree directory holding your schemas
 381  * in the above fixture_setup() routine.
 382  *
 383  * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
 384  * by compiling the schemas locally as a step before running test cases, an autotools setup might
 385  * do the following in the directory holding schemas:
 386  * |[
 387  *     all-am:
 388  *             $(GLIB_COMPILE_SCHEMAS) .
 389  *
 390  *     CLEANFILES += gschemas.compiled
 391  * ]|
 392  */
 393
 394 typedef struct _GTestDBusClass   GTestDBusClass;
 395 typedef struct _GTestDBusPrivate GTestDBusPrivate;
 396
 397 /**
 398  * GTestDBus:
 399  *
 400  * The #GTestDBus structure contains only private data and
 401  * should only be accessed using the provided API.
 402  *
 403  * Since: 2.34
 404  */
 405 struct _GTestDBus {
 406   GObject parent;
 407
 408   GTestDBusPrivate *priv;
 409 };
 410
 411 struct _GTestDBusClass {
 412   GObjectClass parent_class;
 413 };
 414
 415 struct _GTestDBusPrivate
 416 {
 417   GTestDBusFlags flags;
 418   GPtrArray *service_dirs;
 419   GPid bus_pid;
 420   gchar *bus_address;
 421   gboolean up;
 422 };
 423
 424 enum
 425 {
 426   PROP_0,
 427   PROP_FLAGS,
 428 };
 429
 430 G_DEFINE_TYPE_WITH_PRIVATE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
 431
 432 static void
 433 g_test_dbus_init (GTestDBus *self)
 434 {
 435   self->priv = g_test_dbus_get_instance_private (self);
 436   self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
 437 }
 438
 439 static void
 440 g_test_dbus_dispose (GObject *object)
 441 {
 442   GTestDBus *self = (GTestDBus *) object;
 443
 444   if (self->priv->up)
 445     g_test_dbus_down (self);
 446
 447   G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
 448 }
 449
 450 static void
 451 g_test_dbus_finalize (GObject *object)
 452 {
 453   GTestDBus *self = (GTestDBus *) object;
 454
 455   g_ptr_array_unref (self->priv->service_dirs);
 456   g_free (self->priv->bus_address);
 457
 458   G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
 459 }
 460
 461 static void
 462 g_test_dbus_get_property (GObject *object,
 463     guint property_id,
 464     GValue *value,
 465     GParamSpec *pspec)
 466 {
 467   GTestDBus *self = (GTestDBus *) object;
 468
 469   switch (property_id)
 470     {
 471       case PROP_FLAGS:
 472         g_value_set_flags (value, g_test_dbus_get_flags (self));
 473         break;
 474       default:
 475         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 476         break;
 477     }
 478 }
 479
 480 static void
 481 g_test_dbus_set_property (GObject *object,
 482     guint property_id,
 483     const GValue *value,
 484     GParamSpec *pspec)
 485 {
 486   GTestDBus *self = (GTestDBus *) object;
 487
 488   switch (property_id)
 489     {
 490       case PROP_FLAGS:
 491         self->priv->flags = g_value_get_flags (value);
 492         break;
 493       default:
 494         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 495         break;
 496     }
 497 }
 498
 499 static void
 500 g_test_dbus_class_init (GTestDBusClass *klass)
 501 {
 502   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 503
 504   object_class->dispose = g_test_dbus_dispose;
 505   object_class->finalize = g_test_dbus_finalize;
 506   object_class->get_property = g_test_dbus_get_property;
 507   object_class->set_property = g_test_dbus_set_property;
 508
 509   /**
 510    * GTestDBus:flags:
 511    *
 512    * #GTestDBusFlags specifying the behaviour of the D-Bus session.
 513    *
 514    * Since: 2.34
 515    */
 516   g_object_class_install_property (object_class, PROP_FLAGS,
 517     g_param_spec_flags ("flags",
 518                         P_("D-Bus session flags"),
 519                         P_("Flags specifying the behaviour of the D-Bus session"),
 520                         G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
 521                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 522                         G_PARAM_STATIC_STRINGS));
 523
 524 }
 525
 526 static gchar *
 527 write_config_file (GTestDBus *self)
 528 {
 529   GString *contents;
 530   gint fd;
 531   guint i;
 532   GError *error = NULL;
 533   gchar *path = NULL;
 534
 535   fd = g_file_open_tmp ("g-test-dbus-XXXXXX", &path, &error);
 536   g_assert_no_error (error);
 537
 538   contents = g_string_new (NULL);
 539   g_string_append (contents,
 540       "<busconfig>\n"
 541       "  <type>session</type>\n"
 542 #ifdef G_OS_WIN32
 543       "  <listen>nonce-tcp:</listen>\n"
 544 #else
 545       "  <listen>unix:tmpdir=/tmp</listen>\n"
 546 #endif
 547                    );
 548
 549   for (i = 0; i < self->priv->service_dirs->len; i++)
 550     {
 551       const gchar *dir_path = g_ptr_array_index (self->priv->service_dirs, i);
 552
 553       g_string_append_printf (contents,
 554           "  <servicedir>%s</servicedir>\n", dir_path);
 555     }
 556
 557   g_string_append (contents,
 558       "  <policy context=\"default\">\n"
 559       "    <!-- Allow everything to be sent -->\n"
 560       "    <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
 561       "    <!-- Allow everything to be received -->\n"
 562       "    <allow eavesdrop=\"true\"/>\n"
 563       "    <!-- Allow anyone to own anything -->\n"
 564       "    <allow own=\"*\"/>\n"
 565       "  </policy>\n"
 566       "</busconfig>\n");
 567
 568   g_file_set_contents (path, contents->str, contents->len, &error);
 569   g_assert_no_error (error);
 570
 571   g_string_free (contents, TRUE);
 572
 573   close (fd);
 574
 575   return path;
 576 }
 577
 578 static void
 579 start_daemon (GTestDBus *self)
 580 {
 581   const gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
 582   gchar *config_path;
 583   gchar *config_arg;
 584   gint stdout_fd;
 585   GIOChannel *channel;
 586   gsize termpos;
 587   GError *error = NULL;
 588
 589   if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL)
 590     argv[0] = (gchar *)g_getenv ("G_TEST_DBUS_DAEMON");
 591
 592   /* Write config file and set its path in argv */
 593   config_path = write_config_file (self);
 594   config_arg = g_strdup_printf ("--config-file=%s", config_path);
 595   argv[2] = config_arg;
 596
 597   /* Spawn dbus-daemon */
 598   g_spawn_async_with_pipes (NULL,
 599                             (gchar **) argv,
 600                             NULL,
 601 #ifdef G_OS_WIN32
 602                             /* We Need this to get the pid returned on win32 */
 603                             G_SPAWN_DO_NOT_REAP_CHILD |
 604 #endif
 605                             G_SPAWN_SEARCH_PATH,
 606                             NULL,
 607                             NULL,
 608                             &self->priv->bus_pid,
 609                             NULL,
 610                             &stdout_fd,
 611                             NULL,
 612                             &error);
 613   g_assert_no_error (error);
 614
 615   _g_test_watcher_add_pid (self->priv->bus_pid);
 616
 617   /* Read bus address from daemon' stdout */
 618   channel = g_io_channel_unix_new (stdout_fd);
 619   g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
 620       &termpos, &error);
 621   g_assert_no_error (error);
 622   self->priv->bus_address[termpos] = '\0';
 623
 624   /* start dbus-monitor */
 625   if (g_getenv ("G_DBUS_MONITOR") != NULL)
 626     {
 627       gchar *command;
 628
 629       command = g_strdup_printf ("dbus-monitor --address %s",
 630           self->priv->bus_address);
 631       g_spawn_command_line_async (command, NULL);
 632       g_free (command);
 633
 634       g_usleep (500 * 1000);
 635     }
 636
 637   /* Cleanup */
 638   g_io_channel_shutdown (channel, FALSE, &error);
 639   g_assert_no_error (error);
 640   g_io_channel_unref (channel);
 641
 642   /* Don't use g_file_delete since it calls into gvfs */
 643   if (g_unlink (config_path) != 0)
 644     g_assert_not_reached ();
 645
 646   g_free (config_path);
 647   g_free (config_arg);
 648 }
 649
 650 static void
 651 stop_daemon (GTestDBus *self)
 652 {
 653 #ifdef G_OS_WIN32
 654   if (!TerminateProcess (self->priv->bus_pid, 0))
 655     g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
 656 #else
 657   kill (self->priv->bus_pid, SIGTERM);
 658 #endif
 659   _g_test_watcher_remove_pid (self->priv->bus_pid);
 660   g_spawn_close_pid (self->priv->bus_pid);
 661   self->priv->bus_pid = 0;
 662
 663   g_free (self->priv->bus_address);
 664   self->priv->bus_address = NULL;
 665 }
 666
 667 /**
 668  * g_test_dbus_new:
 669  * @flags: a #GTestDBusFlags
 670  *
 671  * Create a new #GTestDBus object.
 672  *
 673  * Returns: (transfer full): a new #GTestDBus.
 674  */
 675 GTestDBus *
 676 g_test_dbus_new (GTestDBusFlags flags)
 677 {
 678   return g_object_new (G_TYPE_TEST_DBUS,
 679       "flags", flags,
 680       NULL);
 681 }
 682
 683 /**
 684  * g_test_dbus_get_flags:
 685  * @self: a #GTestDBus
 686  *
 687  * Get the flags of the #GTestDBus object.
 688  *
 689  * Returns: the value of #GTestDBus:flags property
 690  */
 691 GTestDBusFlags
 692 g_test_dbus_get_flags (GTestDBus *self)
 693 {
 694   g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);
 695
 696   return self->priv->flags;
 697 }
 698
 699 /**
 700  * g_test_dbus_get_bus_address:
 701  * @self: a #GTestDBus
 702  *
 703  * Get the address on which dbus-daemon is running. If g_test_dbus_up() has not
 704  * been called yet, %NULL is returned. This can be used with
 705  * g_dbus_connection_new_for_address().
 706  *
 707  * Returns: (allow-none): the address of the bus, or %NULL.
 708  */
 709 const gchar *
 710 g_test_dbus_get_bus_address (GTestDBus *self)
 711 {
 712   g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);
 713
 714   return self->priv->bus_address;
 715 }
 716
 717 /**
 718  * g_test_dbus_add_service_dir:
 719  * @self: a #GTestDBus
 720  * @path: path to a directory containing .service files
 721  *
 722  * Add a path where dbus-daemon will look up .service files. This can't be
 723  * called after g_test_dbus_up().
 724  */
 725 void
 726 g_test_dbus_add_service_dir (GTestDBus *self,
 727     const gchar *path)
 728 {
 729   g_return_if_fail (G_IS_TEST_DBUS (self));
 730   g_return_if_fail (self->priv->bus_address == NULL);
 731
 732   g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
 733 }
 734
 735 /**
 736  * g_test_dbus_up:
 737  * @self: a #GTestDBus
 738  *
 739  * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
 740  * call, it is safe for unit tests to start sending messages on the session bus.
 741  *
 742  * If this function is called from setup callback of g_test_add(),
 743  * g_test_dbus_down() must be called in its teardown callback.
 744  *
 745  * If this function is called from unit test's main(), then g_test_dbus_down()
 746  * must be called after g_test_run().
 747  */
 748 void
 749 g_test_dbus_up (GTestDBus *self)
 750 {
 751   g_return_if_fail (G_IS_TEST_DBUS (self));
 752   g_return_if_fail (self->priv->bus_address == NULL);
 753   g_return_if_fail (!self->priv->up);
 754
 755   start_daemon (self);
 756
 757   g_test_dbus_unset ();
 758   g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
 759   self->priv->up = TRUE;
 760 }
 761
 762
 763 /**
 764  * g_test_dbus_stop:
 765  * @self: a #GTestDBus
 766  *
 767  * Stop the session bus started by g_test_dbus_up().
 768  *
 769  * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
 770  * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
 771  * tests wanting to verify behaviour after the session bus has been stopped
 772  * can use this function but should still call g_test_dbus_down() when done.
 773  */
 774 void
 775 g_test_dbus_stop (GTestDBus *self)
 776 {
 777   g_return_if_fail (G_IS_TEST_DBUS (self));
 778   g_return_if_fail (self->priv->bus_address != NULL);
 779
 780   stop_daemon (self);
 781 }
 782
 783 /**
 784  * g_test_dbus_down:
 785  * @self: a #GTestDBus
 786  *
 787  * Stop the session bus started by g_test_dbus_up().
 788  *
 789  * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
 790  * is destroyed. This is done to ensure that the next unit test won't get a
 791  * leaked singleton from this test.
 792  */
 793 void
 794 g_test_dbus_down (GTestDBus *self)
 795 {
 796   GDBusConnection *connection;
 797
 798   g_return_if_fail (G_IS_TEST_DBUS (self));
 799   g_return_if_fail (self->priv->up);
 800
 801   connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
 802   if (connection != NULL)
 803     g_dbus_connection_set_exit_on_close (connection, FALSE);
 804
 805   if (self->priv->bus_address != NULL)
 806     stop_daemon (self);
 807
 808   if (connection != NULL)
 809     _g_object_dispose_and_wait_weak_notify (connection);
 810
 811   g_test_dbus_unset ();
 812   self->priv->up = FALSE;
 813 }
 814
 815 /**
 816  * g_test_dbus_unset:
 817  *
 818  * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
 819  * won't use user's session bus.
 820  *
 821  * This is useful for unit tests that want to verify behaviour when no session
 822  * bus is running. It is not necessary to call this if unit test already calls
 823  * g_test_dbus_up() before acquiring the session bus.
 824  */
 825 void
 826 g_test_dbus_unset (void)
 827 {
 828   g_unsetenv ("DISPLAY");
 829   g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
 830   g_unsetenv ("DBUS_STARTER_ADDRESS");
 831   g_unsetenv ("DBUS_STARTER_BUS_TYPE");
 832 }