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
|
"""
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 json
import os
from pathlib import Path
from tempfile import TemporaryDirectory
import pytest
from proton.vpn.connection import VPNServer, ProtocolPorts
from proton.vpn.connection.persistence import ConnectionPersistence, ConnectionParameters
@pytest.fixture
def temp_dir() -> str:
with TemporaryDirectory(suffix=__name__) as temp_dir:
yield f"{temp_dir}"
def test_load(temp_dir: str):
with open(os.path.join(temp_dir, ConnectionPersistence.FILENAME), "w") as f:
f.write('''{
"connection_id": "connection_id",
"backend": "backend",
"protocol": "protocol",
"server": {
"server_ip": "1.2.3.4",
"openvpn_ports": {
"udp": [12345],
"tcp": [80]
},
"wireguard_ports": {
"udp": [54321],
"tcp": [81]
},
"domain": "server.domain",
"x25519pk": "public_key",
"server_id": "server_id",
"server_name": "server_name",
"has_ipv6_support": "0",
"label": "label"
}
}''')
connection_persistence = ConnectionPersistence(persistence_directory=temp_dir)
persisted_parameters = connection_persistence.load()
assert persisted_parameters.connection_id == "connection_id"
assert persisted_parameters.backend == "backend"
assert persisted_parameters.protocol == "protocol"
assert persisted_parameters.server.server_ip == "1.2.3.4"
assert persisted_parameters.server.openvpn_ports.udp == [12345]
assert persisted_parameters.server.openvpn_ports.tcp == [80]
assert persisted_parameters.server.wireguard_ports.udp == [54321]
assert persisted_parameters.server.wireguard_ports.tcp == [81]
assert persisted_parameters.server.domain == "server.domain"
assert persisted_parameters.server.x25519pk == "public_key"
assert persisted_parameters.server.server_id == "server_id"
assert persisted_parameters.server.server_name == "server_name"
assert persisted_parameters.server.label == "label"
def test_load_returns_none_and_logs_error_when_persistence_file_contains_invalid_json(temp_dir, caplog):
with open(os.path.join(temp_dir, ConnectionPersistence.FILENAME), "w") as f:
f.write('{"conn')
connection_persistence = ConnectionPersistence(persistence_directory=temp_dir)
persisted_parameters = connection_persistence.load()
assert not persisted_parameters
assert len([r for r in caplog.records if r.levelname == "WARNING"]) == 1
def test_load_returns_none_and_logs_error_when_persistence_file_misses_expected_parameters(temp_dir):
with open(os.path.join(temp_dir, ConnectionPersistence.FILENAME), "w") as f:
f.write('{"foo": "bar"}')
connection_persistence = ConnectionPersistence(persistence_directory=temp_dir)
persisted_parameters = connection_persistence.load()
assert not persisted_parameters
def test_save_(temp_dir: str):
connection_parameters = ConnectionParameters(
connection_id="connection_id",
backend="backend",
protocol="protocol",
server=VPNServer(
server_ip="1.2.3.4",
openvpn_ports=ProtocolPorts(
udp=[12345],
tcp=[80]
),
wireguard_ports=ProtocolPorts(
udp=[54321],
tcp=[81]
),
domain="server.domain",
x25519pk="public_key",
server_id="server_id",
server_name="server_name",
has_ipv6_support=False,
label="label"
)
)
connection_persistence = ConnectionPersistence(persistence_directory=temp_dir)
connection_persistence.save(connection_parameters)
with open(os.path.join(temp_dir, ConnectionPersistence.FILENAME)) as f:
persistence_file_content = json.load(f)
assert connection_parameters.connection_id == persistence_file_content["connection_id"]
assert connection_parameters.backend == persistence_file_content["backend"]
assert connection_parameters.protocol == persistence_file_content["protocol"]
assert connection_parameters.server.server_ip == persistence_file_content["server"]["server_ip"]
assert connection_parameters.server.openvpn_ports.udp == persistence_file_content["server"]["openvpn_ports"]["udp"]
assert connection_parameters.server.openvpn_ports.tcp == persistence_file_content["server"]["openvpn_ports"]["tcp"]
assert connection_parameters.server.wireguard_ports.udp == persistence_file_content["server"]["wireguard_ports"]["udp"]
assert connection_parameters.server.wireguard_ports.tcp == persistence_file_content["server"]["wireguard_ports"]["tcp"]
assert connection_parameters.server.domain == persistence_file_content["server"]["domain"]
assert connection_parameters.server.x25519pk == persistence_file_content["server"]["x25519pk"]
assert connection_parameters.server.server_id == persistence_file_content["server"]["server_id"]
assert connection_parameters.server.server_name == persistence_file_content["server"]["server_name"]
assert connection_parameters.server.label == persistence_file_content["server"]["label"]
def test_remove(temp_dir: str):
persistence_file_path = Path(temp_dir) / ConnectionPersistence.FILENAME
persistence_file_path.touch()
assert persistence_file_path.is_file()
connection_persistence = ConnectionPersistence(persistence_directory=temp_dir)
connection_persistence.remove()
assert not persistence_file_path.exists()
def test_remove_logs_a_warning_when_persistence_file_was_not_found(
temp_dir:str, caplog
):
connection_persistence = ConnectionPersistence(persistence_directory=temp_dir)
connection_persistence.remove()
assert len(caplog.records) == 1
assert len([r for r in caplog.records if r.levelname == "WARNING"]) == 1
|
