test/message: Add a targeted test for recently-fixed leaks

Signed-off-by: Simon McVittie <smcv@collabora.com>
Reviewed-by: Philip Withnall <withnall@endlessm.com>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101568

2 files changed, 246 insertions, 0 deletions

diff --git a/test/Makefile.am b/test/Makefile.am
index 869d4d85..ff2fcfe2 100644
--- a/test/Makefile.am
+++ b/test/Makefile.am
@@ -165,6 +165,7 @@ installable_tests += \
 	test-dbus-daemon \
 	test-dbus-daemon-eavesdrop \
 	test-fdpass \
+	test-message \
 	test-monitor \
 	test-loopback \
 	test-marshal \
@@ -330,6 +331,15 @@ test_marshal_LDADD = \
     $(GLIB_LIBS) \
     $(NULL)
 
+test_message_SOURCES = \
+    message.c \
+    $(NULL)
+test_message_LDADD = \
+    libdbus-testutils.la \
+    $(top_builddir)/dbus/libdbus-internal.la \
+    $(GLIB_LIBS) \
+    $(NULL)
+
 test_monitor_SOURCES = \
     monitor.c \
     $(NULL)
diff --git a/test/message.c b/test/message.c
new file mode 100644
index 00000000..3d959941
--- /dev/null
+++ b/test/message.c
@@ -0,0 +1,236 @@
+/* Targeted unit tests for OOM paths in DBusMessage
+ *
+ * Copyright © 2017 Collabora Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation files
+ * (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include <config.h>
+
+#include <string.h>
+
+#include <glib.h>
+
+#include <dbus/dbus.h>
+#include "dbus/dbus-internals.h"
+#include "dbus/dbus-pipe.h"
+#include "test-utils-glib.h"
+
+/* Return TRUE if the right thing happens, but the right thing might include
+ * OOM. */
+static dbus_bool_t
+test_array (void *contained_signature)
+{
+  DBusMessage *m;
+  DBusMessageIter iter;
+  DBusMessageIter arr_iter;
+  dbus_bool_t arr_iter_open = FALSE;
+  DBusMessageIter inner_iter;
+  dbus_bool_t inner_iter_open = FALSE;
+
+  m = dbus_message_new_signal ("/", "a.b", "c");
+
+  if (m == NULL)
+    goto out;
+
+  dbus_message_iter_init_append (m, &iter);
+
+  /* open_container only opens the container if it succeeds */
+  if (!dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
+                                         contained_signature,
+                                         &arr_iter))
+    goto out;
+
+  arr_iter_open = TRUE;
+
+  if (g_strcmp0 (contained_signature, "ai") == 0)
+    {
+      /* open_container only opens the container if it succeeds */
+      if (!dbus_message_iter_open_container (&arr_iter, DBUS_TYPE_ARRAY, "i",
+                                             &inner_iter))
+        goto out;
+
+      /* We do not set inner_iter_open to TRUE here because we would
+       * immediately set it to FALSE again */
+
+      /* close_container closes the container, even when it fails */
+      if (!dbus_message_iter_close_container (&arr_iter, &inner_iter))
+        goto out;
+    }
+  else if (g_strcmp0 (contained_signature, "{ss}") == 0)
+    {
+      const char *s = "hello";
+
+      /* open_container only opens the container if it succeeds */
+      if (!dbus_message_iter_open_container (&arr_iter, DBUS_TYPE_DICT_ENTRY,
+                                             NULL, &inner_iter))
+        goto out;
+
+      inner_iter_open = TRUE;
+
+      if (!dbus_message_iter_append_basic (&inner_iter, DBUS_TYPE_STRING, &s))
+        goto out;
+
+      if (!dbus_message_iter_append_basic (&inner_iter, DBUS_TYPE_STRING, &s))
+        goto out;
+
+      /* close_container closes the container, even when it fails */
+      inner_iter_open = FALSE;
+
+      if (!dbus_message_iter_close_container (&arr_iter, &inner_iter))
+        goto out;
+    }
+  else if (g_strcmp0 (contained_signature, "v") == 0)
+    {
+      dbus_bool_t yes = TRUE;
+
+      /* open_container only opens the container if it succeeds */
+      if (!dbus_message_iter_open_container (&arr_iter, DBUS_TYPE_VARIANT,
+                                             "b", &inner_iter))
+        goto out;
+
+      inner_iter_open = TRUE;
+
+      if (!dbus_message_iter_append_basic (&inner_iter, DBUS_TYPE_BOOLEAN,
+                                           &yes))
+        goto out;
+
+      /* close_container closes the container, even when it fails */
+      inner_iter_open = FALSE;
+
+      if (!dbus_message_iter_close_container (&arr_iter, &inner_iter))
+        goto out;
+    }
+  else
+    {
+      g_assert_not_reached ();
+    }
+
+  /* close_container closes the container, even when it fails */
+  arr_iter_open = FALSE;
+
+  if (!dbus_message_iter_close_container (&iter, &arr_iter))
+    goto out;
+
+out:
+  if (inner_iter_open)
+    dbus_message_iter_abandon_container (&arr_iter, &inner_iter);
+
+  if (arr_iter_open)
+    dbus_message_iter_abandon_container (&iter, &arr_iter);
+
+  if (m != NULL)
+    dbus_message_unref (m);
+
+  dbus_shutdown ();
+  g_assert_cmpint (_dbus_get_malloc_blocks_outstanding (), ==, 0);
+
+  return !g_test_failed ();
+}
+
+/* Return TRUE if the right thing happens, but the right thing might include
+ * OOM or inability to pass fds. */
+static dbus_bool_t
+test_fd (void *ignored)
+{
+  DBusMessage *m = NULL;
+  DBusPipe pipe;
+
+  _dbus_pipe_init_stdout (&pipe);
+
+  m = dbus_message_new_signal ("/", "a.b", "c");
+
+  if (m == NULL)
+    goto out;
+
+  if (!dbus_message_append_args (m,
+                                 DBUS_TYPE_UNIX_FD, &pipe.fd,
+                                 DBUS_TYPE_INVALID))
+    goto out;
+
+out:
+  if (m != NULL)
+    dbus_message_unref (m);
+
+  dbus_shutdown ();
+  g_assert_cmpint (_dbus_get_malloc_blocks_outstanding (), ==, 0);
+
+  return !g_test_failed ();
+}
+
+typedef struct
+{
+  const gchar *name;
+  DBusTestMemoryFunction function;
+  const void *data;
+} OOMTestCase;
+
+static void
+test_oom_wrapper (gconstpointer data)
+{
+  const OOMTestCase *test = data;
+
+  if (!_dbus_test_oom_handling (test->name, test->function,
+                                (void *) test->data))
+    {
+      g_test_message ("OOM test failed");
+      g_test_fail ();
+    }
+}
+
+static GQueue *test_cases_to_free = NULL;
+
+static void
+add_oom_test (const gchar *name,
+              DBusTestMemoryFunction function,
+              const void *data)
+{
+  /* By using GLib memory allocation here, we avoid being affected by
+   * dbus_shutdown() or contributing to
+   * _dbus_get_malloc_blocks_outstanding() */
+  OOMTestCase *test_case = g_new0 (OOMTestCase, 1);
+
+  test_case->name = name;
+  test_case->function = function;
+  test_case->data = data;
+  g_test_add_data_func (name, test_case, test_oom_wrapper);
+  g_queue_push_tail (test_cases_to_free, test_case);
+}
+
+int
+main (int argc,
+      char **argv)
+{
+  int ret;
+
+  test_init (&argc, &argv);
+
+  test_cases_to_free = g_queue_new ();
+  add_oom_test ("/message/array/array", test_array, "ai");
+  add_oom_test ("/message/array/dict", test_array, "{ss}");
+  add_oom_test ("/message/array/variant", test_array, "v");
+  add_oom_test ("/message/fd", test_fd, NULL);
+
+  ret = g_test_run ();
+
+  g_queue_free_full (test_cases_to_free, g_free);
+  return ret;
+}