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
|
"""
Copyright (c) 2023 Proton AG
This file is part of Proton VPN.
Proton VPN is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Proton VPN 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with ProtonVPN. If not, see <https://www.gnu.org/licenses/>.
"""
import copy
import os
import pytest
from types import SimpleNamespace
import tempfile
import json
from proton.vpn.core.session_holder import ClientTypeMetadata
from proton.vpn.core.usage import UsageReporting
SECRET_FILE = "secret.txt"
SECRET_PATH = os.path.join("/home/wozniak/5nkfiudfmk/.cache", SECRET_FILE)
MACHINE_ID = "bg77t2rmpjhgt9zim5gkz4t78jfur39f"
SENTRY_USER_ID = "70cf75689cecae78ec588316320d76477c71031f7fd172dd5577ac95934d4499"
USERNAME = "tester"
EMAIL = "toby.tubface@bucketworld.com"
GPG_KEY_ID = "D212342HE93E32P8"
EVENT_WITH_USERNAME = {
"frames": [
{
"filename": "/home/tester/src/quick_connect_widget.py",
"abs_path": "/home/tester/src/quick_connect_widget.py",
"function": "_on_disconnect_button_clicked",
"module": "proton.vpn.app.gtk.widgets.vpn.quick_connect_widget",
"lineno": 102,
"pre_context": [
" future = self._controller.connect_to_fastest_server()",
" future.add_done_callback(lambda f: GLib.idle_add(f.result)) # bubble up exceptions if any.",
"",
" def _on_disconnect_button_clicked(self, _):",
" logger.info(\"Disconnect from VPN\", category=\"ui\", event=\"disconnect\")"
],
"context_line": " future = self._controller.disconnect()",
"post_context": [
" future.add_done_callback(lambda f: GLib.idle_add(f.result)) # bubble up exceptions if any."
],
"vars": {
"self": "<quick_connect_widget.... (proton+... at 0x601b5e322d90)>",
"_": "<Gtk.Button object at 0x7f83d4aa8140 (GtkButton at 0x601b5e37ea40)>"
},
"in_app": True
},
{
"filename": "/home/tester/src/ProtonVPN/linux/proton-vpn-gtk-app/proton/vpn/app/gtk/controller.py",
"abs_path": "/home/tester/src/ProtonVPN/linux/proton-vpn-gtk-app/proton/vpn/app/gtk/controller.py",
"function": "disconnect",
"module": "proton.vpn.app.gtk.controller",
"lineno": 224,
"pre_context": [
" :return: A Future object that resolves once the connection reaches the",
" \"disconnected\" state.",
" \"\"\"",
" error = FileNotFoundError(\"This method is not implemented\")",
" error.filename = \"/home/wozniak/randomfile.py\""
],
"context_line": " raise error",
"post_context": [
"",
" return self.executor.submit(self._connector.disconnect)",
"",
" @property",
" def account_name(self) -> str:"
],
"vars": {
"self": "<proton.vpn.app.gtk.controller.Controller object at 0x7f83e1856da0>",
"error": "FileNotFoundError('This method is not implemented')"
},
"in_app": True
}
]
}
EVENT_WITH_GPG_ID = {
"exception": {
"values": [
{
"type": "DBusErrorResponse",
"value": "[me.grimsteel.PassSecretService.GPGError] ('gpg: encrypted with cv25519 key, ID D212342HE93E32P8, created 2025-02-03\\n \"Toby (pass & proton) <toby.tubface@bucketworld.com>\"\\ngpg: [don\\'t know]: invalid packet (ctb=6c)\\ngpg: packet(5) with unknown version 18\\n',)",
}
]
}
}
EVENT_WITH_EMAIL = {
"exception": {
"values": [
{
"type": "DBusErrorResponse",
"value": "Some error that includes an email address: toby.tubface@bucketworld.com',)",
}
]
}
}
@pytest.mark.parametrize("enabled", [True, False])
def test_usage_report_enabled(enabled):
report_error = SimpleNamespace(invoked=False)
usage_reporting = UsageReporting(ClientTypeMetadata("test_usage.py", "none"))
def capture_exception(error):
report_error.invoked = True
usage_reporting.enabled = enabled
usage_reporting._capture_exception = capture_exception
EMPTY_ERROR = None
usage_reporting.report_error(EMPTY_ERROR)
assert report_error.invoked == enabled, "UsageReporting enable state does not match the error reporting"
def test_userid_calaculation():
with tempfile.NamedTemporaryFile() as file:
file.write(MACHINE_ID.encode('utf-8'))
file.seek(0)
assert UsageReporting._get_user_id(
machine_id_filepath=file.name,
user_name=USERNAME) == SENTRY_USER_ID, "Error hashing does not match the expected value"
def test_sanitize_event_for_username():
event = copy.deepcopy(EVENT_WITH_USERNAME)
UsageReporting._sanitize_event(event, None, USERNAME)
assert USERNAME in json.dumps(EVENT_WITH_USERNAME), "Username should be in the event"
assert USERNAME not in json.dumps(event), "Username should not be in the event"
def test_sanitize_event_for_email():
event = copy.deepcopy(EVENT_WITH_EMAIL)
UsageReporting._sanitize_event(event, None, USERNAME)
assert EMAIL in json.dumps(EVENT_WITH_EMAIL), "Email should be in the event"
assert EMAIL not in json.dumps(event), "Email should not be in the event"
def test_sanitize_event_for_gpg_id():
event = copy.deepcopy(EVENT_WITH_GPG_ID)
UsageReporting._sanitize_event(event, None, USERNAME)
assert GPG_KEY_ID in json.dumps(EVENT_WITH_GPG_ID), "GPG ID should be in the event"
assert GPG_KEY_ID not in json.dumps(event), "GPG ID should not be in the event"
|
