Commit | Line | Data |
---|---|---|
d2d857a8 MJ |
1 | # |
2 | # Copyright (C) 2019 EfficiOS Inc. | |
3 | # | |
4 | # This program is free software; you can redistribute it and/or | |
5 | # modify it under the terms of the GNU General Public License | |
6 | # as published by the Free Software Foundation; only version 2 | |
7 | # of the License. | |
8 | # | |
9 | # This program is distributed in the hope that it will be useful, | |
10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | # GNU General Public License for more details. | |
13 | # | |
14 | # You should have received a copy of the GNU General Public License | |
15 | # along with this program; if not, write to the Free Software | |
16 | # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
17 | # | |
18 | ||
811644b8 | 19 | import unittest |
811644b8 PP |
20 | import bt2 |
21 | ||
22 | ||
23 | class UserComponentClassTestCase(unittest.TestCase): | |
24 | def _test_no_init(self, cls): | |
ce4923b0 | 25 | with self.assertRaises(RuntimeError): |
811644b8 PP |
26 | cls() |
27 | ||
28 | def test_no_init_source(self): | |
5602ef81 | 29 | class MyIter(bt2._UserMessageIterator): |
811644b8 PP |
30 | def __next__(self): |
31 | raise bt2.Stop | |
32 | ||
cfbd7cf3 | 33 | class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): |
811644b8 PP |
34 | pass |
35 | ||
36 | self._test_no_init(MySource) | |
37 | ||
38 | def test_no_init_filter(self): | |
5602ef81 | 39 | class MyIter(bt2._UserMessageIterator): |
811644b8 PP |
40 | def __next__(self): |
41 | raise bt2.Stop | |
42 | ||
cfbd7cf3 | 43 | class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyIter): |
811644b8 PP |
44 | pass |
45 | ||
46 | self._test_no_init(MyFilter) | |
47 | ||
48 | def test_no_init_sink(self): | |
49 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 50 | def _user_consume(self): |
a01b452b SM |
51 | pass |
52 | ||
811644b8 PP |
53 | self._test_no_init(MySink) |
54 | ||
5602ef81 SM |
55 | def test_incomplete_source_no_msg_iter_cls(self): |
56 | class MyIter(bt2._UserMessageIterator): | |
811644b8 PP |
57 | pass |
58 | ||
cb06aa27 | 59 | with self.assertRaises(bt2._IncompleteUserClass): |
cfbd7cf3 | 60 | |
811644b8 PP |
61 | class MySource(bt2._UserSourceComponent): |
62 | pass | |
63 | ||
5602ef81 SM |
64 | def test_incomplete_source_wrong_msg_iter_cls_type(self): |
65 | class MyIter(bt2._UserMessageIterator): | |
811644b8 PP |
66 | pass |
67 | ||
cb06aa27 | 68 | with self.assertRaises(bt2._IncompleteUserClass): |
cfbd7cf3 FD |
69 | |
70 | class MySource(bt2._UserSourceComponent, message_iterator_class=int): | |
811644b8 PP |
71 | pass |
72 | ||
5602ef81 SM |
73 | def test_incomplete_filter_no_msg_iter_cls(self): |
74 | class MyIter(bt2._UserMessageIterator): | |
811644b8 PP |
75 | pass |
76 | ||
cb06aa27 | 77 | with self.assertRaises(bt2._IncompleteUserClass): |
cfbd7cf3 | 78 | |
811644b8 PP |
79 | class MyFilter(bt2._UserFilterComponent): |
80 | pass | |
81 | ||
82 | def test_incomplete_sink_no_consume_method(self): | |
5602ef81 | 83 | class MyIter(bt2._UserMessageIterator): |
811644b8 PP |
84 | pass |
85 | ||
cb06aa27 | 86 | with self.assertRaises(bt2._IncompleteUserClass): |
cfbd7cf3 | 87 | |
811644b8 PP |
88 | class MySink(bt2._UserSinkComponent): |
89 | pass | |
90 | ||
91 | def test_minimal_source(self): | |
5602ef81 | 92 | class MyIter(bt2._UserMessageIterator): |
811644b8 PP |
93 | pass |
94 | ||
cfbd7cf3 | 95 | class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): |
811644b8 PP |
96 | pass |
97 | ||
98 | def test_minimal_filter(self): | |
5602ef81 | 99 | class MyIter(bt2._UserMessageIterator): |
811644b8 PP |
100 | pass |
101 | ||
cfbd7cf3 | 102 | class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyIter): |
811644b8 PP |
103 | pass |
104 | ||
105 | def test_minimal_sink(self): | |
106 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 107 | def _user_consume(self): |
a01b452b SM |
108 | pass |
109 | ||
811644b8 PP |
110 | def test_default_name(self): |
111 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 112 | def _user_consume(self): |
a01b452b SM |
113 | pass |
114 | ||
811644b8 PP |
115 | self.assertEqual(MySink.name, 'MySink') |
116 | ||
117 | def test_custom_name(self): | |
118 | class MySink(bt2._UserSinkComponent, name='salut'): | |
6a91742b | 119 | def _user_consume(self): |
a01b452b SM |
120 | pass |
121 | ||
811644b8 PP |
122 | self.assertEqual(MySink.name, 'salut') |
123 | ||
124 | def test_invalid_custom_name(self): | |
125 | with self.assertRaises(TypeError): | |
cfbd7cf3 | 126 | |
811644b8 | 127 | class MySink(bt2._UserSinkComponent, name=23): |
6a91742b | 128 | def _user_consume(self): |
a01b452b SM |
129 | pass |
130 | ||
811644b8 PP |
131 | def test_description(self): |
132 | class MySink(bt2._UserSinkComponent): | |
133 | """ | |
134 | The description. | |
135 | ||
136 | Bacon ipsum dolor amet ribeye t-bone corned beef, beef jerky | |
137 | porchetta burgdoggen prosciutto chicken frankfurter boudin | |
138 | hamburger doner bacon turducken. Sirloin shank sausage, | |
139 | boudin meatloaf alcatra meatball t-bone tongue pastrami | |
140 | cupim flank tenderloin. | |
141 | """ | |
142 | ||
6a91742b | 143 | def _user_consume(self): |
a01b452b SM |
144 | pass |
145 | ||
811644b8 PP |
146 | self.assertEqual(MySink.description, 'The description.') |
147 | ||
148 | def test_empty_description(self): | |
149 | class MySink(bt2._UserSinkComponent): | |
150 | """ | |
151 | """ | |
152 | ||
6a91742b | 153 | def _user_consume(self): |
a01b452b SM |
154 | pass |
155 | ||
811644b8 PP |
156 | self.assertIsNone(MySink.description) |
157 | ||
158 | def test_help(self): | |
159 | class MySink(bt2._UserSinkComponent): | |
160 | """ | |
161 | The description. | |
162 | ||
163 | The help | |
164 | text is | |
165 | here. | |
166 | """ | |
167 | ||
6a91742b | 168 | def _user_consume(self): |
a01b452b SM |
169 | pass |
170 | ||
811644b8 PP |
171 | self.assertEqual(MySink.help, 'The help\ntext is\nhere.') |
172 | ||
173 | def test_addr(self): | |
174 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 175 | def _user_consume(self): |
a01b452b SM |
176 | pass |
177 | ||
811644b8 PP |
178 | self.assertIsInstance(MySink.addr, int) |
179 | self.assertNotEqual(MySink.addr, 0) | |
180 | ||
181 | def test_query_not_implemented(self): | |
182 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 183 | def _user_consume(self): |
a01b452b SM |
184 | pass |
185 | ||
76b6c2f7 | 186 | with self.assertRaises(bt2.UnknownObject): |
3c729b9a | 187 | bt2.QueryExecutor(MySink, 'obj', 23).query() |
811644b8 PP |
188 | |
189 | def test_query_raises(self): | |
190 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 191 | def _user_consume(self): |
a01b452b SM |
192 | pass |
193 | ||
811644b8 | 194 | @classmethod |
3c729b9a | 195 | def _user_query(cls, priv_query_exec, obj, params): |
811644b8 PP |
196 | raise ValueError |
197 | ||
694c792b | 198 | with self.assertRaises(bt2._Error): |
3c729b9a | 199 | bt2.QueryExecutor(MySink, 'obj', 23).query() |
811644b8 PP |
200 | |
201 | def test_query_wrong_return_type(self): | |
202 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 203 | def _user_consume(self): |
a01b452b SM |
204 | pass |
205 | ||
811644b8 | 206 | @classmethod |
7c14d641 | 207 | def _user_query(cls, priv_query_exec, obj, params, method_obj): |
811644b8 PP |
208 | return ... |
209 | ||
694c792b | 210 | with self.assertRaises(bt2._Error): |
3c729b9a | 211 | bt2.QueryExecutor(MySink, 'obj', 23).query() |
811644b8 PP |
212 | |
213 | def test_query_params_none(self): | |
214 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 215 | def _user_consume(self): |
a01b452b SM |
216 | pass |
217 | ||
811644b8 | 218 | @classmethod |
7c14d641 | 219 | def _user_query(cls, priv_query_exec, obj, params, method_obj): |
811644b8 PP |
220 | nonlocal query_params |
221 | query_params = params | |
222 | return None | |
223 | ||
224 | query_params = None | |
225 | params = None | |
3c729b9a | 226 | res = bt2.QueryExecutor(MySink, 'obj', params).query() |
811644b8 PP |
227 | self.assertEqual(query_params, params) |
228 | self.assertIsNone(res) | |
229 | del query_params | |
230 | ||
761e1890 PP |
231 | def test_query_logging_level(self): |
232 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 233 | def _user_consume(self): |
a01b452b SM |
234 | pass |
235 | ||
761e1890 | 236 | @classmethod |
7c14d641 | 237 | def _user_query(cls, priv_query_exec, obj, params, method_obj): |
761e1890 | 238 | nonlocal query_log_level |
3c729b9a | 239 | query_log_level = priv_query_exec.logging_level |
761e1890 PP |
240 | |
241 | query_log_level = None | |
3c729b9a PP |
242 | query_exec = bt2.QueryExecutor(MySink, 'obj', None) |
243 | query_exec.logging_level = bt2.LoggingLevel.WARNING | |
244 | query_exec.query() | |
770538dd | 245 | self.assertEqual(query_log_level, bt2.LoggingLevel.WARNING) |
761e1890 PP |
246 | del query_log_level |
247 | ||
b5947615 SM |
248 | def test_query_returns_none(self): |
249 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 250 | def _user_consume(self): |
a01b452b SM |
251 | pass |
252 | ||
b5947615 | 253 | @staticmethod |
7c14d641 | 254 | def _user_query(priv_query_exec, obj, params, method_obj): |
b5947615 SM |
255 | return |
256 | ||
3c729b9a | 257 | res = bt2.QueryExecutor(MySink, 'obj', None).query() |
b5947615 SM |
258 | self.assertIsNone(res) |
259 | ||
811644b8 PP |
260 | def test_query_simple(self): |
261 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 262 | def _user_consume(self): |
a01b452b SM |
263 | pass |
264 | ||
811644b8 | 265 | @classmethod |
7c14d641 | 266 | def _user_query(cls, priv_query_exec, obj, params, method_obj): |
811644b8 PP |
267 | nonlocal query_params |
268 | query_params = params | |
269 | return 17.5 | |
270 | ||
271 | query_params = None | |
272 | params = ['coucou', 23, None] | |
3c729b9a | 273 | res = bt2.QueryExecutor(MySink, 'obj', params).query() |
811644b8 PP |
274 | self.assertEqual(query_params, params) |
275 | self.assertEqual(res, 17.5) | |
276 | del query_params | |
277 | ||
278 | def test_query_complex(self): | |
279 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 280 | def _user_consume(self): |
a01b452b SM |
281 | pass |
282 | ||
811644b8 | 283 | @classmethod |
7c14d641 | 284 | def _user_query(cls, priv_query_exec, obj, params, method_obj): |
811644b8 PP |
285 | nonlocal query_params |
286 | query_params = params | |
cfbd7cf3 | 287 | return {'null': None, 'bt2': 'BT2'} |
811644b8 PP |
288 | |
289 | query_params = None | |
290 | params = { | |
291 | 'array': ['coucou', 23, None], | |
cfbd7cf3 | 292 | 'other_map': {'yes': 'yeah', '19': 19, 'minus 1.5': -1.5}, |
811644b8 PP |
293 | 'null': None, |
294 | } | |
295 | ||
3c729b9a | 296 | res = bt2.QueryExecutor(MySink, 'obj', params).query() |
811644b8 | 297 | self.assertEqual(query_params, params) |
cfbd7cf3 | 298 | self.assertEqual(res, {'null': None, 'bt2': 'BT2'}) |
811644b8 PP |
299 | del query_params |
300 | ||
301 | def test_eq(self): | |
302 | class MySink(bt2._UserSinkComponent): | |
6a91742b | 303 | def _user_consume(self): |
a01b452b SM |
304 | pass |
305 | ||
811644b8 PP |
306 | self.assertEqual(MySink, MySink) |
307 | ||
308 | ||
68e606ef | 309 | class ComponentClassTestCase(unittest.TestCase): |
811644b8 PP |
310 | def setUp(self): |
311 | class MySink(bt2._UserSinkComponent): | |
312 | ''' | |
313 | The description. | |
314 | ||
315 | The help. | |
316 | ''' | |
cfbd7cf3 | 317 | |
6a91742b | 318 | def _user_consume(self): |
a01b452b SM |
319 | pass |
320 | ||
811644b8 | 321 | @classmethod |
7c14d641 | 322 | def _user_query(cls, priv_query_exec, obj, params, method_obj): |
811644b8 PP |
323 | return [obj, params, 23] |
324 | ||
325 | self._py_comp_cls = MySink | |
326 | graph = bt2.Graph() | |
894a8df5 | 327 | comp = graph.add_component(MySink, 'salut') |
e8ac1aae | 328 | self._comp_cls = comp.cls |
242b863f | 329 | self.assertIs(type(self._comp_cls), bt2._SinkComponentClassConst) |
811644b8 PP |
330 | |
331 | def tearDown(self): | |
332 | del self._py_comp_cls | |
333 | del self._comp_cls | |
334 | ||
335 | def test_description(self): | |
336 | self.assertEqual(self._comp_cls.description, 'The description.') | |
337 | ||
338 | def test_help(self): | |
339 | self.assertEqual(self._comp_cls.help, 'The help.') | |
340 | ||
341 | def test_name(self): | |
342 | self.assertEqual(self._comp_cls.name, 'MySink') | |
343 | ||
344 | def test_addr(self): | |
345 | self.assertIsInstance(self._comp_cls.addr, int) | |
346 | self.assertNotEqual(self._comp_cls.addr, 0) | |
347 | ||
348 | def test_eq_invalid(self): | |
349 | self.assertFalse(self._comp_cls == 23) | |
350 | ||
351 | def test_eq(self): | |
352 | self.assertEqual(self._comp_cls, self._comp_cls) | |
353 | self.assertEqual(self._py_comp_cls, self._comp_cls) | |
354 | ||
355 | def test_query(self): | |
3c729b9a | 356 | res = bt2.QueryExecutor( |
cfbd7cf3 | 357 | self._comp_cls, 'an object', {'yes': 'no', 'book': -17} |
3c729b9a | 358 | ).query() |
811644b8 PP |
359 | expected = ['an object', {'yes': 'no', 'book': -17}, 23] |
360 | self.assertEqual(res, expected) | |
d14ddbba SM |
361 | |
362 | ||
363 | if __name__ == '__main__': | |
364 | unittest.main() |