Add native appearance, screenshot and wallpaper portals

scripts/tests/test_portal_contracts.py

@@ -0,0 +1,125 @@
+"""Check native portal wire contracts on a private bus without touching the desktop."""
+import os
+from pathlib import Path
+import signal
+import subprocess
+import sys
+import tempfile
+import time
+import unittest
+import xml.etree.ElementTree as ET
+
+REPO = Path(__file__).resolve().parents[2]
+BINARY = REPO / os.environ.get("FERESE_TEST_PORTAL_BINARY", "target/debug/xdg-desktop-portal-ferese")
+NAME = "org.freedesktop.impl.portal.desktop.ferese"
+PATH = "/org/freedesktop/portal/desktop"
+
+
+class NativePortalContracts(unittest.TestCase):
+    def test_private_bus_contracts(self):
+        result = subprocess.run(["dbus-run-session", "--", sys.executable, __file__, "--private"],
+                                capture_output=True, text=True, timeout=45)
+        self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
+
+
+def private_bus_checks():
+    import gi
+    gi.require_version("Gio", "2.0")
+    from gi.repository import Gio, GLib
+
+    bus = Gio.bus_get_sync(Gio.BusType.SESSION, None)
+
+    def call(interface, method, parameters, signature=None, destination=NAME):
+        return bus.call_sync(destination, PATH, interface, method, parameters,
+                             GLib.VariantType.new(signature) if signature else None,
+                             Gio.DBusCallFlags.NO_AUTO_START, 5000, None).unpack()
+
+    with tempfile.TemporaryDirectory(prefix="ferese-portal-contracts-") as directory:
+        root = Path(directory)
+        config = root / "ferese/config.kdl"
+        config.parent.mkdir()
+        config.write_text('theme { colors { surface-base "#ffffff"; accent "#ff8000"; }; }; animations { reduced-motion #true; }\n')
+        log = (root / "backend.log").open("w")
+        process = subprocess.Popen([str(BINARY)], env=dict(os.environ, XDG_CONFIG_HOME=directory),
+                                   stdout=log, stderr=log, start_new_session=True)
+        try:
+            deadline = time.monotonic() + 15
+            while True:
+                try:
+                    xml, = call("org.freedesktop.DBus.Introspectable", "Introspect", None, "(s)")
+                    break
+                except GLib.Error:
+                    if time.monotonic() > deadline:
+                        raise AssertionError((root / "backend.log").read_text())
+                    time.sleep(0.05)
+            node = ET.fromstring(xml)
+            for name in ("ScreenCast", "Settings", "Screenshot", "Wallpaper"):
+                interface = node.find(f"interface[@name='org.freedesktop.impl.portal.{name}']")
+                assert interface is not None, name
+                expected = ET.parse(f"/usr/share/dbus-1/interfaces/org.freedesktop.impl.portal.{name}.xml").getroot().find("interface")
+                for member in expected:
+                    if member.tag not in ("method", "signal", "property"):
+                        continue
+                    actual = interface.find(f"{member.tag}[@name='{member.attrib['name']}']")
+                    assert actual is not None, (name, member.tag, member.attrib["name"])
+                    if member.tag == "property":
+                        assert actual.attrib["type"] == member.attrib["type"]
+                    else:
+                        def types(element, direction):
+                            return [arg.attrib["type"] for arg in element.findall("arg")
+                                    if arg.attrib.get("direction", "out" if element.tag == "signal" else "in") == direction]
+                        assert types(actual, "in") == types(member, "in"), (name, member.attrib["name"], "in")
+                        assert types(actual, "out") == types(member, "out"), (name, member.attrib["name"], types(actual, "out"), types(member, "out"))
+            values, = call("org.freedesktop.impl.portal.Settings", "ReadAll", GLib.Variant("(as)", ([],)), "(a{sa{sv}})")
+            appearance = values["org.freedesktop.appearance"]
+            assert appearance["color-scheme"] == 2 and appearance["reduced-motion"] == 1, appearance
+            assert appearance["accent-color"][0] == 1. and appearance["accent-color"][2] == 0., appearance
+            result, = call("org.freedesktop.impl.portal.Settings", "ReadAll", GLib.Variant("(as)", (["other.*"],)), "(a{sa{sv}})")
+            assert result == {}
+            try:
+                call("org.freedesktop.impl.portal.Settings", "Read", GLib.Variant("(ss)", ("org.freedesktop.appearance", "missing")))
+                raise AssertionError("Unknown Settings key succeeded")
+            except GLib.Error as error:
+                assert "InvalidArgs" in str(error)
+
+            params = GLib.Variant("(ossa{sv})", (PATH + "/request/test/screenshot", "org.test.App", "", {"target": GLib.Variant("u", 99)}))
+            try:
+                call("org.freedesktop.impl.portal.Screenshot", "Screenshot", params)
+                raise AssertionError("Untrusted backend caller succeeded")
+            except GLib.Error:
+                pass
+            request_name = bus.call_sync("org.freedesktop.DBus", "/org/freedesktop/DBus", "org.freedesktop.DBus", "RequestName",
+                                         GLib.Variant("(su)", ("org.freedesktop.portal.Desktop", 0)), GLib.VariantType.new("(u)"),
+                                         Gio.DBusCallFlags.NONE, 5000, None).unpack()[0]
+            assert request_name == 1
+            response, values = call("org.freedesktop.impl.portal.Screenshot", "Screenshot", params, "(ua{sv})")
+            assert response == 2 and values == {}
+
+            signals = []
+            subscription = bus.signal_subscribe(NAME, "org.freedesktop.impl.portal.Settings", "SettingChanged", PATH,
+                                                None, Gio.DBusSignalFlags.NONE, lambda *args: signals.append(args[-1].unpack()))
+            temporary = config.with_suffix(".tmp")
+            temporary.write_text('theme { colors { surface-base "#111111"; accent "#0080ff"; }; }; animations { enabled #false; }\n')
+            temporary.replace(config)
+            deadline = time.monotonic() + 5
+            while time.monotonic() < deadline and not any(signal[1] == "color-scheme" for signal in signals):
+                GLib.MainContext.default().iteration(False)
+                time.sleep(0.02)
+            assert any(signal[1] == "color-scheme" and signal[2] == 1 for signal in signals), signals
+            assert any(signal[1] == "accent-color" for signal in signals), signals
+            config.write_text('theme { broken')
+            time.sleep(1.2)
+            scheme, = call("org.freedesktop.impl.portal.Settings", "Read", GLib.Variant("(ss)", ("org.freedesktop.appearance", "color-scheme")))
+            assert scheme == 1, scheme
+            bus.signal_unsubscribe(subscription)
+        finally:
+            os.killpg(process.pid, signal.SIGTERM)
+            process.wait(timeout=5)
+            log.close()
+
+
+if __name__ == "__main__":
+    if sys.argv[1:] == ["--private"]:
+        private_bus_checks()
+    else:
+        unittest.main()