1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
# Copyright 2020-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
#
# SPDX-License-Identifier: GPL-3.0-or-later
import dataclasses
import itertools
from typing import Dict, List
from qutebrowser.qt.core import QObject, QByteArray, QUrl, pyqtSlot
from qutebrowser.qt.gui import QImage
from qutebrowser.qt.dbus import QDBusConnection, QDBusMessage
import pytest
from qutebrowser.browser.webengine import notification
from qutebrowser.utils import utils
from tests.helpers import testutils
@dataclasses.dataclass
class NotificationProperties:
title: str
body: str
replaces_id: int
img_width: int
img_height: int
closed_via_web: bool = False
class TestNotificationServer(QObject):
"""A libnotify notification server used for testing."""
def __init__(self, service: str):
"""Constructs a new server.
This is safe even if there is no DBus daemon; we don't check whether
the connection is successful until register().
"""
# Note that external users should call get() instead.
super().__init__()
self._service = service
# Trying to connect to the bus doesn't fail if there's no bus.
self._bus = QDBusConnection.sessionBus()
self._message_id_gen = itertools.count(1)
# A dict mapping notification IDs to currently-displayed notifications.
self.messages: Dict[int, NotificationProperties] = {}
self.supports_body_markup = True
self.last_id = None
def cleanup(self) -> None:
self.messages = {}
def last_msg(self) -> NotificationProperties:
return self.messages[self.last_id]
def register(self) -> bool:
"""Try to register to DBus.
If no bus is available, returns False.
If a bus is available but registering fails, raises an AssertionError.
If registering succeeded, returns True.
"""
if not self._bus.isConnected():
return False
assert self._bus.registerService(self._service)
assert self._bus.registerObject(
notification.DBusNotificationAdapter.PATH,
notification.DBusNotificationAdapter.INTERFACE,
self,
QDBusConnection.RegisterOption.ExportAllSlots,
)
return True
def unregister(self) -> None:
self._bus.unregisterObject(notification.DBusNotificationAdapter.PATH)
assert self._bus.unregisterService(self._service)
def _parse_notify_args(self, appname, replaces_id, icon, title, body, actions,
hints, timeout) -> NotificationProperties:
"""Parse a Notify dbus reply.
Checks all constant values and returns a NotificationProperties object for
values being checked inside test cases.
"""
assert appname == "qutebrowser"
assert icon == '' # using icon data
assert actions == ['default', 'Activate']
assert timeout == -1
assert hints.keys() == {
"x-qutebrowser-origin",
"x-kde-origin-name",
"desktop-entry",
"image-data",
}
for key in 'x-qutebrowser-origin', 'x-kde-origin-name':
value = hints[key]
url = QUrl(value)
assert url.isValid(), value
assert url.scheme() == 'http', value
assert url.host() == 'localhost', value
assert hints['desktop-entry'] == 'org.qutebrowser.qutebrowser'
img = self._parse_image(*hints["image-data"])
if replaces_id != 0:
assert replaces_id in self.messages
return NotificationProperties(title=title, body=body, replaces_id=replaces_id,
img_width=img.width(), img_height=img.height())
def _parse_image(
self,
width: int,
height: int,
bytes_per_line: int,
has_alpha: bool,
bits_per_color: int,
channel_count: int,
data: QByteArray,
) -> QImage:
"""Make sure the given image data is valid and return a QImage."""
# Chromium limit?
assert 0 < width <= 320
assert 0 < height <= 320
# Based on dunst:
# https://github.com/dunst-project/dunst/blob/v1.6.1/src/icon.c#L336-L348
# (A+7)/8 rounds up A to the next byte boundary
pixelstride = (channel_count * bits_per_color + 7) // 8
expected_len = (height - 1) * bytes_per_line + width * pixelstride
assert len(data) == expected_len
assert bits_per_color == 8
assert channel_count == (4 if has_alpha else 3)
assert bytes_per_line >= width * channel_count
qimage_format = QImage.Format.Format_RGBA8888 if has_alpha else QImage.Format.Format_RGB888
img = QImage(data, width, height, bytes_per_line, qimage_format)
assert not img.isNull()
assert img.width() == width
assert img.height() == height
return img
def close(self, notification_id: int) -> None:
"""Sends a close notification for the given ID."""
message = QDBusMessage.createSignal(
notification.DBusNotificationAdapter.PATH,
notification.DBusNotificationAdapter.INTERFACE,
"NotificationClosed")
# The 2 here is the notification removal reason ("dismissed by the user")
# it's effectively arbitrary as we don't use that information
message.setArguments([
notification._as_uint32(notification_id),
notification._as_uint32(2),
])
if not self._bus.send(message):
raise OSError("Could not send close notification")
def click(self, notification_id: int) -> None:
"""Sends a click (default action) notification for the given ID."""
self.action(notification_id, "default")
def action(self, notification_id: int, name: str) -> None:
"""Sends an action notification for the given ID."""
message = QDBusMessage.createSignal(
notification.DBusNotificationAdapter.PATH,
notification.DBusNotificationAdapter.INTERFACE,
"ActionInvoked")
message.setArguments([notification._as_uint32(notification_id), name])
if not self._bus.send(message):
raise OSError("Could not send action notification")
# Everything below is exposed via DBus
# pylint: disable=invalid-name
@pyqtSlot(QDBusMessage, result="uint")
def Notify(self, dbus_message: QDBusMessage) -> int:
assert dbus_message.signature() == 'susssasa{sv}i'
assert dbus_message.type() == QDBusMessage.MessageType.MethodCallMessage
message = self._parse_notify_args(*dbus_message.arguments())
if message.replaces_id == 0:
message_id = next(self._message_id_gen)
else:
message_id = message.replaces_id
self.messages[message_id] = message
self.last_id = message_id
return message_id
@pyqtSlot(QDBusMessage, result="QStringList")
def GetCapabilities(self, message: QDBusMessage) -> List[str]:
assert not message.signature()
assert not message.arguments()
assert message.type() == QDBusMessage.MessageType.MethodCallMessage
capabilities = ["actions", "x-kde-origin-name"]
if self.supports_body_markup:
capabilities.append("body-markup")
return capabilities
@pyqtSlot(QDBusMessage)
def GetServerInformation(self, message: QDBusMessage) -> None:
name = "test notification server"
vendor = "qutebrowser"
version = "v0.0.1"
spec_version = "1.2"
self._bus.send(message.createReply([name, vendor, version, spec_version]))
@pyqtSlot(QDBusMessage)
def CloseNotification(self, dbus_message: QDBusMessage) -> None:
assert dbus_message.signature() == 'u'
assert dbus_message.type() == QDBusMessage.MessageType.MethodCallMessage
message_id = dbus_message.arguments()[0]
self.messages[message_id].closed_via_web = True
@pytest.fixture(scope='module')
def notification_server(qapp, quteproc_process):
if utils.is_windows:
# The QDBusConnection destructor seems to cause error messages (and potentially
# segfaults) on Windows, so we bail out early in that case. We still try to get
# a connection on macOS, since it's theoretically possible to run DBus there.
pytest.skip("Skipping DBus on Windows")
qb_pid = quteproc_process.proc.processId()
server = TestNotificationServer(
f"{notification.DBusNotificationAdapter.TEST_SERVICE}{qb_pid}")
registered = server.register()
if not registered:
assert not (utils.is_linux and testutils.ON_CI), "Expected DBus on Linux CI"
pytest.skip("No DBus server available")
yield server
server.unregister()
|
