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