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