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.1 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   int errsv;
 241
 242   if (g_once_init_enter (&started))
 243     {
 244       gint pipe_fds[2];
 245
 246       /* fork a child to clean up when we are killed */
 247       if (pipe (pipe_fds) != 0)
 248         {
 249           errsv = errno;
 250           g_warning ("pipe() failed: %s", g_strerror (errsv));
 251           g_assert_not_reached ();
 252         }
 253
 254       switch (fork ())
 255         {
 256         case -1:
 257           errsv = errno;
 258           g_warning ("fork() failed: %s", g_strerror (errsv));
 259           g_assert_not_reached ();
 260           break;
 261
 262         case 0:
 263           /* child */
 264           close (pipe_fds[1]);
 265           watch_parent (pipe_fds[0]);
 266           break;
 267
 268         default:
 269           /* parent */
 270           close (pipe_fds[0]);
 271           channel = g_io_channel_unix_new (pipe_fds[1]);
 272         }
 273
 274       g_once_init_leave (&started, 1);
 275     }
 276
 277   return channel;
 278 }
 279
 280 static void
 281 watcher_send_command (const gchar *command)
 282 {
 283   GIOChannel *channel;
 284   GError *error = NULL;
 285
 286   channel = watcher_init ();
 287
 288   g_io_channel_write_chars (channel, command, -1, NULL, &error);
 289   g_assert_no_error (error);
 290
 291   g_io_channel_flush (channel, &error);
 292   g_assert_no_error (error);
 293 }
 294
 295 /* This could be interesting to expose in public API */
 296 static void
 297 _g_test_watcher_add_pid (GPid pid)
 298 {
 299   gchar *command;
 300
 301   command = g_strdup_printf (ADD_PID_FORMAT, (guint) pid);
 302   watcher_send_command (command);
 303   g_free (command);
 304 }
 305
 306 static void
 307 _g_test_watcher_remove_pid (GPid pid)
 308 {
 309   gchar *command;
 310
 311   command = g_strdup_printf (REMOVE_PID_FORMAT, (guint) pid);
 312   watcher_send_command (command);
 313   g_free (command);
 314 }
 315
 316 #endif
 317
 318 /* -------------------------------------------------------------------------- */
 319 /* GTestDBus object implementation */
 320
 321 /**
 322  * SECTION:gtestdbus
 323  * @short_description: D-Bus testing helper
 324  * @include: gio/gio.h
 325  *
 326  * A helper class for testing code which uses D-Bus without touching the user's
 327  * session bus.
 328  *
 329  * Note that #GTestDBus modifies the user’s environment, calling setenv().
 330  * This is not thread-safe, so all #GTestDBus calls should be completed before
 331  * threads are spawned, or should have appropriate locking to ensure no access
 332  * conflicts to environment variables shared between #GTestDBus and other
 333  * threads.
 334  *
 335  * ## Creating unit tests using GTestDBus
 336  *
 337  * Testing of D-Bus services can be tricky because normally we only ever run
 338  * D-Bus services over an existing instance of the D-Bus daemon thus we
 339  * usually don't activate D-Bus services that are not yet installed into the
 340  * target system. The #GTestDBus object makes this easier for us by taking care
 341  * of the lower level tasks such as running a private D-Bus daemon and looking
 342  * up uninstalled services in customizable locations, typically in your source
 343  * code tree.
 344  *
 345  * The first thing you will need is a separate service description file for the
 346  * D-Bus daemon. Typically a `services` subdirectory of your `tests` directory
 347  * is a good place to put this file.
 348  *
 349  * The service file should list your service along with an absolute path to the
 350  * uninstalled service executable in your source tree. Using autotools we would
 351  * achieve this by adding a file such as `my-server.service.in` in the services
 352  * directory and have it processed by configure.
 353  * |[
 354  *     [D-BUS Service]
 355  *     Name=org.gtk.GDBus.Examples.ObjectManager
 356  *     Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server
 357  * ]|
 358  * You will also need to indicate this service directory in your test
 359  * fixtures, so you will need to pass the path while compiling your
 360  * test cases. Typically this is done with autotools with an added
 361  * preprocessor flag specified to compile your tests such as:
 362  * |[
 363  *     -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\"
 364  * ]|
 365  *     Once you have a service definition file which is local to your source tree,
 366  * you can proceed to set up a GTest fixture using the #GTestDBus scaffolding.
 367  *
 368  * An example of a test fixture for D-Bus services can be found
 369  * here:
 370  * [gdbus-test-fixture.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-test-fixture.c)
 371  *
 372  * Note that these examples only deal with isolating the D-Bus aspect of your
 373  * service. To successfully run isolated unit tests on your service you may need
 374  * some additional modifications to your test case fixture. For example; if your
 375  * service uses GSettings and installs a schema then it is important that your test service
 376  * not load the schema in the ordinary installed location (chances are that your service
 377  * and schema files are not yet installed, or worse; there is an older version of the
 378  * schema file sitting in the install location).
 379  *
 380  * Most of the time we can work around these obstacles using the
 381  * environment. Since the environment is inherited by the D-Bus daemon
 382  * created by #GTestDBus and then in turn inherited by any services the
 383  * D-Bus daemon activates, using the setup routine for your fixture is
 384  * a practical place to help sandbox your runtime environment. For the
 385  * rather typical GSettings case we can work around this by setting
 386  * `GSETTINGS_SCHEMA_DIR` to the in tree directory holding your schemas
 387  * in the above fixture_setup() routine.
 388  *
 389  * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
 390  * by compiling the schemas locally as a step before running test cases, an autotools setup might
 391  * do the following in the directory holding schemas:
 392  * |[
 393  *     all-am:
 394  *             $(GLIB_COMPILE_SCHEMAS) .
 395  *
 396  *     CLEANFILES += gschemas.compiled
 397  * ]|
 398  */
 399
 400 typedef struct _GTestDBusClass   GTestDBusClass;
 401 typedef struct _GTestDBusPrivate GTestDBusPrivate;
 402
 403 /**
 404  * GTestDBus:
 405  *
 406  * The #GTestDBus structure contains only private data and
 407  * should only be accessed using the provided API.
 408  *
 409  * Since: 2.34
 410  */
 411 struct _GTestDBus {
 412   GObject parent;
 413
 414   GTestDBusPrivate *priv;
 415 };
 416
 417 struct _GTestDBusClass {
 418   GObjectClass parent_class;
 419 };
 420
 421 struct _GTestDBusPrivate
 422 {
 423   GTestDBusFlags flags;
 424   GPtrArray *service_dirs;
 425   GPid bus_pid;
 426   gint bus_stdout_fd;
 427   gchar *bus_address;
 428   gboolean up;
 429 };
 430
 431 enum
 432 {
 433   PROP_0,
 434   PROP_FLAGS,
 435 };
 436
 437 G_DEFINE_TYPE_WITH_PRIVATE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
 438
 439 static void
 440 g_test_dbus_init (GTestDBus *self)
 441 {
 442   self->priv = g_test_dbus_get_instance_private (self);
 443   self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
 444 }
 445
 446 static void
 447 g_test_dbus_dispose (GObject *object)
 448 {
 449   GTestDBus *self = (GTestDBus *) object;
 450
 451   if (self->priv->up)
 452     g_test_dbus_down (self);
 453
 454   G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
 455 }
 456
 457 static void
 458 g_test_dbus_finalize (GObject *object)
 459 {
 460   GTestDBus *self = (GTestDBus *) object;
 461
 462   g_ptr_array_unref (self->priv->service_dirs);
 463   g_free (self->priv->bus_address);
 464
 465   G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
 466 }
 467
 468 static void
 469 g_test_dbus_get_property (GObject *object,
 470     guint property_id,
 471     GValue *value,
 472     GParamSpec *pspec)
 473 {
 474   GTestDBus *self = (GTestDBus *) object;
 475
 476   switch (property_id)
 477     {
 478       case PROP_FLAGS:
 479         g_value_set_flags (value, g_test_dbus_get_flags (self));
 480         break;
 481       default:
 482         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 483         break;
 484     }
 485 }
 486
 487 static void
 488 g_test_dbus_set_property (GObject *object,
 489     guint property_id,
 490     const GValue *value,
 491     GParamSpec *pspec)
 492 {
 493   GTestDBus *self = (GTestDBus *) object;
 494
 495   switch (property_id)
 496     {
 497       case PROP_FLAGS:
 498         self->priv->flags = g_value_get_flags (value);
 499         break;
 500       default:
 501         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 502         break;
 503     }
 504 }
 505
 506 static void
 507 g_test_dbus_class_init (GTestDBusClass *klass)
 508 {
 509   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 510
 511   object_class->dispose = g_test_dbus_dispose;
 512   object_class->finalize = g_test_dbus_finalize;
 513   object_class->get_property = g_test_dbus_get_property;
 514   object_class->set_property = g_test_dbus_set_property;
 515
 516   /**
 517    * GTestDBus:flags:
 518    *
 519    * #GTestDBusFlags specifying the behaviour of the D-Bus session.
 520    *
 521    * Since: 2.34
 522    */
 523   g_object_class_install_property (object_class, PROP_FLAGS,
 524     g_param_spec_flags ("flags",
 525                         P_("D-Bus session flags"),
 526                         P_("Flags specifying the behaviour of the D-Bus session"),
 527                         G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
 528                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 529                         G_PARAM_STATIC_STRINGS));
 530
 531 }
 532
 533 static gchar *
 534 write_config_file (GTestDBus *self)
 535 {
 536   GString *contents;
 537   gint fd;
 538   guint i;
 539   GError *error = NULL;
 540   gchar *path = NULL;
 541
 542   fd = g_file_open_tmp ("g-test-dbus-XXXXXX", &path, &error);
 543   g_assert_no_error (error);
 544
 545   contents = g_string_new (NULL);
 546   g_string_append (contents,
 547       "<busconfig>\n"
 548       "  <type>session</type>\n"
 549 #ifdef G_OS_WIN32
 550       "  <listen>nonce-tcp:</listen>\n"
 551 #else
 552       "  <listen>unix:tmpdir=/tmp</listen>\n"
 553 #endif
 554                    );
 555
 556   for (i = 0; i < self->priv->service_dirs->len; i++)
 557     {
 558       const gchar *dir_path = g_ptr_array_index (self->priv->service_dirs, i);
 559
 560       g_string_append_printf (contents,
 561           "  <servicedir>%s</servicedir>\n", dir_path);
 562     }
 563
 564   g_string_append (contents,
 565       "  <policy context=\"default\">\n"
 566       "    <!-- Allow everything to be sent -->\n"
 567       "    <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
 568       "    <!-- Allow everything to be received -->\n"
 569       "    <allow eavesdrop=\"true\"/>\n"
 570       "    <!-- Allow anyone to own anything -->\n"
 571       "    <allow own=\"*\"/>\n"
 572       "  </policy>\n"
 573       "</busconfig>\n");
 574
 575   close (fd);
 576   g_file_set_contents (path, contents->str, contents->len, &error);
 577   g_assert_no_error (error);
 578
 579   g_string_free (contents, TRUE);
 580
 581   return path;
 582 }
 583
 584 static void
 585 start_daemon (GTestDBus *self)
 586 {
 587   const gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
 588   gchar *config_path;
 589   gchar *config_arg;
 590   GIOChannel *channel;
 591   gint stdout_fd2;
 592   gsize termpos;
 593   GError *error = NULL;
 594
 595   if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL)
 596     argv[0] = (gchar *)g_getenv ("G_TEST_DBUS_DAEMON");
 597
 598   /* Write config file and set its path in argv */
 599   config_path = write_config_file (self);
 600   config_arg = g_strdup_printf ("--config-file=%s", config_path);
 601   argv[2] = config_arg;
 602
 603   /* Spawn dbus-daemon */
 604   g_spawn_async_with_pipes (NULL,
 605                             (gchar **) argv,
 606                             NULL,
 607 #ifdef G_OS_WIN32
 608                             /* We Need this to get the pid returned on win32 */
 609                             G_SPAWN_DO_NOT_REAP_CHILD |
 610 #endif
 611                             G_SPAWN_SEARCH_PATH,
 612                             NULL,
 613                             NULL,
 614                             &self->priv->bus_pid,
 615                             NULL,
 616                             &self->priv->bus_stdout_fd,
 617                             NULL,
 618                             &error);
 619   g_assert_no_error (error);
 620
 621   _g_test_watcher_add_pid (self->priv->bus_pid);
 622
 623   /* Read bus address from daemon' stdout. We have to be careful to avoid
 624    * closing the FD, as it is passed to any D-Bus service activated processes,
 625    * and if we close it, they will get a SIGPIPE and die when they try to write
 626    * to their stdout. */
 627   stdout_fd2 = dup (self->priv->bus_stdout_fd);
 628   g_assert_cmpint (stdout_fd2, >=, 0);
 629   channel = g_io_channel_unix_new (stdout_fd2);
 630
 631   g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
 632       &termpos, &error);
 633   g_assert_no_error (error);
 634   self->priv->bus_address[termpos] = '\0';
 635
 636   /* start dbus-monitor */
 637   if (g_getenv ("G_DBUS_MONITOR") != NULL)
 638     {
 639       gchar *command;
 640
 641       command = g_strdup_printf ("dbus-monitor --address %s",
 642           self->priv->bus_address);
 643       g_spawn_command_line_async (command, NULL);
 644       g_free (command);
 645
 646       g_usleep (500 * 1000);
 647     }
 648
 649   /* Cleanup */
 650   g_io_channel_shutdown (channel, FALSE, &error);
 651   g_assert_no_error (error);
 652   g_io_channel_unref (channel);
 653
 654   /* Don't use g_file_delete since it calls into gvfs */
 655   if (g_unlink (config_path) != 0)
 656     g_assert_not_reached ();
 657
 658   g_free (config_path);
 659   g_free (config_arg);
 660 }
 661
 662 static void
 663 stop_daemon (GTestDBus *self)
 664 {
 665 #ifdef G_OS_WIN32
 666   if (!TerminateProcess (self->priv->bus_pid, 0))
 667     g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
 668 #else
 669   kill (self->priv->bus_pid, SIGTERM);
 670 #endif
 671   _g_test_watcher_remove_pid (self->priv->bus_pid);
 672   g_spawn_close_pid (self->priv->bus_pid);
 673   self->priv->bus_pid = 0;
 674   close (self->priv->bus_stdout_fd);
 675   self->priv->bus_stdout_fd = -1;
 676
 677   g_free (self->priv->bus_address);
 678   self->priv->bus_address = NULL;
 679 }
 680
 681 /**
 682  * g_test_dbus_new:
 683  * @flags: a #GTestDBusFlags
 684  *
 685  * Create a new #GTestDBus object.
 686  *
 687  * Returns: (transfer full): a new #GTestDBus.
 688  */
 689 GTestDBus *
 690 g_test_dbus_new (GTestDBusFlags flags)
 691 {
 692   return g_object_new (G_TYPE_TEST_DBUS,
 693       "flags", flags,
 694       NULL);
 695 }
 696
 697 /**
 698  * g_test_dbus_get_flags:
 699  * @self: a #GTestDBus
 700  *
 701  * Get the flags of the #GTestDBus object.
 702  *
 703  * Returns: the value of #GTestDBus:flags property
 704  */
 705 GTestDBusFlags
 706 g_test_dbus_get_flags (GTestDBus *self)
 707 {
 708   g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);
 709
 710   return self->priv->flags;
 711 }
 712
 713 /**
 714  * g_test_dbus_get_bus_address:
 715  * @self: a #GTestDBus
 716  *
 717  * Get the address on which dbus-daemon is running. If g_test_dbus_up() has not
 718  * been called yet, %NULL is returned. This can be used with
 719  * g_dbus_connection_new_for_address().
 720  *
 721  * Returns: (nullable): the address of the bus, or %NULL.
 722  */
 723 const gchar *
 724 g_test_dbus_get_bus_address (GTestDBus *self)
 725 {
 726   g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);
 727
 728   return self->priv->bus_address;
 729 }
 730
 731 /**
 732  * g_test_dbus_add_service_dir:
 733  * @self: a #GTestDBus
 734  * @path: path to a directory containing .service files
 735  *
 736  * Add a path where dbus-daemon will look up .service files. This can't be
 737  * called after g_test_dbus_up().
 738  */
 739 void
 740 g_test_dbus_add_service_dir (GTestDBus *self,
 741     const gchar *path)
 742 {
 743   g_return_if_fail (G_IS_TEST_DBUS (self));
 744   g_return_if_fail (self->priv->bus_address == NULL);
 745
 746   g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
 747 }
 748
 749 /**
 750  * g_test_dbus_up:
 751  * @self: a #GTestDBus
 752  *
 753  * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
 754  * call, it is safe for unit tests to start sending messages on the session bus.
 755  *
 756  * If this function is called from setup callback of g_test_add(),
 757  * g_test_dbus_down() must be called in its teardown callback.
 758  *
 759  * If this function is called from unit test's main(), then g_test_dbus_down()
 760  * must be called after g_test_run().
 761  */
 762 void
 763 g_test_dbus_up (GTestDBus *self)
 764 {
 765   g_return_if_fail (G_IS_TEST_DBUS (self));
 766   g_return_if_fail (self->priv->bus_address == NULL);
 767   g_return_if_fail (!self->priv->up);
 768
 769   start_daemon (self);
 770
 771   g_test_dbus_unset ();
 772   g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
 773   self->priv->up = TRUE;
 774 }
 775
 776
 777 /**
 778  * g_test_dbus_stop:
 779  * @self: a #GTestDBus
 780  *
 781  * Stop the session bus started by g_test_dbus_up().
 782  *
 783  * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
 784  * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
 785  * tests wanting to verify behaviour after the session bus has been stopped
 786  * can use this function but should still call g_test_dbus_down() when done.
 787  */
 788 void
 789 g_test_dbus_stop (GTestDBus *self)
 790 {
 791   g_return_if_fail (G_IS_TEST_DBUS (self));
 792   g_return_if_fail (self->priv->bus_address != NULL);
 793
 794   stop_daemon (self);
 795 }
 796
 797 /**
 798  * g_test_dbus_down:
 799  * @self: a #GTestDBus
 800  *
 801  * Stop the session bus started by g_test_dbus_up().
 802  *
 803  * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
 804  * is destroyed. This is done to ensure that the next unit test won't get a
 805  * leaked singleton from this test.
 806  */
 807 void
 808 g_test_dbus_down (GTestDBus *self)
 809 {
 810   GDBusConnection *connection;
 811
 812   g_return_if_fail (G_IS_TEST_DBUS (self));
 813   g_return_if_fail (self->priv->up);
 814
 815   connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
 816   if (connection != NULL)
 817     g_dbus_connection_set_exit_on_close (connection, FALSE);
 818
 819   if (self->priv->bus_address != NULL)
 820     stop_daemon (self);
 821
 822   if (connection != NULL)
 823     _g_object_dispose_and_wait_weak_notify (connection);
 824
 825   g_test_dbus_unset ();
 826   self->priv->up = FALSE;
 827 }
 828
 829 /**
 830  * g_test_dbus_unset:
 831  *
 832  * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
 833  * won't use user's session bus.
 834  *
 835  * This is useful for unit tests that want to verify behaviour when no session
 836  * bus is running. It is not necessary to call this if unit test already calls
 837  * g_test_dbus_up() before acquiring the session bus.
 838  */
 839 void
 840 g_test_dbus_unset (void)
 841 {
 842   g_unsetenv ("DISPLAY");
 843   g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
 844   g_unsetenv ("DBUS_STARTER_ADDRESS");
 845   g_unsetenv ("DBUS_STARTER_BUS_TYPE");
 846   /* avoid using XDG_RUNTIME_DIR/bus */
 847   g_unsetenv ("XDG_RUNTIME_DIR");
 848 }