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 | ||
b4f45851 | 19 | import unittest |
b4f45851 | 20 | import bt2 |
d47b87ac | 21 | from utils import get_default_trace_class |
b4f45851 SM |
22 | |
23 | ||
aae30e61 PP |
24 | class BoolFieldClassTestCase(unittest.TestCase): |
25 | def setUp(self): | |
26 | tc = get_default_trace_class() | |
27 | self._fc = tc.create_bool_field_class() | |
28 | ||
29 | def test_create_default(self): | |
30 | self.assertIsNotNone(self._fc) | |
31 | ||
32 | ||
d47b87ac SM |
33 | class _TestIntegerFieldClassProps: |
34 | def test_create_default(self): | |
35 | fc = self._create_func() | |
36 | self.assertEqual(fc.field_value_range, 64) | |
37 | self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.DECIMAL) | |
b4f45851 | 38 | |
d47b87ac SM |
39 | def test_create_range(self): |
40 | fc = self._create_func(field_value_range=35) | |
41 | self.assertEqual(fc.field_value_range, 35) | |
b4f45851 | 42 | |
d47b87ac SM |
43 | fc = self._create_func(36) |
44 | self.assertEqual(fc.field_value_range, 36) | |
b4f45851 | 45 | |
d47b87ac SM |
46 | def test_create_invalid_range(self): |
47 | with self.assertRaises(TypeError): | |
48 | self._create_func('yes') | |
b4f45851 | 49 | |
d47b87ac SM |
50 | with self.assertRaises(TypeError): |
51 | self._create_func(field_value_range='yes') | |
b4f45851 | 52 | |
b4f45851 | 53 | with self.assertRaises(ValueError): |
d47b87ac | 54 | self._create_func(field_value_range=-2) |
b4f45851 | 55 | |
d47b87ac SM |
56 | with self.assertRaises(ValueError): |
57 | self._create_func(field_value_range=0) | |
b4f45851 | 58 | |
d47b87ac | 59 | def test_create_base(self): |
cfbd7cf3 FD |
60 | fc = self._create_func( |
61 | preferred_display_base=bt2.IntegerDisplayBase.HEXADECIMAL | |
62 | ) | |
d47b87ac | 63 | self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.HEXADECIMAL) |
b4f45851 | 64 | |
d47b87ac | 65 | def test_create_invalid_base_type(self): |
b4f45851 | 66 | with self.assertRaises(TypeError): |
d47b87ac | 67 | self._create_func(preferred_display_base='yes') |
b4f45851 | 68 | |
d47b87ac SM |
69 | def test_create_invalid_base_value(self): |
70 | with self.assertRaises(ValueError): | |
71 | self._create_func(preferred_display_base=444) | |
b4f45851 | 72 | |
d47b87ac SM |
73 | def test_create_full(self): |
74 | fc = self._create_func(24, preferred_display_base=bt2.IntegerDisplayBase.OCTAL) | |
75 | self.assertEqual(fc.field_value_range, 24) | |
76 | self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.OCTAL) | |
b4f45851 SM |
77 | |
78 | ||
d47b87ac SM |
79 | class IntegerFieldClassTestCase(_TestIntegerFieldClassProps, unittest.TestCase): |
80 | def setUp(self): | |
81 | self._tc = get_default_trace_class() | |
82 | self._create_func = self._tc.create_signed_integer_field_class | |
b4f45851 | 83 | |
b4f45851 | 84 | |
d47b87ac SM |
85 | class RealFieldClassTestCase(unittest.TestCase): |
86 | def setUp(self): | |
87 | self._tc = get_default_trace_class() | |
b4f45851 | 88 | |
d47b87ac SM |
89 | def test_create_default(self): |
90 | fc = self._tc.create_real_field_class() | |
91 | self.assertFalse(fc.is_single_precision) | |
b4f45851 | 92 | |
d47b87ac SM |
93 | def test_create_is_single_precision(self): |
94 | fc = self._tc.create_real_field_class(is_single_precision=True) | |
95 | self.assertTrue(fc.is_single_precision) | |
96 | ||
97 | def test_create_invalid_is_single_precision(self): | |
b4f45851 | 98 | with self.assertRaises(TypeError): |
d47b87ac | 99 | self._tc.create_real_field_class(is_single_precision='hohoho') |
b4f45851 | 100 | |
b4f45851 | 101 | |
d47b87ac SM |
102 | # Converts an _EnumerationFieldClassMapping to a list of ranges: |
103 | # | |
104 | # [(lower0, upper0), (lower1, upper1), ...] | |
105 | ||
cfbd7cf3 | 106 | |
45c51519 PP |
107 | def enum_mapping_to_set(mapping): |
108 | return {(x.lower, x.upper) for x in mapping.ranges} | |
b4f45851 | 109 | |
b4f45851 | 110 | |
45c51519 | 111 | class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): |
d47b87ac SM |
112 | def setUp(self): |
113 | self._tc = get_default_trace_class() | |
45c51519 PP |
114 | self._spec_set_up() |
115 | self._fc = self._create_func() | |
d47b87ac SM |
116 | |
117 | def test_create_from_invalid_type(self): | |
b4f45851 | 118 | with self.assertRaises(TypeError): |
d47b87ac | 119 | self._create_func('coucou') |
b4f45851 | 120 | |
d47b87ac | 121 | def test_add_mapping_simple(self): |
45c51519 | 122 | self._fc.add_mapping('hello', self._ranges1) |
d47b87ac SM |
123 | mapping = self._fc['hello'] |
124 | self.assertEqual(mapping.label, 'hello') | |
45c51519 | 125 | self.assertEqual(mapping.ranges, self._ranges1) |
b4f45851 | 126 | |
d47b87ac | 127 | def test_add_mapping_simple_kwargs(self): |
45c51519 | 128 | self._fc.add_mapping(label='hello', ranges=self._ranges1) |
d47b87ac SM |
129 | mapping = self._fc['hello'] |
130 | self.assertEqual(mapping.label, 'hello') | |
45c51519 | 131 | self.assertEqual(mapping.ranges, self._ranges1) |
b4f45851 | 132 | |
45c51519 PP |
133 | def test_add_mapping_invalid_name(self): |
134 | with self.assertRaises(TypeError): | |
135 | self._fc.add_mapping(17, self._ranges1) | |
b4f45851 | 136 | |
45c51519 PP |
137 | def test_add_mapping_invalid_range(self): |
138 | with self.assertRaises(TypeError): | |
139 | self._fc.add_mapping('allo', 'meow') | |
d47b87ac | 140 | |
45c51519 | 141 | def test_add_mapping_dup_label(self): |
ce4923b0 | 142 | with self.assertRaises(ValueError): |
45c51519 PP |
143 | self._fc.add_mapping('a', self._ranges1) |
144 | self._fc.add_mapping('a', self._ranges2) | |
d47b87ac | 145 | |
45c51519 | 146 | def test_add_mapping_invalid_ranges_signedness(self): |
b4f45851 | 147 | with self.assertRaises(TypeError): |
45c51519 | 148 | self._fc.add_mapping('allo', self._inval_ranges) |
b4f45851 | 149 | |
d47b87ac | 150 | def test_iadd(self): |
45c51519 | 151 | self._fc.add_mapping('c', self._ranges1) |
b4f45851 | 152 | |
cfbd7cf3 | 153 | self._fc += [('d', self._ranges2), ('e', self._ranges3)] |
b4f45851 | 154 | |
45c51519 | 155 | self.assertEqual(len(self._fc), 3) |
d47b87ac | 156 | self.assertEqual(self._fc['c'].label, 'c') |
45c51519 | 157 | self.assertEqual(self._fc['c'].ranges, self._ranges1) |
d47b87ac | 158 | self.assertEqual(self._fc['d'].label, 'd') |
45c51519 | 159 | self.assertEqual(self._fc['d'].ranges, self._ranges2) |
d47b87ac | 160 | self.assertEqual(self._fc['e'].label, 'e') |
45c51519 | 161 | self.assertEqual(self._fc['e'].ranges, self._ranges3) |
b4f45851 | 162 | |
d47b87ac SM |
163 | def test_bool_op(self): |
164 | self.assertFalse(self._fc) | |
45c51519 | 165 | self._fc.add_mapping('a', self._ranges1) |
d47b87ac | 166 | self.assertTrue(self._fc) |
b4f45851 | 167 | |
d47b87ac | 168 | def test_len(self): |
45c51519 PP |
169 | self._fc.add_mapping('a', self._ranges1) |
170 | self._fc.add_mapping('b', self._ranges2) | |
171 | self._fc.add_mapping('c', self._ranges3) | |
d47b87ac | 172 | self.assertEqual(len(self._fc), 3) |
b4f45851 | 173 | |
d47b87ac | 174 | def test_getitem(self): |
45c51519 PP |
175 | self._fc.add_mapping('a', self._ranges1) |
176 | self._fc.add_mapping('b', self._ranges2) | |
177 | self._fc.add_mapping('c', self._ranges3) | |
d47b87ac | 178 | mapping = self._fc['a'] |
d47b87ac | 179 | self.assertEqual(mapping.label, 'a') |
45c51519 | 180 | self.assertEqual(mapping.ranges, self._ranges1) |
b4f45851 | 181 | |
45c51519 | 182 | def test_getitem_nonexistent(self): |
d47b87ac SM |
183 | with self.assertRaises(KeyError): |
184 | self._fc['doesnotexist'] | |
b4f45851 | 185 | |
d47b87ac | 186 | def test_iter(self): |
45c51519 PP |
187 | self._fc.add_mapping('a', self._ranges1) |
188 | self._fc.add_mapping('b', self._ranges2) | |
189 | self._fc.add_mapping('c', self._ranges3) | |
b4f45851 | 190 | |
d47b87ac SM |
191 | # This exercises iteration. |
192 | labels = sorted(self._fc) | |
b4f45851 | 193 | |
45c51519 | 194 | self.assertEqual(labels, ['a', 'b', 'c']) |
b4f45851 | 195 | |
d47b87ac | 196 | def test_find_by_value(self): |
45c51519 PP |
197 | self._fc.add_mapping('a', self._ranges1) |
198 | self._fc.add_mapping('b', self._ranges2) | |
199 | self._fc.add_mapping('c', self._ranges3) | |
200 | mappings = self._fc.mappings_for_value(self._value_in_range_1_and_3) | |
201 | labels = set([mapping.label for mapping in mappings]) | |
202 | expected_labels = set(['a', 'c']) | |
203 | self.assertEqual(labels, expected_labels) | |
204 | ||
205 | ||
cfbd7cf3 FD |
206 | class UnsignedEnumerationFieldClassTestCase( |
207 | _EnumerationFieldClassTestCase, unittest.TestCase | |
208 | ): | |
45c51519 PP |
209 | def _spec_set_up(self): |
210 | self._ranges1 = bt2.UnsignedIntegerRangeSet([(1, 4), (18, 47)]) | |
211 | self._ranges2 = bt2.UnsignedIntegerRangeSet([(5, 5)]) | |
212 | self._ranges3 = bt2.UnsignedIntegerRangeSet([(8, 22), (48, 99)]) | |
213 | self._inval_ranges = bt2.SignedIntegerRangeSet([(-8, -5), (48, 1928)]) | |
214 | self._value_in_range_1_and_3 = 20 | |
d47b87ac | 215 | self._create_func = self._tc.create_unsigned_enumeration_field_class |
b4f45851 | 216 | |
b4f45851 | 217 | |
cfbd7cf3 FD |
218 | class SignedEnumerationFieldClassTestCase( |
219 | _EnumerationFieldClassTestCase, unittest.TestCase | |
220 | ): | |
45c51519 PP |
221 | def _spec_set_up(self): |
222 | self._ranges1 = bt2.SignedIntegerRangeSet([(-10, -4), (18, 47)]) | |
223 | self._ranges2 = bt2.SignedIntegerRangeSet([(-3, -3)]) | |
224 | self._ranges3 = bt2.SignedIntegerRangeSet([(-100, -1), (8, 16), (48, 99)]) | |
225 | self._inval_ranges = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) | |
226 | self._value_in_range_1_and_3 = -7 | |
d47b87ac | 227 | self._create_func = self._tc.create_signed_enumeration_field_class |
b4f45851 | 228 | |
b4f45851 | 229 | |
d47b87ac | 230 | class StringFieldClassTestCase(unittest.TestCase): |
b4f45851 | 231 | def setUp(self): |
d47b87ac SM |
232 | tc = get_default_trace_class() |
233 | self._fc = tc.create_string_field_class() | |
b4f45851 SM |
234 | |
235 | def test_create_default(self): | |
d47b87ac | 236 | self.assertIsNotNone(self._fc) |
b4f45851 | 237 | |
b4f45851 | 238 | |
cfbd7cf3 | 239 | class _TestElementContainer: |
45c51519 PP |
240 | def setUp(self): |
241 | self._tc = get_default_trace_class() | |
242 | self._fc = self._create_default_fc() | |
243 | ||
244 | def test_create_default(self): | |
245 | self.assertIsNotNone(self._fc) | |
246 | ||
d47b87ac SM |
247 | def test_append_element(self): |
248 | int_field_class = self._tc.create_signed_integer_field_class(32) | |
249 | self._append_element_method(self._fc, 'int32', int_field_class) | |
45c51519 | 250 | field_class = self._fc['int32'].field_class |
d47b87ac | 251 | self.assertEqual(field_class.addr, int_field_class.addr) |
b4f45851 | 252 | |
45c51519 | 253 | def test_append_element_kwargs(self): |
d47b87ac SM |
254 | int_field_class = self._tc.create_signed_integer_field_class(32) |
255 | self._append_element_method(self._fc, name='int32', field_class=int_field_class) | |
45c51519 | 256 | field_class = self._fc['int32'].field_class |
d47b87ac SM |
257 | self.assertEqual(field_class.addr, int_field_class.addr) |
258 | ||
259 | def test_append_element_invalid_name(self): | |
260 | sub_fc = self._tc.create_string_field_class() | |
b4f45851 | 261 | |
b4f45851 | 262 | with self.assertRaises(TypeError): |
d47b87ac | 263 | self._append_element_method(self._fc, 23, sub_fc) |
b4f45851 | 264 | |
d47b87ac | 265 | def test_append_element_invalid_field_class(self): |
b4f45851 | 266 | with self.assertRaises(TypeError): |
d47b87ac | 267 | self._append_element_method(self._fc, 'yes', object()) |
b4f45851 | 268 | |
45c51519 PP |
269 | def test_append_element_dup_name(self): |
270 | sub_fc1 = self._tc.create_string_field_class() | |
271 | sub_fc2 = self._tc.create_string_field_class() | |
272 | ||
ce4923b0 | 273 | with self.assertRaises(ValueError): |
45c51519 PP |
274 | self._append_element_method(self._fc, 'yes', sub_fc1) |
275 | self._append_element_method(self._fc, 'yes', sub_fc2) | |
276 | ||
b4f45851 | 277 | def test_iadd(self): |
45c51519 | 278 | other_fc = self._create_default_fc() |
d47b87ac SM |
279 | a_field_class = self._tc.create_real_field_class() |
280 | b_field_class = self._tc.create_signed_integer_field_class(17) | |
281 | self._append_element_method(self._fc, 'a_float', a_field_class) | |
282 | self._append_element_method(self._fc, 'b_int', b_field_class) | |
45c51519 | 283 | c_field_class = self._tc.create_string_field_class() |
cfbd7cf3 FD |
284 | d_field_class = self._tc.create_signed_enumeration_field_class( |
285 | field_value_range=32 | |
286 | ) | |
45c51519 PP |
287 | e_field_class = self._tc.create_structure_field_class() |
288 | self._fc += [ | |
289 | ('c_string', c_field_class), | |
290 | ('d_enum', d_field_class), | |
291 | ('e_struct', e_field_class), | |
292 | ] | |
293 | self.assertEqual(self._fc['a_float'].field_class.addr, a_field_class.addr) | |
294 | self.assertEqual(self._fc['a_float'].name, 'a_float') | |
295 | self.assertEqual(self._fc['b_int'].field_class.addr, b_field_class.addr) | |
296 | self.assertEqual(self._fc['b_int'].name, 'b_int') | |
297 | self.assertEqual(self._fc['c_string'].field_class.addr, c_field_class.addr) | |
298 | self.assertEqual(self._fc['c_string'].name, 'c_string') | |
299 | self.assertEqual(self._fc['d_enum'].field_class.addr, d_field_class.addr) | |
300 | self.assertEqual(self._fc['d_enum'].name, 'd_enum') | |
301 | self.assertEqual(self._fc['e_struct'].field_class.addr, e_field_class.addr) | |
302 | self.assertEqual(self._fc['e_struct'].name, 'e_struct') | |
b4f45851 SM |
303 | |
304 | def test_bool_op(self): | |
305 | self.assertFalse(self._fc) | |
d47b87ac | 306 | self._append_element_method(self._fc, 'a', self._tc.create_string_field_class()) |
b4f45851 SM |
307 | self.assertTrue(self._fc) |
308 | ||
309 | def test_len(self): | |
45c51519 PP |
310 | self._append_element_method(self._fc, 'a', self._tc.create_string_field_class()) |
311 | self._append_element_method(self._fc, 'b', self._tc.create_string_field_class()) | |
312 | self._append_element_method(self._fc, 'c', self._tc.create_string_field_class()) | |
b4f45851 SM |
313 | self.assertEqual(len(self._fc), 3) |
314 | ||
315 | def test_getitem(self): | |
d47b87ac SM |
316 | a_fc = self._tc.create_signed_integer_field_class(32) |
317 | b_fc = self._tc.create_string_field_class() | |
318 | c_fc = self._tc.create_real_field_class() | |
319 | self._append_element_method(self._fc, 'a', a_fc) | |
320 | self._append_element_method(self._fc, 'b', b_fc) | |
321 | self._append_element_method(self._fc, 'c', c_fc) | |
45c51519 PP |
322 | self.assertEqual(self._fc['b'].field_class.addr, b_fc.addr) |
323 | self.assertEqual(self._fc['b'].name, 'b') | |
b4f45851 SM |
324 | |
325 | def test_getitem_invalid_key_type(self): | |
326 | with self.assertRaises(TypeError): | |
327 | self._fc[0] | |
328 | ||
329 | def test_getitem_invalid_key(self): | |
330 | with self.assertRaises(KeyError): | |
331 | self._fc['no way'] | |
332 | ||
333 | def test_contains(self): | |
334 | self.assertFalse('a' in self._fc) | |
d47b87ac | 335 | self._append_element_method(self._fc, 'a', self._tc.create_string_field_class()) |
b4f45851 SM |
336 | self.assertTrue('a' in self._fc) |
337 | ||
338 | def test_iter(self): | |
d47b87ac SM |
339 | a_fc = self._tc.create_signed_integer_field_class(32) |
340 | b_fc = self._tc.create_string_field_class() | |
341 | c_fc = self._tc.create_real_field_class() | |
cfbd7cf3 | 342 | elements = (('a', a_fc), ('b', b_fc), ('c', c_fc)) |
b4f45851 | 343 | |
45c51519 PP |
344 | for elem in elements: |
345 | self._append_element_method(self._fc, *elem) | |
b4f45851 | 346 | |
45c51519 PP |
347 | for (name, element), test_elem in zip(self._fc.items(), elements): |
348 | self.assertEqual(element.name, test_elem[0]) | |
349 | self.assertEqual(name, element.name) | |
350 | self.assertEqual(element.field_class.addr, test_elem[1].addr) | |
b4f45851 SM |
351 | |
352 | def test_at_index(self): | |
d47b87ac SM |
353 | a_fc = self._tc.create_signed_integer_field_class(32) |
354 | b_fc = self._tc.create_string_field_class() | |
355 | c_fc = self._tc.create_real_field_class() | |
356 | self._append_element_method(self._fc, 'c', c_fc) | |
357 | self._append_element_method(self._fc, 'a', a_fc) | |
358 | self._append_element_method(self._fc, 'b', b_fc) | |
45c51519 PP |
359 | elem = self._at_index_method(self._fc, 1) |
360 | self.assertEqual(elem.field_class.addr, a_fc.addr) | |
361 | self.assertEqual(elem.name, 'a') | |
b4f45851 SM |
362 | |
363 | def test_at_index_invalid(self): | |
cfbd7cf3 FD |
364 | self._append_element_method( |
365 | self._fc, 'c', self._tc.create_signed_integer_field_class(32) | |
366 | ) | |
b4f45851 SM |
367 | |
368 | with self.assertRaises(TypeError): | |
d47b87ac | 369 | self._at_index_method(self._fc, 'yes') |
b4f45851 SM |
370 | |
371 | def test_at_index_out_of_bounds_after(self): | |
cfbd7cf3 FD |
372 | self._append_element_method( |
373 | self._fc, 'c', self._tc.create_signed_integer_field_class(32) | |
374 | ) | |
b4f45851 SM |
375 | |
376 | with self.assertRaises(IndexError): | |
d47b87ac | 377 | self._at_index_method(self._fc, len(self._fc)) |
b4f45851 SM |
378 | |
379 | ||
45c51519 | 380 | class StructureFieldClassTestCase(_TestElementContainer, unittest.TestCase): |
3fb99a22 PP |
381 | _append_element_method = staticmethod(bt2._StructureFieldClass.append_member) |
382 | _at_index_method = staticmethod(bt2._StructureFieldClass.member_at_index) | |
45c51519 PP |
383 | |
384 | def _create_default_fc(self): | |
385 | return self._tc.create_structure_field_class() | |
386 | ||
387 | ||
cfbd7cf3 FD |
388 | class VariantFieldClassWithoutSelectorTestCase( |
389 | _TestElementContainer, unittest.TestCase | |
390 | ): | |
391 | _append_element_method = staticmethod( | |
3fb99a22 | 392 | bt2._VariantFieldClassWithoutSelector.append_option |
cfbd7cf3 FD |
393 | ) |
394 | _at_index_method = staticmethod( | |
3fb99a22 | 395 | bt2._VariantFieldClassWithoutSelector.option_at_index |
cfbd7cf3 | 396 | ) |
45c51519 PP |
397 | |
398 | def _create_default_fc(self): | |
399 | return self._tc.create_variant_field_class() | |
400 | ||
401 | ||
402 | class _VariantFieldClassWithSelectorTestCase: | |
b4f45851 | 403 | def setUp(self): |
d47b87ac | 404 | self._tc = get_default_trace_class() |
45c51519 PP |
405 | self._spec_set_up() |
406 | self._fc = self._create_default_fc() | |
407 | ||
408 | def _create_default_fc(self): | |
409 | return self._tc.create_variant_field_class(self._selector_fc) | |
d47b87ac SM |
410 | |
411 | def test_create_default(self): | |
412 | self.assertIsNotNone(self._fc) | |
b4f45851 | 413 | |
45c51519 PP |
414 | def test_append_element(self): |
415 | str_field_class = self._tc.create_string_field_class() | |
416 | self._fc.append_option('str', str_field_class, self._ranges1) | |
417 | opt = self._fc['str'] | |
418 | self.assertEqual(opt.field_class.addr, str_field_class.addr) | |
419 | self.assertEqual(opt.name, 'str') | |
420 | self.assertEqual(opt.ranges.addr, self._ranges1.addr) | |
421 | ||
422 | def test_append_element_kwargs(self): | |
423 | int_field_class = self._tc.create_signed_integer_field_class(32) | |
cfbd7cf3 FD |
424 | self._fc.append_option( |
425 | name='int32', field_class=int_field_class, ranges=self._ranges1 | |
426 | ) | |
45c51519 PP |
427 | opt = self._fc['int32'] |
428 | self.assertEqual(opt.field_class.addr, int_field_class.addr) | |
429 | self.assertEqual(opt.name, 'int32') | |
430 | self.assertEqual(opt.ranges.addr, self._ranges1.addr) | |
d47b87ac | 431 | |
45c51519 PP |
432 | def test_append_element_invalid_name(self): |
433 | sub_fc = self._tc.create_string_field_class() | |
b4f45851 | 434 | |
45c51519 PP |
435 | with self.assertRaises(TypeError): |
436 | self._fc.append_option(self._fc, 23, sub_fc) | |
b4f45851 | 437 | |
45c51519 PP |
438 | def test_append_element_invalid_field_class(self): |
439 | with self.assertRaises(TypeError): | |
440 | self._fc.append_option(self._fc, 'yes', object()) | |
441 | ||
442 | def test_append_element_invalid_ranges(self): | |
443 | sub_fc = self._tc.create_string_field_class() | |
444 | ||
445 | with self.assertRaises(TypeError): | |
446 | self._fc.append_option(self._fc, sub_fc, 'lel') | |
447 | ||
448 | def test_append_element_dup_name(self): | |
449 | sub_fc1 = self._tc.create_string_field_class() | |
450 | sub_fc2 = self._tc.create_string_field_class() | |
451 | ||
ce4923b0 | 452 | with self.assertRaises(ValueError): |
45c51519 PP |
453 | self._fc.append_option('yes', sub_fc1, self._ranges1) |
454 | self._fc.append_option('yes', sub_fc2, self._ranges2) | |
455 | ||
456 | def test_append_element_invalid_ranges_signedness(self): | |
457 | sub_fc = self._tc.create_string_field_class() | |
458 | ||
459 | with self.assertRaises(TypeError): | |
460 | self._fc.append_option(self._fc, sub_fc, self._inval_ranges) | |
461 | ||
462 | def test_iadd(self): | |
463 | other_fc = self._create_default_fc() | |
464 | a_field_class = self._tc.create_real_field_class() | |
465 | self._fc.append_option('a_float', a_field_class, self._ranges1) | |
466 | c_field_class = self._tc.create_string_field_class() | |
cfbd7cf3 FD |
467 | d_field_class = self._tc.create_signed_enumeration_field_class( |
468 | field_value_range=32 | |
469 | ) | |
45c51519 PP |
470 | self._fc += [ |
471 | ('c_string', c_field_class, self._ranges2), | |
472 | ('d_enum', d_field_class, self._ranges3), | |
473 | ] | |
474 | self.assertEqual(self._fc['a_float'].field_class.addr, a_field_class.addr) | |
475 | self.assertEqual(self._fc['a_float'].name, 'a_float') | |
476 | self.assertEqual(self._fc['a_float'].ranges, self._ranges1) | |
477 | self.assertEqual(self._fc['c_string'].field_class.addr, c_field_class.addr) | |
478 | self.assertEqual(self._fc['c_string'].name, 'c_string') | |
479 | self.assertEqual(self._fc['c_string'].ranges, self._ranges2) | |
480 | self.assertEqual(self._fc['d_enum'].field_class.addr, d_field_class.addr) | |
481 | self.assertEqual(self._fc['d_enum'].name, 'd_enum') | |
482 | self.assertEqual(self._fc['d_enum'].ranges, self._ranges3) | |
483 | ||
484 | def test_bool_op(self): | |
485 | self.assertFalse(self._fc) | |
486 | self._fc.append_option('a', self._tc.create_string_field_class(), self._ranges1) | |
487 | self.assertTrue(self._fc) | |
488 | ||
489 | def test_len(self): | |
490 | self._fc.append_option('a', self._tc.create_string_field_class(), self._ranges1) | |
491 | self._fc.append_option('b', self._tc.create_string_field_class(), self._ranges2) | |
492 | self._fc.append_option('c', self._tc.create_string_field_class(), self._ranges3) | |
493 | self.assertEqual(len(self._fc), 3) | |
494 | ||
495 | def test_getitem(self): | |
496 | a_fc = self._tc.create_signed_integer_field_class(32) | |
497 | b_fc = self._tc.create_string_field_class() | |
498 | c_fc = self._tc.create_real_field_class() | |
499 | self._fc.append_option('a', a_fc, self._ranges1) | |
500 | self._fc.append_option('b', b_fc, self._ranges2) | |
501 | self._fc.append_option('c', c_fc, self._ranges3) | |
502 | self.assertEqual(self._fc['b'].field_class.addr, b_fc.addr) | |
503 | self.assertEqual(self._fc['b'].name, 'b') | |
504 | self.assertEqual(self._fc['b'].ranges.addr, self._ranges2.addr) | |
505 | ||
506 | def test_getitem_invalid_key_type(self): | |
507 | with self.assertRaises(TypeError): | |
508 | self._fc[0] | |
509 | ||
510 | def test_getitem_invalid_key(self): | |
511 | with self.assertRaises(KeyError): | |
512 | self._fc['no way'] | |
513 | ||
514 | def test_contains(self): | |
515 | self.assertFalse('a' in self._fc) | |
516 | self._fc.append_option('a', self._tc.create_string_field_class(), self._ranges1) | |
517 | self.assertTrue('a' in self._fc) | |
518 | ||
519 | def test_iter(self): | |
520 | a_fc = self._tc.create_signed_integer_field_class(32) | |
521 | b_fc = self._tc.create_string_field_class() | |
522 | c_fc = self._tc.create_real_field_class() | |
523 | opts = ( | |
524 | ('a', a_fc, self._ranges1), | |
525 | ('b', b_fc, self._ranges2), | |
526 | ('c', c_fc, self._ranges3), | |
527 | ) | |
528 | ||
529 | for opt in opts: | |
530 | self._fc.append_option(*opt) | |
b4f45851 | 531 | |
45c51519 PP |
532 | for (name, opt), test_opt in zip(self._fc.items(), opts): |
533 | self.assertEqual(opt.name, test_opt[0]) | |
534 | self.assertEqual(name, opt.name) | |
535 | self.assertEqual(opt.field_class.addr, test_opt[1].addr) | |
536 | self.assertEqual(opt.ranges.addr, test_opt[2].addr) | |
537 | ||
538 | def test_at_index(self): | |
539 | a_fc = self._tc.create_signed_integer_field_class(32) | |
540 | b_fc = self._tc.create_string_field_class() | |
541 | c_fc = self._tc.create_real_field_class() | |
542 | self._fc.append_option('c', c_fc, self._ranges1) | |
543 | self._fc.append_option('a', a_fc, self._ranges2) | |
544 | self._fc.append_option('b', b_fc, self._ranges3) | |
545 | self.assertEqual(self._fc.option_at_index(1).field_class.addr, a_fc.addr) | |
546 | self.assertEqual(self._fc.option_at_index(1).name, 'a') | |
547 | self.assertEqual(self._fc.option_at_index(1).ranges.addr, self._ranges2.addr) | |
548 | ||
549 | def test_at_index_invalid(self): | |
cfbd7cf3 FD |
550 | self._fc.append_option( |
551 | 'c', self._tc.create_signed_integer_field_class(32), self._ranges3 | |
552 | ) | |
45c51519 PP |
553 | |
554 | with self.assertRaises(TypeError): | |
555 | self._fc.option_at_index('yes') | |
556 | ||
557 | def test_at_index_out_of_bounds_after(self): | |
cfbd7cf3 FD |
558 | self._fc.append_option( |
559 | 'c', self._tc.create_signed_integer_field_class(32), self._ranges3 | |
560 | ) | |
45c51519 PP |
561 | |
562 | with self.assertRaises(IndexError): | |
563 | self._fc.option_at_index(len(self._fc)) | |
564 | ||
565 | def _fill_default_fc_for_field_path_test(self): | |
d47b87ac SM |
566 | # Create something equivalent to: |
567 | # | |
568 | # struct outer_struct_fc { | |
569 | # real foo; | |
570 | # struct inner_struct_fc { | |
45c51519 | 571 | # [u]int64_t selector; |
d47b87ac SM |
572 | # string bar; |
573 | # string baz; | |
45c51519 PP |
574 | # variant <selector> { |
575 | # real a; // selected with self._ranges1 | |
576 | # int21_t b; // selected with self._ranges2 | |
577 | # uint34_t c; // selected with self._ranges3 | |
d47b87ac SM |
578 | # } variant; |
579 | # } inner_struct[2]; | |
580 | # }; | |
45c51519 | 581 | self._fc.append_option('a', self._tc.create_real_field_class(), self._ranges1) |
cfbd7cf3 FD |
582 | self._fc.append_option( |
583 | 'b', self._tc.create_signed_integer_field_class(21), self._ranges2 | |
584 | ) | |
585 | self._fc.append_option( | |
586 | 'c', self._tc.create_unsigned_integer_field_class(34), self._ranges3 | |
587 | ) | |
b4f45851 | 588 | |
d47b87ac SM |
589 | foo_fc = self._tc.create_real_field_class() |
590 | bar_fc = self._tc.create_string_field_class() | |
591 | baz_fc = self._tc.create_string_field_class() | |
b4f45851 | 592 | |
d47b87ac | 593 | inner_struct_fc = self._tc.create_structure_field_class() |
45c51519 | 594 | inner_struct_fc.append_member('selector', self._selector_fc) |
d47b87ac SM |
595 | inner_struct_fc.append_member('bar', bar_fc) |
596 | inner_struct_fc.append_member('baz', baz_fc) | |
45c51519 | 597 | inner_struct_fc.append_member('variant', self._fc) |
b4f45851 | 598 | |
cfbd7cf3 FD |
599 | inner_struct_array_fc = self._tc.create_static_array_field_class( |
600 | inner_struct_fc, 2 | |
601 | ) | |
b4f45851 | 602 | |
d47b87ac SM |
603 | outer_struct_fc = self._tc.create_structure_field_class() |
604 | outer_struct_fc.append_member('foo', foo_fc) | |
605 | outer_struct_fc.append_member('inner_struct', inner_struct_array_fc) | |
b4f45851 | 606 | |
d47b87ac SM |
607 | # The path to the selector field is resolved when the sequence is |
608 | # actually used, for example in a packet context. | |
cfbd7cf3 FD |
609 | self._tc.create_stream_class( |
610 | supports_packets=True, packet_context_field_class=outer_struct_fc | |
611 | ) | |
b4f45851 | 612 | |
d47b87ac | 613 | def test_selector_field_path_length(self): |
45c51519 PP |
614 | self._fill_default_fc_for_field_path_test() |
615 | self.assertEqual(len(self._fc.selector_field_path), 3) | |
b4f45851 | 616 | |
d47b87ac | 617 | def test_selector_field_path_iter(self): |
45c51519 PP |
618 | self._fill_default_fc_for_field_path_test() |
619 | path_items = list(self._fc.selector_field_path) | |
b4f45851 | 620 | |
d47b87ac | 621 | self.assertEqual(len(path_items), 3) |
b4f45851 | 622 | |
3fb99a22 | 623 | self.assertIsInstance(path_items[0], bt2._IndexFieldPathItem) |
d47b87ac | 624 | self.assertEqual(path_items[0].index, 1) |
b4f45851 | 625 | |
3fb99a22 | 626 | self.assertIsInstance(path_items[1], bt2._CurrentArrayElementFieldPathItem) |
b4f45851 | 627 | |
3fb99a22 | 628 | self.assertIsInstance(path_items[2], bt2._IndexFieldPathItem) |
d47b87ac | 629 | self.assertEqual(path_items[2].index, 0) |
b4f45851 | 630 | |
d47b87ac | 631 | def test_selector_field_path_root_scope(self): |
45c51519 | 632 | self._fill_default_fc_for_field_path_test() |
cfbd7cf3 | 633 | self.assertEqual( |
e7ceb9df | 634 | self._fc.selector_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT |
cfbd7cf3 | 635 | ) |
45c51519 PP |
636 | |
637 | ||
cfbd7cf3 FD |
638 | class VariantFieldClassWithUnsignedSelectorTestCase( |
639 | _VariantFieldClassWithSelectorTestCase, unittest.TestCase | |
640 | ): | |
45c51519 PP |
641 | def _spec_set_up(self): |
642 | self._ranges1 = bt2.UnsignedIntegerRangeSet([(1, 4), (18, 47)]) | |
643 | self._ranges2 = bt2.UnsignedIntegerRangeSet([(5, 5)]) | |
644 | self._ranges3 = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) | |
645 | self._inval_ranges = bt2.SignedIntegerRangeSet([(-8, 16), (48, 99)]) | |
646 | self._selector_fc = self._tc.create_unsigned_integer_field_class() | |
647 | ||
648 | ||
cfbd7cf3 FD |
649 | class VariantFieldClassWithSignedSelectorTestCase( |
650 | _VariantFieldClassWithSelectorTestCase, unittest.TestCase | |
651 | ): | |
45c51519 PP |
652 | def _spec_set_up(self): |
653 | self._ranges1 = bt2.SignedIntegerRangeSet([(-10, -4), (18, 47)]) | |
654 | self._ranges2 = bt2.SignedIntegerRangeSet([(-3, -3)]) | |
655 | self._ranges3 = bt2.SignedIntegerRangeSet([(8, 16), (48, 99)]) | |
656 | self._inval_ranges = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) | |
657 | self._selector_fc = self._tc.create_signed_integer_field_class() | |
b4f45851 | 658 | |
d47b87ac SM |
659 | |
660 | class StaticArrayFieldClassTestCase(unittest.TestCase): | |
661 | def setUp(self): | |
662 | self._tc = get_default_trace_class() | |
663 | self._elem_fc = self._tc.create_signed_integer_field_class(23) | |
b4f45851 SM |
664 | |
665 | def test_create_default(self): | |
d47b87ac SM |
666 | fc = self._tc.create_static_array_field_class(self._elem_fc, 45) |
667 | self.assertEqual(fc.element_field_class.addr, self._elem_fc.addr) | |
668 | self.assertEqual(fc.length, 45) | |
b4f45851 | 669 | |
d47b87ac | 670 | def test_create_invalid_elem_field_class(self): |
b4f45851 | 671 | with self.assertRaises(TypeError): |
d47b87ac | 672 | self._tc.create_static_array_field_class(object(), 45) |
b4f45851 SM |
673 | |
674 | def test_create_invalid_length(self): | |
675 | with self.assertRaises(ValueError): | |
cfbd7cf3 FD |
676 | self._tc.create_static_array_field_class( |
677 | self._tc.create_string_field_class(), -17 | |
678 | ) | |
b4f45851 SM |
679 | |
680 | def test_create_invalid_length_type(self): | |
681 | with self.assertRaises(TypeError): | |
cfbd7cf3 FD |
682 | self._tc.create_static_array_field_class( |
683 | self._tc.create_string_field_class(), 'the length' | |
684 | ) | |
d47b87ac SM |
685 | |
686 | ||
687 | class DynamicArrayFieldClassTestCase(unittest.TestCase): | |
688 | def setUp(self): | |
689 | self._tc = get_default_trace_class() | |
690 | self._elem_fc = self._tc.create_signed_integer_field_class(23) | |
691 | self._len_fc = self._tc.create_unsigned_integer_field_class(12) | |
b4f45851 | 692 | |
d47b87ac SM |
693 | def test_create_default(self): |
694 | fc = self._tc.create_dynamic_array_field_class(self._elem_fc) | |
695 | self.assertEqual(fc.element_field_class.addr, self._elem_fc.addr) | |
696 | self.assertIsNone(fc.length_field_path, None) | |
b4f45851 | 697 | |
d47b87ac SM |
698 | def _create_field_class_for_field_path_test(self): |
699 | # Create something a field class that is equivalent to: | |
700 | # | |
701 | # struct outer_struct_fc { | |
702 | # real foo; | |
703 | # struct inner_struct_fc { | |
704 | # string bar; | |
705 | # string baz; | |
706 | # uint12_t len; | |
707 | # uint23_t dyn_array[len]; | |
708 | # } inner_struct[2]; | |
709 | # }; | |
b4f45851 | 710 | |
d47b87ac | 711 | fc = self._tc.create_dynamic_array_field_class(self._elem_fc, self._len_fc) |
b4f45851 | 712 | |
d47b87ac SM |
713 | foo_fc = self._tc.create_real_field_class() |
714 | bar_fc = self._tc.create_string_field_class() | |
715 | baz_fc = self._tc.create_string_field_class() | |
b4f45851 | 716 | |
d47b87ac SM |
717 | inner_struct_fc = self._tc.create_structure_field_class() |
718 | inner_struct_fc.append_member('bar', bar_fc) | |
719 | inner_struct_fc.append_member('baz', baz_fc) | |
720 | inner_struct_fc.append_member('len', self._len_fc) | |
721 | inner_struct_fc.append_member('dyn_array', fc) | |
b4f45851 | 722 | |
cfbd7cf3 FD |
723 | inner_struct_array_fc = self._tc.create_static_array_field_class( |
724 | inner_struct_fc, 2 | |
725 | ) | |
d47b87ac SM |
726 | |
727 | outer_struct_fc = self._tc.create_structure_field_class() | |
728 | outer_struct_fc.append_member('foo', foo_fc) | |
729 | outer_struct_fc.append_member('inner_struct', inner_struct_array_fc) | |
730 | ||
731 | # The path to the length field is resolved when the sequence is | |
732 | # actually used, for example in a packet context. | |
cfbd7cf3 FD |
733 | self._tc.create_stream_class( |
734 | packet_context_field_class=outer_struct_fc, supports_packets=True | |
735 | ) | |
d47b87ac SM |
736 | |
737 | return fc | |
738 | ||
739 | def test_field_path_len(self): | |
740 | fc = self._create_field_class_for_field_path_test() | |
741 | self.assertEqual(len(fc.length_field_path), 3) | |
742 | ||
743 | def test_field_path_iter(self): | |
744 | fc = self._create_field_class_for_field_path_test() | |
745 | path_items = list(fc.length_field_path) | |
746 | ||
747 | self.assertEqual(len(path_items), 3) | |
748 | ||
3fb99a22 | 749 | self.assertIsInstance(path_items[0], bt2._IndexFieldPathItem) |
d47b87ac SM |
750 | self.assertEqual(path_items[0].index, 1) |
751 | ||
3fb99a22 | 752 | self.assertIsInstance(path_items[1], bt2._CurrentArrayElementFieldPathItem) |
d47b87ac | 753 | |
3fb99a22 | 754 | self.assertIsInstance(path_items[2], bt2._IndexFieldPathItem) |
d47b87ac SM |
755 | self.assertEqual(path_items[2].index, 2) |
756 | ||
757 | def test_field_path_root_scope(self): | |
758 | fc = self._create_field_class_for_field_path_test() | |
e7ceb9df PP |
759 | self.assertEqual( |
760 | fc.length_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT | |
761 | ) | |
b4f45851 SM |
762 | |
763 | def test_create_invalid_field_class(self): | |
764 | with self.assertRaises(TypeError): | |
d47b87ac | 765 | self._tc.create_dynamic_array_field_class(object()) |
b4f45851 SM |
766 | |
767 | def test_create_invalid_length_type(self): | |
768 | with self.assertRaises(TypeError): | |
cfbd7cf3 FD |
769 | self._tc.create_dynamic_array_field_class( |
770 | self._tc.create_string_field_class(), 17 | |
771 | ) | |
b4f45851 | 772 | |
b4f45851 | 773 | |
d47b87ac SM |
774 | if __name__ == "__main__": |
775 | unittest.main() |