gio/tests: Add tests for portal support functions

Test all the snap cases and the unknown sandbox one.

We need to use different test processes as we initialize the portal
type early enough that it can't be changed later.

gio/tests/meson.build

@@ -227,6 +227,22 @@ if host_machine.system() != 'windows'
     'gdbus-peer-object-manager' : {},
     'gdbus-sasl' : {},
     'live-g-file' : {},
+    'portal-support-none' : {
+      'extra_sources': ['../gportalsupport.c', '../gsandbox.c'],
+      'suite': ['portal-support'],
+    },
+    'portal-support-env-var' : {
+      'extra_sources': ['../gportalsupport.c', '../gsandbox.c'],
+      'suite': ['portal-support'],
+    },
+    'portal-support-snap' : {
+      'extra_sources': ['../gportalsupport.c', '../gsandbox.c', 'portal-support-utils.c'],
+      'suite': ['portal-support'],
+    },
+    'portal-support-snap-classic' : {
+      'extra_sources': ['../gportalsupport.c', '../gsandbox.c', 'portal-support-utils.c'],
+      'suite': ['portal-support'],
+    },
     'resolver-parsing' : {'dependencies' : [network_libs]},
     'socket-address' : {},
     'stream-rw_all' : {},

gio/tests/portal-support-env-var.c

@@ -0,0 +1,45 @@
+/*
+ * GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2022 Canonical Ltd.
+ *
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Marco Trevisan <marco.trevisan@canonical.com>
+ */
+
+#include "../gportalsupport.h"
+#include <gio/gio.h>
+
+static void
+test_portal_support_env_var (void)
+{
+  g_assert_true (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+}
+
+int
+main (int argc, char **argv)
+{
+  g_test_init (&argc, &argv, NULL);
+
+  g_setenv ("GTK_USE_PORTAL", "1", TRUE);
+
+  g_test_add_func ("/portal-support/env-var", test_portal_support_env_var);
+
+  return g_test_run ();
+}

gio/tests/portal-support-none.c

@@ -0,0 +1,43 @@
+/*
+ * GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2022 Canonical Ltd.
+ *
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Marco Trevisan <marco.trevisan@canonical.com>
+ */
+
+#include "../gportalsupport.h"
+#include <gio/gio.h>
+
+static void
+test_portal_support_none (void)
+{
+  g_assert_false (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+}
+
+int
+main (int argc, char **argv)
+{
+  g_test_init (&argc, &argv, NULL);
+
+  g_test_add_func ("/portal-support/none", test_portal_support_none);
+
+  return g_test_run ();
+}

gio/tests/portal-support-snap-classic.c

@@ -0,0 +1,119 @@
+/*
+ * GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2022 Canonical Ltd.
+ *
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Marco Trevisan <marco.trevisan@canonical.com>
+ */
+
+#include "portal-support-utils.h"
+
+#include "../gportalsupport.h"
+#include <gio/gio.h>
+
+typedef struct
+{
+  char *old_path;
+  char *old_snap;
+
+  const char *bin_path;
+  const char *snap_path;
+} SetupData;
+
+static void
+tests_setup (SetupData *setup_data,
+             gconstpointer data)
+{
+  setup_data->old_path = g_strdup (g_getenv ("PATH"));
+  setup_data->old_snap = g_strdup (g_getenv ("SNAP"));
+
+  setup_data->bin_path = g_get_user_runtime_dir ();
+  setup_data->snap_path = g_getenv ("G_TEST_TMPDIR");
+
+  g_assert_nonnull (setup_data->bin_path);
+  g_assert_nonnull (setup_data->snap_path);
+
+  g_setenv ("PATH", setup_data->bin_path, TRUE);
+  g_setenv ("SNAP", setup_data->snap_path, TRUE);
+}
+
+static void
+tests_teardown (SetupData *setup_data,
+                gconstpointer data)
+{
+  if (setup_data->old_path)
+    g_setenv ("PATH", setup_data->old_path, TRUE);
+  else
+    g_unsetenv ("PATH");
+
+  if (setup_data->old_snap)
+    g_setenv ("SNAP", setup_data->old_snap, TRUE);
+  else
+    g_unsetenv ("SNAP");
+
+  g_clear_pointer (&setup_data->old_path, g_free);
+  g_clear_pointer (&setup_data->old_snap, g_free);
+}
+
+static void
+test_portal_support_snap_no_snapctl (SetupData *setup,
+                                     gconstpointer data)
+{
+  g_assert_false (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+}
+
+static void
+test_portal_support_snap_none (SetupData *setup,
+                               gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, TRUE);
+  create_fake_snapctl (setup->bin_path, NULL);
+
+  g_assert_false (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+}
+
+static void
+test_portal_support_snap_all (SetupData *setup,
+                              gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, TRUE);
+  create_fake_snapctl (setup->bin_path, "desktop|network-status|gsettings");
+
+  g_assert_false (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+}
+
+int
+main (int argc, char **argv)
+{
+  g_test_init (&argc, &argv, G_TEST_OPTION_ISOLATE_DIRS, NULL);
+
+  g_test_add ("/portal-support/snap-classic/no-snapctl", SetupData, NULL,
+    tests_setup, test_portal_support_snap_no_snapctl, tests_teardown);
+  g_test_add ("/portal-support/snap-classic/none", SetupData, NULL,
+    tests_setup, test_portal_support_snap_none, tests_teardown);
+  g_test_add ("/portal-support/snap-classic/all", SetupData, NULL,
+    tests_setup, test_portal_support_snap_all, tests_teardown);
+
+  return g_test_run ();
+}

gio/tests/portal-support-snap.c

@@ -0,0 +1,208 @@
+/*
+ * GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2022 Canonical Ltd.
+ *
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Marco Trevisan <marco.trevisan@canonical.com>
+ */
+
+#include "portal-support-utils.h"
+
+#include "../gportalsupport.h"
+#include <gio/gio.h>
+#include <glib/gstdio.h>
+
+typedef struct
+{
+  char *old_path;
+  char *old_snap;
+
+  const char *bin_path;
+  const char *snap_path;
+} SetupData;
+
+static void
+tests_setup (SetupData *setup_data,
+             gconstpointer data)
+{
+  setup_data->old_path = g_strdup (g_getenv ("PATH"));
+  setup_data->old_snap = g_strdup (g_getenv ("SNAP"));
+
+  setup_data->bin_path = g_get_user_runtime_dir ();
+  setup_data->snap_path = g_getenv ("G_TEST_TMPDIR");
+
+  g_assert_nonnull (setup_data->bin_path);
+  g_assert_nonnull (setup_data->snap_path);
+
+  g_setenv ("PATH", setup_data->bin_path, TRUE);
+  g_setenv ("SNAP", setup_data->snap_path, TRUE);
+}
+
+static void
+tests_teardown (SetupData *setup_data,
+                gconstpointer data)
+{
+  if (setup_data->old_path)
+    g_setenv ("PATH", setup_data->old_path, TRUE);
+  else
+    g_unsetenv ("PATH");
+
+  if (setup_data->old_snap)
+    g_setenv ("SNAP", setup_data->old_snap, TRUE);
+  else
+    g_unsetenv ("SNAP");
+
+  g_clear_pointer (&setup_data->old_path, g_free);
+  g_clear_pointer (&setup_data->old_snap, g_free);
+}
+
+static void
+test_portal_support_snap_no_snapctl (SetupData *setup,
+                                     gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, FALSE);
+
+  g_assert_false (glib_should_use_portal ());
+  g_assert_false (glib_network_available_in_sandbox ());
+  g_assert_false (glib_has_dconf_access_in_sandbox ());
+}
+
+static void
+test_portal_support_snap_none (SetupData *setup,
+                               gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, FALSE);
+  create_fake_snapctl (setup->bin_path, NULL);
+
+  g_assert_false (glib_should_use_portal ());
+  g_assert_false (glib_network_available_in_sandbox ());
+  g_assert_false (glib_has_dconf_access_in_sandbox ());
+}
+
+static void
+test_portal_support_snap_all (SetupData *setup,
+                              gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, FALSE);
+  create_fake_snapctl (setup->bin_path, "desktop|network-status|gsettings");
+
+  g_assert_true (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+}
+
+static void
+test_portal_support_snap_desktop_only (SetupData *setup,
+                                       gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, FALSE);
+  create_fake_snapctl (setup->bin_path, "desktop");
+
+  g_assert_true (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_false (glib_has_dconf_access_in_sandbox ());
+}
+
+static void
+test_portal_support_snap_network_only (SetupData *setup,
+                                       gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, FALSE);
+  create_fake_snapctl (setup->bin_path, "network-status");
+
+  g_assert_false (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_false (glib_has_dconf_access_in_sandbox ());
+}
+
+static void
+test_portal_support_snap_gsettings_only (SetupData *setup,
+                                         gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, FALSE);
+  create_fake_snapctl (setup->bin_path, "gsettings");
+
+  g_assert_false (glib_should_use_portal ());
+  g_assert_false (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+}
+
+static void
+test_portal_support_snap_updates_dynamically (SetupData *setup,
+                                              gconstpointer data)
+{
+  create_fake_snap_yaml (setup->snap_path, FALSE);
+  create_fake_snapctl (setup->bin_path, NULL);
+
+  g_assert_false (glib_should_use_portal ());
+  g_assert_false (glib_network_available_in_sandbox ());
+  g_assert_false (glib_has_dconf_access_in_sandbox ());
+
+  create_fake_snapctl (setup->bin_path, "desktop");
+  g_assert_true (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_false (glib_has_dconf_access_in_sandbox ());
+
+  create_fake_snapctl (setup->bin_path, "network-status|gsettings");
+  g_assert_false (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+
+  create_fake_snapctl (setup->bin_path, "desktop|network-status|gsettings");
+  g_assert_true (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+
+  create_fake_snapctl (setup->bin_path, "desktop|gsettings");
+  g_assert_true (glib_should_use_portal ());
+  g_assert_true (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+
+  create_fake_snapctl (setup->bin_path, "gsettings");
+  g_assert_false (glib_should_use_portal ());
+  g_assert_false (glib_network_available_in_sandbox ());
+  g_assert_true (glib_has_dconf_access_in_sandbox ());
+
+  create_fake_snapctl (setup->bin_path, NULL);
+  g_assert_false (glib_should_use_portal ());
+  g_assert_false (glib_network_available_in_sandbox ());
+  g_assert_false (glib_has_dconf_access_in_sandbox ());
+}
+
+int
+main (int argc, char **argv)
+{
+  g_test_init (&argc, &argv, G_TEST_OPTION_ISOLATE_DIRS, NULL);
+
+  g_test_add ("/portal-support/snap/no-snapctl", SetupData, NULL,
+    tests_setup, test_portal_support_snap_no_snapctl, tests_teardown);
+  g_test_add ("/portal-support/snap/none", SetupData, NULL,
+    tests_setup, test_portal_support_snap_none, tests_teardown);
+  g_test_add ("/portal-support/snap/all", SetupData, NULL,
+    tests_setup, test_portal_support_snap_all, tests_teardown);
+  g_test_add ("/portal-support/snap/desktop-only", SetupData, NULL,
+    tests_setup, test_portal_support_snap_desktop_only, tests_teardown);
+  g_test_add ("/portal-support/snap/network-only", SetupData, NULL,
+    tests_setup, test_portal_support_snap_network_only, tests_teardown);
+  g_test_add ("/portal-support/snap/gsettings-only", SetupData, NULL,
+    tests_setup, test_portal_support_snap_gsettings_only, tests_teardown);
+  g_test_add ("/portal-support/snap/updates-dynamically", SetupData, NULL,
+    tests_setup, test_portal_support_snap_updates_dynamically, tests_teardown);
+
+  return g_test_run ();
+}

gio/tests/portal-support-utils.c

@@ -0,0 +1,87 @@
+/*
+ * GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2022 Canonical Ltd.
+ *
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Marco Trevisan <marco.trevisan@canonical.com>
+ */
+
+#include "portal-support-utils.h"
+
+#include <glib.h>
+#include <glib/gstdio.h>
+
+void
+create_fake_snapctl (const char *path,
+                     const char *supported_op)
+{
+  GError *error = NULL;
+  char *snapctl_content;
+  char *snapctl;
+
+  snapctl = g_build_filename (path, "snapctl", NULL);
+  snapctl_content = g_strdup_printf ("#!/bin/sh\n" \
+                                     "[ \"$1\" != 'is-connected' ] && exit 2\n"
+                                     "[ -z \"$2\" ] && exit 3\n"
+                                     "[ -n \"$3\" ] && exit 4\n"
+                                     "case \"$2\" in\n"
+                                     "  %s) exit 0;;\n"
+                                     "  *) exit 1;;\n"
+                                     "esac\n",
+                                     supported_op ? supported_op : "<invalid>");
+
+  g_file_set_contents (snapctl, snapctl_content, -1, &error);
+  g_assert_no_error (error);
+  g_assert_cmpint (g_chmod (snapctl, 0500), ==, 0);
+
+  g_test_message ("Created snapctl in %s", snapctl);
+
+  g_clear_error (&error);
+  g_free (snapctl_content);
+  g_free (snapctl);
+}
+
+void
+create_fake_snap_yaml (const char *snap_path,
+                       gboolean is_classic)
+{
+  char *meta_path;
+  char *yaml_path;
+  char *yaml_contents;
+
+  g_assert_nonnull (snap_path);
+
+  yaml_contents = g_strconcat ("name: glib-test-portal-support\n"
+                               "title: GLib Portal Support Test\n"
+                               "version: 2.76\n"
+                               "summary: Test it works\n",
+                               is_classic ?
+                                "confinement: classic\n" : NULL, NULL);
+
+  meta_path = g_build_filename (snap_path, "meta", NULL);
+  g_assert_cmpint (g_mkdir_with_parents (meta_path, 0700), ==, 0);
+
+  yaml_path = g_build_filename (meta_path, "snap.yaml", NULL);
+  g_file_set_contents (yaml_path, yaml_contents, -1, NULL);
+
+  g_test_message ("Created snap.yaml in %s", yaml_path);
+
+  g_free (meta_path);
+  g_free (yaml_path);
+  g_free (yaml_contents);
+}

gio/tests/portal-support-utils.h

@@ -0,0 +1,30 @@
+/*
+ * GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2022 Canonical Ltd.
+ *
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author: Marco Trevisan <marco.trevisan@canonical.com>
+ */
+
+#include <glib.h>
+
+void create_fake_snap_yaml (const char *snap_path,
+                            gboolean is_classic);
+
+void create_fake_snapctl (const char *path,
+                          const char *supported_op);