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
|
# -*- coding: utf-8 -*-
# test_baseconfig.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 baseconfig
"""
import json
import unittest
import copy
from leap.common.config.baseconfig import BaseConfig, LocalizedKey
from leap.common.testing.basetest import BaseLeapTest
from mock import Mock
# reduced eipconfig sample config
sample_config = {
"gateways": [
{
"capabilities": {
"adblock": False,
"transport": ["openvpn"],
"user_ips": False
},
"host": "host.dev.example.org",
}, {
"capabilities": {
"adblock": False,
"transport": ["openvpn"],
"user_ips": False
},
"host": "host2.dev.example.org",
}
],
"default_language": "en",
"languages": [
"en",
"es"
],
"name": {
"en": "Baseconfig testing environment",
"es": "Entorno de pruebas de Baseconfig"
},
"serial": 1,
"version": 1
}
# reduced eipconfig.spec version
sample_spec = {
'description': 'sample eip service config',
'type': 'object',
'properties': {
'serial': {
'type': int,
'default': 1,
'required': ["True"]
},
'version': {
'type': int,
'default': 1,
'required': ["True"]
},
"default_language": {
'type': unicode,
'default': 'en'
},
'languages': {
'type': list,
'default': ['en']
},
'name': {
'type': dict,
'format': 'translatable',
'default': {u'en': u'Test Provider'}
},
'gateways': {
'type': list,
'default': [
{"capabilities": {
"adblock": True,
"transport": ["openvpn"],
"user_ips": False},
"host": "location.example.org",
}]
},
}
}
class Config(BaseConfig):
"""
BaseConfig implementation for testing purposes only.
"""
def get_gateways(self):
return self._safe_get_value("gateways")
def get_serial(self):
return self._safe_get_value("serial")
def get_version(self):
return self._safe_get_value("version")
def _get_schema(self):
return sample_spec
def _get_spec(self):
return self._get_schema()
def get_default_language(self):
return self._safe_get_value("default_language")
@LocalizedKey
def get_name(self):
return self._safe_get_value("name")
class BaseConfigTest(BaseLeapTest):
def setUp(self):
pass
def tearDown(self):
pass
def _write_config(self, data):
"""
Helper to write some data to a temp config file.
:param data: data to be used to save in the config file.
:data type: dict (valid json)
"""
self.config_file = self.get_tempfile("config.json")
conf = open(self.config_file, "w")
conf.write(json.dumps(data))
conf.close()
def _get_config(self, fromfile=False, data=sample_config):
"""
Helper that returns a Config object using the data parameter
or a sample data.
:param fromfile: sets if we should use a file or a string
:fromfile type: bool
:param data: sets the data to be used to load in the Config object
:data type: dict (valid json)
:rtype: Config
"""
config = Config()
loaded = False
if fromfile:
self._write_config(data)
loaded = config.load(self.config_file, relative=False)
else:
json_string = json.dumps(data)
loaded = config.load(data=json_string)
if not loaded:
return None
return config
def test_loads_from_file(self):
config = self._get_config(fromfile=True)
self.assertIsNotNone(config)
def test_loads_from_data(self):
config = self._get_config()
self.assertIsNotNone(config)
def test_load_valid_config_from_file(self):
config = self._get_config(fromfile=True)
self.assertIsNotNone(config)
self.assertEqual(config.get_version(), sample_config["version"])
self.assertEqual(config.get_serial(), sample_config["serial"])
self.assertEqual(config.get_gateways(), sample_config["gateways"])
def test_load_valid_config_from_data(self):
config = self._get_config()
self.assertIsNotNone(config)
self.assertEqual(config.get_version(), sample_config["version"])
self.assertEqual(config.get_serial(), sample_config["serial"])
self.assertEqual(config.get_gateways(), sample_config["gateways"])
def test_safe_get_value_no_config(self):
config = Config()
with self.assertRaises(AssertionError):
config.get_version()
def test_safe_get_value_non_existent_value(self):
config = self._get_config()
self.assertIsNone(config._safe_get_value('non-existent-value'))
def test_loaded(self):
config = self._get_config()
self.assertTrue(config.loaded())
def test_not_loaded(self):
config = Config()
self.assertFalse(config.loaded())
def test_save_and_load(self):
config = self._get_config()
config.get_path_prefix = Mock(return_value=self.tempdir)
config_file = 'test_config.json'
self.assertTrue(config.save([config_file]))
config_saved = Config()
config_file_path = self.get_tempfile(config_file)
self.assertTrue(config_saved.load(config_file_path, relative=False))
self.assertEqual(config.get_version(), config_saved.get_version())
self.assertEqual(config.get_serial(), config_saved.get_serial())
self.assertEqual(config.get_gateways(), config_saved.get_gateways())
def test_localizations(self):
conf = self._get_config()
self.assertEqual(conf.get_name(lang='en'), sample_config['name']['en'])
self.assertEqual(conf.get_name(lang='es'), sample_config['name']['es'])
def _localized_config(self, lang):
"""
Helper to change default language of the provider config.
"""
conf = copy.deepcopy(sample_config)
conf['default_language'] = lang
json_string = json.dumps(conf)
config = Config()
config.load(data=json_string)
return config
def test_default_localization1(self):
default_language = sample_config['languages'][0]
config = self._localized_config(default_language)
default_name = sample_config['name'][default_language]
self.assertEqual(config.get_name(lang='xx'), default_name)
self.assertEqual(config.get_name(), default_name)
def test_default_localization2(self):
default_language = sample_config['languages'][1]
config = self._localized_config(default_language)
default_name = sample_config['name'][default_language]
self.assertEqual(config.get_name(lang='xx'), default_name)
self.assertEqual(config.get_name(), default_name)
if __name__ == "__main__":
unittest.main(verbosity=2)
|
