gtestdbus.c 22.5 KB
Newer Older
Xavier Claessens's avatar
Xavier Claessens committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* GIO testing utilities
 *
 * Copyright (C) 2008-2010 Red Hat, Inc.
 * Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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/>.
Xavier Claessens's avatar
Xavier Claessens committed
18 19 20 21 22 23 24 25 26
 *
 * Authors: David Zeuthen <davidz@redhat.com>
 *          Xavier Claessens <xavier.claessens@collabora.co.uk>
 */

#include "config.h"

#include <stdlib.h>
#include <stdio.h>
27 28
#include <errno.h>
#include <string.h>
29
#include <gstdio.h>
30
#ifdef G_OS_UNIX
Xavier Claessens's avatar
Xavier Claessens committed
31
#include <unistd.h>
32
#endif
Chun-wei Fan's avatar
Chun-wei Fan committed
33 34 35
#ifdef G_OS_WIN32
#include <io.h>
#endif
Xavier Claessens's avatar
Xavier Claessens committed
36 37 38 39 40 41 42 43 44 45 46

#include <glib.h>

#include "gdbusconnection.h"
#include "gdbusprivate.h"
#include "gfile.h"
#include "gioenumtypes.h"
#include "gtestdbus.h"

#include "glibintl.h"

47 48 49 50
#ifdef G_OS_WIN32
#include <windows.h>
#endif

Xavier Claessens's avatar
Xavier Claessens committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/* -------------------------------------------------------------------------- */
/* Utility: Wait until object has a single ref  */

typedef struct
{
  GMainLoop *loop;
  gboolean   timed_out;
} WeakNotifyData;

static gboolean
on_weak_notify_timeout (gpointer user_data)
{
  WeakNotifyData *data = user_data;
  data->timed_out = TRUE;
  g_main_loop_quit (data->loop);
  return FALSE;
}

static gboolean
70
dispose_on_idle (gpointer object)
Xavier Claessens's avatar
Xavier Claessens committed
71
{
72
  g_object_run_dispose (object);
Xavier Claessens's avatar
Xavier Claessens committed
73 74 75 76
  g_object_unref (object);
  return FALSE;
}

77
static gboolean
78
_g_object_dispose_and_wait_weak_notify (gpointer object)
Xavier Claessens's avatar
Xavier Claessens committed
79 80 81 82 83 84 85 86 87 88 89
{
  WeakNotifyData data;
  guint timeout_id;

  data.loop = g_main_loop_new (NULL, FALSE);
  data.timed_out = FALSE;

  g_object_weak_ref (object, (GWeakNotify) g_main_loop_quit, data.loop);

  /* Drop the ref in an idle callback, this is to make sure the mainloop
   * is already running when weak notify happens */
90
  g_idle_add (dispose_on_idle, object);
Xavier Claessens's avatar
Xavier Claessens committed
91 92 93 94 95 96 97 98 99 100 101

  /* Make sure we don't block forever */
  timeout_id = g_timeout_add (30 * 1000, on_weak_notify_timeout, &data);

  g_main_loop_run (data.loop);

  if (data.timed_out)
    {
      g_warning ("Weak notify timeout, object ref_count=%d\n",
          G_OBJECT (object)->ref_count);
    }
102 103 104 105
  else
    {
      g_source_remove (timeout_id);
    }
Xavier Claessens's avatar
Xavier Claessens committed
106

107
  g_main_loop_unref (data.loop);
Xavier Claessens's avatar
Xavier Claessens committed
108 109 110 111 112 113
  return data.timed_out;
}

/* -------------------------------------------------------------------------- */
/* Utilities to cleanup the mess in the case unit test process crash */

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
#ifdef G_OS_WIN32

/* This could be interesting to expose in public API */
static void
_g_test_watcher_add_pid (GPid pid)
{
  static gsize started = 0;
  HANDLE job;

  if (g_once_init_enter (&started))
    {
      JOBOBJECT_EXTENDED_LIMIT_INFORMATION info;

      job = CreateJobObjectW (NULL, NULL);
      memset (&info, 0, sizeof (info));
      info.BasicLimitInformation.LimitFlags = 0x2000 /* JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE */;

      if (!SetInformationJobObject(job, JobObjectExtendedLimitInformation, &info, sizeof (info)))
	g_warning ("Can't enable JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE: %s", g_win32_error_message (GetLastError()));

      g_once_init_leave (&started,(gsize)job);
    }

  job = (HANDLE)started;

  if (!AssignProcessToJobObject(job, pid))
    g_warning ("Can't assign process to job: %s", g_win32_error_message (GetLastError()));
}

static void
_g_test_watcher_remove_pid (GPid pid)
{
  /* No need to unassign the process from the job object as the process
     will be killed anyway */
}

#else

Xavier Claessens's avatar
Xavier Claessens committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
#define ADD_PID_FORMAT "add pid %d\n"
#define REMOVE_PID_FORMAT "remove pid %d\n"

static void
watch_parent (gint fd)
{
  GIOChannel *channel;
  GPollFD fds[1];
  GArray *pids_to_kill;

  channel = g_io_channel_unix_new (fd);

  fds[0].fd = fd;
  fds[0].events = G_IO_HUP | G_IO_IN;
  fds[0].revents = 0;

  pids_to_kill = g_array_new (FALSE, FALSE, sizeof (guint));

  do
    {
      gint num_events;
      gchar *command = NULL;
      guint pid;
      guint n;
      GError *error = NULL;

      num_events = g_poll (fds, 1, -1);
      if (num_events == 0)
        continue;

      if (fds[0].revents == G_IO_HUP)
        {
          /* Parent quit, cleanup the mess and exit */
          for (n = 0; n < pids_to_kill->len; n++)
            {
              pid = g_array_index (pids_to_kill, guint, n);
188
              g_printerr ("cleaning up pid %d\n", pid);
Xavier Claessens's avatar
Xavier Claessens committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
              kill (pid, SIGTERM);
            }

          g_array_unref (pids_to_kill);
          g_io_channel_shutdown (channel, FALSE, &error);
          g_assert_no_error (error);
          g_io_channel_unref (channel);

          exit (0);
        }

      /* Read the command from the input */
      g_io_channel_read_line (channel, &command, NULL, NULL, &error);
      g_assert_no_error (error);

      /* Check for known commands */
      if (sscanf (command, ADD_PID_FORMAT, &pid) == 1)
        {
          g_array_append_val (pids_to_kill, pid);
        }
      else if (sscanf (command, REMOVE_PID_FORMAT, &pid) == 1)
        {
          for (n = 0; n < pids_to_kill->len; n++)
            {
              if (g_array_index (pids_to_kill, guint, n) == pid)
                {
                  g_array_remove_index (pids_to_kill, n);
                  pid = 0;
                  break;
                }
            }
          if (pid != 0)
            {
              g_warning ("unknown pid %d to remove", pid);
            }
        }
      else
        {
          g_warning ("unknown command from parent '%s'", command);
        }

      g_free (command);
    }
  while (TRUE);
}

static GIOChannel *
watcher_init (void)
{
  static gsize started = 0;
  static GIOChannel *channel = NULL;

  if (g_once_init_enter (&started))
    {
      gint pipe_fds[2];

      /* fork a child to clean up when we are killed */
      if (pipe (pipe_fds) != 0)
        {
248
          g_warning ("pipe() failed: %s", strerror (errno));
Xavier Claessens's avatar
Xavier Claessens committed
249 250 251 252 253 254
          g_assert_not_reached ();
        }

      switch (fork ())
        {
        case -1:
255
          g_warning ("fork() failed: %s", strerror (errno));
Xavier Claessens's avatar
Xavier Claessens committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
          g_assert_not_reached ();
          break;

        case 0:
          /* child */
          close (pipe_fds[1]);
          watch_parent (pipe_fds[0]);
          break;

        default:
          /* parent */
          close (pipe_fds[0]);
          channel = g_io_channel_unix_new (pipe_fds[1]);
        }

      g_once_init_leave (&started, 1);
    }

  return channel;
}

static void
watcher_send_command (const gchar *command)
{
  GIOChannel *channel;
  GError *error = NULL;

  channel = watcher_init ();

  g_io_channel_write_chars (channel, command, -1, NULL, &error);
  g_assert_no_error (error);

  g_io_channel_flush (channel, &error);
  g_assert_no_error (error);
}

/* This could be interesting to expose in public API */
static void
_g_test_watcher_add_pid (GPid pid)
{
  gchar *command;

  command = g_strdup_printf (ADD_PID_FORMAT, (guint) pid);
  watcher_send_command (command);
  g_free (command);
}

static void
_g_test_watcher_remove_pid (GPid pid)
{
  gchar *command;

  command = g_strdup_printf (REMOVE_PID_FORMAT, (guint) pid);
  watcher_send_command (command);
  g_free (command);
}

313 314
#endif

Xavier Claessens's avatar
Xavier Claessens committed
315 316 317 318 319 320 321 322
/* -------------------------------------------------------------------------- */
/* GTestDBus object implementation */

/**
 * SECTION:gtestdbus
 * @short_description: D-Bus testing helper
 * @include: gio/gio.h
 *
323 324
 * A helper class for testing code which uses D-Bus without touching the user's
 * session bus.
325
 *
326 327
 * Note that #GTestDBus modifies the user’s environment, calling setenv().
 * This is not thread-safe, so all #GTestDBus calls should be completed before
328 329 330 331
 * threads are spawned, or should have appropriate locking to ensure no access
 * conflicts to environment variables shared between #GTestDBus and other
 * threads.
 *
332 333 334 335 336 337 338 339 340 341 342
 * ## Creating unit tests using GTestDBus
 * 
 * Testing of D-Bus services can be tricky because normally we only ever run
 * D-Bus services over an existing instance of the D-Bus daemon thus we
 * usually don't activate D-Bus services that are not yet installed into the
 * target system. The #GTestDBus object makes this easier for us by taking care
 * of the lower level tasks such as running a private D-Bus daemon and looking
 * up uninstalled services in customizable locations, typically in your source
 * code tree.
 *
 * The first thing you will need is a separate service description file for the
343 344
 * D-Bus daemon. Typically a `services` subdirectory of your `tests` directory
 * is a good place to put this file.
345 346 347
 *
 * The service file should list your service along with an absolute path to the
 * uninstalled service executable in your source tree. Using autotools we would
348 349
 * achieve this by adding a file such as `my-server.service.in` in the services
 * directory and have it processed by configure.
350
 * |[
351 352 353
 *     [D-BUS Service]
 *     Name=org.gtk.GDBus.Examples.ObjectManager
 *     Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server
354 355 356 357 358 359
 * ]|
 * You will also need to indicate this service directory in your test
 * fixtures, so you will need to pass the path while compiling your
 * test cases. Typically this is done with autotools with an added
 * preprocessor flag specified to compile your tests such as:
 * |[
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 364
 * you can proceed to set up a GTest fixture using the #GTestDBus scaffolding.
 *
365
 * An example of a test fixture for D-Bus services can be found
366 367
 * here:
 * [gdbus-test-fixture.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-test-fixture.c)
368
 *
369 370 371 372 373 374 375 376
 * Note that these examples only deal with isolating the D-Bus aspect of your
 * service. To successfully run isolated unit tests on your service you may need
 * some additional modifications to your test case fixture. For example; if your
 * service uses GSettings and installs a schema then it is important that your test service
 * not load the schema in the ordinary installed location (chances are that your service
 * and schema files are not yet installed, or worse; there is an older version of the
 * schema file sitting in the install location).
 *
377 378 379 380 381 382 383 384
 * Most of the time we can work around these obstacles using the
 * environment. Since the environment is inherited by the D-Bus daemon
 * created by #GTestDBus and then in turn inherited by any services the
 * D-Bus daemon activates, using the setup routine for your fixture is
 * a practical place to help sandbox your runtime environment. For the
 * rather typical GSettings case we can work around this by setting
 * `GSETTINGS_SCHEMA_DIR` to the in tree directory holding your schemas
 * in the above fixture_setup() routine.
385 386 387 388 389
 *
 * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
 * by compiling the schemas locally as a step before running test cases, an autotools setup might
 * do the following in the directory holding schemas:
 * |[
390 391 392 393
 *     all-am:
 *             $(GLIB_COMPILE_SCHEMAS) .
 *
 *     CLEANFILES += gschemas.compiled
394
 * ]|
Xavier Claessens's avatar
Xavier Claessens committed
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
 */

typedef struct _GTestDBusClass   GTestDBusClass;
typedef struct _GTestDBusPrivate GTestDBusPrivate;

/**
 * GTestDBus:
 *
 * The #GTestDBus structure contains only private data and
 * should only be accessed using the provided API.
 *
 * Since: 2.34
 */
struct _GTestDBus {
  GObject parent;

  GTestDBusPrivate *priv;
};

struct _GTestDBusClass {
  GObjectClass parent_class;
};

struct _GTestDBusPrivate
{
  GTestDBusFlags flags;
  GPtrArray *service_dirs;
  GPid bus_pid;
423
  gint bus_stdout_fd;
Xavier Claessens's avatar
Xavier Claessens committed
424 425 426 427 428 429 430 431 432 433
  gchar *bus_address;
  gboolean up;
};

enum
{
  PROP_0,
  PROP_FLAGS,
};

434
G_DEFINE_TYPE_WITH_PRIVATE (GTestDBus, g_test_dbus, G_TYPE_OBJECT)
Xavier Claessens's avatar
Xavier Claessens committed
435 436 437 438

static void
g_test_dbus_init (GTestDBus *self)
{
439
  self->priv = g_test_dbus_get_instance_private (self);
Xavier Claessens's avatar
Xavier Claessens committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
  self->priv->service_dirs = g_ptr_array_new_with_free_func (g_free);
}

static void
g_test_dbus_dispose (GObject *object)
{
  GTestDBus *self = (GTestDBus *) object;

  if (self->priv->up)
    g_test_dbus_down (self);

  G_OBJECT_CLASS (g_test_dbus_parent_class)->dispose (object);
}

static void
g_test_dbus_finalize (GObject *object)
{
  GTestDBus *self = (GTestDBus *) object;

  g_ptr_array_unref (self->priv->service_dirs);
  g_free (self->priv->bus_address);

  G_OBJECT_CLASS (g_test_dbus_parent_class)->finalize (object);
}

static void
g_test_dbus_get_property (GObject *object,
    guint property_id,
    GValue *value,
    GParamSpec *pspec)
{
  GTestDBus *self = (GTestDBus *) object;

  switch (property_id)
    {
      case PROP_FLAGS:
        g_value_set_flags (value, g_test_dbus_get_flags (self));
        break;
      default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
        break;
    }
}

static void
g_test_dbus_set_property (GObject *object,
    guint property_id,
    const GValue *value,
    GParamSpec *pspec)
{
  GTestDBus *self = (GTestDBus *) object;

  switch (property_id)
    {
      case PROP_FLAGS:
        self->priv->flags = g_value_get_flags (value);
        break;
      default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
        break;
    }
}

static void
g_test_dbus_class_init (GTestDBusClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->dispose = g_test_dbus_dispose;
  object_class->finalize = g_test_dbus_finalize;
  object_class->get_property = g_test_dbus_get_property;
  object_class->set_property = g_test_dbus_set_property;

  /**
   * GTestDBus:flags:
   *
516
   * #GTestDBusFlags specifying the behaviour of the D-Bus session.
Xavier Claessens's avatar
Xavier Claessens committed
517 518 519 520 521
   *
   * Since: 2.34
   */
  g_object_class_install_property (object_class, PROP_FLAGS,
    g_param_spec_flags ("flags",
522 523
                        P_("D-Bus session flags"),
                        P_("Flags specifying the behaviour of the D-Bus session"),
Xavier Claessens's avatar
Xavier Claessens committed
524 525 526 527 528 529
                        G_TYPE_TEST_DBUS_FLAGS, G_TEST_DBUS_NONE,
                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                        G_PARAM_STATIC_STRINGS));

}

530
static gchar *
Xavier Claessens's avatar
Xavier Claessens committed
531 532 533
write_config_file (GTestDBus *self)
{
  GString *contents;
534
  gint fd;
Xavier Claessens's avatar
Xavier Claessens committed
535 536
  guint i;
  GError *error = NULL;
537
  gchar *path = NULL;
Xavier Claessens's avatar
Xavier Claessens committed
538

539
  fd = g_file_open_tmp ("g-test-dbus-XXXXXX", &path, &error);
Xavier Claessens's avatar
Xavier Claessens committed
540 541 542 543 544 545
  g_assert_no_error (error);

  contents = g_string_new (NULL);
  g_string_append (contents,
      "<busconfig>\n"
      "  <type>session</type>\n"
546 547 548 549 550 551
#ifdef G_OS_WIN32
      "  <listen>nonce-tcp:</listen>\n"
#else
      "  <listen>unix:tmpdir=/tmp</listen>\n"
#endif
		   );
Xavier Claessens's avatar
Xavier Claessens committed
552 553 554

  for (i = 0; i < self->priv->service_dirs->len; i++)
    {
555
      const gchar *dir_path = g_ptr_array_index (self->priv->service_dirs, i);
Xavier Claessens's avatar
Xavier Claessens committed
556 557

      g_string_append_printf (contents,
558
          "  <servicedir>%s</servicedir>\n", dir_path);
Xavier Claessens's avatar
Xavier Claessens committed
559 560 561 562 563 564 565 566 567 568 569 570 571
    }

  g_string_append (contents,
      "  <policy context=\"default\">\n"
      "    <!-- Allow everything to be sent -->\n"
      "    <allow send_destination=\"*\" eavesdrop=\"true\"/>\n"
      "    <!-- Allow everything to be received -->\n"
      "    <allow eavesdrop=\"true\"/>\n"
      "    <!-- Allow anyone to own anything -->\n"
      "    <allow own=\"*\"/>\n"
      "  </policy>\n"
      "</busconfig>\n");

572
  close (fd);
573
  g_file_set_contents (path, contents->str, contents->len, &error);
Xavier Claessens's avatar
Xavier Claessens committed
574 575 576 577
  g_assert_no_error (error);

  g_string_free (contents, TRUE);

578
  return path;
Xavier Claessens's avatar
Xavier Claessens committed
579 580 581 582 583
}

static void
start_daemon (GTestDBus *self)
{
584
  const gchar *argv[] = {"dbus-daemon", "--print-address", "--config-file=foo", NULL};
Xavier Claessens's avatar
Xavier Claessens committed
585 586 587
  gchar *config_path;
  gchar *config_arg;
  GIOChannel *channel;
588
  gint stdout_fd2;
Xavier Claessens's avatar
Xavier Claessens committed
589 590 591
  gsize termpos;
  GError *error = NULL;

592
  if (g_getenv ("G_TEST_DBUS_DAEMON") != NULL)
Dan Winship's avatar
Dan Winship committed
593
    argv[0] = (gchar *)g_getenv ("G_TEST_DBUS_DAEMON");
594

Xavier Claessens's avatar
Xavier Claessens committed
595
  /* Write config file and set its path in argv */
596
  config_path = write_config_file (self);
Xavier Claessens's avatar
Xavier Claessens committed
597 598 599 600 601
  config_arg = g_strdup_printf ("--config-file=%s", config_path);
  argv[2] = config_arg;

  /* Spawn dbus-daemon */
  g_spawn_async_with_pipes (NULL,
602
                            (gchar **) argv,
Xavier Claessens's avatar
Xavier Claessens committed
603
                            NULL,
604
#ifdef G_OS_WIN32
Matthias Clasen's avatar
Matthias Clasen committed
605 606
                            /* We Need this to get the pid returned on win32 */
                            G_SPAWN_DO_NOT_REAP_CHILD |
607
#endif
Matthias Clasen's avatar
Matthias Clasen committed
608
                            G_SPAWN_SEARCH_PATH,
Xavier Claessens's avatar
Xavier Claessens committed
609 610 611 612
                            NULL,
                            NULL,
                            &self->priv->bus_pid,
                            NULL,
613
                            &self->priv->bus_stdout_fd,
Xavier Claessens's avatar
Xavier Claessens committed
614 615 616 617 618 619
                            NULL,
                            &error);
  g_assert_no_error (error);

  _g_test_watcher_add_pid (self->priv->bus_pid);

620 621 622 623 624 625 626 627
  /* Read bus address from daemon' stdout. We have to be careful to avoid
   * closing the FD, as it is passed to any D-Bus service activated processes,
   * and if we close it, they will get a SIGPIPE and die when they try to write
   * to their stdout. */
  stdout_fd2 = dup (self->priv->bus_stdout_fd);
  g_assert_cmpint (stdout_fd2, >=, 0);
  channel = g_io_channel_unix_new (stdout_fd2);

Xavier Claessens's avatar
Xavier Claessens committed
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
  g_io_channel_read_line (channel, &self->priv->bus_address, NULL,
      &termpos, &error);
  g_assert_no_error (error);
  self->priv->bus_address[termpos] = '\0';

  /* start dbus-monitor */
  if (g_getenv ("G_DBUS_MONITOR") != NULL)
    {
      gchar *command;

      command = g_strdup_printf ("dbus-monitor --address %s",
          self->priv->bus_address);
      g_spawn_command_line_async (command, NULL);
      g_free (command);

643
      g_usleep (500 * 1000);
Xavier Claessens's avatar
Xavier Claessens committed
644 645 646 647 648 649 650
    }

  /* Cleanup */
  g_io_channel_shutdown (channel, FALSE, &error);
  g_assert_no_error (error);
  g_io_channel_unref (channel);

651 652 653
  /* Don't use g_file_delete since it calls into gvfs */
  if (g_unlink (config_path) != 0)
    g_assert_not_reached ();
Xavier Claessens's avatar
Xavier Claessens committed
654 655 656 657 658 659 660 661

  g_free (config_path);
  g_free (config_arg);
}

static void
stop_daemon (GTestDBus *self)
{
662 663 664 665
#ifdef G_OS_WIN32
  if (!TerminateProcess (self->priv->bus_pid, 0))
    g_warning ("Can't terminate process: %s", g_win32_error_message (GetLastError()));
#else
Xavier Claessens's avatar
Xavier Claessens committed
666
  kill (self->priv->bus_pid, SIGTERM);
667
#endif
Xavier Claessens's avatar
Xavier Claessens committed
668
  _g_test_watcher_remove_pid (self->priv->bus_pid);
669
  g_spawn_close_pid (self->priv->bus_pid);
Xavier Claessens's avatar
Xavier Claessens committed
670
  self->priv->bus_pid = 0;
671 672
  close (self->priv->bus_stdout_fd);
  self->priv->bus_stdout_fd = -1;
Xavier Claessens's avatar
Xavier Claessens committed
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697

  g_free (self->priv->bus_address);
  self->priv->bus_address = NULL;
}

/**
 * g_test_dbus_new:
 * @flags: a #GTestDBusFlags
 *
 * Create a new #GTestDBus object.
 *
 * Returns: (transfer full): a new #GTestDBus.
 */
GTestDBus *
g_test_dbus_new (GTestDBusFlags flags)
{
  return g_object_new (G_TYPE_TEST_DBUS,
      "flags", flags,
      NULL);
}

/**
 * g_test_dbus_get_flags:
 * @self: a #GTestDBus
 *
698
 * Get the flags of the #GTestDBus object.
699
 *
Xavier Claessens's avatar
Xavier Claessens committed
700 701 702 703 704 705 706 707 708 709 710 711 712 713
 * Returns: the value of #GTestDBus:flags property
 */
GTestDBusFlags
g_test_dbus_get_flags (GTestDBus *self)
{
  g_return_val_if_fail (G_IS_TEST_DBUS (self), G_TEST_DBUS_NONE);

  return self->priv->flags;
}

/**
 * g_test_dbus_get_bus_address:
 * @self: a #GTestDBus
 *
714
 * Get the address on which dbus-daemon is running. If g_test_dbus_up() has not
Xavier Claessens's avatar
Xavier Claessens committed
715
 * been called yet, %NULL is returned. This can be used with
716
 * g_dbus_connection_new_for_address().
Xavier Claessens's avatar
Xavier Claessens committed
717
 *
718
 * Returns: (allow-none): the address of the bus, or %NULL.
Xavier Claessens's avatar
Xavier Claessens committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732
 */
const gchar *
g_test_dbus_get_bus_address (GTestDBus *self)
{
  g_return_val_if_fail (G_IS_TEST_DBUS (self), NULL);

  return self->priv->bus_address;
}

/**
 * g_test_dbus_add_service_dir:
 * @self: a #GTestDBus
 * @path: path to a directory containing .service files
 *
733
 * Add a path where dbus-daemon will look up .service files. This can't be
Xavier Claessens's avatar
Xavier Claessens committed
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
 * called after g_test_dbus_up().
 */
void
g_test_dbus_add_service_dir (GTestDBus *self,
    const gchar *path)
{
  g_return_if_fail (G_IS_TEST_DBUS (self));
  g_return_if_fail (self->priv->bus_address == NULL);

  g_ptr_array_add (self->priv->service_dirs, g_strdup (path));
}

/**
 * g_test_dbus_up:
 * @self: a #GTestDBus
 *
 * 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.
Xavier Claessens's avatar
Xavier Claessens committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
 *
 * If this function is called from setup callback of g_test_add(),
 * g_test_dbus_down() must be called in its teardown callback.
 *
 * If this function is called from unit test's main(), then g_test_dbus_down()
 * must be called after g_test_run().
 */
void
g_test_dbus_up (GTestDBus *self)
{
  g_return_if_fail (G_IS_TEST_DBUS (self));
  g_return_if_fail (self->priv->bus_address == NULL);
  g_return_if_fail (!self->priv->up);

  start_daemon (self);

768
  g_test_dbus_unset ();
Xavier Claessens's avatar
Xavier Claessens committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
  g_setenv ("DBUS_SESSION_BUS_ADDRESS", self->priv->bus_address, TRUE);
  self->priv->up = TRUE;
}


/**
 * g_test_dbus_stop:
 * @self: a #GTestDBus
 *
 * Stop the session bus started by g_test_dbus_up().
 *
 * Unlike g_test_dbus_down(), this won't verify the #GDBusConnection
 * singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit
 * tests wanting to verify behaviour after the session bus has been stopped
 * can use this function but should still call g_test_dbus_down() when done.
 */
void
g_test_dbus_stop (GTestDBus *self)
{
  g_return_if_fail (G_IS_TEST_DBUS (self));
  g_return_if_fail (self->priv->bus_address != NULL);

  stop_daemon (self);
}

/**
 * g_test_dbus_down:
 * @self: a #GTestDBus
 *
 * Stop the session bus started by g_test_dbus_up().
 *
 * This will wait for the singleton returned by g_bus_get() or g_bus_get_sync()
 * is destroyed. This is done to ensure that the next unit test won't get a
 * leaked singleton from this test.
 */
void
g_test_dbus_down (GTestDBus *self)
{
  GDBusConnection *connection;

  g_return_if_fail (G_IS_TEST_DBUS (self));
  g_return_if_fail (self->priv->up);

  connection = _g_bus_get_singleton_if_exists (G_BUS_TYPE_SESSION);
  if (connection != NULL)
    g_dbus_connection_set_exit_on_close (connection, FALSE);

  if (self->priv->bus_address != NULL)
    stop_daemon (self);

  if (connection != NULL)
820
    _g_object_dispose_and_wait_weak_notify (connection);
Xavier Claessens's avatar
Xavier Claessens committed
821

822
  g_test_dbus_unset ();
Xavier Claessens's avatar
Xavier Claessens committed
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
  self->priv->up = FALSE;
}

/**
 * g_test_dbus_unset:
 *
 * Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test
 * won't use user's session bus.
 *
 * This is useful for unit tests that want to verify behaviour when no session
 * bus is running. It is not necessary to call this if unit test already calls
 * g_test_dbus_up() before acquiring the session bus.
 */
void
g_test_dbus_unset (void)
{
  g_unsetenv ("DISPLAY");
  g_unsetenv ("DBUS_SESSION_BUS_ADDRESS");
841 842
  g_unsetenv ("DBUS_STARTER_ADDRESS");
  g_unsetenv ("DBUS_STARTER_BUS_TYPE");
843 844
  /* avoid using XDG_RUNTIME_DIR/bus */
  g_unsetenv ("XDG_RUNTIME_DIR");
Xavier Claessens's avatar
Xavier Claessens committed
845
}