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, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *
  21  * Authors: David Zeuthen <davidz@redhat.com>
  22  *          Xavier Claessens <xavier.claessens@collabora.co.uk>
  23  */
  24
  25 #include "config.h"
  26
  27 #include <stdlib.h>
  28 #include <stdio.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_print ("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: %m");
 249           g_assert_not_reached ();
 250         }
 251
 252       switch (fork ())
 253         {
 254         case -1:
 255           g_warning ("fork() failed: %m");
 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  * <refsect2 id="gio-D-Bus-Test-Scaffolding">
 327  *   <title>Creating unit tests using GTestDBus</title>
 328  *   <para>
 329  *     Testing of D-Bus services can be tricky because normally we only ever run
 330  *     D-Bus services over an existing instance of the D-Bus daemon thus we
 331  *     usually don't activate D-Bus services that are not yet installed into the
 332  *     target system. The #GTestDBus object makes this easier for us by taking care
 333  *     of the lower level tasks such as running a private D-Bus daemon and looking
 334  *     up uninstalled services in customizable locations, typically in your source code tree.
 335  *   </para>
 336  *   <para>
 337  *     The first thing you will need is a separate service description file for the
 338  *     D-Bus daemon. Typically a 'services' subdirectory of your 'tests' directory
 339  *     is a good place to put this file.
 340  *   </para>
 341  *   <para>
 342  *     The service file should list your service along with an absolute path to the
 343  *     uninstalled service executable in your source tree. Using autotools we would
 344  *     achieve this by adding a file such as 'my-server.service.in' in the services
 345  *     directory and have it processed by configure.
 346  *     <informalexample><programlisting>
 347  *     [D-BUS Service]
 348  *     Name=org.gtk.GDBus.Examples.ObjectManager
 349  *     Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server
 350  *     </programlisting></informalexample>
 351  *     You will also need to indicate this service directory in your test
 352  *     fixtures, so you will need to pass the path while compiling your
 353  *     test cases. Typically this is done with autotools with an added
 354  *     preprocessor flag specified to compile your tests such as:
 355  *     <informalexample><programlisting>
 356  *     -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\"
 357  *     </programlisting></informalexample>
 358  *   </para>
 359  *   <para>
 360  *     Once you have a service definition file which is local to your source tree,
 361  *     you can proceed to setup a GTest fixture using the GTestDBus scaffolding.
 362  *     <example id="gdbus-test-fixture">
 363  *       <title>Test Fixture for D-Bus services</title>
 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  *     </example>
 370  *   </para>
 371  *   <para>
 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  *   </para>
 380  *   <para>
 381  *     Most of the time we can work around these obstacles using the environment. Since the
 382  *     environment is inherited by the D-Bus daemon created by GTestDBus and then in turn
 383  *     inherited by any services the D-Bus daemon activates, using the setup routine for your
 384  *     fixture is a practical place to help sandbox your runtime environment. For the rather
 385  *     typical GSettings case we can work around this by setting GSETTINGS_SCHEMA_DIR to the
 386  *     in tree directory holding your schemas in the above fixture_setup() routine.
 387  *   </para>
 388  *   <para>
 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  *     <informalexample><programlisting>
 393  *     all-am:
 394  *             $(GLIB_COMPILE_SCHEMAS) .
 395  *
 396  *     CLEANFILES += gschemas.compiled
 397  *     </programlisting></informalexample>
 398  *   </para>
 399  * </refsect2>
 400  */
 401
 402 typedef struct _GTestDBusClass   GTestDBusClass;
 403 typedef struct _GTestDBusPrivate GTestDBusPrivate;
 404
 405 /**
 406  * GTestDBus:
 407  *
 408  * The #GTestDBus structure contains only private data and
 409  * should only be accessed using the provided API.
 410  *
 411  * Since: 2.34
 412  */
 413 struct _GTestDBus {
 414   GObject parent;
 415
 416   GTestDBusPrivate *priv;
 417 };
 418
 419 struct _GTestDBusClass {
 420   GObjectClass parent_class;
 421 };
 422
 423 struct _GTestDBusPrivate
 424 {
 425   GTestDBusFlags flags;
 426   GPtrArray *service_dirs;
 427   GPid bus_pid;
 428   gchar *bus_address;
 429   gboolean up;
 430 };
 431
 432 enum
 433 {
 434   PROP_0,
 435   PROP_FLAGS,
 436 };
 437
 438 G_DEFINE_TYPE_WITH_PRIVATE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
 439
 440 static void
 441 g_test_dbus_init (GTestDBus *self)
 442 {
 443   self->priv = g_test_dbus_get_instance_private (self);
 444   self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
 445 }
 446
 447 static void
 448 g_test_dbus_dispose (GObject *object)
 449 {
 450   GTestDBus *self = (GTestDBus *) object;
 451
 452   if (self->priv->up)
 453     g_test_dbus_down (self);
 454
 455   G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
 456 }
 457
 458 static void
 459 g_test_dbus_finalize (GObject *object)
 460 {
 461   GTestDBus *self = (GTestDBus *) object;
 462
 463   g_ptr_array_unref (self->priv->service_dirs);
 464   g_free (self->priv->bus_address);
 465
 466   G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
 467 }
 468
 469 static void
 470 g_test_dbus_get_property (GObject *object,
 471     guint property_id,
 472     GValue *value,
 473     GParamSpec *pspec)
 474 {
 475   GTestDBus *self = (GTestDBus *) object;
 476
 477   switch (property_id)
 478     {
 479       case PROP_FLAGS:
 480         g_value_set_flags (value, g_test_dbus_get_flags (self));
 481         break;
 482       default:
 483         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 484         break;
 485     }
 486 }
 487
 488 static void
 489 g_test_dbus_set_property (GObject *object,
 490     guint property_id,
 491     const GValue *value,
 492     GParamSpec *pspec)
 493 {
 494   GTestDBus *self = (GTestDBus *) object;
 495
 496   switch (property_id)
 497     {
 498       case PROP_FLAGS:
 499         self->priv->flags = g_value_get_flags (value);
 500         break;
 501       default:
 502         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 503         break;
 504     }
 505 }
 506
 507 static void
 508 g_test_dbus_class_init (GTestDBusClass *klass)
 509 {
 510   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 511
 512   object_class->dispose = g_test_dbus_dispose;
 513   object_class->finalize = g_test_dbus_finalize;
 514   object_class->get_property = g_test_dbus_get_property;
 515   object_class->set_property = g_test_dbus_set_property;
 516
 517   /**
 518    * GTestDBus:flags:
 519    *
 520    * #GTestDBusFlags specifying the behaviour of the dbus session
 521    *
 522    * Since: 2.34
 523    */
 524   g_object_class_install_property (object_class, PROP_FLAGS,
 525     g_param_spec_flags ("flags",
 526                         P_("dbus session flags"),
 527                         P_("Flags specifying the behaviour of the dbus session"),
 528                         G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
 529                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 530                         G_PARAM_STATIC_STRINGS));
 531
 532 }
 533
 534 static gchar *
 535 write_config_file (GTestDBus *self)
 536 {
 537   GString *contents;
 538   gint fd;
 539   guint i;
 540   GError *error = NULL;
 541   gchar *path = NULL;
 542
 543   fd = g_file_open_tmp ("g-test-dbus-XXXXXX", &path, &error);
 544   g_assert_no_error (error);
 545
 546   contents = g_string_new (NULL);
 547   g_string_append (contents,
 548       "<busconfig>\n"
 549       "  <type>session</type>\n"
 550 #ifdef G_OS_WIN32
 551       "  <listen>nonce-tcp:</listen>\n"
 552 #else
 553       "  <listen>unix:tmpdir=/tmp</listen>\n"
 554 #endif
 555                    );
 556
 557   for (i = 0; i < self->priv->service_dirs->len; i++)
 558     {
 559       const gchar *dir_path = g_ptr_array_index (self->priv->service_dirs, i);
 560
 561       g_string_append_printf (contents,
 562           "  <servicedir>%s</servicedir>\n", dir_path);
 563     }
 564
 565   g_string_append (contents,
 566       "  <policy context=\"default\">\n"
 567       "    <!-- Allow everything to be sent -->\n"
 568       "    <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
 569       "    <!-- Allow everything to be received -->\n"
 570       "    <allow eavesdrop=\"true\"/>\n"
 571       "    <!-- Allow anyone to own anything -->\n"
 572       "    <allow own=\"*\"/>\n"
 573       "  </policy>\n"
 574       "</busconfig>\n");
 575
 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   close (fd);
 582
 583   return path;
 584 }
 585
 586 static void
 587 start_daemon (GTestDBus *self)
 588 {
 589   gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
 590   gchar *config_path;
 591   gchar *config_arg;
 592   gint stdout_fd;
 593   GIOChannel *channel;
 594   gsize termpos;
 595   GError *error = NULL;
 596
 597   if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL)
 598     argv[0] = (gchar *)g_getenv ("G_TEST_DBUS_DAEMON");
 599
 600   /* Write config file and set its path in argv */
 601   config_path = write_config_file (self);
 602   config_arg = g_strdup_printf ("--config-file=%s", config_path);
 603   argv[2] = config_arg;
 604
 605   /* Spawn dbus-daemon */
 606   g_spawn_async_with_pipes (NULL,
 607                             argv,
 608                             NULL,
 609 #ifdef G_OS_WIN32
 610                             /* We Need this to get the pid returned on win32 */
 611                             G_SPAWN_DO_NOT_REAP_CHILD |
 612 #endif
 613                             G_SPAWN_SEARCH_PATH,
 614                             NULL,
 615                             NULL,
 616                             &self->priv->bus_pid,
 617                             NULL,
 618                             &stdout_fd,
 619                             NULL,
 620                             &error);
 621   g_assert_no_error (error);
 622
 623   _g_test_watcher_add_pid (self->priv->bus_pid);
 624
 625   /* Read bus address from daemon' stdout */
 626   channel = g_io_channel_unix_new (stdout_fd);
 627   g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
 628       &termpos, &error);
 629   g_assert_no_error (error);
 630   self->priv->bus_address[termpos] = '\0';
 631
 632   /* start dbus-monitor */
 633   if (g_getenv ("G_DBUS_MONITOR") != NULL)
 634     {
 635       gchar *command;
 636
 637       command = g_strdup_printf ("dbus-monitor --address %s",
 638           self->priv->bus_address);
 639       g_spawn_command_line_async (command, NULL);
 640       g_free (command);
 641
 642       g_usleep (500 * 1000);
 643     }
 644
 645   /* Cleanup */
 646   g_io_channel_shutdown (channel, FALSE, &error);
 647   g_assert_no_error (error);
 648   g_io_channel_unref (channel);
 649
 650   /* Don't use g_file_delete since it calls into gvfs */
 651   if (g_unlink (config_path) != 0)
 652     g_assert_not_reached ();
 653
 654   g_free (config_path);
 655   g_free (config_arg);
 656 }
 657
 658 static void
 659 stop_daemon (GTestDBus *self)
 660 {
 661 #ifdef G_OS_WIN32
 662   if (!TerminateProcess (self->priv->bus_pid, 0))
 663     g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
 664 #else
 665   kill (self->priv->bus_pid, SIGTERM);
 666 #endif
 667   _g_test_watcher_remove_pid (self->priv->bus_pid);
 668   g_spawn_close_pid (self->priv->bus_pid);
 669   self->priv->bus_pid = 0;
 670
 671   g_free (self->priv->bus_address);
 672   self->priv->bus_address = NULL;
 673 }
 674
 675 /**
 676  * g_test_dbus_new:
 677  * @flags: a #GTestDBusFlags
 678  *
 679  * Create a new #GTestDBus object.
 680  *
 681  * Returns: (transfer full): a new #GTestDBus.
 682  */
 683 GTestDBus *
 684 g_test_dbus_new (GTestDBusFlags flags)
 685 {
 686   return g_object_new (G_TYPE_TEST_DBUS,
 687       "flags", flags,
 688       NULL);
 689 }
 690
 691 /**
 692  * g_test_dbus_get_flags:
 693  * @self: a #GTestDBus
 694  *
 695  * Gets the flags of the #GTestDBus object.
 696  *
 697  * Returns: the value of #GTestDBus:flags property
 698  */
 699 GTestDBusFlags
 700 g_test_dbus_get_flags (GTestDBus *self)
 701 {
 702   g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);
 703
 704   return self->priv->flags;
 705 }
 706
 707 /**
 708  * g_test_dbus_get_bus_address:
 709  * @self: a #GTestDBus
 710  *
 711  * Get the address on which dbus-daemon is running. if g_test_dbus_up() has not
 712  * been called yet, %NULL is returned. This can be used with
 713  * g_dbus_connection_new_for_address()
 714  *
 715  * Returns: the address of the bus, or %NULL.
 716  */
 717 const gchar *
 718 g_test_dbus_get_bus_address (GTestDBus *self)
 719 {
 720   g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);
 721
 722   return self->priv->bus_address;
 723 }
 724
 725 /**
 726  * g_test_dbus_add_service_dir:
 727  * @self: a #GTestDBus
 728  * @path: path to a directory containing .service files
 729  *
 730  * Add a path where dbus-daemon will lookup for .services files. This can't be
 731  * called after g_test_dbus_up().
 732  */
 733 void
 734 g_test_dbus_add_service_dir (GTestDBus *self,
 735     const gchar *path)
 736 {
 737   g_return_if_fail (G_IS_TEST_DBUS (self));
 738   g_return_if_fail (self->priv->bus_address == NULL);
 739
 740   g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
 741 }
 742
 743 /**
 744  * g_test_dbus_up:
 745  * @self: a #GTestDBus
 746  *
 747  * Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this
 748  * call, it is safe for unit tests to start sending messages on the session bus.
 749  *
 750  * If this function is called from setup callback of g_test_add(),
 751  * g_test_dbus_down() must be called in its teardown callback.
 752  *
 753  * If this function is called from unit test's main(), then g_test_dbus_down()
 754  * must be called after g_test_run().
 755  */
 756 void
 757 g_test_dbus_up (GTestDBus *self)
 758 {
 759   g_return_if_fail (G_IS_TEST_DBUS (self));
 760   g_return_if_fail (self->priv->bus_address == NULL);
 761   g_return_if_fail (!self->priv->up);
 762
 763   start_daemon (self);
 764
 765   g_test_dbus_unset ();
 766   g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
 767   self->priv->up = TRUE;
 768 }
 769
 770
 771 /**
 772  * g_test_dbus_stop:
 773  * @self: a #GTestDBus
 774  *
 775  * Stop the session bus started by g_test_dbus_up().
 776  *
 777  * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
 778  * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
 779  * tests wanting to verify behaviour after the session bus has been stopped
 780  * can use this function but should still call g_test_dbus_down() when done.
 781  */
 782 void
 783 g_test_dbus_stop (GTestDBus *self)
 784 {
 785   g_return_if_fail (G_IS_TEST_DBUS (self));
 786   g_return_if_fail (self->priv->bus_address != NULL);
 787
 788   stop_daemon (self);
 789 }
 790
 791 /**
 792  * g_test_dbus_down:
 793  * @self: a #GTestDBus
 794  *
 795  * Stop the session bus started by g_test_dbus_up().
 796  *
 797  * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
 798  * is destroyed. This is done to ensure that the next unit test won't get a
 799  * leaked singleton from this test.
 800  */
 801 void
 802 g_test_dbus_down (GTestDBus *self)
 803 {
 804   GDBusConnection *connection;
 805
 806   g_return_if_fail (G_IS_TEST_DBUS (self));
 807   g_return_if_fail (self->priv->up);
 808
 809   connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
 810   if (connection != NULL)
 811     g_dbus_connection_set_exit_on_close (connection, FALSE);
 812
 813   if (self->priv->bus_address != NULL)
 814     stop_daemon (self);
 815
 816   if (connection != NULL)
 817     _g_object_dispose_and_wait_weak_notify (connection);
 818
 819   g_test_dbus_unset ();
 820   self->priv->up = FALSE;
 821 }
 822
 823 /**
 824  * g_test_dbus_unset:
 825  *
 826  * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
 827  * won't use user's session bus.
 828  *
 829  * This is useful for unit tests that want to verify behaviour when no session
 830  * bus is running. It is not necessary to call this if unit test already calls
 831  * g_test_dbus_up() before acquiring the session bus.
 832  */
 833 void
 834 g_test_dbus_unset (void)
 835 {
 836   g_unsetenv ("DISPLAY");
 837   g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
 838   g_unsetenv ("DBUS_STARTER_ADDRESS");
 839   g_unsetenv ("DBUS_STARTER_BUS_TYPE");
 840 }