Allow tests to set the AppInfo to type HOST with a specific app id

src/meson.build

@@ -56,6 +56,10 @@ xdp_method_info_sources = files('xdp-method-info.c') + xdp_method_info_built_sou
 xdp_utils_includes = include_directories('.')
 xdp_utils_sources = files('xdp-utils.c')
 
+if have_libsystemd
+  xdp_utils_sources += sd_escape_sources
+endif
+
 xdg_desktop_portal_sources = files(
   'account.c',
   'background.c',
@@ -114,10 +118,6 @@ if have_geoclue
   )
 endif
 
-if have_libsystemd
-  xdg_desktop_portal_sources += sd_escape_sources
-endif
-
 common_deps = [
   glib_dep,
   gio_dep,

src/xdp-utils.c

@@ -200,7 +200,7 @@ _xdp_parse_app_id_from_unit_name (const char *unit)
 }
 #endif /* HAVE_LIBSYSTEMD */
 
-void
+static void
 set_appid_from_pid (XdpAppInfo *app_info, pid_t pid)
 {
 #ifdef HAVE_LIBSYSTEMD
@@ -238,6 +238,14 @@ xdp_app_info_new_host (pid_t pid)
   return app_info;
 }
 
+static XdpAppInfo *
+xdp_app_info_new_test_host (const char *app_id)
+{
+  XdpAppInfo *app_info = xdp_app_info_new (XDP_APP_INFO_KIND_HOST);
+  app_info->id = g_strdup (app_id);
+  return app_info;
+}
+
 static void
 xdp_app_info_free (XdpAppInfo *app_info)
 {
@@ -927,6 +935,11 @@ xdp_invocation_lookup_app_info_sync (GDBusMethodInvocation *invocation,
 {
   GDBusConnection *connection = g_dbus_method_invocation_get_connection (invocation);
   const gchar *sender = g_dbus_method_invocation_get_sender (invocation);
+  const char *test_override_app_id;
+
+  test_override_app_id = g_getenv ("XDG_DESKTOP_PORTAL_TEST_APP_ID");
+  if (test_override_app_id)
+    return xdp_app_info_new_test_host (test_override_app_id);
 
   return xdp_connection_lookup_app_info_sync (connection, sender, cancellable, error);
 }

tests/__init__.py

@@ -332,13 +332,14 @@ class PortalMock:
     Parent class for portal tests.
     """
 
-    def __init__(self, session_bus, portal_name: str):
+    def __init__(self, session_bus, portal_name: str, app_id: str = "org.example.App"):
         self.bus = session_bus
         self.portal_name = portal_name
         self.p_mock = None
         self.xdp = None
         self.portal_interfaces: Dict[str, dbus.Interface] = {}
         self.dbus_monitor = None
+        self.app_id = app_id
 
     @property
     def interface_name(self) -> str:
@@ -412,6 +413,7 @@ def start_xdp(self):
         env["G_DEBUG"] = "fatal-criticals"
         env["XDG_DESKTOP_PORTAL_DIR"] = portal_dir
         env["XDG_CURRENT_DESKTOP"] = "test"
+        env["XDG_DESKTOP_PORTAL_TEST_APP_ID"] = self.app_id
 
         xdp = subprocess.Popen(argv, env=env)
 

tests/conftest.py

@@ -57,11 +57,19 @@ def params() -> dict[str, Any]:
 
 
 @pytest.fixture
-def portal_mock(session_bus, portal_name, params, portal_has_impl) -> PortalMock:
+def app_id():
+    """
+    Default fixture providing the app id of the connecting process
+    """
+    return "org.example.App"
+
+
+@pytest.fixture
+def portal_mock(session_bus, portal_name, params, portal_has_impl, app_id) -> PortalMock:
     """
     Fixture yielding a PortalMock object with the impl started, if applicable.
     """
-    pmock = PortalMock(session_bus, portal_name)
+    pmock = PortalMock(session_bus, portal_name, app_id)
     if portal_has_impl:
         pmock.start_impl_portal(params)
     pmock.start_xdp()

tests/limited-portals.c

@@ -138,14 +138,15 @@ global_setup (void)
   g_autofree gchar *argv0 = NULL;
   g_autoptr(GSubprocessLauncher) launcher = NULL;
   g_autoptr(GSubprocess) subprocess = NULL;
-  g_autoptr(XdpAppInfo) appinfo = NULL;
   guint name_timeout;
   const char *argv[4];
   GQuark portal_errors G_GNUC_UNUSED;
   static gboolean name_appeared;
   guint watch;
   guint timeout_mult = 1;
 
+  appid = "org.example.App";
+
   update_data_dirs ();
 
   g_mkdtemp (outdir);
@@ -154,6 +155,7 @@ global_setup (void)
   g_setenv ("XDG_CURRENT_DESKTOP", "limited", TRUE);
   g_setenv ("XDG_RUNTIME_DIR", outdir, TRUE);
   g_setenv ("XDG_DATA_HOME", outdir, TRUE);
+  g_setenv ("XDG_DESKTOP_PORTAL_TEST_APP_ID", appid, TRUE);
 
   /* Re-defining dbus-daemon with a custom script */
   setup_dbus_daemon_wrapper (outdir);
@@ -320,10 +322,6 @@ global_setup (void)
                                                     &error);
   g_assert_no_error (error);
 
-  appinfo = xdp_get_app_info_from_pid (getpid (), &error);
-  g_assert_no_error (error);
-  appid = g_strdup (xdp_app_info_get_id (appinfo));
-
   /* make sure errors are registered */
   portal_errors = XDG_DESKTOP_PORTAL_ERROR;
 }
@@ -380,7 +378,6 @@ global_teardown (void)
 
   g_object_unref (lockdown);
   g_object_unref (permission_store);
-  g_free (appid);
 
   g_object_unref (session_bus);
 

tests/meson.build

@@ -126,7 +126,6 @@ test_portals = executable(
   impl_built_sources,
   permission_store_built_sources,
   portal_built_sources,
-  sd_escape_sources,
   test_portals_sources,
   xdp_utils_sources,
   dependencies: [common_deps, libportal_dep, libsystemd_dep],
@@ -144,7 +143,6 @@ limited_portals = executable(
   impl_built_sources,
   permission_store_built_sources,
   portal_built_sources,
-  sd_escape_sources,
   limited_portals_sources,
   xdp_utils_sources,
   dependencies: [common_deps, libportal_dep, libsystemd_dep],
@@ -231,7 +229,6 @@ test_permission_store = executable(
   'utils.c',
   permission_store_built_sources,
   xdp_utils_sources,
-  sd_escape_sources,
   dependencies: [common_deps, libsystemd_dep],
   include_directories: [common_includes, xdp_utils_includes],
   install: enable_installed_tests,
@@ -250,7 +247,6 @@ test_xdp_utils = executable(
   'test-xdp-utils.c',
   'utils.c',
   xdp_utils_sources,
-  sd_escape_sources,
   dependencies: [common_deps, libsystemd_dep],
   include_directories: [common_includes, xdp_utils_includes],
   install: enable_installed_tests,

tests/test-portals.c

@@ -137,14 +137,15 @@ global_setup (void)
   g_autofree gchar *argv0 = NULL;
   g_autoptr(GSubprocessLauncher) launcher = NULL;
   g_autoptr(GSubprocess) subprocess = NULL;
-  g_autoptr(XdpAppInfo) appinfo = NULL;
   guint name_timeout;
   const char *argv[4];
   GQuark portal_errors G_GNUC_UNUSED;
   static gboolean name_appeared;
   guint watch;
   guint timeout_mult = 1;
 
+  appid = "org.example.App";
+
   update_data_dirs ();
 
   g_mkdtemp (outdir);
@@ -154,6 +155,7 @@ global_setup (void)
   g_setenv ("XDG_CURRENT_DESKTOP", "test", TRUE);
   g_setenv ("XDG_RUNTIME_DIR", outdir, TRUE);
   g_setenv ("XDG_DATA_HOME", outdir, TRUE);
+  g_setenv ("XDG_DESKTOP_PORTAL_TEST_APP_ID", appid, TRUE);
 
   /* Re-defining dbus-daemon with a custom script */
   setup_dbus_daemon_wrapper (outdir);
@@ -333,10 +335,6 @@ global_setup (void)
                                                     &error);
   g_assert_no_error (error);
 
-  appinfo = xdp_get_app_info_from_pid (getpid (), &error);
-  g_assert_no_error (error);
-  appid = g_strdup (xdp_app_info_get_id (appinfo));
-
   /* make sure errors are registered */
   portal_errors = XDG_DESKTOP_PORTAL_ERROR;
 }
@@ -393,7 +391,6 @@ global_teardown (void)
 
   g_object_unref (lockdown);
   g_object_unref (permission_store);
-  g_free (appid);
 
   g_object_unref (session_bus);
 

tests/test_globalshortcuts.py

@@ -20,7 +20,7 @@ class TestGlobalShortcuts:
     def test_version(self, portal_mock):
         portal_mock.check_version(1)
 
-    def test_global_shortcuts_create_close_session(self, portal_mock):
+    def test_global_shortcuts_create_close_session(self, portal_mock, app_id):
         request = portal_mock.create_request()
         options = {
             "session_handle_token": "session_token0",
@@ -38,7 +38,7 @@ def test_global_shortcuts_create_close_session(self, portal_mock):
         assert len(method_calls) > 0
         _, args = method_calls[-1]
         assert args[1] == session.handle
-#        assert args[2] == ""  # appid, not necessary empty
+        assert args[2] == app_id
 
         session.close()
 
@@ -49,7 +49,7 @@ def test_global_shortcuts_create_close_session(self, portal_mock):
         assert session.closed
 
     @pytest.mark.parametrize("params", ({"force-close": 500},))
-    def test_global_shortcuts_create_session_signal_closed(self, portal_mock):
+    def test_global_shortcuts_create_session_signal_closed(self, portal_mock, app_id):
         request = portal_mock.create_request()
         options = {
             "session_handle_token": "session_token0",
@@ -67,7 +67,7 @@ def test_global_shortcuts_create_session_signal_closed(self, portal_mock):
         assert len(method_calls) > 0
         _, args = method_calls[-1]
         assert args[1] == session.handle
-#        assert args[2] == ""  # appid, not necessary empty
+        assert args[2] == app_id
 
         # Now expect the backend to close it