From 7b4f77787d3980f74b063e2e213f3fa41b2b729f Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Tue, 21 Nov 2017 13:36:10 +0000 Subject: [PATCH 10/12] Add a targeted test for OOM during _dbus_server_new_for_tcp_socket() This also covers _dbus_server_new_for_socket(), which is one of the worse places in terms of complexity of the error-unwinding path (3 labels). Signed-off-by: Simon McVittie --- cmake/test/CMakeLists.txt | 1 + test/Makefile.am | 4 ++ test/internals/server-oom.c | 149 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 154 insertions(+) create mode 100644 test/internals/server-oom.c diff --git a/cmake/test/CMakeLists.txt b/cmake/test/CMakeLists.txt index 5b190b72..3b22ea1d 100644 --- a/cmake/test/CMakeLists.txt +++ b/cmake/test/CMakeLists.txt @@ -107,6 +107,7 @@ if(DBUS_WITH_GLIB) add_test_executable(test-monitor ${CMAKE_SOURCE_DIR}/../test/monitor.c ${TEST_LIBRARIES}) add_test_executable(test-refs ${CMAKE_SOURCE_DIR}/../test/internals/refs.c ${TEST_LIBRARIES}) add_test_executable(test-relay ${CMAKE_SOURCE_DIR}/../test/relay.c ${TEST_LIBRARIES}) + add_test_executable(test-server-oom ${CMAKE_SOURCE_DIR}/../test/internals/server-oom.c ${TEST_LIBRARIES}) add_test_executable(test-syntax ${CMAKE_SOURCE_DIR}/../test/syntax.c ${TEST_LIBRARIES}) add_test_executable(test-syslog ${CMAKE_SOURCE_DIR}/../test/internals/syslog.c ${TEST_LIBRARIES}) add_test_executable(test-uid-permissions ${CMAKE_SOURCE_DIR}/../test/uid-permissions.c ${TEST_LIBRARIES}) diff --git a/test/Makefile.am b/test/Makefile.am index a748b10a..57342034 100644 --- a/test/Makefile.am +++ b/test/Makefile.am @@ -105,6 +105,9 @@ test_printf_LDADD = $(top_builddir)/dbus/libdbus-internal.la test_refs_SOURCES = internals/refs.c test_refs_LDADD = libdbus-testutils.la $(GLIB_LIBS) +test_server_oom_SOURCES = internals/server-oom.c +test_server_oom_LDADD = libdbus-testutils.la $(GLIB_LIBS) + test_syslog_SOURCES = internals/syslog.c test_syslog_LDADD = libdbus-testutils.la $(GLIB_LIBS) @@ -164,6 +167,7 @@ installable_tests += \ test-marshal \ test-refs \ test-relay \ + test-server-oom \ test-syntax \ test-syslog \ test-uid-permissions \ diff --git a/test/internals/server-oom.c b/test/internals/server-oom.c new file mode 100644 index 00000000..f3f48964 --- /dev/null +++ b/test/internals/server-oom.c @@ -0,0 +1,149 @@ +/* Targeted unit tests for OOM paths in DBusServer + * + * 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 + +#include + +#include + +#include +#include "dbus/dbus-internals.h" +#include "dbus/dbus-pipe.h" +#include "dbus/dbus-server-socket.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_new_tcp (void *user_data, + dbus_bool_t have_memory) +{ + DBusError error = DBUS_ERROR_INIT; + DBusServer *server = NULL; + dbus_bool_t use_nonce = FALSE; + const char *bind = "localhost"; + const char *family = NULL; + dbus_bool_t result = FALSE; + + if (user_data != NULL) + { + if (strcmp (user_data, "nonce") == 0) + use_nonce = TRUE; + + if (strcmp (user_data, "star") == 0) + bind = "*"; + + if (strcmp (user_data, "v4") == 0) + family = "ipv4"; + } + + server = _dbus_server_new_for_tcp_socket ("localhost", bind, + "0", family, &error, + use_nonce); + + if (server == NULL) + goto out; + + result = TRUE; + +out: + if (have_memory || result) + { + test_assert_no_error (&error); + } + else + { + g_assert_cmpstr (error.name, ==, DBUS_ERROR_NO_MEMORY); + result = TRUE; + } + + if (server != NULL) + dbus_server_disconnect (server); + + dbus_clear_server (&server); + dbus_error_free (&error); + + return result; +} + +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 ("/server/new-tcp", test_new_tcp, NULL); + add_oom_test ("/server/new-nonce-tcp", test_new_tcp, "nonce"); + add_oom_test ("/server/new-tcp-star", test_new_tcp, "star"); + add_oom_test ("/server/new-tcp-v4", test_new_tcp, "v4"); + + ret = g_test_run (); + + g_queue_free_full (test_cases_to_free, g_free); + return ret; +} -- 2.15.0