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
|
"""
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/>.
"""
from unittest.mock import Mock
import copy
import pytest
import itertools
from proton.vpn.core.settings import Settings, SettingsPersistence, NetShield, SplitTunnelingMode
from proton.vpn.killswitch.interface import KillSwitchState
FREE_TIER = 0
PLUS_TIER = 1
@pytest.fixture
def default_free_settings_dict():
return {
"protocol": "wireguard",
"killswitch": KillSwitchState.OFF.value,
"custom_dns": {
"enabled": False,
"ip_list": []
},
"ipv6": True,
"anonymous_crash_reports": True,
"features": {
"netshield": NetShield.NO_BLOCK.value,
"moderate_nat": False,
"vpn_accelerator": True,
"port_forwarding": False,
"split_tunneling": {
"enabled": False,
"mode": SplitTunnelingMode.EXCLUDE.value,
"config_by_mode": {
SplitTunnelingMode.EXCLUDE.value: {
"mode": SplitTunnelingMode.EXCLUDE.value,
"app_paths": [],
"ip_ranges": []
},
SplitTunnelingMode.INCLUDE.value: {
"mode": SplitTunnelingMode.INCLUDE.value,
"app_paths": [],
"ip_ranges": []
},
}
},
}
}
def test_settings_get_default(default_free_settings_dict):
free_settings = Settings.default(FREE_TIER)
assert free_settings.to_dict() == default_free_settings_dict
def test_settings_save_to_disk(default_free_settings_dict):
free_settings = Settings.default(FREE_TIER)
cache_handler_mock = Mock()
sp = SettingsPersistence(cache_handler_mock)
sp.save(free_settings)
cache_handler_mock.save.assert_called_once_with(free_settings.to_dict())
def test_settings_persistence_get_returns_default_settings_and_does_not_persist_them(default_free_settings_dict):
cache_handler_mock = Mock()
cache_handler_mock.load.return_value = None
sp = SettingsPersistence(cache_handler_mock)
sp.get(FREE_TIER)
cache_handler_mock.save.assert_not_called()
def test_settings_persistence_save_persisted_settings(default_free_settings_dict):
cache_handler_mock = Mock()
sp = SettingsPersistence(cache_handler_mock)
sp.save(Settings.from_dict(default_free_settings_dict, FREE_TIER))
cache_handler_mock.save.assert_called()
def test_settings_persistence_get_returns_in_memory_settings_if_they_were_already_loaded(default_free_settings_dict):
cache_handler_mock = Mock()
cache_handler_mock.load.return_value = default_free_settings_dict
sp = SettingsPersistence(cache_handler_mock)
sp.get(FREE_TIER)
# The persistend settings should be loaded once, not twice.
cache_handler_mock.load.assert_called_once()
@pytest.mark.parametrize("user_tier", [FREE_TIER, PLUS_TIER])
def test_settings_persistence_ensure_features_are_loaded_with_default_values_based_on_user_tier(user_tier):
cache_handler_mock = Mock()
cache_handler_mock.load.return_value = None
sp = SettingsPersistence(cache_handler_mock)
settings = sp.get(user_tier)
if user_tier == FREE_TIER:
assert settings.features.netshield == NetShield.NO_BLOCK.value
else:
assert settings.features.netshield == NetShield.BLOCK_MALICIOUS_URL.value
def test_settings_persistence_delete_removes_persisted_settings(default_free_settings_dict):
cache_handler_mock = Mock()
cache_handler_mock.load.return_value = default_free_settings_dict
sp = SettingsPersistence(cache_handler_mock)
sp.get(FREE_TIER)
sp.delete()
cache_handler_mock.remove.assert_called_once()
def test_get_ipv4_custom_dns_ips_returns_only_valid_ips(default_free_settings_dict):
valid_ips = [
{"ip": "1.1.1.1"},
{"ip": "2.2.2.2"},
{"ip": "3.3.3.3"}
]
invalid_ips = [
{"ip": "asdasd"},
{"ip": "wasd2.q212.123123"},
{"ip": "123123123.123123123.123123123.123123"},
{"ip": "ef0e:e1d4:87f9:a578:5e52:fb88:46a7:010a"}
]
default_free_settings_dict["custom_dns"]["ip_list"] = list(itertools.chain.from_iterable([valid_ips, invalid_ips]))
sp = Settings.from_dict(default_free_settings_dict, FREE_TIER)
list_of_ipv4_addresses_in_string_form = [ip.exploded for ip in sp.custom_dns.get_enabled_ipv4_ips()]
assert [dns["ip"] for dns in valid_ips] == list_of_ipv4_addresses_in_string_form
def test_get_ipv6_custom_dns_ips_returns_only_valid_ips(default_free_settings_dict):
valid_ips = [
{"ip": "ef0e:e1d4:87f9:a578:5e52:fb88:46a7:010a"},
{"ip": "0275:ef68:faeb:736b:49af:36f7:1620:9308"},
{"ip": "4e69:39c4:9c55:5b26:7fa7:730e:4012:48b6"}
]
invalid_ips = [
{"ip": "asdasd"},
{"ip": "wasd2.q212.123123"},
{"ip": "1.1.1.1"},
{"ip": "2.2.2.2"},
{"ip": "3.3.3.3"},
{"ip": "123123123.123123123.123123123.123123"}
]
default_free_settings_dict["custom_dns"]["ip_list"] = list(itertools.chain.from_iterable([valid_ips, invalid_ips]))
sp = Settings.from_dict(default_free_settings_dict, FREE_TIER)
list_of_ipv6_addresses_in_string_form = [ip.exploded for ip in sp.custom_dns.get_enabled_ipv6_ips()]
assert [dns["ip"] for dns in valid_ips] == list_of_ipv6_addresses_in_string_form
def test_settings_default_split_tunneling_data_is_built_when_config_by_mode_value_is_invalid(default_free_settings_dict):
deep_copy_default_free_settings_dict = copy.deepcopy(default_free_settings_dict)
default_free_settings_dict["features"]["split_tunneling"]["config_by_mode"] = {}
free_settings = Settings.default(FREE_TIER)
free_settings.to_dict() == deep_copy_default_free_settings_dict
|
