/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
#include "test-utils.h"
#include <glib/gprintf.h>
#include <locale.h>
#include <signal.h>
#ifdef HAVE_APACHE
static gboolean apache_running;
#endif
static SoupLogger *logger;
static SoupBuffer *index_buffer;
int debug_level;
gboolean expect_warning, tls_available;
static int http_debug_level;
static gboolean
increment_debug_level (const char *option_name, const char *value,
gpointer data, GError **error)
{
debug_level++;
return TRUE;
}
static gboolean
increment_http_debug_level (const char *option_name, const char *value,
gpointer data, GError **error)
{
http_debug_level++;
return TRUE;
}
static GOptionEntry debug_entry[] = {
{ "debug", 'd', G_OPTION_FLAG_NO_ARG,
G_OPTION_ARG_CALLBACK, increment_debug_level,
"Enable (or increase) test-specific debugging", NULL },
{ "http-debug", 'H', G_OPTION_FLAG_NO_ARG,
G_OPTION_ARG_CALLBACK, increment_http_debug_level,
"Enable (or increase) HTTP-level debugging", NULL },
{ NULL }
};
static void
quit (int sig)
{
#ifdef HAVE_APACHE
if (apache_running)
apache_cleanup ();
#endif
exit (1);
}
void
test_init (int argc, char **argv, GOptionEntry *entries)
{
GOptionContext *opts;
char *name;
GError *error = NULL;
GTlsBackend *tls_backend;
setlocale (LC_ALL, "");
g_setenv ("GSETTINGS_BACKEND", "memory", TRUE);
g_setenv ("GIO_USE_PROXY_RESOLVER", "dummy", TRUE);
g_setenv ("GIO_USE_VFS", "local", TRUE);
name = strrchr (argv[0], '/');
if (!name++)
name = argv[0];
if (!strncmp (name, "lt-", 3))
name += 3;
g_set_prgname (name);
g_test_init (&argc, &argv, NULL);
g_test_set_nonfatal_assertions ();
g_test_bug_base ("https://bugzilla.gnome.org/");
opts = g_option_context_new (NULL);
g_option_context_add_main_entries (opts, debug_entry, NULL);
if (entries)
g_option_context_add_main_entries (opts, entries, NULL);
if (!g_option_context_parse (opts, &argc, &argv, &error)) {
g_printerr ("Could not parse arguments: %s\n",
error->message);
g_printerr ("%s",
g_option_context_get_help (opts, TRUE, NULL));
exit (1);
}
g_option_context_free (opts);
/* Exit cleanly on ^C in case we're valgrinding. */
signal (SIGINT, quit);
tls_backend = g_tls_backend_get_default ();
tls_available = g_tls_backend_supports_tls (tls_backend);
}
void
test_cleanup (void)
{
#ifdef HAVE_APACHE
if (apache_running)
apache_cleanup ();
#endif
if (logger)
g_object_unref (logger);
if (index_buffer)
soup_buffer_free (index_buffer);
g_main_context_unref (g_main_context_default ());
debug_printf (1, "\n");
}
void
debug_printf (int level, const char *format, ...)
{
va_list args;
if (debug_level < level)
return;
va_start (args, format);
g_vprintf (format, args);
va_end (args);
}
#ifdef HAVE_APACHE
static gboolean
apache_cmd (const char *cmd)
{
GPtrArray *argv;
char *server_root, *cwd, *pid_file;
#ifdef HAVE_APACHE_2_4
char *default_runtime_dir;
#endif
int status;
gboolean ok;
server_root = g_test_build_filename (G_TEST_BUILT, "", NULL);
cwd = g_get_current_dir ();
#ifdef HAVE_APACHE_2_4
default_runtime_dir = g_strdup_printf ("DefaultRuntimeDir %s", cwd);
#endif
pid_file = g_strdup_printf ("PidFile %s/httpd.pid", cwd);
argv = g_ptr_array_new ();
g_ptr_array_add (argv, APACHE_HTTPD);
g_ptr_array_add (argv, "-d");
g_ptr_array_add (argv, server_root);
g_ptr_array_add (argv, "-f");
g_ptr_array_add (argv, "httpd.conf");
#ifdef HAVE_APACHE_2_4
g_ptr_array_add (argv, "-c");
g_ptr_array_add (argv, default_runtime_dir);
#endif
g_ptr_array_add (argv, "-c");
g_ptr_array_add (argv, pid_file);
g_ptr_array_add (argv, "-k");
g_ptr_array_add (argv, (char *)cmd);
g_ptr_array_add (argv, NULL);
ok = g_spawn_sync (cwd, (char **)argv->pdata, NULL, 0, NULL, NULL,
NULL, NULL, &status, NULL);
if (ok)
ok = (status == 0);
g_free (server_root);
g_free (cwd);
g_free (pid_file);
#ifdef HAVE_APACHE_2_4
g_free (default_runtime_dir);
#endif
g_ptr_array_free (argv, TRUE);
return ok;
}
void
apache_init (void)
{
if (g_getenv ("SOUP_TESTS_IN_MAKE_CHECK"))
return;
if (!apache_cmd ("start")) {
g_printerr ("Could not start apache\n");
exit (1);
}
apache_running = TRUE;
}
void
apache_cleanup (void)
{
pid_t pid;
char *contents;
if (g_file_get_contents ("httpd.pid", &contents, NULL, NULL)) {
pid = strtoul (contents, NULL, 10);
g_free (contents);
} else
pid = 0;
if (!apache_cmd ("graceful-stop"))
return;
apache_running = FALSE;
if (pid) {
while (kill (pid, 0) == 0)
g_usleep (100);
}
}
#endif /* HAVE_APACHE */
SoupSession *
soup_test_session_new (GType type, ...)
{
va_list args;
const char *propname;
SoupSession *session;
GTlsDatabase *tlsdb;
char *cafile;
GError *error = NULL;
va_start (args, type);
propname = va_arg (args, const char *);
session = (SoupSession *)g_object_new_valist (type, propname, args);
va_end (args);
if (tls_available) {
cafile = g_test_build_filename (G_TEST_DIST, "test-cert.pem", NULL);
tlsdb = g_tls_file_database_new (cafile, &error);
g_free (cafile);
if (error) {
if (g_strcmp0 (g_getenv ("GIO_USE_TLS"), "dummy") == 0)
g_clear_error (&error);
else
g_assert_no_error (error);
}
g_object_set (G_OBJECT (session),
SOUP_SESSION_TLS_DATABASE, tlsdb,
NULL);
g_clear_object (&tlsdb);
}
if (http_debug_level && !logger) {
SoupLoggerLogLevel level = MIN ((SoupLoggerLogLevel)http_debug_level, SOUP_LOGGER_LOG_BODY);
logger = soup_logger_new (level, -1);
}
if (logger)
soup_session_add_feature (session, SOUP_SESSION_FEATURE (logger));
return session;
}
void
soup_test_session_abort_unref (SoupSession *session)
{
soup_session_abort (session);
g_assert_cmpint (G_OBJECT (session)->ref_count, ==, 1);
g_object_unref (session);
}
static void
server_listen (SoupServer *server)
{
GError *error = NULL;
soup_server_listen_local (server, 0, 0, &error);
if (error) {
g_printerr ("Unable to create server: %s\n", error->message);
exit (1);
}
}
static GMutex server_start_mutex;
static GCond server_start_cond;
static gpointer
run_server_thread (gpointer user_data)
{
SoupServer *server = user_data;
SoupTestServerOptions options =
GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (server), "options"));
GMainContext *context;
GMainLoop *loop;
context = g_main_context_new ();
g_main_context_push_thread_default (context);
loop = g_main_loop_new (context, FALSE);
g_object_set_data (G_OBJECT (server), "GMainLoop", loop);
if (!(options & SOUP_TEST_SERVER_NO_DEFAULT_LISTENER))
server_listen (server);
g_mutex_lock (&server_start_mutex);
g_cond_signal (&server_start_cond);
g_mutex_unlock (&server_start_mutex);
g_main_loop_run (loop);
g_main_loop_unref (loop);
soup_server_disconnect (server);
g_main_context_pop_thread_default (context);
g_main_context_unref (context);
return NULL;
}
SoupServer *
soup_test_server_new (SoupTestServerOptions options)
{
SoupServer *server;
GTlsCertificate *cert = NULL;
GError *error = NULL;
if (tls_available) {
char *ssl_cert_file, *ssl_key_file;
ssl_cert_file = g_test_build_filename (G_TEST_DIST, "test-cert.pem", NULL);
ssl_key_file = g_test_build_filename (G_TEST_DIST, "test-key.pem", NULL);
cert = g_tls_certificate_new_from_files (ssl_cert_file,
ssl_key_file,
&error);
g_free (ssl_cert_file);
g_free (ssl_key_file);
if (error) {
g_printerr ("Unable to create server: %s\n", error->message);
exit (1);
}
}
server = soup_server_new (SOUP_SERVER_TLS_CERTIFICATE, cert,
NULL);
g_clear_object (&cert);
g_object_set_data (G_OBJECT (server), "options", GUINT_TO_POINTER (options));
if (options & SOUP_TEST_SERVER_IN_THREAD) {
GThread *thread;
g_mutex_lock (&server_start_mutex);
thread = g_thread_new ("server_thread", run_server_thread, server);
g_cond_wait (&server_start_cond, &server_start_mutex);
g_mutex_unlock (&server_start_mutex);
g_object_set_data (G_OBJECT (server), "thread", thread);
} else if (!(options & SOUP_TEST_SERVER_NO_DEFAULT_LISTENER))
server_listen (server);
return server;
}
static SoupURI *
find_server_uri (SoupServer *server, const char *scheme, const char *host)
{
GSList *uris, *u;
SoupURI *uri, *ret_uri = NULL;
uris = soup_server_get_uris (server);
for (u = uris; u; u = u->next) {
uri = u->data;
if (scheme && strcmp (uri->scheme, scheme) != 0)
continue;
if (host && strcmp (uri->host, host) != 0)
continue;
ret_uri = soup_uri_copy (uri);
break;
}
g_slist_free_full (uris, (GDestroyNotify)soup_uri_free);
return ret_uri;
}
static SoupURI *
add_listener (SoupServer *server, const char *scheme, const char *host)
{
SoupServerListenOptions options = 0;
GError *error = NULL;
if (!g_strcmp0 (scheme, SOUP_URI_SCHEME_HTTPS))
options |= SOUP_SERVER_LISTEN_HTTPS;
if (!g_strcmp0 (host, "127.0.0.1"))
options |= SOUP_SERVER_LISTEN_IPV4_ONLY;
else if (!g_strcmp0 (host, "::1"))
options |= SOUP_SERVER_LISTEN_IPV6_ONLY;
soup_server_listen_local (server, 0, options, &error);
g_assert_no_error (error);
return find_server_uri (server, scheme, host);
}
typedef struct {
GMutex mutex;
GCond cond;
SoupServer *server;
const char *scheme;
const char *host;
SoupURI *uri;
} AddListenerData;
static gboolean
add_listener_in_thread (gpointer user_data)
{
AddListenerData *data = user_data;
data->uri = add_listener (data->server, data->scheme, data->host);
g_mutex_lock (&data->mutex);
g_cond_signal (&data->cond);
g_mutex_unlock (&data->mutex);
return FALSE;
}
SoupURI *
soup_test_server_get_uri (SoupServer *server,
const char *scheme,
const char *host)
{
SoupURI *uri;
GMainLoop *loop;
uri = find_server_uri (server, scheme, host);
if (uri)
return uri;
/* Need to add a new listener */
loop = g_object_get_data (G_OBJECT (server), "GMainLoop");
if (loop) {
GMainContext *context = g_main_loop_get_context (loop);
AddListenerData data;
g_mutex_init (&data.mutex);
g_cond_init (&data.cond);
data.server = server;
data.scheme = scheme;
data.host = host;
data.uri = NULL;
g_mutex_lock (&data.mutex);
soup_add_completion (context, add_listener_in_thread, &data);
while (!data.uri)
g_cond_wait (&data.cond, &data.mutex);
g_mutex_unlock (&data.mutex);
g_mutex_clear (&data.mutex);
g_cond_clear (&data.cond);
uri = data.uri;
} else
uri = add_listener (server, scheme, host);
return uri;
}
static gboolean
done_waiting (gpointer user_data)
{
gboolean *done = user_data;
*done = TRUE;
return FALSE;
}
static void
disconnect_and_wait (SoupServer *server,
GMainContext *context)
{
GSource *source;
gboolean done = FALSE;
source = g_idle_source_new ();
g_source_set_priority (source, G_PRIORITY_LOW);
g_source_set_callback (source, done_waiting, &done, NULL);
g_source_attach (source, context);
g_source_unref (source);
soup_server_disconnect (server);
while (!done)
g_main_context_iteration (context, TRUE);
}
static gboolean
idle_quit_server (gpointer user_data)
{
SoupServer *server = user_data;
GMainLoop *loop = g_object_get_data (G_OBJECT (server), "GMainLoop");
disconnect_and_wait (server, g_main_loop_get_context (loop));
g_main_loop_quit (loop);
return FALSE;
}
void
soup_test_server_quit_unref (SoupServer *server)
{
GThread *thread;
thread = g_object_get_data (G_OBJECT (server), "thread");
if (thread) {
GMainLoop *loop;
GMainContext *context;
loop = g_object_get_data (G_OBJECT (server), "GMainLoop");
context = g_main_loop_get_context (loop);
g_main_context_ref (context);
soup_add_completion (context, idle_quit_server, server);
g_main_context_unref (context);
g_thread_join (thread);
} else
disconnect_and_wait (server, NULL);
g_assert_cmpint (G_OBJECT (server)->ref_count, ==, 1);
g_object_unref (server);
}
typedef struct {
GMainLoop *loop;
GAsyncResult *result;
} AsyncAsSyncData;
static void
async_as_sync_callback (GObject *object,
GAsyncResult *result,
gpointer user_data)
{
AsyncAsSyncData *data = user_data;
GMainContext *context;
data->result = g_object_ref (result);
context = g_main_loop_get_context (data->loop);
while (g_main_context_pending (context))
g_main_context_iteration (context, FALSE);
g_main_loop_quit (data->loop);
}
typedef struct {
SoupRequest *req;
GCancellable *cancellable;
SoupTestRequestFlags flags;
} CancelData;
static CancelData *
create_cancel_data (SoupRequest *req,
GCancellable *cancellable,
SoupTestRequestFlags flags)
{
CancelData *cancel_data;
if (!flags)
return NULL;
cancel_data = g_slice_new0 (CancelData);
cancel_data->flags = flags;
if (flags & SOUP_TEST_REQUEST_CANCEL_MESSAGE && SOUP_IS_REQUEST_HTTP (req))
cancel_data->req = g_object_ref (req);
else if (flags & SOUP_TEST_REQUEST_CANCEL_CANCELLABLE)
cancel_data->cancellable = g_object_ref (cancellable);
return cancel_data;
}
inline static void
cancel_message_or_cancellable (CancelData *cancel_data)
{
if (cancel_data->flags & SOUP_TEST_REQUEST_CANCEL_MESSAGE) {
SoupRequest *req = cancel_data->req;
SoupMessage *msg = soup_request_http_get_message (SOUP_REQUEST_HTTP (req));
soup_session_cancel_message (soup_request_get_session (req), msg,
SOUP_STATUS_CANCELLED);
g_object_unref (msg);
g_object_unref (req);
} else if (cancel_data->flags & SOUP_TEST_REQUEST_CANCEL_CANCELLABLE) {
g_cancellable_cancel (cancel_data->cancellable);
g_object_unref (cancel_data->cancellable);
}
g_slice_free (CancelData, cancel_data);
}
static gboolean
cancel_request_timeout (gpointer data)
{
cancel_message_or_cancellable ((CancelData *) data);
return FALSE;
}
static gpointer
cancel_request_thread (gpointer data)
{
g_usleep (100000); /* .1s */
cancel_message_or_cancellable ((CancelData *) data);
return NULL;
}
GInputStream *
soup_test_request_send (SoupRequest *req,
GCancellable *cancellable,
guint flags,
GError **error)
{
AsyncAsSyncData data;
GInputStream *stream;
CancelData *cancel_data = create_cancel_data (req, cancellable, flags);
if (SOUP_IS_SESSION_SYNC (soup_request_get_session (req))) {
GThread *thread;
if (cancel_data)
thread = g_thread_new ("cancel_request_thread", cancel_request_thread,
cancel_data);
stream = soup_request_send (req, cancellable, error);
if (cancel_data)
g_thread_unref (thread);
return stream;
}
data.loop = g_main_loop_new (g_main_context_get_thread_default (), FALSE);
if (cancel_data &&
(flags & SOUP_TEST_REQUEST_CANCEL_SOON || flags & SOUP_TEST_REQUEST_CANCEL_IMMEDIATE)) {
guint interval = flags & SOUP_TEST_REQUEST_CANCEL_SOON ? 100 : 0;
g_timeout_add_full (G_PRIORITY_HIGH, interval, cancel_request_timeout, cancel_data, NULL);
}
if (cancel_data && (flags & SOUP_TEST_REQUEST_CANCEL_PREEMPTIVE))
cancel_message_or_cancellable (cancel_data);
soup_request_send_async (req, cancellable, async_as_sync_callback, &data);
g_main_loop_run (data.loop);
stream = soup_request_send_finish (req, data.result, error);
if (cancel_data && (flags & SOUP_TEST_REQUEST_CANCEL_AFTER_SEND_FINISH)) {
GMainContext *context;
cancel_message_or_cancellable (cancel_data);
context = g_main_loop_get_context (data.loop);
while (g_main_context_pending (context))
g_main_context_iteration (context, FALSE);
}
g_main_loop_unref (data.loop);
g_object_unref (data.result);
return stream;
}
gboolean
soup_test_request_read_all (SoupRequest *req,
GInputStream *stream,
GCancellable *cancellable,
GError **error)
{
char buf[8192];
AsyncAsSyncData data;
gsize nread;
if (!SOUP_IS_SESSION_SYNC (soup_request_get_session (req)))
data.loop = g_main_loop_new (g_main_context_get_thread_default (), FALSE);
do {
if (SOUP_IS_SESSION_SYNC (soup_request_get_session (req))) {
nread = g_input_stream_read (stream, buf, sizeof (buf),
cancellable, error);
} else {
g_input_stream_read_async (stream, buf, sizeof (buf),
G_PRIORITY_DEFAULT, cancellable,
async_as_sync_callback, &data);
g_main_loop_run (data.loop);
nread = g_input_stream_read_finish (stream, data.result, error);
g_object_unref (data.result);
}
} while (nread > 0);
if (!SOUP_IS_SESSION_SYNC (soup_request_get_session (req)))
g_main_loop_unref (data.loop);
return nread == 0;
}
gboolean
soup_test_request_close_stream (SoupRequest *req,
GInputStream *stream,
GCancellable *cancellable,
GError **error)
{
AsyncAsSyncData data;
gboolean ok;
if (SOUP_IS_SESSION_SYNC (soup_request_get_session (req)))
return g_input_stream_close (stream, cancellable, error);
data.loop = g_main_loop_new (g_main_context_get_thread_default (), FALSE);
g_input_stream_close_async (stream, G_PRIORITY_DEFAULT, cancellable,
async_as_sync_callback, &data);
g_main_loop_run (data.loop);
ok = g_input_stream_close_finish (stream, data.result, error);
g_main_loop_unref (data.loop);
g_object_unref (data.result);
return ok;
}
void
soup_test_register_resources (void)
{
static gboolean registered = FALSE;
GResource *resource;
char *path;
GError *error = NULL;
if (registered)
return;
path = g_test_build_filename (G_TEST_BUILT, "soup-tests.gresource", NULL);
resource = g_resource_load (path, &error);
if (!resource) {
g_printerr ("Could not load resource soup-tests.gresource: %s\n",
error->message);
exit (1);
}
g_free (path);
g_resources_register (resource);
g_resource_unref (resource);
registered = TRUE;
}
SoupBuffer *
soup_test_load_resource (const char *name,
GError **error)
{
GBytes *bytes;
char *path;
soup_test_register_resources ();
path = g_build_path ("/", "/org/gnome/libsoup/tests/resources", name, NULL);
bytes = g_resources_lookup_data (path, G_RESOURCE_LOOKUP_FLAGS_NONE, error);
g_free (path);
if (!bytes)
return NULL;
return soup_buffer_new_with_owner (g_bytes_get_data (bytes, NULL),
g_bytes_get_size (bytes),
bytes,
(GDestroyNotify) g_bytes_unref);
}
SoupBuffer *
soup_test_get_index (void)
{
if (!index_buffer) {
char *path, *contents;
gsize length;
GError *error = NULL;
path = g_test_build_filename (G_TEST_DIST, "index.txt", NULL);
if (!g_file_get_contents (path, &contents, &length, &error)) {
g_printerr ("Could not read index.txt: %s\n",
error->message);
exit (1);
}
g_free (path);
index_buffer = soup_buffer_new (SOUP_MEMORY_TAKE, contents, length);
}
return index_buffer;
}
#ifndef G_HAVE_ISO_VARARGS
void
soup_test_assert (gboolean expr, const char *fmt, ...)
{
char *message;
va_list args;
if (G_UNLIKELY (!expr)) {
va_start (args, fmt);
message = g_strdup_vprintf (fmt, args);
va_end (args);
g_assertion_message (G_LOG_DOMAIN,
"???", 0, "???"
message);
g_free (message);
}
}
#endif