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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
# -*- coding: utf-8 -*-
# test_providerconfig.py
# Copyright (C) 2013 LEAP
#
# This program 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.
#
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
"""
Tests for providerconfig
"""
try:
import unittest2 as unittest
except ImportError:
import unittest
import os
import json
import copy
from leap.bitmask.config.providerconfig import ProviderConfig, MissingCACert
from leap.bitmask.services import get_supported
from leap.common.testing.basetest import BaseLeapTest
from mock import Mock
sample_config = {
"api_uri": "https://api.test.bitmask.net:4430",
"api_version": "1",
"ca_cert_fingerprint":
"SHA256: 0f17c033115f6b76ff67871872303ff65034efe7dd1b910062ca323eb4da5c7e",
"ca_cert_uri": "https://test.bitmask.net/ca.crt",
"default_language": "en",
"description": {
"en": "Test description for provider",
"es": "Descripcion de prueba para el proveedor"
},
"domain": "test.bitmask.net",
"enrollment_policy": "open",
"languages": [
"en",
"es"
],
"name": {
"en": "Bitmask testing environment",
"es": "Entorno de pruebas de Bitmask"
},
"service": {
"allow_anonymous": True,
"allow_free": True,
"allow_limited_bandwidth": True,
"allow_paid": False,
"allow_registration": True,
"allow_unlimited_bandwidth": False,
"bandwidth_limit": 400000,
"default_service_level": 1,
"levels": [
{
"bandwidth": "limited",
"id": 1,
"name": "anonymous"
},
{
"bandwidth": "limited",
"id": 2,
"name": "free",
"storage": 50
}
]
},
"services": [
"openvpn"
]
}
class ProviderConfigTest(BaseLeapTest):
"""Tests for ProviderConfig"""
def setUp(self):
self._provider_config = ProviderConfig()
json_string = json.dumps(sample_config)
self._provider_config.load(data=json_string)
# At certain points we are going to be replacing these method
# to avoid creating a file.
# We need to save the old implementation and restore it in
# tearDown so we are sure everything is as expected for each
# test. If we do it inside each specific test, a failure in
# the test will leave the implementation with the mock.
self._old_ospath_exists = os.path.exists
def tearDown(self):
os.path.exists = self._old_ospath_exists
def test_configs_ok(self):
"""
Test if the configs loads ok
"""
# TODO: this test should go to the BaseConfig tests
pc = self._provider_config
self.assertEqual(pc.get_api_uri(), sample_config['api_uri'])
self.assertEqual(pc.get_api_version(), sample_config['api_version'])
self.assertEqual(pc.get_ca_cert_fingerprint(),
sample_config['ca_cert_fingerprint'])
self.assertEqual(pc.get_ca_cert_uri(), sample_config['ca_cert_uri'])
self.assertEqual(pc.get_default_language(),
sample_config['default_language'])
self.assertEqual(pc.get_domain(), sample_config['domain'])
self.assertEqual(pc.get_enrollment_policy(),
sample_config['enrollment_policy'])
self.assertEqual(pc.get_languages(), sample_config['languages'])
def test_localizations(self):
pc = self._provider_config
self.assertEqual(pc.get_description(lang='en'),
sample_config['description']['en'])
self.assertEqual(pc.get_description(lang='es'),
sample_config['description']['es'])
self.assertEqual(pc.get_name(lang='en'), sample_config['name']['en'])
self.assertEqual(pc.get_name(lang='es'), sample_config['name']['es'])
def _localize(self, lang):
"""
Helper to change default language of the provider config.
"""
pc = self._provider_config
config = copy.deepcopy(sample_config)
config['default_language'] = lang
json_string = json.dumps(config)
pc.load(data=json_string)
return config
def test_default_localization1(self):
pc = self._provider_config
config = self._localize(sample_config['languages'][0])
default_language = config['default_language']
default_description = config['description'][default_language]
default_name = config['name'][default_language]
self.assertEqual(pc.get_description(lang='xx'), default_description)
self.assertEqual(pc.get_description(), default_description)
self.assertEqual(pc.get_name(lang='xx'), default_name)
self.assertEqual(pc.get_name(), default_name)
def test_default_localization2(self):
pc = self._provider_config
config = self._localize(sample_config['languages'][1])
default_language = config['default_language']
default_description = config['description'][default_language]
default_name = config['name'][default_language]
self.assertEqual(pc.get_description(lang='xx'), default_description)
self.assertEqual(pc.get_description(), default_description)
self.assertEqual(pc.get_name(lang='xx'), default_name)
self.assertEqual(pc.get_name(), default_name)
def test_get_ca_cert_path_as_expected(self):
pc = self._provider_config
provider_domain = sample_config['domain']
expected_path = os.path.join('leap', 'providers',
provider_domain, 'keys', 'ca',
'cacert.pem')
# mock 'os.path.exists' so we don't get an error for unexisting file
os.path.exists = Mock(return_value=True)
cert_path = pc.get_ca_cert_path()
self.assertTrue(cert_path.endswith(expected_path))
def test_get_ca_cert_path_about_to_download(self):
pc = self._provider_config
provider_domain = sample_config['domain']
expected_path = os.path.join('leap', 'providers',
provider_domain, 'keys', 'ca',
'cacert.pem')
cert_path = pc.get_ca_cert_path(about_to_download=True)
self.assertTrue(cert_path.endswith(expected_path))
def test_get_ca_cert_path_fails(self):
pc = self._provider_config
# mock 'get_domain' so we don't need to load a config
provider_domain = 'test.provider.com'
pc.get_domain = Mock(return_value=provider_domain)
with self.assertRaises(MissingCACert):
pc.get_ca_cert_path()
def test_provides_eip(self):
pc = self._provider_config
config = copy.deepcopy(sample_config)
# It provides
config['services'] = ['openvpn', 'test_service']
json_string = json.dumps(config)
pc.load(data=json_string)
self.assertTrue(pc.provides_eip())
# It does not provides
config['services'] = ['test_service', 'other_service']
json_string = json.dumps(config)
pc.load(data=json_string)
self.assertFalse(pc.provides_eip())
def test_provides_mx(self):
pc = self._provider_config
config = copy.deepcopy(sample_config)
# It provides
config['services'] = ['mx', 'other_service']
json_string = json.dumps(config)
pc.load(data=json_string)
self.assertTrue(pc.provides_mx())
# It does not provides
config['services'] = ['test_service', 'other_service']
json_string = json.dumps(config)
pc.load(data=json_string)
self.assertFalse(pc.provides_mx())
def test_supports_unknown_service(self):
pc = self._provider_config
config = copy.deepcopy(sample_config)
config['services'] = ['unknown']
json_string = json.dumps(config)
pc.load(data=json_string)
self.assertFalse('unknown' in get_supported(pc.get_services()))
def test_provides_unknown_service(self):
pc = self._provider_config
config = copy.deepcopy(sample_config)
config['services'] = ['unknown']
json_string = json.dumps(config)
pc.load(data=json_string)
self.assertTrue('unknown' in pc.get_services())
def test_get_services_string(self):
pc = self._provider_config
config = copy.deepcopy(sample_config)
config['services'] = [
'openvpn', 'asdf', 'openvpn', 'not_supported_service']
json_string = json.dumps(config)
pc.load(data=json_string)
self.assertEqual(pc.get_services_string(),
"Encrypted Internet, asdf, Encrypted Internet,"
" not_supported_service")
if __name__ == "__main__":
unittest.main()
|
