tests: add unit test for WpSession (proxy + exported)

tests/wp/meson.build

@@ -16,6 +16,12 @@ test(
   env: common_env,
 )
 
+test(
+  'test-session',
+  executable('test-session', 'session.c', dependencies: common_deps),
+  env: common_env,
+)
+
 test(
   'test-spa-props',
   executable('test-spa-props', 'spa-props.c', dependencies: common_deps),

tests/wp/session.c

+/* WirePlumber
+ *
+ * Copyright © 2019 Collabora Ltd.
+ *    @author George Kiagiadakis <george.kiagiadakis@collabora.com>
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <wp/wp.h>
+#include <pipewire/pipewire.h>
+
+#include "test-server.h"
+
+typedef struct {
+  /* the local pipewire server */
+  WpTestServer server;
+
+  /* the main loop */
+  GMainContext *context;
+  GMainLoop *loop;
+  GSource *timeout_source;
+
+  /* the client that exports */
+  WpCore *export_core;
+  WpObjectManager *export_om;
+
+  /* the client that receives a proxy */
+  WpCore *proxy_core;
+  WpObjectManager *proxy_om;
+
+  WpExportedSession *exported_session;
+  WpProxy *proxy_session;
+
+  gint n_events;
+
+} TestSessionFixture;
+
+static gboolean
+timeout_callback (TestSessionFixture *fixture)
+{
+  g_message ("test timed out");
+  g_test_fail ();
+  g_main_loop_quit (fixture->loop);
+
+  return G_SOURCE_REMOVE;
+}
+
+static void
+test_session_remote_state_changed (WpCore *core, WpRemoteState state,
+    TestSessionFixture *fixture)
+{
+  const gchar * msg = NULL;
+
+  switch (state) {
+  case WP_REMOTE_STATE_ERROR:
+    wp_core_get_remote_state (core, &msg);
+    g_message ("remote error: %s", msg);
+    g_test_fail ();
+    g_main_loop_quit (fixture->loop);
+    break;
+  default:
+    break;
+  }
+}
+
+static void
+test_session_setup (TestSessionFixture *self, gconstpointer user_data)
+{
+  g_autoptr (WpProperties) props = NULL;
+
+  wp_test_server_setup (&self->server);
+  pw_thread_loop_lock (self->server.thread_loop);
+  if (!pw_module_load (self->server.core, "libpipewire-module-session-manager",
+          NULL, NULL)) {
+    pw_thread_loop_unlock (self->server.thread_loop);
+    g_test_skip ("libpipewire-module-session-manager is not installed");
+    return;
+  }
+  pw_thread_loop_unlock (self->server.thread_loop);
+
+  props = wp_properties_new (PW_KEY_REMOTE_NAME, self->server.name, NULL);
+  self->context = g_main_context_new ();
+  self->loop = g_main_loop_new (self->context, FALSE);
+
+  self->export_core = wp_core_new (self->context, props);
+  self->export_om = wp_object_manager_new ();
+
+  self->proxy_core = wp_core_new (self->context, props);
+  self->proxy_om = wp_object_manager_new ();
+
+  g_main_context_push_thread_default (self->context);
+
+  /* watchdogs */
+  g_signal_connect (self->export_core, "remote-state-changed",
+      (GCallback) test_session_remote_state_changed, self);
+  g_signal_connect (self->proxy_core, "remote-state-changed",
+      (GCallback) test_session_remote_state_changed, self);
+
+  self->timeout_source = g_timeout_source_new_seconds (3);
+  g_source_set_callback (self->timeout_source, (GSourceFunc) timeout_callback,
+      self, NULL);
+  g_source_attach (self->timeout_source, self->context);
+}
+
+static void
+test_session_teardown (TestSessionFixture *self, gconstpointer user_data)
+{
+  g_main_context_pop_thread_default (self->context);
+
+  g_clear_object (&self->proxy_om);
+  g_clear_object (&self->proxy_core);
+  g_clear_object (&self->export_om);
+  g_clear_object (&self->export_core);
+  g_clear_pointer (&self->timeout_source, g_source_unref);
+  g_clear_pointer (&self->loop, g_main_loop_unref);
+  g_clear_pointer (&self->context, g_main_context_unref);
+  wp_test_server_teardown (&self->server);
+}
+
+static void
+test_session_basic_exported_object_added (WpObjectManager *om,
+    WpSession *session, TestSessionFixture *fixture)
+{
+  g_debug ("exported object added");
+
+  g_assert_true (WP_IS_SESSION (session));
+  g_assert_true (WP_IS_EXPORTED_SESSION (session));
+
+  g_assert_null (fixture->exported_session);
+  fixture->exported_session = WP_EXPORTED_SESSION (session);
+
+  if (++fixture->n_events == 3)
+    g_main_loop_quit (fixture->loop);
+}
+
+static void
+test_session_basic_exported_object_removed (WpObjectManager *om,
+    WpSession *session, TestSessionFixture *fixture)
+{
+  g_debug ("exported object removed");
+
+  g_assert_true (WP_IS_SESSION (session));
+  g_assert_true (WP_IS_EXPORTED_SESSION (session));
+
+  g_assert_nonnull (fixture->exported_session);
+  fixture->exported_session = NULL;
+
+  if (++fixture->n_events == 2)
+    g_main_loop_quit (fixture->loop);
+}
+
+static void
+test_session_basic_proxy_object_added (WpObjectManager *om,
+    WpSession *session, TestSessionFixture *fixture)
+{
+  g_debug ("proxy object added");
+
+  g_assert_true (WP_IS_SESSION (session));
+  g_assert_true (WP_IS_PROXY_SESSION (session));
+
+  g_assert_null (fixture->proxy_session);
+  fixture->proxy_session = WP_PROXY (session);
+
+  if (++fixture->n_events == 3)
+    g_main_loop_quit (fixture->loop);
+}
+
+static void
+test_session_basic_proxy_object_removed (WpObjectManager *om,
+    WpSession *session, TestSessionFixture *fixture)
+{
+  g_debug ("proxy object removed");
+
+  g_assert_true (WP_IS_SESSION (session));
+  g_assert_true (WP_IS_PROXY_SESSION (session));
+
+  g_assert_nonnull (fixture->proxy_session);
+  fixture->proxy_session = NULL;
+
+  if (++fixture->n_events == 2)
+    g_main_loop_quit (fixture->loop);
+}
+
+static void
+test_session_basic_export_done (WpExported * session, GAsyncResult * res,
+    TestSessionFixture *fixture)
+{
+  g_autoptr (GError) error = NULL;
+
+  g_debug ("export done");
+
+  g_assert_true (wp_exported_export_finish (session, res, &error));
+  g_assert_no_error (error);
+
+  g_assert_true (WP_IS_EXPORTED_SESSION (session));
+
+  if (++fixture->n_events == 3)
+    g_main_loop_quit (fixture->loop);
+}
+
+static void
+test_session_basic_default_endpoint_changed (WpSession * session,
+    WpDefaultEndpointType type, guint32 id, TestSessionFixture *fixture)
+{
+  g_debug ("endpoint changed: %s (%u, %u)", G_OBJECT_TYPE_NAME (session),
+      type, id);
+
+  g_assert_true (WP_IS_SESSION (session));
+
+  if (++fixture->n_events == 2)
+    g_main_loop_quit (fixture->loop);
+}
+
+static void
+test_session_basic_notify_properties (WpSession * session, GParamSpec * param,
+    TestSessionFixture *fixture)
+{
+  g_debug ("properties changed: %s", G_OBJECT_TYPE_NAME (session));
+
+  g_assert_true (WP_IS_SESSION (session));
+
+  if (++fixture->n_events == 2)
+    g_main_loop_quit (fixture->loop);
+}
+
+static void
+test_session_basic (TestSessionFixture *fixture, gconstpointer data)
+{
+  WpRemoteState state;
+  g_autoptr (WpExportedSession) session = NULL;
+
+  /* set up the export side */
+  g_signal_connect (fixture->export_om, "object-added",
+      (GCallback) test_session_basic_exported_object_added, fixture);
+  g_signal_connect (fixture->export_om, "object-removed",
+      (GCallback) test_session_basic_exported_object_removed, fixture);
+  wp_object_manager_add_object_interest (fixture->export_om,
+      WP_TYPE_EXPORTED_SESSION, NULL);
+  wp_core_install_object_manager (fixture->export_core, fixture->export_om);
+
+  g_assert_true (wp_core_connect (fixture->export_core));
+  do {
+    g_main_context_iteration (fixture->context, FALSE);
+    state = wp_core_get_remote_state (fixture->export_core, NULL);
+    g_assert_cmpint (state, !=, WP_REMOTE_STATE_ERROR);
+  } while (state != WP_REMOTE_STATE_CONNECTED);
+
+  /* set up the proxy side */
+  g_signal_connect (fixture->proxy_om, "object-added",
+      (GCallback) test_session_basic_proxy_object_added, fixture);
+  g_signal_connect (fixture->proxy_om, "object-removed",
+      (GCallback) test_session_basic_proxy_object_removed, fixture);
+  wp_object_manager_add_proxy_interest (fixture->proxy_om,
+      PW_TYPE_INTERFACE_Session, NULL,
+      WP_PROXY_FEATURE_INFO | WP_PROXY_SESSION_FEATURE_DEFAULT_ENDPOINT);
+  wp_core_install_object_manager (fixture->proxy_core, fixture->proxy_om);
+
+  g_assert_true (wp_core_connect (fixture->proxy_core));
+  do {
+    g_main_context_iteration (fixture->context, FALSE);
+    state = wp_core_get_remote_state (fixture->proxy_core, NULL);
+    g_assert_cmpint (state, !=, WP_REMOTE_STATE_ERROR);
+  } while (state != WP_REMOTE_STATE_CONNECTED);
+
+  /* create session */
+  session = wp_exported_session_new (fixture->export_core);
+  wp_exported_session_set_property (session, "test.property", "test-value");
+  wp_session_set_default_endpoint (WP_SESSION (session),
+      WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SINK, 5);
+  wp_session_set_default_endpoint (WP_SESSION (session),
+      WP_DEFAULT_ENDPOINT_TYPE_VIDEO_SOURCE, 9);
+
+  /* verify properties are set before export */
+  {
+    g_autoptr (WpProperties) props =
+        wp_session_get_properties (WP_SESSION (session));
+    g_assert_cmpstr (wp_properties_get (props, "test.property"), ==,
+        "test-value");
+  }
+  g_assert_cmpuint (wp_session_get_default_endpoint (WP_SESSION (session),
+          WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SINK), ==, 5);
+  g_assert_cmpuint (wp_session_get_default_endpoint (WP_SESSION (session),
+          WP_DEFAULT_ENDPOINT_TYPE_VIDEO_SOURCE), ==, 9);
+
+  /* do export */
+  wp_exported_export (WP_EXPORTED (session), NULL,
+      (GAsyncReadyCallback) test_session_basic_export_done, fixture);
+
+  /* run until objects are created and features are cached */
+  fixture->n_events = 0;
+  g_main_loop_run (fixture->loop);
+  g_assert_cmpint (fixture->n_events, ==, 3);
+  g_assert_nonnull (fixture->exported_session);
+  g_assert_nonnull (fixture->proxy_session);
+  g_assert_true (fixture->exported_session == session);
+
+  /* test round 1: verify the values on the proxy */
+
+  g_assert_cmphex (wp_proxy_get_features (fixture->proxy_session), ==,
+      WP_PROXY_FEATURE_PW_PROXY |
+      WP_PROXY_FEATURE_INFO |
+      WP_PROXY_SESSION_FEATURE_DEFAULT_ENDPOINT);
+
+  g_assert_cmpuint (wp_proxy_get_global_id (fixture->proxy_session), ==,
+      wp_exported_session_get_global_id (session));
+
+  {
+    g_autoptr (WpProperties) props =
+        wp_session_get_properties (WP_SESSION (fixture->proxy_session));
+    g_assert_cmpstr (wp_properties_get (props, "test.property"), ==,
+        "test-value");
+  }
+  g_assert_cmpuint (wp_session_get_default_endpoint (
+          WP_SESSION (fixture->proxy_session),
+          WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SINK), ==, 5);
+  g_assert_cmpuint (wp_session_get_default_endpoint (
+          WP_SESSION (fixture->proxy_session),
+          WP_DEFAULT_ENDPOINT_TYPE_VIDEO_SOURCE), ==, 9);
+
+  /* setup change signals */
+  g_signal_connect (fixture->proxy_session, "default-endpoint-changed",
+      (GCallback) test_session_basic_default_endpoint_changed, fixture);
+  g_signal_connect (session, "default-endpoint-changed",
+      (GCallback) test_session_basic_default_endpoint_changed, fixture);
+  g_signal_connect (fixture->proxy_session, "notify::properties",
+      (GCallback) test_session_basic_notify_properties, fixture);
+  g_signal_connect (session, "notify::properties",
+      (GCallback) test_session_basic_notify_properties, fixture);
+
+  /* change default endpoint on the proxy */
+  wp_session_set_default_endpoint (WP_SESSION (fixture->proxy_session),
+      WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SINK, 73);
+
+  /* run until the change is on both sides */
+  fixture->n_events = 0;
+  g_main_loop_run (fixture->loop);
+  g_assert_cmpint (fixture->n_events, ==, 2);
+
+  /* test round 2: verify the value change on both sides */
+
+  g_assert_cmpuint (wp_session_get_default_endpoint (
+          WP_SESSION (fixture->proxy_session),
+          WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SINK), ==, 73);
+  g_assert_cmpuint (wp_session_get_default_endpoint (
+          WP_SESSION (fixture->proxy_session),
+          WP_DEFAULT_ENDPOINT_TYPE_VIDEO_SOURCE), ==, 9);
+
+  g_assert_cmpuint (wp_session_get_default_endpoint (
+          WP_SESSION (session), WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SINK), ==, 73);
+  g_assert_cmpuint (wp_session_get_default_endpoint (
+          WP_SESSION (session), WP_DEFAULT_ENDPOINT_TYPE_VIDEO_SOURCE), ==, 9);
+
+  /* change default endpoint on the exported */
+  fixture->n_events = 0;
+  wp_session_set_default_endpoint (WP_SESSION (session),
+      WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SOURCE, 44);
+
+  /* run until the change is on both sides */
+  g_main_loop_run (fixture->loop);
+  g_assert_cmpint (fixture->n_events, ==, 2);
+
+  /* test round 3: verify the value change on both sides */
+
+  g_assert_cmpuint (wp_session_get_default_endpoint (
+          WP_SESSION (session), WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SOURCE), ==, 44);
+  g_assert_cmpuint (wp_session_get_default_endpoint (
+          WP_SESSION (fixture->proxy_session),
+          WP_DEFAULT_ENDPOINT_TYPE_AUDIO_SOURCE), ==, 44);
+
+  /* change a property on the exported */
+  fixture->n_events = 0;
+  wp_exported_session_set_property (session, "test.property", "changed-value");
+
+  /* run until the change is on both sides */
+  g_main_loop_run (fixture->loop);
+  g_assert_cmpint (fixture->n_events, ==, 2);
+
+  /* test round 4: verify the property change on both sides */
+
+  {
+    g_autoptr (WpProperties) props =
+        wp_session_get_properties (WP_SESSION (session));
+    g_assert_cmpstr (wp_properties_get (props, "test.property"), ==,
+        "changed-value");
+  }
+  {
+    g_autoptr (WpProperties) props =
+        wp_session_get_properties (WP_SESSION (fixture->proxy_session));
+    g_assert_cmpstr (wp_properties_get (props, "test.property"), ==,
+        "changed-value");
+  }
+
+  /* unexport */
+  fixture->n_events = 0;
+  wp_exported_unexport (WP_EXPORTED (session));
+
+  /* run until objects are destroyed */
+  g_main_loop_run (fixture->loop);
+  g_assert_cmpint (fixture->n_events, ==, 2);
+  g_assert_null (fixture->exported_session);
+  g_assert_null (fixture->proxy_session);
+}
+
+gint
+main (gint argc, gchar *argv[])
+{
+  g_test_init (&argc, &argv, NULL);
+  pw_init (NULL, NULL);
+
+  g_test_add ("/wp/session/basic", TestSessionFixture, NULL,
+      test_session_setup, test_session_basic, test_session_teardown);
+
+  return g_test_run ();
+}