tests/bindings/python/bt2/test_field_class.py

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