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  * Here is an example of a test fixture for D-Bus services:
 364  * <programlisting>
 365  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-test-fixture.c">
 366  * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
 367  * </xi:include>
 368  * </programlisting>
 369  *
 370  * Note that these examples only deal with isolating the D-Bus aspect of your
 371  * service. To successfully run isolated unit tests on your service you may need
 372  * some additional modifications to your test case fixture. For example; if your
 373  * service uses GSettings and installs a schema then it is important that your test service
 374  * not load the schema in the ordinary installed location (chances are that your service
 375  * and schema files are not yet installed, or worse; there is an older version of the
 376  * schema file sitting in the install location).
 377  *
 378  * Most of the time we can work around these obstacles using the environment. Since the
 379  * environment is inherited by the D-Bus daemon created by #GTestDBus and then in turn
 380  * inherited by any services the D-Bus daemon activates, using the setup routine for your
 381  * fixture is a practical place to help sandbox your runtime environment. For the rather
 382  * typical GSettings case we can work around this by setting <envar>GSETTINGS_SCHEMA_DIR</envar> to the
 383  * in tree directory holding your schemas in the above fixture_setup() routine.
 384  *
 385  * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
 386  * by compiling the schemas locally as a step before running test cases, an autotools setup might
 387  * do the following in the directory holding schemas:
 388  * |[
 389  *     all-am:
 390  *             $(GLIB_COMPILE_SCHEMAS) .
 391  *
 392  *     CLEANFILES += gschemas.compiled
 393  * ]|
 394  */
 395
 396 typedef struct _GTestDBusClass   GTestDBusClass;
 397 typedef struct _GTestDBusPrivate GTestDBusPrivate;
 398
 399 /**
 400  * GTestDBus:
 401  *
 402  * The #GTestDBus structure contains only private data and
 403  * should only be accessed using the provided API.
 404  *
 405  * Since: 2.34
 406  */
 407 struct _GTestDBus {
 408   GObject parent;
 409
 410   GTestDBusPrivate *priv;
 411 };
 412
 413 struct _GTestDBusClass {
 414   GObjectClass parent_class;
 415 };
 416
 417 struct _GTestDBusPrivate
 418 {
 419   GTestDBusFlags flags;
 420   GPtrArray *service_dirs;
 421   GPid bus_pid;
 422   gchar *bus_address;
 423   gboolean up;
 424 };
 425
 426 enum
 427 {
 428   PROP_0,
 429   PROP_FLAGS,
 430 };
 431
 432 G_DEFINE_TYPE_WITH_PRIVATE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
 433
 434 static void
 435 g_test_dbus_init (GTestDBus *self)
 436 {
 437   self->priv = g_test_dbus_get_instance_private (self);
 438   self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
 439 }
 440
 441 static void
 442 g_test_dbus_dispose (GObject *object)
 443 {
 444   GTestDBus *self = (GTestDBus *) object;
 445
 446   if (self->priv->up)
 447     g_test_dbus_down (self);
 448
 449   G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
 450 }
 451
 452 static void
 453 g_test_dbus_finalize (GObject *object)
 454 {
 455   GTestDBus *self = (GTestDBus *) object;
 456
 457   g_ptr_array_unref (self->priv->service_dirs);
 458   g_free (self->priv->bus_address);
 459
 460   G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
 461 }
 462
 463 static void
 464 g_test_dbus_get_property (GObject *object,
 465     guint property_id,
 466     GValue *value,
 467     GParamSpec *pspec)
 468 {
 469   GTestDBus *self = (GTestDBus *) object;
 470
 471   switch (property_id)
 472     {
 473       case PROP_FLAGS:
 474         g_value_set_flags (value, g_test_dbus_get_flags (self));
 475         break;
 476       default:
 477         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 478         break;
 479     }
 480 }
 481
 482 static void
 483 g_test_dbus_set_property (GObject *object,
 484     guint property_id,
 485     const GValue *value,
 486     GParamSpec *pspec)
 487 {
 488   GTestDBus *self = (GTestDBus *) object;
 489
 490   switch (property_id)
 491     {
 492       case PROP_FLAGS:
 493         self->priv->flags = g_value_get_flags (value);
 494         break;
 495       default:
 496         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 497         break;
 498     }
 499 }
 500
 501 static void
 502 g_test_dbus_class_init (GTestDBusClass *klass)
 503 {
 504   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 505
 506   object_class->dispose = g_test_dbus_dispose;
 507   object_class->finalize = g_test_dbus_finalize;
 508   object_class->get_property = g_test_dbus_get_property;
 509   object_class->set_property = g_test_dbus_set_property;
 510
 511   /**
 512    * GTestDBus:flags:
 513    *
 514    * #GTestDBusFlags specifying the behaviour of the D-Bus session.
 515    *
 516    * Since: 2.34
 517    */
 518   g_object_class_install_property (object_class, PROP_FLAGS,
 519     g_param_spec_flags ("flags",
 520                         P_("D-Bus session flags"),
 521                         P_("Flags specifying the behaviour of the D-Bus session"),
 522                         G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
 523                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 524                         G_PARAM_STATIC_STRINGS));
 525
 526 }
 527
 528 static gchar *
 529 write_config_file (GTestDBus *self)
 530 {
 531   GString *contents;
 532   gint fd;
 533   guint i;
 534   GError *error = NULL;
 535   gchar *path = NULL;
 536
 537   fd = g_file_open_tmp ("g-test-dbus-XXXXXX", &path, &error);
 538   g_assert_no_error (error);
 539
 540   contents = g_string_new (NULL);
 541   g_string_append (contents,
 542       "<busconfig>\n"
 543       "  <type>session</type>\n"
 544 #ifdef G_OS_WIN32
 545       "  <listen>nonce-tcp:</listen>\n"
 546 #else
 547       "  <listen>unix:tmpdir=/tmp</listen>\n"
 548 #endif
 549                    );
 550
 551   for (i = 0; i < self->priv->service_dirs->len; i++)
 552     {
 553       const gchar *dir_path = g_ptr_array_index (self->priv->service_dirs, i);
 554
 555       g_string_append_printf (contents,
 556           "  <servicedir>%s</servicedir>\n", dir_path);
 557     }
 558
 559   g_string_append (contents,
 560       "  <policy context=\"default\">\n"
 561       "    <!-- Allow everything to be sent -->\n"
 562       "    <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
 563       "    <!-- Allow everything to be received -->\n"
 564       "    <allow eavesdrop=\"true\"/>\n"
 565       "    <!-- Allow anyone to own anything -->\n"
 566       "    <allow own=\"*\"/>\n"
 567       "  </policy>\n"
 568       "</busconfig>\n");
 569
 570   g_file_set_contents (path, contents->str, contents->len, &error);
 571   g_assert_no_error (error);
 572
 573   g_string_free (contents, TRUE);
 574
 575   close (fd);
 576
 577   return path;
 578 }
 579
 580 static void
 581 start_daemon (GTestDBus *self)
 582 {
 583   const gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
 584   gchar *config_path;
 585   gchar *config_arg;
 586   gint stdout_fd;
 587   GIOChannel *channel;
 588   gsize termpos;
 589   GError *error = NULL;
 590
 591   if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL)
 592     argv[0] = (gchar *)g_getenv ("G_TEST_DBUS_DAEMON");
 593
 594   /* Write config file and set its path in argv */
 595   config_path = write_config_file (self);
 596   config_arg = g_strdup_printf ("--config-file=%s", config_path);
 597   argv[2] = config_arg;
 598
 599   /* Spawn dbus-daemon */
 600   g_spawn_async_with_pipes (NULL,
 601                             (gchar **) argv,
 602                             NULL,
 603 #ifdef G_OS_WIN32
 604                             /* We Need this to get the pid returned on win32 */
 605                             G_SPAWN_DO_NOT_REAP_CHILD |
 606 #endif
 607                             G_SPAWN_SEARCH_PATH,
 608                             NULL,
 609                             NULL,
 610                             &self->priv->bus_pid,
 611                             NULL,
 612                             &stdout_fd,
 613                             NULL,
 614                             &error);
 615   g_assert_no_error (error);
 616
 617   _g_test_watcher_add_pid (self->priv->bus_pid);
 618
 619   /* Read bus address from daemon' stdout */
 620   channel = g_io_channel_unix_new (stdout_fd);
 621   g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
 622       &termpos, &error);
 623   g_assert_no_error (error);
 624   self->priv->bus_address[termpos] = '\0';
 625
 626   /* start dbus-monitor */
 627   if (g_getenv ("G_DBUS_MONITOR") != NULL)
 628     {
 629       gchar *command;
 630
 631       command = g_strdup_printf ("dbus-monitor --address %s",
 632           self->priv->bus_address);
 633       g_spawn_command_line_async (command, NULL);
 634       g_free (command);
 635
 636       g_usleep (500 * 1000);
 637     }
 638
 639   /* Cleanup */
 640   g_io_channel_shutdown (channel, FALSE, &error);
 641   g_assert_no_error (error);
 642   g_io_channel_unref (channel);
 643
 644   /* Don't use g_file_delete since it calls into gvfs */
 645   if (g_unlink (config_path) != 0)
 646     g_assert_not_reached ();
 647
 648   g_free (config_path);
 649   g_free (config_arg);
 650 }
 651
 652 static void
 653 stop_daemon (GTestDBus *self)
 654 {
 655 #ifdef G_OS_WIN32
 656   if (!TerminateProcess (self->priv->bus_pid, 0))
 657     g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
 658 #else
 659   kill (self->priv->bus_pid, SIGTERM);
 660 #endif
 661   _g_test_watcher_remove_pid (self->priv->bus_pid);
 662   g_spawn_close_pid (self->priv->bus_pid);
 663   self->priv->bus_pid = 0;
 664
 665   g_free (self->priv->bus_address);
 666   self->priv->bus_address = NULL;
 667 }
 668
 669 /**
 670  * g_test_dbus_new:
 671  * @flags: a #GTestDBusFlags
 672  *
 673  * Create a new #GTestDBus object.
 674  *
 675  * Returns: (transfer full): a new #GTestDBus.
 676  */
 677 GTestDBus *
 678 g_test_dbus_new (GTestDBusFlags flags)
 679 {
 680   return g_object_new (G_TYPE_TEST_DBUS,
 681       "flags", flags,
 682       NULL);
 683 }
 684
 685 /**
 686  * g_test_dbus_get_flags:
 687  * @self: a #GTestDBus
 688  *
 689  * Get the flags of the #GTestDBus object.
 690  *
 691  * Returns: the value of #GTestDBus:flags property
 692  */
 693 GTestDBusFlags
 694 g_test_dbus_get_flags (GTestDBus *self)
 695 {
 696   g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);
 697
 698   return self->priv->flags;
 699 }
 700
 701 /**
 702  * g_test_dbus_get_bus_address:
 703  * @self: a #GTestDBus
 704  *
 705  * Get the address on which dbus-daemon is running. If g_test_dbus_up() has not
 706  * been called yet, %NULL is returned. This can be used with
 707  * g_dbus_connection_new_for_address().
 708  *
 709  * Returns: (allow-none): the address of the bus, or %NULL.
 710  */
 711 const gchar *
 712 g_test_dbus_get_bus_address (GTestDBus *self)
 713 {
 714   g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);
 715
 716   return self->priv->bus_address;
 717 }
 718
 719 /**
 720  * g_test_dbus_add_service_dir:
 721  * @self: a #GTestDBus
 722  * @path: path to a directory containing .service files
 723  *
 724  * Add a path where dbus-daemon will look up .service files. This can't be
 725  * called after g_test_dbus_up().
 726  */
 727 void
 728 g_test_dbus_add_service_dir (GTestDBus *self,
 729     const gchar *path)
 730 {
 731   g_return_if_fail (G_IS_TEST_DBUS (self));
 732   g_return_if_fail (self->priv->bus_address == NULL);
 733
 734   g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
 735 }
 736
 737 /**
 738  * g_test_dbus_up:
 739  * @self: a #GTestDBus
 740  *
 741  * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
 742  * call, it is safe for unit tests to start sending messages on the session bus.
 743  *
 744  * If this function is called from setup callback of g_test_add(),
 745  * g_test_dbus_down() must be called in its teardown callback.
 746  *
 747  * If this function is called from unit test's main(), then g_test_dbus_down()
 748  * must be called after g_test_run().
 749  */
 750 void
 751 g_test_dbus_up (GTestDBus *self)
 752 {
 753   g_return_if_fail (G_IS_TEST_DBUS (self));
 754   g_return_if_fail (self->priv->bus_address == NULL);
 755   g_return_if_fail (!self->priv->up);
 756
 757   start_daemon (self);
 758
 759   g_test_dbus_unset ();
 760   g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
 761   self->priv->up = TRUE;
 762 }
 763
 764
 765 /**
 766  * g_test_dbus_stop:
 767  * @self: a #GTestDBus
 768  *
 769  * Stop the session bus started by g_test_dbus_up().
 770  *
 771  * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
 772  * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
 773  * tests wanting to verify behaviour after the session bus has been stopped
 774  * can use this function but should still call g_test_dbus_down() when done.
 775  */
 776 void
 777 g_test_dbus_stop (GTestDBus *self)
 778 {
 779   g_return_if_fail (G_IS_TEST_DBUS (self));
 780   g_return_if_fail (self->priv->bus_address != NULL);
 781
 782   stop_daemon (self);
 783 }
 784
 785 /**
 786  * g_test_dbus_down:
 787  * @self: a #GTestDBus
 788  *
 789  * Stop the session bus started by g_test_dbus_up().
 790  *
 791  * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
 792  * is destroyed. This is done to ensure that the next unit test won't get a
 793  * leaked singleton from this test.
 794  */
 795 void
 796 g_test_dbus_down (GTestDBus *self)
 797 {
 798   GDBusConnection *connection;
 799
 800   g_return_if_fail (G_IS_TEST_DBUS (self));
 801   g_return_if_fail (self->priv->up);
 802
 803   connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
 804   if (connection != NULL)
 805     g_dbus_connection_set_exit_on_close (connection, FALSE);
 806
 807   if (self->priv->bus_address != NULL)
 808     stop_daemon (self);
 809
 810   if (connection != NULL)
 811     _g_object_dispose_and_wait_weak_notify (connection);
 812
 813   g_test_dbus_unset ();
 814   self->priv->up = FALSE;
 815 }
 816
 817 /**
 818  * g_test_dbus_unset:
 819  *
 820  * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
 821  * won't use user's session bus.
 822  *
 823  * This is useful for unit tests that want to verify behaviour when no session
 824  * bus is running. It is not necessary to call this if unit test already calls
 825  * g_test_dbus_up() before acquiring the session bus.
 826  */
 827 void
 828 g_test_dbus_unset (void)
 829 {
 830   g_unsetenv ("DISPLAY");
 831   g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
 832   g_unsetenv ("DBUS_STARTER_ADDRESS");
 833   g_unsetenv ("DBUS_STARTER_BUS_TYPE");
 834 }