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
276
277
278
279
280
281
282
283
284
|
"""
Part of the tagit test suite.
A copy of the license is provided with the project.
Author: Matthias Baumgartner, 2022
"""
# standard imports
import unittest
# tagit imports
from tagit.config import types
from tagit.utils import errors
# objects to test
from tagit.config.schema import ConfigSchema, ConfigKey, ConfigTitle, IncompatibleTypes
## code ##
def _config_title_check(self, key0, key1):
self.assertEqual(key0, key1)
self.assertEqual(key0._title, key1._title)
self.assertEqual(key0._description, key1._description)
self.assertSetEqual(key0._modules, key1._modules)
def _config_key_check(self, key0, key1):
self.assertEqual(key0, key1)
self.assertEqual(key0._title, key1._title)
self.assertEqual(key0._description, key1._description)
self.assertSetEqual(key0._modules, key1._modules)
self.assertSetEqual(key0._examples, key1._examples)
class TestConfigSchema(unittest.TestCase):
def test_collection(self):
# getitem, call
# contains
# iter
# len
# keys
pass
def test_title(self):
schema = ConfigSchema()
# recognize title
schema.declare_title(('some', 'key'), 'module', 'title', 'description')
schema.declare(('other', 'key'), types.Int(), 0,
'module', 'title', 'description', 'example')
self.assertTrue(schema.is_title(('some', 'key')))
self.assertFalse(schema.is_title(('other', 'key')))
_config_title_check(self, schema.get_title(('some', 'key')),
ConfigTitle(('some', 'key'), 'title', 'module', 'description'))
self.assertRaises(KeyError, schema.get_title, ('other', 'key'))
# config takes precedence
schema.declare(('some', 'key'), types.Int(), 0,
'module', 'title', 'description', 'example')
self.assertFalse(schema.is_title(('some', 'key')))
# can still retrieve the title
_config_title_check(self, schema.get_title(('some', 'key')),
ConfigTitle(('some', 'key'), 'title', 'module', 'description'))
def test_declare(self):
schema = ConfigSchema()
# keys can be declared
schema.declare(('some', 'key'), types.Int(), 0,
'module', 'title', 'description', 'example')
self.assertSetEqual(set(schema.config.keys()), {('some', 'key')})
_config_key_check(self, schema.config[('some', 'key')],
ConfigKey(('some', 'key'), types.Int(), 0,
'module', 'title', 'description', 'example'))
# double insert with identical signature is accepted
schema.declare(('some', 'key'), types.Int(), 0,
'module', 'title', 'description', 'example')
self.assertSetEqual(set(schema.config.keys()), {('some', 'key')})
_config_key_check(self, schema.config[('some', 'key')],
ConfigKey(('some', 'key'), types.Int(), 0,
'module', 'title', 'description', 'example'))
# additional info is accepted
schema.declare(('some', 'key'), types.Int(), 0,
'other_module', 'other_title', 'other_description', 'other_example')
self.assertSetEqual(set(schema.config.keys()), {('some', 'key')})
ck = ConfigKey(('some', 'key'), types.Int(), 0,
'module', 'other_title', 'other_description', 'example')
ck._examples.add('other_example')
ck._modules.add('other_module')
_config_key_check(self, schema.config[('some', 'key')], ck)
# empty key is rejected
self.assertRaises(errors.ProgrammingError, schema.declare, [], types.Int(), 0)
# empty type is rejected
self.assertRaises(AttributeError, schema.declare, ('foo', ), None, None)
# invalid defaults are rejected
self.assertRaises(errors.ProgrammingError, schema.declare, ('foo', ), types.Unsigned(), -1)
self.assertRaises(errors.ProgrammingError, schema.declare, ('foo', ), types.Int(), 'abc')
self.assertRaises(errors.ProgrammingError, schema.declare, ('foo', ), types.String(), 123)
self.assertRaises(errors.ProgrammingError, schema.declare, ('foo', ), types.Enum('foo'), 'bar')
# double insert with different signature is rejected
self.assertRaises(IncompatibleTypes, schema.declare, ('some', 'key'), types.Unsigned(), 0)
self.assertRaises(IncompatibleTypes, schema.declare, ('some', 'key'), types.Int(), 2)
def test_declare_title(self):
schema = ConfigSchema()
# titles can be declared
schema.declare_title(('some', 'key'), 'module', 'title', 'description')
self.assertSetEqual(set(schema.titles.keys()), {('some', 'key')})
_config_title_check(self, schema.titles[('some', 'key')],
ConfigTitle(('some', 'key'),
'title', 'module', 'description'))
# double insert is accepted
schema.declare_title(('some', 'key'), 'module', 'title', 'description')
self.assertSetEqual(set(schema.titles.keys()), {('some', 'key')})
_config_title_check(self, schema.titles[('some', 'key')], ConfigTitle(('some', 'key'),
'title', 'module', 'description'))
# additional info is accepted
schema.declare_title(('some', 'key'), 'other_module', 'other_title', 'other_description')
self.assertSetEqual(set(schema.titles.keys()), {('some', 'key')})
ck = ConfigTitle(('some', 'key'), 'other_title', 'module', 'other_description')
ck._modules.add('other_module')
_config_title_check(self, schema.titles[('some', 'key')], ck)
# empty key is rejected
self.assertRaises(errors.ProgrammingError, schema.declare_title, [], types.Int(), 0)
# title and config key can exist in parallel
schema.declare(('other', 'key'), types.Int(), 0)
self.assertSetEqual(set(schema.config.keys()), {('other', 'key')})
_config_key_check(self, schema.config[('other', 'key')],
ConfigKey(('other', 'key'), types.Int(), 0))
schema.declare_title(('other', 'key'), 'module', 'title', 'description')
self.assertIn(('other', 'key'), set(schema.titles.keys()))
_config_title_check(self, schema.titles[('other', 'key')], ConfigTitle(('other', 'key'),
'title', 'module', 'description'))
class TestConfigTitle(unittest.TestCase):
def test_magicks(self):
ck = ConfigTitle(('some', 'key'), 'title', 'module', 'description')
# representation
self.assertEqual(repr(ck), "ConfigTitle(('some', 'key'), title)")
# comparison
self.assertEqual(ck, ConfigTitle(('some', 'key')))
self.assertEqual(hash(ck), hash(ConfigTitle(('some', 'key'))))
self.assertNotEqual(ck, ConfigTitle(('other', 'key')))
def test_properties(self):
ck = ConfigTitle(('some', 'key'), 'title', 'module', 'some_description')
# key can't be overwritten
self.assertRaises(AttributeError, ck.__setattr__, 'key', ('other', 'key'))
# modules
ck.modules = 'other_module'
self.assertSetEqual(ck.modules, {'module', 'other_module'})
ck.modules = None
self.assertSetEqual(ck.modules, {'module', 'other_module'})
ck.modules = ''
self.assertSetEqual(ck.modules, {'module', 'other_module'})
# title
ck.title = 'other_title'
self.assertEqual(ck.title, 'other_title')
ck.title = None
self.assertEqual(ck.title, 'other_title')
ck.title = ''
self.assertEqual(ck.title, 'other_title')
# description
ck.description = 'other_description'
self.assertEqual(ck.description, 'other_description')
ck.description = None
self.assertEqual(ck.description, 'other_description')
ck.description = ''
self.assertEqual(ck.description, 'other_description')
def test_tree(self):
self.assertEqual(ConfigTitle(('some', 'path', 'to', 'a', 'key')).branch,
('some', 'path', 'to', 'a'))
self.assertEqual(ConfigTitle(('some', 'path', 'to', 'a', 'key')).leaf,
'key')
self.assertEqual(ConfigTitle(('somekey', )).branch,
tuple())
self.assertEqual(ConfigTitle(('somekey', )).leaf,
'somekey')
class TestConfigKey(unittest.TestCase):
def test_magicks(self):
ck = ConfigKey(('some', 'key'), types.Int(), 0,
'module', 'title', 'some_description', 'some_example')
ck.example = 'other_example'
ck.modules = 'other_module'
# representation
self.assertEqual(repr(ck), "ConfigKey(('some', 'key'), Int, 0)")
# comparison
self.assertEqual(ck, ConfigKey(('some', 'key'), types.Int(), 0))
self.assertEqual(hash(ck), hash(ConfigKey(('some', 'key'), types.Int(), 0)))
self.assertNotEqual(ck, ConfigKey(('some', 'key'), types.Int(), 1))
self.assertNotEqual(ck, ConfigKey(('some', 'key'), types.Unsigned(), 0))
self.assertNotEqual(ck, ConfigKey(('other', 'key'), types.Int(), 0))
def test_properties(self):
ck = ConfigKey(('some', 'key'), types.Int(), 0,
'module', 'title', 'some_description', 'some_example')
self.assertEqual(ck.key, ('some', 'key'))
self.assertEqual(ck.type, types.Int())
self.assertEqual(ck.default, 0)
self.assertSetEqual(ck.modules, {'module'})
self.assertEqual(ck.title, 'title')
self.assertEqual(ck.description, 'some_description')
self.assertEqual(ck.example, 'some_example')
# key, type, default can't be overwritten
self.assertRaises(AttributeError, ck.__setattr__, 'key', ('other', 'key'))
self.assertRaises(AttributeError, ck.__setattr__, 'type', types.Unsigned())
self.assertRaises(AttributeError, ck.__setattr__, 'default', 123)
# modules
ck.modules = 'other_module'
self.assertSetEqual(ck.modules, {'module', 'other_module'})
ck.modules = None
self.assertSetEqual(ck.modules, {'module', 'other_module'})
ck.modules = ''
self.assertSetEqual(ck.modules, {'module', 'other_module'})
# title
ck.title = 'other_title'
self.assertEqual(ck.title, 'other_title')
ck.title = None
self.assertEqual(ck.title, 'other_title')
ck.title = ''
self.assertEqual(ck.title, 'other_title')
# description
ck.description = 'other_description'
self.assertEqual(ck.description, 'other_description')
ck.description = None
self.assertEqual(ck.description, 'other_description')
ck.description = ''
self.assertEqual(ck.description, 'other_description')
# example
ck.example = 'other_example'
ex = ck.example
self.assertTrue('other_example' in ex)
self.assertTrue('some_example' in ex)
ck.example = None
self.assertEqual(ck.example, ex)
ck.example = ''
self.assertEqual(ck.example, ex)
# type example if unspecified
self.assertEqual(ConfigKey(('some', 'key'), types.Int(), 0).example, types.Int().example)
def test_checks(self):
# check
self.assertTrue(ConfigKey(('some', 'key'), types.Int(), 0).check(0))
self.assertFalse(ConfigKey(('some', 'key'), types.Int(), 0).check(1.23))
self.assertFalse(ConfigKey(('some', 'key'), types.Int(), 0).check('foobar'))
self.assertTrue(ConfigKey(('some', 'key'), types.Unsigned(), 0).check(0))
self.assertFalse(ConfigKey(('some', 'key'), types.Unsigned(), 0).check(-1))
self.assertTrue(ConfigKey(('some', 'key'), types.String(), 0).check('foobar'))
self.assertFalse(ConfigKey(('some', 'key'), types.String(), 0).check(['foo', 'bar']))
# backtrack
self.assertTrue(ConfigKey(['somekey'], types.Int(), 0).backtrack(0))
self.assertTrue(ConfigKey(['somekey'], types.Int(), 0).backtrack(-1))
self.assertTrue(ConfigKey(['somekey'], types.Int(), 0).backtrack(123))
self.assertRaises(types.ConfigTypeError,
ConfigKey(['somekey'], types.Int(), 0).backtrack, 1.23)
self.assertRaises(types.ConfigTypeError,
ConfigKey(['somekey'], types.Int(), 0).backtrack, 'foobar')
self.assertTrue(ConfigKey(['somekey'], types.Unsigned(), 0).backtrack(0))
self.assertRaises(types.ConfigTypeError,
ConfigKey(['somekey'], types.Unsigned(), 0).backtrack, -1)
self.assertTrue(ConfigKey(['somekey'], types.String(), 0).backtrack('foobar'))
self.assertRaises(types.ConfigTypeError,
ConfigKey(['somekey'], types.String(), 0).backtrack, ['foo', 'bar'])
def test_tree(self):
self.assertEqual(ConfigKey(('some', 'path', 'to', 'a', 'key'), types.Int(), 0).branch,
('some', 'path', 'to', 'a'))
self.assertEqual(ConfigKey(('some', 'path', 'to', 'a', 'key'), types.Int(), 0).leaf,
'key')
self.assertEqual(ConfigKey(('somekey', ), types.Int(), 0).branch,
tuple())
self.assertEqual(ConfigKey(('somekey', ), types.Int(), 0).leaf,
'somekey')
## main ##
if __name__ == '__main__':
unittest.main()
## EOF ##
|
