Commit | Line | Data |
---|---|---|
0235b0db | 1 | # SPDX-License-Identifier: GPL-2.0-only |
d2d857a8 MJ |
2 | # |
3 | # Copyright (C) 2019 EfficiOS Inc. | |
4 | # | |
d2d857a8 | 5 | |
b4f45851 | 6 | import unittest |
5995b304 | 7 | |
b4f45851 | 8 | import bt2 |
f0a42b33 FD |
9 | from bt2 import value as bt2_value |
10 | from bt2 import field_class as bt2_field_class | |
5995b304 | 11 | from utils import TestOutputPortMessageIterator, get_default_trace_class |
f0a42b33 FD |
12 | |
13 | ||
14 | def _create_stream(tc, ctx_field_classes): | |
15 | packet_context_fc = tc.create_structure_field_class() | |
16 | for name, fc in ctx_field_classes: | |
17 | packet_context_fc.append_member(name, fc) | |
18 | ||
19 | trace = tc() | |
20 | stream_class = tc.create_stream_class( | |
21 | packet_context_field_class=packet_context_fc, supports_packets=True | |
22 | ) | |
23 | ||
24 | stream = trace.create_stream(stream_class) | |
25 | return stream | |
26 | ||
27 | ||
28 | def _create_const_field_class(tc, field_class, value_setter_fn): | |
f5567ea8 | 29 | field_name = "const field" |
f0a42b33 FD |
30 | |
31 | class MyIter(bt2._UserMessageIterator): | |
8d8b141d | 32 | def __init__(self, config, self_port_output): |
f0a42b33 FD |
33 | nonlocal field_class |
34 | nonlocal value_setter_fn | |
35 | stream = _create_stream(tc, [(field_name, field_class)]) | |
36 | packet = stream.create_packet() | |
37 | ||
38 | value_setter_fn(packet.context_field[field_name]) | |
39 | ||
40 | self._msgs = [ | |
41 | self._create_stream_beginning_message(stream), | |
42 | self._create_packet_beginning_message(packet), | |
43 | ] | |
44 | ||
45 | def __next__(self): | |
46 | if len(self._msgs) == 0: | |
47 | raise StopIteration | |
48 | ||
49 | return self._msgs.pop(0) | |
50 | ||
51 | class MySrc(bt2._UserSourceComponent, message_iterator_class=MyIter): | |
59225a3e | 52 | def __init__(self, config, params, obj): |
f5567ea8 | 53 | self._add_output_port("out", params) |
f0a42b33 FD |
54 | |
55 | graph = bt2.Graph() | |
f5567ea8 FD |
56 | src_comp = graph.add_component(MySrc, "my_source", None) |
57 | msg_iter = TestOutputPortMessageIterator(graph, src_comp.output_ports["out"]) | |
f0a42b33 FD |
58 | |
59 | # Ignore first message, stream beginning | |
60 | _ = next(msg_iter) | |
61 | packet_beg_msg = next(msg_iter) | |
62 | ||
63 | return packet_beg_msg.packet.context_field[field_name].cls | |
b4f45851 SM |
64 | |
65 | ||
5783664e PP |
66 | class _TestFieldClass: |
67 | def test_create_user_attributes(self): | |
f5567ea8 FD |
68 | fc = self._create_default_field_class(user_attributes={"salut": 23}) |
69 | self.assertEqual(fc.user_attributes, {"salut": 23}) | |
f0a42b33 FD |
70 | self.assertIs(type(fc.user_attributes), bt2_value.MapValue) |
71 | ||
72 | def test_const_create_user_attributes(self): | |
f5567ea8 FD |
73 | fc = self._create_default_const_field_class(user_attributes={"salut": 23}) |
74 | self.assertEqual(fc.user_attributes, {"salut": 23}) | |
f0a42b33 | 75 | self.assertIs(type(fc.user_attributes), bt2_value._MapValueConst) |
5783664e PP |
76 | |
77 | def test_create_invalid_user_attributes(self): | |
78 | with self.assertRaises(TypeError): | |
79 | self._create_default_field_class(user_attributes=object()) | |
80 | ||
81 | def test_create_invalid_user_attributes_value_type(self): | |
82 | with self.assertRaises(TypeError): | |
83 | self._create_default_field_class(user_attributes=23) | |
84 | ||
85 | ||
86 | class BoolFieldClassTestCase(_TestFieldClass, unittest.TestCase): | |
f0a42b33 FD |
87 | @staticmethod |
88 | def _const_value_setter(field): | |
d47b6b4e | 89 | field.value = False |
f0a42b33 | 90 | |
5783664e | 91 | def _create_default_field_class(self, **kwargs): |
aae30e61 | 92 | tc = get_default_trace_class() |
5783664e PP |
93 | return tc.create_bool_field_class(**kwargs) |
94 | ||
f0a42b33 FD |
95 | def _create_default_const_field_class(self, *args, **kwargs): |
96 | tc = get_default_trace_class() | |
97 | fc = tc.create_bool_field_class(*args, **kwargs) | |
98 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
99 | ||
5783664e PP |
100 | def setUp(self): |
101 | self._fc = self._create_default_field_class() | |
f0a42b33 | 102 | self._fc_const = self._create_default_const_field_class() |
aae30e61 PP |
103 | |
104 | def test_create_default(self): | |
105 | self.assertIsNotNone(self._fc) | |
5783664e | 106 | self.assertEqual(len(self._fc.user_attributes), 0) |
aae30e61 PP |
107 | |
108 | ||
5783664e | 109 | class BitArrayFieldClassTestCase(_TestFieldClass, unittest.TestCase): |
f0a42b33 FD |
110 | @staticmethod |
111 | def _const_value_setter(field): | |
d47b6b4e | 112 | field.value = [] |
f0a42b33 | 113 | |
5783664e PP |
114 | def _create_field_class(self, *args, **kwargs): |
115 | tc = get_default_trace_class() | |
116 | return tc.create_bit_array_field_class(*args, **kwargs) | |
117 | ||
118 | def _create_default_field_class(self, **kwargs): | |
119 | return self._create_field_class(17, **kwargs) | |
120 | ||
f0a42b33 FD |
121 | def _create_default_const_field_class(self, *args, **kwargs): |
122 | tc = get_default_trace_class() | |
123 | fc = tc.create_bit_array_field_class(17, **kwargs) | |
124 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
125 | ||
ead8c3d4 | 126 | def setUp(self): |
5783664e | 127 | self._fc = self._create_default_field_class() |
ead8c3d4 PP |
128 | |
129 | def test_create_default(self): | |
130 | self.assertIsNotNone(self._fc) | |
5783664e | 131 | self.assertEqual(len(self._fc.user_attributes), 0) |
ead8c3d4 PP |
132 | |
133 | def test_create_length_out_of_range(self): | |
134 | with self.assertRaises(ValueError): | |
5783664e | 135 | self._create_field_class(65) |
ead8c3d4 PP |
136 | |
137 | def test_create_length_zero(self): | |
138 | with self.assertRaises(ValueError): | |
5783664e | 139 | self._create_field_class(0) |
ead8c3d4 PP |
140 | |
141 | def test_create_length_invalid_type(self): | |
142 | with self.assertRaises(TypeError): | |
f5567ea8 | 143 | self._create_field_class("lel") |
ead8c3d4 PP |
144 | |
145 | def test_length_prop(self): | |
146 | self.assertEqual(self._fc.length, 17) | |
147 | ||
148 | ||
d47b87ac SM |
149 | class _TestIntegerFieldClassProps: |
150 | def test_create_default(self): | |
5783664e | 151 | fc = self._create_default_field_class() |
d47b87ac SM |
152 | self.assertEqual(fc.field_value_range, 64) |
153 | self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.DECIMAL) | |
5783664e | 154 | self.assertEqual(len(fc.user_attributes), 0) |
b4f45851 | 155 | |
d47b87ac | 156 | def test_create_range(self): |
5783664e | 157 | fc = self._create_field_class(field_value_range=35) |
d47b87ac | 158 | self.assertEqual(fc.field_value_range, 35) |
b4f45851 | 159 | |
5783664e | 160 | fc = self._create_field_class(36) |
d47b87ac | 161 | self.assertEqual(fc.field_value_range, 36) |
b4f45851 | 162 | |
d47b87ac SM |
163 | def test_create_invalid_range(self): |
164 | with self.assertRaises(TypeError): | |
f5567ea8 | 165 | self._create_field_class("yes") |
b4f45851 | 166 | |
d47b87ac | 167 | with self.assertRaises(TypeError): |
f5567ea8 | 168 | self._create_field_class(field_value_range="yes") |
b4f45851 | 169 | |
b4f45851 | 170 | with self.assertRaises(ValueError): |
5783664e | 171 | self._create_field_class(field_value_range=-2) |
b4f45851 | 172 | |
d47b87ac | 173 | with self.assertRaises(ValueError): |
5783664e | 174 | self._create_field_class(field_value_range=0) |
b4f45851 | 175 | |
d47b87ac | 176 | def test_create_base(self): |
5783664e | 177 | fc = self._create_field_class( |
cfbd7cf3 FD |
178 | preferred_display_base=bt2.IntegerDisplayBase.HEXADECIMAL |
179 | ) | |
d47b87ac | 180 | self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.HEXADECIMAL) |
b4f45851 | 181 | |
d47b87ac | 182 | def test_create_invalid_base_type(self): |
b4f45851 | 183 | with self.assertRaises(TypeError): |
f5567ea8 | 184 | self._create_field_class(preferred_display_base="yes") |
b4f45851 | 185 | |
d47b87ac SM |
186 | def test_create_invalid_base_value(self): |
187 | with self.assertRaises(ValueError): | |
5783664e | 188 | self._create_field_class(preferred_display_base=444) |
b4f45851 | 189 | |
d47b87ac | 190 | def test_create_full(self): |
5783664e PP |
191 | fc = self._create_field_class( |
192 | 24, preferred_display_base=bt2.IntegerDisplayBase.OCTAL | |
193 | ) | |
d47b87ac SM |
194 | self.assertEqual(fc.field_value_range, 24) |
195 | self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.OCTAL) | |
b4f45851 SM |
196 | |
197 | ||
5783664e PP |
198 | class SignedIntegerFieldClassTestCase( |
199 | _TestIntegerFieldClassProps, _TestFieldClass, unittest.TestCase | |
200 | ): | |
f0a42b33 FD |
201 | @staticmethod |
202 | def _const_value_setter(field): | |
d47b6b4e | 203 | field.value = -18 |
f0a42b33 | 204 | |
5783664e PP |
205 | def _create_field_class(self, *args, **kwargs): |
206 | tc = get_default_trace_class() | |
207 | return tc.create_signed_integer_field_class(*args, **kwargs) | |
b4f45851 | 208 | |
f0a42b33 FD |
209 | def _create_default_const_field_class(self, *args, **kwargs): |
210 | tc = get_default_trace_class() | |
211 | fc = tc.create_signed_integer_field_class(*args, **kwargs) | |
212 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
213 | ||
5783664e PP |
214 | _create_default_field_class = _create_field_class |
215 | ||
216 | ||
217 | class UnsignedIntegerFieldClassTestCase( | |
218 | _TestIntegerFieldClassProps, _TestFieldClass, unittest.TestCase | |
219 | ): | |
f0a42b33 FD |
220 | @staticmethod |
221 | def _const_value_setter(field): | |
d47b6b4e | 222 | field.value = 18 |
f0a42b33 | 223 | |
5783664e PP |
224 | def _create_field_class(self, *args, **kwargs): |
225 | tc = get_default_trace_class() | |
226 | return tc.create_unsigned_integer_field_class(*args, **kwargs) | |
227 | ||
f0a42b33 FD |
228 | def _create_default_const_field_class(self, *args, **kwargs): |
229 | tc = get_default_trace_class() | |
230 | fc = tc.create_signed_integer_field_class(*args, **kwargs) | |
231 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
232 | ||
5783664e | 233 | _create_default_field_class = _create_field_class |
b4f45851 | 234 | |
5783664e | 235 | |
fe4df857 | 236 | class SingleRealFieldClassTestCase(_TestFieldClass, unittest.TestCase): |
f0a42b33 FD |
237 | @staticmethod |
238 | def _const_value_setter(field): | |
fe4df857 | 239 | field.value = -18.0 |
f0a42b33 | 240 | |
5783664e PP |
241 | def _create_field_class(self, *args, **kwargs): |
242 | tc = get_default_trace_class() | |
fe4df857 | 243 | return tc.create_single_precision_real_field_class(*args, **kwargs) |
5783664e | 244 | |
f0a42b33 FD |
245 | def _create_default_const_field_class(self, *args, **kwargs): |
246 | tc = get_default_trace_class() | |
fe4df857 | 247 | fc = tc.create_single_precision_real_field_class(*args, **kwargs) |
f0a42b33 FD |
248 | return _create_const_field_class(tc, fc, self._const_value_setter) |
249 | ||
5783664e | 250 | _create_default_field_class = _create_field_class |
b4f45851 | 251 | |
d47b87ac | 252 | def test_create_default(self): |
5783664e | 253 | fc = self._create_field_class() |
5783664e | 254 | self.assertEqual(len(fc.user_attributes), 0) |
b4f45851 | 255 | |
d47b87ac | 256 | |
fe4df857 FD |
257 | class DoubleRealFieldClassTestCase(_TestFieldClass, unittest.TestCase): |
258 | @staticmethod | |
259 | def _const_value_setter(field): | |
260 | field.value = -18.0 | |
261 | ||
262 | def _create_field_class(self, *args, **kwargs): | |
263 | tc = get_default_trace_class() | |
264 | return tc.create_double_precision_real_field_class(*args, **kwargs) | |
265 | ||
266 | def _create_default_const_field_class(self, *args, **kwargs): | |
267 | tc = get_default_trace_class() | |
268 | fc = tc.create_double_precision_real_field_class(*args, **kwargs) | |
269 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
270 | ||
271 | _create_default_field_class = _create_field_class | |
272 | ||
273 | def test_create_default(self): | |
274 | fc = self._create_field_class() | |
275 | self.assertEqual(len(fc.user_attributes), 0) | |
b4f45851 | 276 | |
b4f45851 | 277 | |
d47b87ac SM |
278 | # Converts an _EnumerationFieldClassMapping to a list of ranges: |
279 | # | |
280 | # [(lower0, upper0), (lower1, upper1), ...] | |
281 | ||
cfbd7cf3 | 282 | |
45c51519 PP |
283 | def enum_mapping_to_set(mapping): |
284 | return {(x.lower, x.upper) for x in mapping.ranges} | |
b4f45851 | 285 | |
b4f45851 | 286 | |
45c51519 | 287 | class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): |
d47b87ac | 288 | def setUp(self): |
45c51519 | 289 | self._spec_set_up() |
5783664e | 290 | self._fc = self._create_default_field_class() |
f0a42b33 | 291 | self._fc_const = self._create_default_const_field_class() |
d47b87ac SM |
292 | |
293 | def test_create_from_invalid_type(self): | |
b4f45851 | 294 | with self.assertRaises(TypeError): |
f5567ea8 | 295 | self._create_field_class("coucou") |
b4f45851 | 296 | |
d47b87ac | 297 | def test_add_mapping_simple(self): |
f5567ea8 FD |
298 | self._fc.add_mapping("hello", self._ranges1) |
299 | mapping = self._fc["hello"] | |
300 | self.assertEqual(mapping.label, "hello") | |
45c51519 | 301 | self.assertEqual(mapping.ranges, self._ranges1) |
b4f45851 | 302 | |
f0a42b33 FD |
303 | def test_const_add_mapping(self): |
304 | with self.assertRaises(AttributeError): | |
f5567ea8 | 305 | self._fc_const.add_mapping("hello", self._ranges1) |
f0a42b33 | 306 | |
d47b87ac | 307 | def test_add_mapping_simple_kwargs(self): |
f5567ea8 FD |
308 | self._fc.add_mapping(label="hello", ranges=self._ranges1) |
309 | mapping = self._fc["hello"] | |
310 | self.assertEqual(mapping.label, "hello") | |
45c51519 | 311 | self.assertEqual(mapping.ranges, self._ranges1) |
b4f45851 | 312 | |
45c51519 PP |
313 | def test_add_mapping_invalid_name(self): |
314 | with self.assertRaises(TypeError): | |
315 | self._fc.add_mapping(17, self._ranges1) | |
b4f45851 | 316 | |
45c51519 PP |
317 | def test_add_mapping_invalid_range(self): |
318 | with self.assertRaises(TypeError): | |
f5567ea8 | 319 | self._fc.add_mapping("allo", "meow") |
d47b87ac | 320 | |
45c51519 | 321 | def test_add_mapping_dup_label(self): |
ce4923b0 | 322 | with self.assertRaises(ValueError): |
f5567ea8 FD |
323 | self._fc.add_mapping("a", self._ranges1) |
324 | self._fc.add_mapping("a", self._ranges2) | |
d47b87ac | 325 | |
45c51519 | 326 | def test_add_mapping_invalid_ranges_signedness(self): |
b4f45851 | 327 | with self.assertRaises(TypeError): |
f5567ea8 | 328 | self._fc.add_mapping("allo", self._inval_ranges) |
b4f45851 | 329 | |
d47b87ac | 330 | def test_iadd(self): |
f5567ea8 | 331 | self._fc.add_mapping("c", self._ranges1) |
b4f45851 | 332 | |
f5567ea8 | 333 | self._fc += [("d", self._ranges2), ("e", self._ranges3)] |
b4f45851 | 334 | |
45c51519 | 335 | self.assertEqual(len(self._fc), 3) |
f5567ea8 FD |
336 | self.assertEqual(self._fc["c"].label, "c") |
337 | self.assertEqual(self._fc["c"].ranges, self._ranges1) | |
338 | self.assertEqual(self._fc["d"].label, "d") | |
339 | self.assertEqual(self._fc["d"].ranges, self._ranges2) | |
340 | self.assertEqual(self._fc["e"].label, "e") | |
341 | self.assertEqual(self._fc["e"].ranges, self._ranges3) | |
b4f45851 | 342 | |
f0a42b33 FD |
343 | def test_const_iadd(self): |
344 | with self.assertRaises(TypeError): | |
f5567ea8 | 345 | self._fc_const += [("d", self._ranges2), ("e", self._ranges3)] |
f0a42b33 | 346 | |
d47b87ac SM |
347 | def test_bool_op(self): |
348 | self.assertFalse(self._fc) | |
f5567ea8 | 349 | self._fc.add_mapping("a", self._ranges1) |
d47b87ac | 350 | self.assertTrue(self._fc) |
b4f45851 | 351 | |
d47b87ac | 352 | def test_len(self): |
f5567ea8 FD |
353 | self._fc.add_mapping("a", self._ranges1) |
354 | self._fc.add_mapping("b", self._ranges2) | |
355 | self._fc.add_mapping("c", self._ranges3) | |
d47b87ac | 356 | self.assertEqual(len(self._fc), 3) |
b4f45851 | 357 | |
d47b87ac | 358 | def test_getitem(self): |
f5567ea8 FD |
359 | self._fc.add_mapping("a", self._ranges1) |
360 | self._fc.add_mapping("b", self._ranges2) | |
361 | self._fc.add_mapping("c", self._ranges3) | |
362 | mapping = self._fc["a"] | |
363 | self.assertEqual(mapping.label, "a") | |
45c51519 | 364 | self.assertEqual(mapping.ranges, self._ranges1) |
fc866000 FD |
365 | self.assertIs(type(mapping), self._MAPPING_CLASS) |
366 | self.assertIs(type(mapping.ranges), self._CONST_RANGE_SET_CLASS) | |
b4f45851 | 367 | |
45c51519 | 368 | def test_getitem_nonexistent(self): |
d47b87ac | 369 | with self.assertRaises(KeyError): |
f5567ea8 | 370 | self._fc["doesnotexist"] |
b4f45851 | 371 | |
d47b87ac | 372 | def test_iter(self): |
f5567ea8 FD |
373 | self._fc.add_mapping("a", self._ranges1) |
374 | self._fc.add_mapping("b", self._ranges2) | |
375 | self._fc.add_mapping("c", self._ranges3) | |
b4f45851 | 376 | |
d47b87ac SM |
377 | # This exercises iteration. |
378 | labels = sorted(self._fc) | |
b4f45851 | 379 | |
f5567ea8 | 380 | self.assertEqual(labels, ["a", "b", "c"]) |
b4f45851 | 381 | |
d47b87ac | 382 | def test_find_by_value(self): |
f5567ea8 FD |
383 | self._fc.add_mapping("a", self._ranges1) |
384 | self._fc.add_mapping("b", self._ranges2) | |
385 | self._fc.add_mapping("c", self._ranges3) | |
45c51519 PP |
386 | mappings = self._fc.mappings_for_value(self._value_in_range_1_and_3) |
387 | labels = set([mapping.label for mapping in mappings]) | |
f5567ea8 | 388 | expected_labels = set(["a", "c"]) |
45c51519 PP |
389 | self.assertEqual(labels, expected_labels) |
390 | ||
391 | ||
cfbd7cf3 | 392 | class UnsignedEnumerationFieldClassTestCase( |
5783664e | 393 | _EnumerationFieldClassTestCase, _TestFieldClass, unittest.TestCase |
cfbd7cf3 | 394 | ): |
fc866000 FD |
395 | _MAPPING_CLASS = bt2_field_class._UnsignedEnumerationFieldClassMappingConst |
396 | _RANGE_SET_CLASS = bt2.UnsignedIntegerRangeSet | |
397 | _CONST_RANGE_SET_CLASS = bt2._UnsignedIntegerRangeSetConst | |
398 | ||
45c51519 PP |
399 | def _spec_set_up(self): |
400 | self._ranges1 = bt2.UnsignedIntegerRangeSet([(1, 4), (18, 47)]) | |
401 | self._ranges2 = bt2.UnsignedIntegerRangeSet([(5, 5)]) | |
402 | self._ranges3 = bt2.UnsignedIntegerRangeSet([(8, 22), (48, 99)]) | |
403 | self._inval_ranges = bt2.SignedIntegerRangeSet([(-8, -5), (48, 1928)]) | |
404 | self._value_in_range_1_and_3 = 20 | |
5783664e | 405 | |
f0a42b33 FD |
406 | @staticmethod |
407 | def _const_value_setter(field): | |
d47b6b4e | 408 | field.value = 0 |
f0a42b33 | 409 | |
5783664e PP |
410 | def _create_field_class(self, *args, **kwargs): |
411 | tc = get_default_trace_class() | |
412 | return tc.create_unsigned_enumeration_field_class(*args, **kwargs) | |
413 | ||
f0a42b33 FD |
414 | def _create_default_const_field_class(self, *args, **kwargs): |
415 | tc = get_default_trace_class() | |
416 | fc = tc.create_unsigned_enumeration_field_class(*args, **kwargs) | |
417 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
418 | ||
5783664e | 419 | _create_default_field_class = _create_field_class |
b4f45851 | 420 | |
b4f45851 | 421 | |
cfbd7cf3 | 422 | class SignedEnumerationFieldClassTestCase( |
5783664e | 423 | _EnumerationFieldClassTestCase, _TestFieldClass, unittest.TestCase |
cfbd7cf3 | 424 | ): |
fc866000 FD |
425 | _MAPPING_CLASS = bt2_field_class._SignedEnumerationFieldClassMappingConst |
426 | _RANGE_SET_CLASS = bt2.SignedIntegerRangeSet | |
427 | _CONST_RANGE_SET_CLASS = bt2._SignedIntegerRangeSetConst | |
428 | ||
45c51519 PP |
429 | def _spec_set_up(self): |
430 | self._ranges1 = bt2.SignedIntegerRangeSet([(-10, -4), (18, 47)]) | |
431 | self._ranges2 = bt2.SignedIntegerRangeSet([(-3, -3)]) | |
432 | self._ranges3 = bt2.SignedIntegerRangeSet([(-100, -1), (8, 16), (48, 99)]) | |
433 | self._inval_ranges = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) | |
434 | self._value_in_range_1_and_3 = -7 | |
b4f45851 | 435 | |
f0a42b33 FD |
436 | @staticmethod |
437 | def _const_value_setter(field): | |
d47b6b4e | 438 | field.value = 0 |
f0a42b33 | 439 | |
5783664e PP |
440 | def _create_field_class(self, *args, **kwargs): |
441 | tc = get_default_trace_class() | |
442 | return tc.create_signed_enumeration_field_class(*args, **kwargs) | |
443 | ||
f0a42b33 FD |
444 | def _create_default_const_field_class(self, *args, **kwargs): |
445 | tc = get_default_trace_class() | |
446 | fc = tc.create_signed_enumeration_field_class(*args, **kwargs) | |
447 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
448 | ||
5783664e | 449 | _create_default_field_class = _create_field_class |
b4f45851 | 450 | |
5783664e PP |
451 | |
452 | class StringFieldClassTestCase(_TestFieldClass, unittest.TestCase): | |
f0a42b33 FD |
453 | @staticmethod |
454 | def _const_value_setter(field): | |
f5567ea8 | 455 | field.value = "chaine" |
f0a42b33 | 456 | |
5783664e | 457 | def _create_field_class(self, *args, **kwargs): |
d47b87ac | 458 | tc = get_default_trace_class() |
5783664e PP |
459 | return tc.create_string_field_class(*args, **kwargs) |
460 | ||
f0a42b33 FD |
461 | def _create_default_const_field_class(self, *args, **kwargs): |
462 | tc = get_default_trace_class() | |
463 | fc = tc.create_string_field_class(*args, **kwargs) | |
464 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
465 | ||
5783664e PP |
466 | _create_default_field_class = _create_field_class |
467 | ||
468 | def setUp(self): | |
469 | self._fc = self._create_default_field_class() | |
b4f45851 SM |
470 | |
471 | def test_create_default(self): | |
d47b87ac | 472 | self.assertIsNotNone(self._fc) |
5783664e | 473 | self.assertEqual(len(self._fc.user_attributes), 0) |
b4f45851 | 474 | |
b4f45851 | 475 | |
cfbd7cf3 | 476 | class _TestElementContainer: |
45c51519 PP |
477 | def setUp(self): |
478 | self._tc = get_default_trace_class() | |
5783664e | 479 | self._fc = self._create_default_field_class() |
f0a42b33 | 480 | self._fc_const = self._create_default_const_field_class() |
45c51519 PP |
481 | |
482 | def test_create_default(self): | |
483 | self.assertIsNotNone(self._fc) | |
5783664e | 484 | self.assertEqual(len(self._fc.user_attributes), 0) |
45c51519 | 485 | |
d47b87ac SM |
486 | def test_append_element(self): |
487 | int_field_class = self._tc.create_signed_integer_field_class(32) | |
f5567ea8 FD |
488 | self._append_element_method(self._fc, "int32", int_field_class) |
489 | field_class = self._fc["int32"].field_class | |
d47b87ac | 490 | self.assertEqual(field_class.addr, int_field_class.addr) |
b4f45851 | 491 | |
45c51519 | 492 | def test_append_element_kwargs(self): |
d47b87ac | 493 | int_field_class = self._tc.create_signed_integer_field_class(32) |
f5567ea8 FD |
494 | self._append_element_method(self._fc, name="int32", field_class=int_field_class) |
495 | field_class = self._fc["int32"].field_class | |
d47b87ac SM |
496 | self.assertEqual(field_class.addr, int_field_class.addr) |
497 | ||
498 | def test_append_element_invalid_name(self): | |
499 | sub_fc = self._tc.create_string_field_class() | |
b4f45851 | 500 | |
b4f45851 | 501 | with self.assertRaises(TypeError): |
d47b87ac | 502 | self._append_element_method(self._fc, 23, sub_fc) |
b4f45851 | 503 | |
d47b87ac | 504 | def test_append_element_invalid_field_class(self): |
b4f45851 | 505 | with self.assertRaises(TypeError): |
f5567ea8 | 506 | self._append_element_method(self._fc, "yes", object()) |
b4f45851 | 507 | |
45c51519 PP |
508 | def test_append_element_dup_name(self): |
509 | sub_fc1 = self._tc.create_string_field_class() | |
510 | sub_fc2 = self._tc.create_string_field_class() | |
511 | ||
ce4923b0 | 512 | with self.assertRaises(ValueError): |
f5567ea8 FD |
513 | self._append_element_method(self._fc, "yes", sub_fc1) |
514 | self._append_element_method(self._fc, "yes", sub_fc2) | |
45c51519 | 515 | |
f0a42b33 FD |
516 | def test_attr_field_class(self): |
517 | int_field_class = self._tc.create_signed_integer_field_class(32) | |
f5567ea8 FD |
518 | self._append_element_method(self._fc, "int32", int_field_class) |
519 | field_class = self._fc["int32"].field_class | |
f0a42b33 FD |
520 | |
521 | self.assertIs(type(field_class), bt2_field_class._SignedIntegerFieldClass) | |
522 | ||
523 | def test_const_attr_field_class(self): | |
524 | int_field_class = self._tc.create_signed_integer_field_class(32) | |
f5567ea8 FD |
525 | self._append_element_method(self._fc, "int32", int_field_class) |
526 | field_class = self._fc["int32"].field_class | |
f0a42b33 FD |
527 | const_fc = _create_const_field_class( |
528 | self._tc, self._fc, self._const_value_setter | |
529 | ) | |
f5567ea8 | 530 | field_class = const_fc["int32"].field_class |
f0a42b33 FD |
531 | |
532 | self.assertIs(type(field_class), bt2_field_class._SignedIntegerFieldClassConst) | |
533 | ||
b4f45851 | 534 | def test_iadd(self): |
fe4df857 | 535 | a_field_class = self._tc.create_single_precision_real_field_class() |
d47b87ac | 536 | b_field_class = self._tc.create_signed_integer_field_class(17) |
f5567ea8 FD |
537 | self._append_element_method(self._fc, "a_float", a_field_class) |
538 | self._append_element_method(self._fc, "b_int", b_field_class) | |
45c51519 | 539 | c_field_class = self._tc.create_string_field_class() |
cfbd7cf3 FD |
540 | d_field_class = self._tc.create_signed_enumeration_field_class( |
541 | field_value_range=32 | |
542 | ) | |
45c51519 PP |
543 | e_field_class = self._tc.create_structure_field_class() |
544 | self._fc += [ | |
f5567ea8 FD |
545 | ("c_string", c_field_class), |
546 | ("d_enum", d_field_class), | |
547 | ("e_struct", e_field_class), | |
45c51519 | 548 | ] |
f5567ea8 FD |
549 | self.assertEqual(self._fc["a_float"].field_class.addr, a_field_class.addr) |
550 | self.assertEqual(self._fc["a_float"].name, "a_float") | |
551 | self.assertEqual(self._fc["b_int"].field_class.addr, b_field_class.addr) | |
552 | self.assertEqual(self._fc["b_int"].name, "b_int") | |
553 | self.assertEqual(self._fc["c_string"].field_class.addr, c_field_class.addr) | |
554 | self.assertEqual(self._fc["c_string"].name, "c_string") | |
555 | self.assertEqual(self._fc["d_enum"].field_class.addr, d_field_class.addr) | |
556 | self.assertEqual(self._fc["d_enum"].name, "d_enum") | |
557 | self.assertEqual(self._fc["e_struct"].field_class.addr, e_field_class.addr) | |
558 | self.assertEqual(self._fc["e_struct"].name, "e_struct") | |
b4f45851 | 559 | |
f0a42b33 | 560 | def test_const_iadd(self): |
fe4df857 | 561 | a_field_class = self._tc.create_single_precision_real_field_class() |
f0a42b33 FD |
562 | with self.assertRaises(TypeError): |
563 | self._fc_const += a_field_class | |
564 | ||
b4f45851 SM |
565 | def test_bool_op(self): |
566 | self.assertFalse(self._fc) | |
f5567ea8 | 567 | self._append_element_method(self._fc, "a", self._tc.create_string_field_class()) |
b4f45851 SM |
568 | self.assertTrue(self._fc) |
569 | ||
570 | def test_len(self): | |
f5567ea8 FD |
571 | self._append_element_method(self._fc, "a", self._tc.create_string_field_class()) |
572 | self._append_element_method(self._fc, "b", self._tc.create_string_field_class()) | |
573 | self._append_element_method(self._fc, "c", self._tc.create_string_field_class()) | |
b4f45851 SM |
574 | self.assertEqual(len(self._fc), 3) |
575 | ||
576 | def test_getitem(self): | |
d47b87ac SM |
577 | a_fc = self._tc.create_signed_integer_field_class(32) |
578 | b_fc = self._tc.create_string_field_class() | |
fe4df857 | 579 | c_fc = self._tc.create_single_precision_real_field_class() |
f5567ea8 FD |
580 | self._append_element_method(self._fc, "a", a_fc) |
581 | self._append_element_method(self._fc, "b", b_fc) | |
582 | self._append_element_method(self._fc, "c", c_fc) | |
583 | self.assertEqual(self._fc["b"].field_class.addr, b_fc.addr) | |
584 | self.assertEqual(self._fc["b"].name, "b") | |
b4f45851 SM |
585 | |
586 | def test_getitem_invalid_key_type(self): | |
587 | with self.assertRaises(TypeError): | |
588 | self._fc[0] | |
589 | ||
590 | def test_getitem_invalid_key(self): | |
591 | with self.assertRaises(KeyError): | |
f5567ea8 | 592 | self._fc["no way"] |
b4f45851 SM |
593 | |
594 | def test_contains(self): | |
f5567ea8 FD |
595 | self.assertFalse("a" in self._fc) |
596 | self._append_element_method(self._fc, "a", self._tc.create_string_field_class()) | |
597 | self.assertTrue("a" in self._fc) | |
b4f45851 SM |
598 | |
599 | def test_iter(self): | |
d47b87ac SM |
600 | a_fc = self._tc.create_signed_integer_field_class(32) |
601 | b_fc = self._tc.create_string_field_class() | |
fe4df857 | 602 | c_fc = self._tc.create_single_precision_real_field_class() |
f5567ea8 | 603 | elements = (("a", a_fc), ("b", b_fc), ("c", c_fc)) |
b4f45851 | 604 | |
45c51519 PP |
605 | for elem in elements: |
606 | self._append_element_method(self._fc, *elem) | |
b4f45851 | 607 | |
45c51519 PP |
608 | for (name, element), test_elem in zip(self._fc.items(), elements): |
609 | self.assertEqual(element.name, test_elem[0]) | |
610 | self.assertEqual(name, element.name) | |
611 | self.assertEqual(element.field_class.addr, test_elem[1].addr) | |
5783664e | 612 | self.assertEqual(len(element.user_attributes), 0) |
b4f45851 SM |
613 | |
614 | def test_at_index(self): | |
d47b87ac SM |
615 | a_fc = self._tc.create_signed_integer_field_class(32) |
616 | b_fc = self._tc.create_string_field_class() | |
fe4df857 | 617 | c_fc = self._tc.create_single_precision_real_field_class() |
f5567ea8 FD |
618 | self._append_element_method(self._fc, "c", c_fc) |
619 | self._append_element_method(self._fc, "a", a_fc) | |
620 | self._append_element_method(self._fc, "b", b_fc) | |
45c51519 PP |
621 | elem = self._at_index_method(self._fc, 1) |
622 | self.assertEqual(elem.field_class.addr, a_fc.addr) | |
f5567ea8 | 623 | self.assertEqual(elem.name, "a") |
b4f45851 SM |
624 | |
625 | def test_at_index_invalid(self): | |
cfbd7cf3 | 626 | self._append_element_method( |
f5567ea8 | 627 | self._fc, "c", self._tc.create_signed_integer_field_class(32) |
cfbd7cf3 | 628 | ) |
b4f45851 SM |
629 | |
630 | with self.assertRaises(TypeError): | |
f5567ea8 | 631 | self._at_index_method(self._fc, "yes") |
b4f45851 SM |
632 | |
633 | def test_at_index_out_of_bounds_after(self): | |
cfbd7cf3 | 634 | self._append_element_method( |
f5567ea8 | 635 | self._fc, "c", self._tc.create_signed_integer_field_class(32) |
cfbd7cf3 | 636 | ) |
b4f45851 SM |
637 | |
638 | with self.assertRaises(IndexError): | |
d47b87ac | 639 | self._at_index_method(self._fc, len(self._fc)) |
b4f45851 | 640 | |
5783664e PP |
641 | def test_user_attributes(self): |
642 | self._append_element_method( | |
643 | self._fc, | |
f5567ea8 | 644 | "c", |
5783664e | 645 | self._tc.create_string_field_class(), |
f5567ea8 | 646 | user_attributes={"salut": 23}, |
5783664e | 647 | ) |
f5567ea8 | 648 | self.assertEqual(self._fc["c"].user_attributes, {"salut": 23}) |
f0a42b33 | 649 | self.assertIs(type(self._fc.user_attributes), bt2_value.MapValue) |
f5567ea8 | 650 | self.assertIs(type(self._fc["c"].user_attributes), bt2_value.MapValue) |
b4f45851 | 651 | |
5783664e PP |
652 | def test_invalid_user_attributes(self): |
653 | with self.assertRaises(TypeError): | |
654 | self._append_element_method( | |
655 | self._fc, | |
f5567ea8 | 656 | "c", |
5783664e PP |
657 | self._tc.create_string_field_class(), |
658 | user_attributes=object(), | |
659 | ) | |
660 | ||
661 | def test_invalid_user_attributes_value_type(self): | |
662 | with self.assertRaises(TypeError): | |
663 | self._append_element_method( | |
f5567ea8 | 664 | self._fc, "c", self._tc.create_string_field_class(), user_attributes=23 |
5783664e PP |
665 | ) |
666 | ||
667 | ||
668 | class StructureFieldClassTestCase( | |
669 | _TestFieldClass, _TestElementContainer, unittest.TestCase | |
670 | ): | |
3fb99a22 PP |
671 | _append_element_method = staticmethod(bt2._StructureFieldClass.append_member) |
672 | _at_index_method = staticmethod(bt2._StructureFieldClass.member_at_index) | |
45c51519 | 673 | |
f0a42b33 FD |
674 | @staticmethod |
675 | def _const_value_setter(field): | |
676 | field.value = {} | |
677 | ||
5783664e PP |
678 | def _create_field_class(self, *args, **kwargs): |
679 | tc = get_default_trace_class() | |
680 | return tc.create_structure_field_class(*args, **kwargs) | |
45c51519 | 681 | |
f0a42b33 FD |
682 | def _create_default_const_field_class(self, *args, **kwargs): |
683 | tc = get_default_trace_class() | |
684 | fc = tc.create_structure_field_class(*args, **kwargs) | |
685 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
686 | ||
5783664e PP |
687 | _create_default_field_class = _create_field_class |
688 | ||
f0a42b33 FD |
689 | def test_const_member_field_class(self): |
690 | def _real_value_setter(field): | |
f5567ea8 | 691 | field.value = {"real": 0} |
f0a42b33 FD |
692 | |
693 | tc = get_default_trace_class() | |
694 | fc = tc.create_structure_field_class() | |
fe4df857 | 695 | member_fc = self._tc.create_single_precision_real_field_class() |
f5567ea8 | 696 | fc.append_member("real", member_fc) |
f0a42b33 FD |
697 | const_fc = _create_const_field_class(tc, fc, _real_value_setter) |
698 | ||
699 | self.assertIs( | |
f5567ea8 | 700 | type(const_fc["real"].field_class), |
fe4df857 | 701 | bt2_field_class._SinglePrecisionRealFieldClassConst, |
f0a42b33 FD |
702 | ) |
703 | ||
704 | def test_member_field_class(self): | |
705 | tc = get_default_trace_class() | |
706 | fc = tc.create_structure_field_class() | |
fe4df857 | 707 | member_fc = self._tc.create_single_precision_real_field_class() |
f5567ea8 | 708 | fc.append_member("real", member_fc) |
f0a42b33 | 709 | |
fe4df857 | 710 | self.assertIs( |
f5567ea8 | 711 | type(fc["real"].field_class), bt2_field_class._SinglePrecisionRealFieldClass |
fe4df857 | 712 | ) |
f0a42b33 | 713 | |
5783664e | 714 | |
0aa006b7 | 715 | class OptionWithoutSelectorFieldClassTestCase(_TestFieldClass, unittest.TestCase): |
f0a42b33 FD |
716 | @staticmethod |
717 | def _const_value_setter(field): | |
718 | field.has_field = True | |
719 | field.value = 12 | |
720 | ||
5783664e | 721 | def _create_default_field_class(self, *args, **kwargs): |
0aa006b7 PP |
722 | return self._tc.create_option_without_selector_field_class( |
723 | self._content_fc, *args, **kwargs | |
724 | ) | |
45c51519 | 725 | |
f0a42b33 | 726 | def _create_default_const_field_class(self, *args, **kwargs): |
0aa006b7 PP |
727 | fc = self._tc.create_option_without_selector_field_class( |
728 | self._content_fc, *args, **kwargs | |
729 | ) | |
f0a42b33 FD |
730 | return _create_const_field_class(self._tc, fc, self._const_value_setter) |
731 | ||
cec0261d PP |
732 | def setUp(self): |
733 | self._tc = get_default_trace_class() | |
734 | self._content_fc = self._tc.create_signed_integer_field_class(23) | |
cec0261d PP |
735 | |
736 | def test_create_default(self): | |
5783664e | 737 | fc = self._create_default_field_class() |
cec0261d | 738 | self.assertEqual(fc.field_class.addr, self._content_fc.addr) |
5783664e | 739 | self.assertEqual(len(fc.user_attributes), 0) |
cec0261d | 740 | |
0aa006b7 PP |
741 | def test_create_invalid_field_class(self): |
742 | with self.assertRaises(TypeError): | |
743 | self._tc.create_option_without_selector_field_class(object()) | |
744 | ||
f0a42b33 FD |
745 | def test_attr_field_class(self): |
746 | fc = self._create_default_field_class() | |
747 | self.assertIs(type(fc.field_class), bt2_field_class._SignedIntegerFieldClass) | |
748 | ||
749 | def test_const_attr_field_class(self): | |
750 | fc = self._create_default_const_field_class() | |
751 | self.assertIs( | |
752 | type(fc.field_class), bt2_field_class._SignedIntegerFieldClassConst | |
753 | ) | |
754 | ||
0aa006b7 PP |
755 | |
756 | class _OptionWithSelectorFieldClassTestCase(_TestFieldClass): | |
757 | @staticmethod | |
758 | def _const_value_setter(field): | |
f5567ea8 FD |
759 | field["opt"].has_field = True |
760 | field["opt"].value = 12 | |
0aa006b7 PP |
761 | |
762 | def _create_default_const_field_class(self, *args, **kwargs): | |
763 | # Create a struct to contain the option and its selector else we can't | |
764 | # create the non-const field necessary to get the the const field_class | |
765 | struct_fc = self._tc.create_structure_field_class() | |
f5567ea8 | 766 | struct_fc.append_member("selecteux", self._tag_fc) |
0aa006b7 | 767 | opt_fc = self._create_default_field_class(*args, **kwargs) |
f5567ea8 | 768 | struct_fc.append_member("opt", opt_fc) |
0aa006b7 PP |
769 | |
770 | return _create_const_field_class(self._tc, struct_fc, self._const_value_setter)[ | |
f5567ea8 | 771 | "opt" |
0aa006b7 PP |
772 | ].field_class |
773 | ||
774 | def setUp(self): | |
775 | self._tc = get_default_trace_class() | |
776 | self._content_fc = self._tc.create_signed_integer_field_class(23) | |
777 | self._tag_fc = self._create_tag_fc() | |
778 | ||
cec0261d | 779 | def _create_field_class_for_field_path_test(self): |
0aa006b7 | 780 | fc = self._create_default_field_class() |
cec0261d | 781 | |
fe4df857 | 782 | foo_fc = self._tc.create_single_precision_real_field_class() |
cec0261d PP |
783 | bar_fc = self._tc.create_string_field_class() |
784 | baz_fc = self._tc.create_string_field_class() | |
785 | ||
786 | inner_struct_fc = self._tc.create_structure_field_class() | |
f5567ea8 FD |
787 | inner_struct_fc.append_member("bar", bar_fc) |
788 | inner_struct_fc.append_member("baz", baz_fc) | |
789 | inner_struct_fc.append_member("tag", self._tag_fc) | |
790 | inner_struct_fc.append_member("opt", fc) | |
cec0261d | 791 | |
0aa006b7 PP |
792 | opt_struct_array_fc = self._tc.create_option_without_selector_field_class( |
793 | inner_struct_fc | |
794 | ) | |
cec0261d PP |
795 | |
796 | outer_struct_fc = self._tc.create_structure_field_class() | |
f5567ea8 FD |
797 | outer_struct_fc.append_member("foo", foo_fc) |
798 | outer_struct_fc.append_member("inner_opt", opt_struct_array_fc) | |
cec0261d PP |
799 | |
800 | # The path to the selector field class is resolved when the | |
801 | # option field class is actually used, for example in a packet | |
802 | # context. | |
803 | self._tc.create_stream_class( | |
804 | packet_context_field_class=outer_struct_fc, supports_packets=True | |
805 | ) | |
806 | ||
807 | return fc | |
808 | ||
809 | def test_field_path_len(self): | |
810 | fc = self._create_field_class_for_field_path_test() | |
811 | self.assertEqual(len(fc.selector_field_path), 3) | |
812 | ||
813 | def test_field_path_iter(self): | |
814 | fc = self._create_field_class_for_field_path_test() | |
815 | path_items = list(fc.selector_field_path) | |
816 | ||
817 | self.assertEqual(len(path_items), 3) | |
818 | ||
819 | self.assertIsInstance(path_items[0], bt2._IndexFieldPathItem) | |
820 | self.assertEqual(path_items[0].index, 1) | |
821 | ||
822 | self.assertIsInstance(path_items[1], bt2._CurrentOptionContentFieldPathItem) | |
823 | ||
824 | self.assertIsInstance(path_items[2], bt2._IndexFieldPathItem) | |
825 | self.assertEqual(path_items[2].index, 2) | |
826 | ||
827 | def test_field_path_root_scope(self): | |
828 | fc = self._create_field_class_for_field_path_test() | |
829 | self.assertEqual( | |
830 | fc.selector_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT | |
831 | ) | |
832 | ||
0aa006b7 PP |
833 | |
834 | class OptionWithBoolSelectorFieldClassTestCase( | |
835 | _OptionWithSelectorFieldClassTestCase, unittest.TestCase | |
836 | ): | |
837 | def _create_default_field_class(self, *args, **kwargs): | |
838 | return self._tc.create_option_with_bool_selector_field_class( | |
839 | self._content_fc, self._tag_fc, *args, **kwargs | |
840 | ) | |
841 | ||
842 | def _create_tag_fc(self): | |
843 | return self._tc.create_bool_field_class() | |
844 | ||
845 | def test_create_default(self): | |
846 | fc = self._create_default_field_class() | |
847 | self.assertEqual(fc.field_class.addr, self._content_fc.addr) | |
848 | self.assertFalse(fc.selector_is_reversed) | |
849 | self.assertEqual(len(fc.user_attributes), 0) | |
850 | ||
851 | def test_create_selector_is_reversed_wrong_type(self): | |
cec0261d | 852 | with self.assertRaises(TypeError): |
0aa006b7 | 853 | self._create_default_field_class(selector_is_reversed=23) |
cec0261d PP |
854 | |
855 | def test_create_invalid_selector_type(self): | |
856 | with self.assertRaises(TypeError): | |
0aa006b7 PP |
857 | self._tc.create_option_with_bool_selector_field_class(self._content_fc, 17) |
858 | ||
859 | def test_attr_selector_is_reversed(self): | |
860 | fc = self._create_default_field_class(selector_is_reversed=True) | |
861 | self.assertTrue(fc.selector_is_reversed) | |
862 | ||
863 | def test_const_attr_selector_is_reversed(self): | |
864 | fc = self._create_default_const_field_class(selector_is_reversed=True) | |
865 | self.assertTrue(fc.selector_is_reversed) | |
866 | ||
867 | ||
868 | class _OptionWithIntegerSelectorFieldClassTestCase( | |
869 | _OptionWithSelectorFieldClassTestCase | |
870 | ): | |
871 | def _create_default_field_class(self, *args, **kwargs): | |
872 | return self._tc.create_option_with_integer_selector_field_class( | |
873 | self._content_fc, self._tag_fc, self._ranges, *args, **kwargs | |
874 | ) | |
875 | ||
876 | def test_create_default(self): | |
877 | fc = self._create_default_field_class() | |
878 | self.assertEqual(fc.field_class.addr, self._content_fc.addr) | |
879 | self.assertEqual(fc.ranges, self._ranges) | |
880 | self.assertEqual(len(fc.user_attributes), 0) | |
881 | ||
882 | def test_create_ranges_wrong_type(self): | |
883 | with self.assertRaises(TypeError): | |
884 | self._tc.create_option_with_integer_selector_field_class( | |
885 | self._content_fc, self._tag_fc, 23 | |
886 | ) | |
887 | ||
888 | def test_create_ranges_empty(self): | |
889 | with self.assertRaises(ValueError): | |
890 | self._tc.create_option_with_integer_selector_field_class( | |
891 | self._content_fc, self._tag_fc, type(self._ranges)() | |
892 | ) | |
893 | ||
894 | def test_create_invalid_selector_type(self): | |
895 | with self.assertRaises(TypeError): | |
896 | self._tc.create_option_with_bool_selector_field_class(self._content_fc, 17) | |
897 | ||
898 | def test_attr_ranges(self): | |
899 | fc = self._create_default_field_class() | |
0aa006b7 PP |
900 | self.assertEqual(fc.ranges, self._ranges) |
901 | ||
902 | def test_const_attr_ranges(self): | |
903 | fc = self._create_default_const_field_class() | |
904 | self.assertEqual(fc.ranges, self._ranges) | |
905 | ||
906 | ||
907 | class OptionWithUnsignedIntegerSelectorFieldClassTestCase( | |
908 | _OptionWithIntegerSelectorFieldClassTestCase, unittest.TestCase | |
909 | ): | |
910 | def setUp(self): | |
911 | self._ranges = bt2.UnsignedIntegerRangeSet([(1, 3), (18, 44)]) | |
912 | super().setUp() | |
913 | ||
914 | def _create_tag_fc(self): | |
915 | return self._tc.create_unsigned_integer_field_class() | |
cec0261d PP |
916 | |
917 | ||
cfbd7cf3 | 918 | class VariantFieldClassWithoutSelectorTestCase( |
5783664e | 919 | _TestFieldClass, _TestElementContainer, unittest.TestCase |
cfbd7cf3 FD |
920 | ): |
921 | _append_element_method = staticmethod( | |
3fb99a22 | 922 | bt2._VariantFieldClassWithoutSelector.append_option |
cfbd7cf3 FD |
923 | ) |
924 | _at_index_method = staticmethod( | |
3fb99a22 | 925 | bt2._VariantFieldClassWithoutSelector.option_at_index |
cfbd7cf3 | 926 | ) |
45c51519 | 927 | |
f0a42b33 FD |
928 | @staticmethod |
929 | def _const_value_setter(variant_field): | |
930 | variant_field.selected_option_index = 0 | |
931 | variant_field.value = 12 | |
932 | ||
5783664e PP |
933 | def _create_field_class(self, *args, **kwargs): |
934 | tc = get_default_trace_class() | |
935 | return tc.create_variant_field_class(*args, **kwargs) | |
936 | ||
f0a42b33 FD |
937 | def _create_default_const_field_class(self, *args, **kwargs): |
938 | tc = get_default_trace_class() | |
939 | fc = tc.create_variant_field_class(*args, **kwargs) | |
940 | int_field_class = self._tc.create_signed_integer_field_class(32) | |
f5567ea8 | 941 | fc.append_option("int32", int_field_class) |
f0a42b33 FD |
942 | |
943 | return _create_const_field_class(tc, fc, self._const_value_setter) | |
944 | ||
5783664e | 945 | _create_default_field_class = _create_field_class |
45c51519 PP |
946 | |
947 | ||
fabfe034 | 948 | class _VariantFieldClassWithIntegerSelectorTestCase: |
f0a42b33 FD |
949 | @staticmethod |
950 | def _const_value_setter(field): | |
f5567ea8 FD |
951 | field["variant"].selected_option_index = 0 |
952 | field["variant"] = 12 | |
f0a42b33 | 953 | |
5783664e PP |
954 | def _create_default_field_class(self, *args, **kwargs): |
955 | return self._tc.create_variant_field_class( | |
956 | *args, selector_fc=self._selector_fc, **kwargs | |
957 | ) | |
958 | ||
f0a42b33 FD |
959 | def _create_default_const_field_class(self, *args, **kwargs): |
960 | # Create a struct to contain the variant and its selector else we can't | |
961 | # create the non-const field necessary to get the the const field_class | |
962 | struct_fc = self._tc.create_structure_field_class() | |
f5567ea8 | 963 | struct_fc.append_member("selecteux", self._selector_fc) |
f0a42b33 FD |
964 | variant_fc = self._tc.create_variant_field_class( |
965 | *args, selector_fc=self._selector_fc | |
966 | ) | |
967 | variant_fc.append_option( | |
f5567ea8 | 968 | "a", self._tc.create_signed_integer_field_class(32), self._ranges1 |
f0a42b33 | 969 | ) |
f5567ea8 | 970 | struct_fc.append_member("variant", variant_fc, **kwargs) |
f0a42b33 FD |
971 | |
972 | return _create_const_field_class(self._tc, struct_fc, self._const_value_setter)[ | |
f5567ea8 | 973 | "variant" |
f0a42b33 FD |
974 | ].field_class |
975 | ||
b4f45851 | 976 | def setUp(self): |
d47b87ac | 977 | self._tc = get_default_trace_class() |
45c51519 | 978 | self._spec_set_up() |
5783664e | 979 | self._fc = self._create_default_field_class() |
d47b87ac SM |
980 | |
981 | def test_create_default(self): | |
982 | self.assertIsNotNone(self._fc) | |
5783664e | 983 | self.assertEqual(len(self._fc.user_attributes), 0) |
b4f45851 | 984 | |
45c51519 PP |
985 | def test_append_element(self): |
986 | str_field_class = self._tc.create_string_field_class() | |
f5567ea8 FD |
987 | self._fc.append_option("str", str_field_class, self._ranges1) |
988 | opt = self._fc["str"] | |
45c51519 | 989 | self.assertEqual(opt.field_class.addr, str_field_class.addr) |
f5567ea8 | 990 | self.assertEqual(opt.name, "str") |
45c51519 PP |
991 | self.assertEqual(opt.ranges.addr, self._ranges1.addr) |
992 | ||
f0a42b33 FD |
993 | def test_const_append(self): |
994 | fc_const = self._create_default_const_field_class() | |
fd4e6235 | 995 | str_field_class = self._tc.create_string_field_class() |
f0a42b33 | 996 | with self.assertRaises(AttributeError): |
f5567ea8 | 997 | fc_const.append_option("str", str_field_class, self._ranges1) |
f0a42b33 | 998 | |
45c51519 PP |
999 | def test_append_element_kwargs(self): |
1000 | int_field_class = self._tc.create_signed_integer_field_class(32) | |
cfbd7cf3 | 1001 | self._fc.append_option( |
f5567ea8 | 1002 | name="int32", field_class=int_field_class, ranges=self._ranges1 |
cfbd7cf3 | 1003 | ) |
f5567ea8 | 1004 | opt = self._fc["int32"] |
45c51519 | 1005 | self.assertEqual(opt.field_class.addr, int_field_class.addr) |
f5567ea8 | 1006 | self.assertEqual(opt.name, "int32") |
45c51519 | 1007 | self.assertEqual(opt.ranges.addr, self._ranges1.addr) |
d47b87ac | 1008 | |
45c51519 PP |
1009 | def test_append_element_invalid_name(self): |
1010 | sub_fc = self._tc.create_string_field_class() | |
b4f45851 | 1011 | |
45c51519 PP |
1012 | with self.assertRaises(TypeError): |
1013 | self._fc.append_option(self._fc, 23, sub_fc) | |
b4f45851 | 1014 | |
45c51519 PP |
1015 | def test_append_element_invalid_field_class(self): |
1016 | with self.assertRaises(TypeError): | |
f5567ea8 | 1017 | self._fc.append_option(self._fc, "yes", object()) |
45c51519 PP |
1018 | |
1019 | def test_append_element_invalid_ranges(self): | |
1020 | sub_fc = self._tc.create_string_field_class() | |
1021 | ||
1022 | with self.assertRaises(TypeError): | |
f5567ea8 | 1023 | self._fc.append_option(self._fc, sub_fc, "lel") |
45c51519 PP |
1024 | |
1025 | def test_append_element_dup_name(self): | |
1026 | sub_fc1 = self._tc.create_string_field_class() | |
1027 | sub_fc2 = self._tc.create_string_field_class() | |
1028 | ||
ce4923b0 | 1029 | with self.assertRaises(ValueError): |
f5567ea8 FD |
1030 | self._fc.append_option("yes", sub_fc1, self._ranges1) |
1031 | self._fc.append_option("yes", sub_fc2, self._ranges2) | |
45c51519 PP |
1032 | |
1033 | def test_append_element_invalid_ranges_signedness(self): | |
1034 | sub_fc = self._tc.create_string_field_class() | |
1035 | ||
1036 | with self.assertRaises(TypeError): | |
1037 | self._fc.append_option(self._fc, sub_fc, self._inval_ranges) | |
1038 | ||
5783664e PP |
1039 | def test_user_attributes(self): |
1040 | self._fc.append_option( | |
f5567ea8 | 1041 | "c", |
5783664e PP |
1042 | self._tc.create_string_field_class(), |
1043 | self._ranges1, | |
f5567ea8 | 1044 | user_attributes={"salut": 23}, |
5783664e | 1045 | ) |
f5567ea8 | 1046 | self.assertEqual(self._fc["c"].user_attributes, {"salut": 23}) |
f0a42b33 FD |
1047 | self.assertIs(type(self._fc.user_attributes), bt2_value.MapValue) |
1048 | ||
1049 | def test_const_user_attributes(self): | |
1050 | fc_const = self._create_default_const_field_class() | |
1051 | self.assertIs(type(fc_const.user_attributes), bt2_value._MapValueConst) | |
5783664e PP |
1052 | |
1053 | def test_invalid_user_attributes(self): | |
1054 | with self.assertRaises(TypeError): | |
1055 | self._fc.append_option( | |
f5567ea8 | 1056 | "c", |
5783664e PP |
1057 | self._tc.create_string_field_class(), |
1058 | self._ranges1, | |
1059 | user_attributes=object(), | |
1060 | ) | |
1061 | ||
1062 | def test_invalid_user_attributes_value_type(self): | |
1063 | with self.assertRaises(TypeError): | |
1064 | self._fc.append_option( | |
f5567ea8 | 1065 | "c", |
5783664e PP |
1066 | self._tc.create_string_field_class(), |
1067 | self._ranges1, | |
1068 | user_attributes=23, | |
1069 | ) | |
1070 | ||
45c51519 | 1071 | def test_iadd(self): |
fe4df857 | 1072 | a_field_class = self._tc.create_single_precision_real_field_class() |
f5567ea8 | 1073 | self._fc.append_option("a_float", a_field_class, self._ranges1) |
45c51519 | 1074 | c_field_class = self._tc.create_string_field_class() |
cfbd7cf3 FD |
1075 | d_field_class = self._tc.create_signed_enumeration_field_class( |
1076 | field_value_range=32 | |
1077 | ) | |
45c51519 | 1078 | self._fc += [ |
f5567ea8 FD |
1079 | ("c_string", c_field_class, self._ranges2), |
1080 | ("d_enum", d_field_class, self._ranges3), | |
45c51519 | 1081 | ] |
f5567ea8 FD |
1082 | self.assertEqual(self._fc["a_float"].field_class.addr, a_field_class.addr) |
1083 | self.assertEqual(self._fc["a_float"].name, "a_float") | |
1084 | self.assertEqual(self._fc["a_float"].ranges, self._ranges1) | |
1085 | self.assertEqual(self._fc["c_string"].field_class.addr, c_field_class.addr) | |
1086 | self.assertEqual(self._fc["c_string"].name, "c_string") | |
1087 | self.assertEqual(self._fc["c_string"].ranges, self._ranges2) | |
1088 | self.assertEqual(self._fc["d_enum"].field_class.addr, d_field_class.addr) | |
1089 | self.assertEqual(self._fc["d_enum"].name, "d_enum") | |
1090 | self.assertEqual(self._fc["d_enum"].ranges, self._ranges3) | |
45c51519 | 1091 | |
f0a42b33 FD |
1092 | def test_const_iadd(self): |
1093 | fc_const = self._create_default_const_field_class() | |
fe4df857 | 1094 | a_field_class = self._tc.create_single_precision_real_field_class() |
f0a42b33 | 1095 | with self.assertRaises(TypeError): |
f5567ea8 | 1096 | fc_const += [("a_float", a_field_class, self._ranges1)] |
f0a42b33 | 1097 | |
45c51519 PP |
1098 | def test_bool_op(self): |
1099 | self.assertFalse(self._fc) | |
f5567ea8 | 1100 | self._fc.append_option("a", self._tc.create_string_field_class(), self._ranges1) |
45c51519 PP |
1101 | self.assertTrue(self._fc) |
1102 | ||
1103 | def test_len(self): | |
f5567ea8 FD |
1104 | self._fc.append_option("a", self._tc.create_string_field_class(), self._ranges1) |
1105 | self._fc.append_option("b", self._tc.create_string_field_class(), self._ranges2) | |
1106 | self._fc.append_option("c", self._tc.create_string_field_class(), self._ranges3) | |
45c51519 PP |
1107 | self.assertEqual(len(self._fc), 3) |
1108 | ||
1109 | def test_getitem(self): | |
1110 | a_fc = self._tc.create_signed_integer_field_class(32) | |
1111 | b_fc = self._tc.create_string_field_class() | |
fe4df857 | 1112 | c_fc = self._tc.create_single_precision_real_field_class() |
f5567ea8 FD |
1113 | self._fc.append_option("a", a_fc, self._ranges1) |
1114 | self._fc.append_option("b", b_fc, self._ranges2) | |
1115 | self._fc.append_option("c", c_fc, self._ranges3) | |
1116 | self.assertEqual(self._fc["b"].field_class.addr, b_fc.addr) | |
1117 | self.assertEqual(self._fc["b"].name, "b") | |
1118 | self.assertEqual(self._fc["b"].ranges.addr, self._ranges2.addr) | |
45c51519 | 1119 | |
f0a42b33 FD |
1120 | def test_option_field_class(self): |
1121 | a_fc = self._tc.create_signed_integer_field_class(32) | |
f5567ea8 | 1122 | self._fc.append_option("a", a_fc, self._ranges1) |
f0a42b33 | 1123 | self.assertIs( |
f5567ea8 | 1124 | type(self._fc["a"].field_class), bt2_field_class._SignedIntegerFieldClass |
f0a42b33 FD |
1125 | ) |
1126 | ||
1127 | def test_const_option_field_class(self): | |
1128 | fc_const = self._create_default_const_field_class() | |
1129 | self.assertIs( | |
f5567ea8 | 1130 | type(fc_const["a"].field_class), |
f0a42b33 FD |
1131 | bt2_field_class._SignedIntegerFieldClassConst, |
1132 | ) | |
1133 | ||
45c51519 PP |
1134 | def test_getitem_invalid_key_type(self): |
1135 | with self.assertRaises(TypeError): | |
1136 | self._fc[0] | |
1137 | ||
1138 | def test_getitem_invalid_key(self): | |
1139 | with self.assertRaises(KeyError): | |
f5567ea8 | 1140 | self._fc["no way"] |
45c51519 PP |
1141 | |
1142 | def test_contains(self): | |
f5567ea8 FD |
1143 | self.assertFalse("a" in self._fc) |
1144 | self._fc.append_option("a", self._tc.create_string_field_class(), self._ranges1) | |
1145 | self.assertTrue("a" in self._fc) | |
45c51519 PP |
1146 | |
1147 | def test_iter(self): | |
1148 | a_fc = self._tc.create_signed_integer_field_class(32) | |
1149 | b_fc = self._tc.create_string_field_class() | |
fe4df857 | 1150 | c_fc = self._tc.create_single_precision_real_field_class() |
45c51519 | 1151 | opts = ( |
f5567ea8 FD |
1152 | ("a", a_fc, self._ranges1), |
1153 | ("b", b_fc, self._ranges2), | |
1154 | ("c", c_fc, self._ranges3), | |
45c51519 PP |
1155 | ) |
1156 | ||
1157 | for opt in opts: | |
1158 | self._fc.append_option(*opt) | |
b4f45851 | 1159 | |
45c51519 PP |
1160 | for (name, opt), test_opt in zip(self._fc.items(), opts): |
1161 | self.assertEqual(opt.name, test_opt[0]) | |
1162 | self.assertEqual(name, opt.name) | |
1163 | self.assertEqual(opt.field_class.addr, test_opt[1].addr) | |
1164 | self.assertEqual(opt.ranges.addr, test_opt[2].addr) | |
1165 | ||
1166 | def test_at_index(self): | |
1167 | a_fc = self._tc.create_signed_integer_field_class(32) | |
1168 | b_fc = self._tc.create_string_field_class() | |
fe4df857 | 1169 | c_fc = self._tc.create_single_precision_real_field_class() |
f5567ea8 FD |
1170 | self._fc.append_option("c", c_fc, self._ranges1) |
1171 | self._fc.append_option("a", a_fc, self._ranges2) | |
1172 | self._fc.append_option("b", b_fc, self._ranges3) | |
45c51519 | 1173 | self.assertEqual(self._fc.option_at_index(1).field_class.addr, a_fc.addr) |
f5567ea8 | 1174 | self.assertEqual(self._fc.option_at_index(1).name, "a") |
45c51519 PP |
1175 | self.assertEqual(self._fc.option_at_index(1).ranges.addr, self._ranges2.addr) |
1176 | ||
1177 | def test_at_index_invalid(self): | |
cfbd7cf3 | 1178 | self._fc.append_option( |
f5567ea8 | 1179 | "c", self._tc.create_signed_integer_field_class(32), self._ranges3 |
cfbd7cf3 | 1180 | ) |
45c51519 PP |
1181 | |
1182 | with self.assertRaises(TypeError): | |
f5567ea8 | 1183 | self._fc.option_at_index("yes") |
45c51519 PP |
1184 | |
1185 | def test_at_index_out_of_bounds_after(self): | |
cfbd7cf3 | 1186 | self._fc.append_option( |
f5567ea8 | 1187 | "c", self._tc.create_signed_integer_field_class(32), self._ranges3 |
cfbd7cf3 | 1188 | ) |
45c51519 PP |
1189 | |
1190 | with self.assertRaises(IndexError): | |
1191 | self._fc.option_at_index(len(self._fc)) | |
1192 | ||
1193 | def _fill_default_fc_for_field_path_test(self): | |
d47b87ac SM |
1194 | # Create something equivalent to: |
1195 | # | |
1196 | # struct outer_struct_fc { | |
1197 | # real foo; | |
1198 | # struct inner_struct_fc { | |
45c51519 | 1199 | # [u]int64_t selector; |
d47b87ac SM |
1200 | # string bar; |
1201 | # string baz; | |
45c51519 PP |
1202 | # variant <selector> { |
1203 | # real a; // selected with self._ranges1 | |
1204 | # int21_t b; // selected with self._ranges2 | |
1205 | # uint34_t c; // selected with self._ranges3 | |
d47b87ac SM |
1206 | # } variant; |
1207 | # } inner_struct[2]; | |
1208 | # }; | |
fe4df857 | 1209 | self._fc.append_option( |
f5567ea8 | 1210 | "a", self._tc.create_single_precision_real_field_class(), self._ranges1 |
fe4df857 | 1211 | ) |
cfbd7cf3 | 1212 | self._fc.append_option( |
f5567ea8 | 1213 | "b", self._tc.create_signed_integer_field_class(21), self._ranges2 |
cfbd7cf3 FD |
1214 | ) |
1215 | self._fc.append_option( | |
f5567ea8 | 1216 | "c", self._tc.create_unsigned_integer_field_class(34), self._ranges3 |
cfbd7cf3 | 1217 | ) |
b4f45851 | 1218 | |
fe4df857 | 1219 | foo_fc = self._tc.create_single_precision_real_field_class() |
d47b87ac SM |
1220 | bar_fc = self._tc.create_string_field_class() |
1221 | baz_fc = self._tc.create_string_field_class() | |
b4f45851 | 1222 | |
d47b87ac | 1223 | inner_struct_fc = self._tc.create_structure_field_class() |
f5567ea8 FD |
1224 | inner_struct_fc.append_member("selector", self._selector_fc) |
1225 | inner_struct_fc.append_member("bar", bar_fc) | |
1226 | inner_struct_fc.append_member("baz", baz_fc) | |
1227 | inner_struct_fc.append_member("variant", self._fc) | |
b4f45851 | 1228 | |
cfbd7cf3 FD |
1229 | inner_struct_array_fc = self._tc.create_static_array_field_class( |
1230 | inner_struct_fc, 2 | |
1231 | ) | |
b4f45851 | 1232 | |
d47b87ac | 1233 | outer_struct_fc = self._tc.create_structure_field_class() |
f5567ea8 FD |
1234 | outer_struct_fc.append_member("foo", foo_fc) |
1235 | outer_struct_fc.append_member("inner_struct", inner_struct_array_fc) | |
b4f45851 | 1236 | |
d47b87ac SM |
1237 | # The path to the selector field is resolved when the sequence is |
1238 | # actually used, for example in a packet context. | |
cfbd7cf3 FD |
1239 | self._tc.create_stream_class( |
1240 | supports_packets=True, packet_context_field_class=outer_struct_fc | |
1241 | ) | |
b4f45851 | 1242 | |
d47b87ac | 1243 | def test_selector_field_path_length(self): |
45c51519 PP |
1244 | self._fill_default_fc_for_field_path_test() |
1245 | self.assertEqual(len(self._fc.selector_field_path), 3) | |
b4f45851 | 1246 | |
d47b87ac | 1247 | def test_selector_field_path_iter(self): |
45c51519 PP |
1248 | self._fill_default_fc_for_field_path_test() |
1249 | path_items = list(self._fc.selector_field_path) | |
b4f45851 | 1250 | |
d47b87ac | 1251 | self.assertEqual(len(path_items), 3) |
b4f45851 | 1252 | |
3fb99a22 | 1253 | self.assertIsInstance(path_items[0], bt2._IndexFieldPathItem) |
d47b87ac | 1254 | self.assertEqual(path_items[0].index, 1) |
b4f45851 | 1255 | |
3fb99a22 | 1256 | self.assertIsInstance(path_items[1], bt2._CurrentArrayElementFieldPathItem) |
b4f45851 | 1257 | |
3fb99a22 | 1258 | self.assertIsInstance(path_items[2], bt2._IndexFieldPathItem) |
d47b87ac | 1259 | self.assertEqual(path_items[2].index, 0) |
b4f45851 | 1260 | |
d47b87ac | 1261 | def test_selector_field_path_root_scope(self): |
45c51519 | 1262 | self._fill_default_fc_for_field_path_test() |
cfbd7cf3 | 1263 | self.assertEqual( |
e7ceb9df | 1264 | self._fc.selector_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT |
cfbd7cf3 | 1265 | ) |
45c51519 PP |
1266 | |
1267 | ||
cfbd7cf3 | 1268 | class VariantFieldClassWithUnsignedSelectorTestCase( |
fabfe034 | 1269 | _VariantFieldClassWithIntegerSelectorTestCase, unittest.TestCase |
cfbd7cf3 | 1270 | ): |
45c51519 PP |
1271 | def _spec_set_up(self): |
1272 | self._ranges1 = bt2.UnsignedIntegerRangeSet([(1, 4), (18, 47)]) | |
1273 | self._ranges2 = bt2.UnsignedIntegerRangeSet([(5, 5)]) | |
1274 | self._ranges3 = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) | |
1275 | self._inval_ranges = bt2.SignedIntegerRangeSet([(-8, 16), (48, 99)]) | |
1276 | self._selector_fc = self._tc.create_unsigned_integer_field_class() | |
1277 | ||
1278 | ||
cfbd7cf3 | 1279 | class VariantFieldClassWithSignedSelectorTestCase( |
fabfe034 | 1280 | _VariantFieldClassWithIntegerSelectorTestCase, unittest.TestCase |
cfbd7cf3 | 1281 | ): |
45c51519 PP |
1282 | def _spec_set_up(self): |
1283 | self._ranges1 = bt2.SignedIntegerRangeSet([(-10, -4), (18, 47)]) | |
1284 | self._ranges2 = bt2.SignedIntegerRangeSet([(-3, -3)]) | |
1285 | self._ranges3 = bt2.SignedIntegerRangeSet([(8, 16), (48, 99)]) | |
1286 | self._inval_ranges = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) | |
1287 | self._selector_fc = self._tc.create_signed_integer_field_class() | |
b4f45851 | 1288 | |
d47b87ac | 1289 | |
f0a42b33 FD |
1290 | class _ArrayFieldClassTestCase: |
1291 | def test_attr_element_field_class(self): | |
1292 | fc = self._create_array() | |
1293 | self.assertIs( | |
1294 | type(fc.element_field_class), bt2_field_class._SignedIntegerFieldClass | |
1295 | ) | |
1296 | ||
81b8fa44 PP |
1297 | |
1298 | class _ArrayFieldClassConstTestCase: | |
f0a42b33 FD |
1299 | def test_const_attr_element_field_class(self): |
1300 | fc = self._create_const_array() | |
1301 | self.assertIs( | |
1302 | type(fc.element_field_class), bt2_field_class._SignedIntegerFieldClassConst | |
1303 | ) | |
1304 | ||
1305 | ||
81b8fa44 PP |
1306 | class StaticArrayFieldClassTestCase( |
1307 | _ArrayFieldClassTestCase, _ArrayFieldClassConstTestCase, unittest.TestCase | |
1308 | ): | |
f0a42b33 FD |
1309 | @staticmethod |
1310 | def _const_value_setter(field): | |
d47b6b4e | 1311 | field.value = [9] * 45 |
f0a42b33 FD |
1312 | |
1313 | def _create_array(self): | |
1314 | return self._tc.create_static_array_field_class(self._elem_fc, 45) | |
1315 | ||
1316 | def _create_const_array(self): | |
1317 | fc = self._tc.create_static_array_field_class(self._elem_fc, 45) | |
1318 | return _create_const_field_class(self._tc, fc, self._const_value_setter) | |
1319 | ||
d47b87ac SM |
1320 | def setUp(self): |
1321 | self._tc = get_default_trace_class() | |
1322 | self._elem_fc = self._tc.create_signed_integer_field_class(23) | |
b4f45851 SM |
1323 | |
1324 | def test_create_default(self): | |
d47b87ac SM |
1325 | fc = self._tc.create_static_array_field_class(self._elem_fc, 45) |
1326 | self.assertEqual(fc.element_field_class.addr, self._elem_fc.addr) | |
1327 | self.assertEqual(fc.length, 45) | |
5783664e | 1328 | self.assertEqual(len(fc.user_attributes), 0) |
b4f45851 | 1329 | |
d47b87ac | 1330 | def test_create_invalid_elem_field_class(self): |
b4f45851 | 1331 | with self.assertRaises(TypeError): |
d47b87ac | 1332 | self._tc.create_static_array_field_class(object(), 45) |
b4f45851 SM |
1333 | |
1334 | def test_create_invalid_length(self): | |
1335 | with self.assertRaises(ValueError): | |
cfbd7cf3 FD |
1336 | self._tc.create_static_array_field_class( |
1337 | self._tc.create_string_field_class(), -17 | |
1338 | ) | |
b4f45851 SM |
1339 | |
1340 | def test_create_invalid_length_type(self): | |
1341 | with self.assertRaises(TypeError): | |
cfbd7cf3 | 1342 | self._tc.create_static_array_field_class( |
f5567ea8 | 1343 | self._tc.create_string_field_class(), "the length" |
cfbd7cf3 | 1344 | ) |
d47b87ac SM |
1345 | |
1346 | ||
81b8fa44 PP |
1347 | class DynamicArrayFieldClassTestCase( |
1348 | _ArrayFieldClassTestCase, _ArrayFieldClassConstTestCase, unittest.TestCase | |
1349 | ): | |
f0a42b33 FD |
1350 | @staticmethod |
1351 | def _const_value_setter(field): | |
d47b6b4e | 1352 | field.value = [] |
f0a42b33 FD |
1353 | |
1354 | def _create_array(self): | |
1355 | return self._tc.create_dynamic_array_field_class(self._elem_fc) | |
1356 | ||
1357 | def _create_const_array(self): | |
1358 | fc = self._tc.create_dynamic_array_field_class(self._elem_fc) | |
1359 | return _create_const_field_class(self._tc, fc, self._const_value_setter) | |
1360 | ||
d47b87ac SM |
1361 | def setUp(self): |
1362 | self._tc = get_default_trace_class() | |
1363 | self._elem_fc = self._tc.create_signed_integer_field_class(23) | |
b4f45851 | 1364 | |
d47b87ac SM |
1365 | def test_create_default(self): |
1366 | fc = self._tc.create_dynamic_array_field_class(self._elem_fc) | |
1367 | self.assertEqual(fc.element_field_class.addr, self._elem_fc.addr) | |
81b8fa44 PP |
1368 | self.assertEqual(len(fc.user_attributes), 0) |
1369 | ||
1370 | def test_create_invalid_field_class(self): | |
1371 | with self.assertRaises(TypeError): | |
1372 | self._tc.create_dynamic_array_field_class(object()) | |
1373 | ||
1374 | ||
1375 | class DynamicArrayWithLengthFieldFieldClassTestCase( | |
1376 | _ArrayFieldClassTestCase, unittest.TestCase | |
1377 | ): | |
1378 | @staticmethod | |
1379 | def _const_value_setter(field): | |
1380 | field.value = [] | |
1381 | ||
1382 | def _create_array(self): | |
1383 | return self._tc.create_dynamic_array_field_class(self._elem_fc, self._len_fc) | |
1384 | ||
1385 | def setUp(self): | |
1386 | self._tc = get_default_trace_class() | |
1387 | self._elem_fc = self._tc.create_signed_integer_field_class(23) | |
1388 | self._len_fc = self._tc.create_unsigned_integer_field_class(12) | |
1389 | ||
1390 | def test_create_default(self): | |
1391 | fc = self._create_array() | |
1392 | self.assertEqual(fc.element_field_class.addr, self._elem_fc.addr) | |
d47b87ac | 1393 | self.assertIsNone(fc.length_field_path, None) |
5783664e | 1394 | self.assertEqual(len(fc.user_attributes), 0) |
b4f45851 | 1395 | |
d47b87ac SM |
1396 | def _create_field_class_for_field_path_test(self): |
1397 | # Create something a field class that is equivalent to: | |
1398 | # | |
1399 | # struct outer_struct_fc { | |
1400 | # real foo; | |
1401 | # struct inner_struct_fc { | |
1402 | # string bar; | |
1403 | # string baz; | |
1404 | # uint12_t len; | |
1405 | # uint23_t dyn_array[len]; | |
1406 | # } inner_struct[2]; | |
1407 | # }; | |
b4f45851 | 1408 | |
81b8fa44 | 1409 | fc = self._create_array() |
b4f45851 | 1410 | |
fe4df857 | 1411 | foo_fc = self._tc.create_single_precision_real_field_class() |
d47b87ac SM |
1412 | bar_fc = self._tc.create_string_field_class() |
1413 | baz_fc = self._tc.create_string_field_class() | |
b4f45851 | 1414 | |
d47b87ac | 1415 | inner_struct_fc = self._tc.create_structure_field_class() |
f5567ea8 FD |
1416 | inner_struct_fc.append_member("bar", bar_fc) |
1417 | inner_struct_fc.append_member("baz", baz_fc) | |
1418 | inner_struct_fc.append_member("len", self._len_fc) | |
1419 | inner_struct_fc.append_member("dyn_array", fc) | |
b4f45851 | 1420 | |
cfbd7cf3 FD |
1421 | inner_struct_array_fc = self._tc.create_static_array_field_class( |
1422 | inner_struct_fc, 2 | |
1423 | ) | |
d47b87ac SM |
1424 | |
1425 | outer_struct_fc = self._tc.create_structure_field_class() | |
f5567ea8 FD |
1426 | outer_struct_fc.append_member("foo", foo_fc) |
1427 | outer_struct_fc.append_member("inner_struct", inner_struct_array_fc) | |
d47b87ac SM |
1428 | |
1429 | # The path to the length field is resolved when the sequence is | |
1430 | # actually used, for example in a packet context. | |
cfbd7cf3 FD |
1431 | self._tc.create_stream_class( |
1432 | packet_context_field_class=outer_struct_fc, supports_packets=True | |
1433 | ) | |
d47b87ac SM |
1434 | |
1435 | return fc | |
1436 | ||
1437 | def test_field_path_len(self): | |
1438 | fc = self._create_field_class_for_field_path_test() | |
1439 | self.assertEqual(len(fc.length_field_path), 3) | |
1440 | ||
1441 | def test_field_path_iter(self): | |
1442 | fc = self._create_field_class_for_field_path_test() | |
1443 | path_items = list(fc.length_field_path) | |
1444 | ||
1445 | self.assertEqual(len(path_items), 3) | |
1446 | ||
3fb99a22 | 1447 | self.assertIsInstance(path_items[0], bt2._IndexFieldPathItem) |
d47b87ac SM |
1448 | self.assertEqual(path_items[0].index, 1) |
1449 | ||
3fb99a22 | 1450 | self.assertIsInstance(path_items[1], bt2._CurrentArrayElementFieldPathItem) |
d47b87ac | 1451 | |
3fb99a22 | 1452 | self.assertIsInstance(path_items[2], bt2._IndexFieldPathItem) |
d47b87ac SM |
1453 | self.assertEqual(path_items[2].index, 2) |
1454 | ||
1455 | def test_field_path_root_scope(self): | |
1456 | fc = self._create_field_class_for_field_path_test() | |
e7ceb9df PP |
1457 | self.assertEqual( |
1458 | fc.length_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT | |
1459 | ) | |
b4f45851 | 1460 | |
b4f45851 SM |
1461 | def test_create_invalid_length_type(self): |
1462 | with self.assertRaises(TypeError): | |
cfbd7cf3 FD |
1463 | self._tc.create_dynamic_array_field_class( |
1464 | self._tc.create_string_field_class(), 17 | |
1465 | ) | |
b4f45851 | 1466 | |
b4f45851 | 1467 | |
d47b87ac SM |
1468 | if __name__ == "__main__": |
1469 | unittest.main() |