X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Fbindings%2Fpython%2Fbt2%2Ftest_field_class.py;h=1d883eea061aa78654c1cd84440cf63bf70afee9;hb=f0a42b33ac3951cd5cb2ee0f66ac04437a681621;hp=afdf9b63088ac4156951ef3ef68e877803eeb317;hpb=185ecf645233ced089ad72b060a420e8f6f7edeb;p=babeltrace.git diff --git a/tests/bindings/python/bt2/test_field_class.py b/tests/bindings/python/bt2/test_field_class.py index afdf9b63..1d883eea 100644 --- a/tests/bindings/python/bt2/test_field_class.py +++ b/tests/bindings/python/bt2/test_field_class.py @@ -16,271 +16,473 @@ # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # -import bt2.field import unittest import bt2 -from utils import get_default_trace_class +from utils import get_default_trace_class, TestOutputPortMessageIterator +from bt2 import value as bt2_value +from bt2 import field_class as bt2_field_class + + +def _create_stream(tc, ctx_field_classes): + packet_context_fc = tc.create_structure_field_class() + for name, fc in ctx_field_classes: + packet_context_fc.append_member(name, fc) + + trace = tc() + stream_class = tc.create_stream_class( + packet_context_field_class=packet_context_fc, supports_packets=True + ) + + stream = trace.create_stream(stream_class) + return stream + + +def _create_const_field_class(tc, field_class, value_setter_fn): + field_name = 'const field' + + class MyIter(bt2._UserMessageIterator): + def __init__(self, self_port_output): + nonlocal field_class + nonlocal value_setter_fn + stream = _create_stream(tc, [(field_name, field_class)]) + packet = stream.create_packet() + + value_setter_fn(packet.context_field[field_name]) + + self._msgs = [ + self._create_stream_beginning_message(stream), + self._create_packet_beginning_message(packet), + ] + + def __next__(self): + if len(self._msgs) == 0: + raise StopIteration + + return self._msgs.pop(0) + + class MySrc(bt2._UserSourceComponent, message_iterator_class=MyIter): + def __init__(self, params, obj): + self._add_output_port('out', params) + + graph = bt2.Graph() + src_comp = graph.add_component(MySrc, 'my_source', None) + msg_iter = TestOutputPortMessageIterator(graph, src_comp.output_ports['out']) + + # Ignore first message, stream beginning + _ = next(msg_iter) + packet_beg_msg = next(msg_iter) + + return packet_beg_msg.packet.context_field[field_name].cls + + +class _TestFieldClass: + def test_create_user_attributes(self): + fc = self._create_default_field_class(user_attributes={'salut': 23}) + self.assertEqual(fc.user_attributes, {'salut': 23}) + self.assertIs(type(fc.user_attributes), bt2_value.MapValue) + + def test_const_create_user_attributes(self): + fc = self._create_default_const_field_class(user_attributes={'salut': 23}) + self.assertEqual(fc.user_attributes, {'salut': 23}) + self.assertIs(type(fc.user_attributes), bt2_value._MapValueConst) + + def test_create_invalid_user_attributes(self): + with self.assertRaises(TypeError): + self._create_default_field_class(user_attributes=object()) + + def test_create_invalid_user_attributes_value_type(self): + with self.assertRaises(TypeError): + self._create_default_field_class(user_attributes=23) + + +class BoolFieldClassTestCase(_TestFieldClass, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field = False + + def _create_default_field_class(self, **kwargs): + tc = get_default_trace_class() + return tc.create_bool_field_class(**kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_bool_field_class(*args, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) + + def setUp(self): + self._fc = self._create_default_field_class() + self._fc_const = self._create_default_const_field_class() + + def test_create_default(self): + self.assertIsNotNone(self._fc) + self.assertEqual(len(self._fc.user_attributes), 0) + + +class BitArrayFieldClassTestCase(_TestFieldClass, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field = [] + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_bit_array_field_class(*args, **kwargs) + + def _create_default_field_class(self, **kwargs): + return self._create_field_class(17, **kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_bit_array_field_class(17, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) + + def setUp(self): + self._fc = self._create_default_field_class() + + def test_create_default(self): + self.assertIsNotNone(self._fc) + self.assertEqual(len(self._fc.user_attributes), 0) + + def test_create_length_out_of_range(self): + with self.assertRaises(ValueError): + self._create_field_class(65) + + def test_create_length_zero(self): + with self.assertRaises(ValueError): + self._create_field_class(0) + + def test_create_length_invalid_type(self): + with self.assertRaises(TypeError): + self._create_field_class('lel') + + def test_length_prop(self): + self.assertEqual(self._fc.length, 17) class _TestIntegerFieldClassProps: def test_create_default(self): - fc = self._create_func() + fc = self._create_default_field_class() self.assertEqual(fc.field_value_range, 64) self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.DECIMAL) + self.assertEqual(len(fc.user_attributes), 0) def test_create_range(self): - fc = self._create_func(field_value_range=35) + fc = self._create_field_class(field_value_range=35) self.assertEqual(fc.field_value_range, 35) - fc = self._create_func(36) + fc = self._create_field_class(36) self.assertEqual(fc.field_value_range, 36) def test_create_invalid_range(self): with self.assertRaises(TypeError): - self._create_func('yes') + self._create_field_class('yes') with self.assertRaises(TypeError): - self._create_func(field_value_range='yes') + self._create_field_class(field_value_range='yes') with self.assertRaises(ValueError): - self._create_func(field_value_range=-2) + self._create_field_class(field_value_range=-2) with self.assertRaises(ValueError): - self._create_func(field_value_range=0) + self._create_field_class(field_value_range=0) def test_create_base(self): - fc = self._create_func(preferred_display_base=bt2.IntegerDisplayBase.HEXADECIMAL) + fc = self._create_field_class( + preferred_display_base=bt2.IntegerDisplayBase.HEXADECIMAL + ) self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.HEXADECIMAL) def test_create_invalid_base_type(self): with self.assertRaises(TypeError): - self._create_func(preferred_display_base='yes') + self._create_field_class(preferred_display_base='yes') def test_create_invalid_base_value(self): with self.assertRaises(ValueError): - self._create_func(preferred_display_base=444) + self._create_field_class(preferred_display_base=444) def test_create_full(self): - fc = self._create_func(24, preferred_display_base=bt2.IntegerDisplayBase.OCTAL) + fc = self._create_field_class( + 24, preferred_display_base=bt2.IntegerDisplayBase.OCTAL + ) self.assertEqual(fc.field_value_range, 24) self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.OCTAL) -class IntegerFieldClassTestCase(_TestIntegerFieldClassProps, unittest.TestCase): - def setUp(self): - self._tc = get_default_trace_class() - self._create_func = self._tc.create_signed_integer_field_class +class SignedIntegerFieldClassTestCase( + _TestIntegerFieldClassProps, _TestFieldClass, unittest.TestCase +): + @staticmethod + def _const_value_setter(field): + field = -18 + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_signed_integer_field_class(*args, **kwargs) -class RealFieldClassTestCase(unittest.TestCase): - def setUp(self): - self._tc = get_default_trace_class() + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_signed_integer_field_class(*args, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) + + _create_default_field_class = _create_field_class + + +class UnsignedIntegerFieldClassTestCase( + _TestIntegerFieldClassProps, _TestFieldClass, unittest.TestCase +): + @staticmethod + def _const_value_setter(field): + field = 18 + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_unsigned_integer_field_class(*args, **kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_signed_integer_field_class(*args, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) + + _create_default_field_class = _create_field_class + + +class RealFieldClassTestCase(_TestFieldClass, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field = -18 + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_real_field_class(*args, **kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_real_field_class(*args, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) + + _create_default_field_class = _create_field_class def test_create_default(self): - fc = self._tc.create_real_field_class() + fc = self._create_field_class() self.assertFalse(fc.is_single_precision) + self.assertEqual(len(fc.user_attributes), 0) def test_create_is_single_precision(self): - fc = self._tc.create_real_field_class(is_single_precision=True) + fc = self._create_field_class(is_single_precision=True) self.assertTrue(fc.is_single_precision) def test_create_invalid_is_single_precision(self): with self.assertRaises(TypeError): - self._tc.create_real_field_class(is_single_precision='hohoho') + self._create_field_class(is_single_precision='hohoho') # Converts an _EnumerationFieldClassMapping to a list of ranges: # # [(lower0, upper0), (lower1, upper1), ...] -def enum_mapping_to_list(mapping): - return sorted([(x.lower, x.upper) for x in mapping]) + +def enum_mapping_to_set(mapping): + return {(x.lower, x.upper) for x in mapping.ranges} -class EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): +class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): def setUp(self): - self._tc = get_default_trace_class() + self._spec_set_up() + self._fc = self._create_default_field_class() + self._fc_const = self._create_default_const_field_class() def test_create_from_invalid_type(self): with self.assertRaises(TypeError): - self._create_func('coucou') + self._create_field_class('coucou') def test_add_mapping_simple(self): - self._fc.map_range('hello', 24) + self._fc.add_mapping('hello', self._ranges1) mapping = self._fc['hello'] self.assertEqual(mapping.label, 'hello') + self.assertEqual(mapping.ranges, self._ranges1) - ranges = enum_mapping_to_list(mapping) - self.assertEqual(ranges, [(24, 24)]) + def test_const_add_mapping(self): + with self.assertRaises(AttributeError): + self._fc_const.add_mapping('hello', self._ranges1) def test_add_mapping_simple_kwargs(self): - self._fc.map_range(label='hello', lower=17, upper=23) + self._fc.add_mapping(label='hello', ranges=self._ranges1) mapping = self._fc['hello'] self.assertEqual(mapping.label, 'hello') + self.assertEqual(mapping.ranges, self._ranges1) - ranges = enum_mapping_to_list(mapping) - self.assertEqual(ranges, [(17, 23)]) + def test_add_mapping_invalid_name(self): + with self.assertRaises(TypeError): + self._fc.add_mapping(17, self._ranges1) - def test_add_mapping_range(self): - self._fc.map_range('hello', 21, 199) - mapping = self._fc['hello'] - self.assertEqual(mapping.label, 'hello') + def test_add_mapping_invalid_range(self): + with self.assertRaises(TypeError): + self._fc.add_mapping('allo', 'meow') - ranges = enum_mapping_to_list(mapping) - self.assertEqual(ranges, [(21, 199)]) + def test_add_mapping_dup_label(self): + with self.assertRaises(ValueError): + self._fc.add_mapping('a', self._ranges1) + self._fc.add_mapping('a', self._ranges2) - def test_add_mapping_invalid_name(self): + def test_add_mapping_invalid_ranges_signedness(self): with self.assertRaises(TypeError): - self._fc.map_range(17, 21, 199) + self._fc.add_mapping('allo', self._inval_ranges) def test_iadd(self): - enum_fc = self._tc.create_signed_enumeration_field_class(field_value_range=16) - enum_fc.map_range('c', 4, 5) - enum_fc.map_range('d', 6, 18) - enum_fc.map_range('e', 20, 27) - self._fc.map_range('a', 0, 2) - self._fc.map_range('b', 3) - self._fc += enum_fc + self._fc.add_mapping('c', self._ranges1) - self.assertEqual(self._fc['a'].label, 'a') - self.assertEqual(enum_mapping_to_list(self._fc['a']), [(0, 2)]) - - self.assertEqual(self._fc['b'].label, 'b') - self.assertEqual(enum_mapping_to_list(self._fc['b']), [(3, 3)]) + self._fc += [('d', self._ranges2), ('e', self._ranges3)] + self.assertEqual(len(self._fc), 3) self.assertEqual(self._fc['c'].label, 'c') - self.assertEqual(enum_mapping_to_list(self._fc['c']), [(4, 5)]) - + self.assertEqual(self._fc['c'].ranges, self._ranges1) self.assertEqual(self._fc['d'].label, 'd') - self.assertEqual(enum_mapping_to_list(self._fc['d']), [(6, 18)]) - + self.assertEqual(self._fc['d'].ranges, self._ranges2) self.assertEqual(self._fc['e'].label, 'e') - self.assertEqual(enum_mapping_to_list(self._fc['e']), [(20, 27)]) + self.assertEqual(self._fc['e'].ranges, self._ranges3) + + def test_const_iadd(self): + with self.assertRaises(TypeError): + self._fc_const += [('d', self._ranges2), ('e', self._ranges3)] def test_bool_op(self): self.assertFalse(self._fc) - self._fc.map_range('a', 0) + self._fc.add_mapping('a', self._ranges1) self.assertTrue(self._fc) def test_len(self): - self._fc.map_range('a', 0) - self._fc.map_range('b', 1) - self._fc.map_range('c', 2) + self._fc.add_mapping('a', self._ranges1) + self._fc.add_mapping('b', self._ranges2) + self._fc.add_mapping('c', self._ranges3) self.assertEqual(len(self._fc), 3) def test_getitem(self): - self._fc.map_range('a', 0) - self._fc.map_range('b', 1, 3) - self._fc.map_range('a', 5) - self._fc.map_range('a', 17, 123) - self._fc.map_range('C', 5) + self._fc.add_mapping('a', self._ranges1) + self._fc.add_mapping('b', self._ranges2) + self._fc.add_mapping('c', self._ranges3) mapping = self._fc['a'] - self.assertEqual(mapping.label, 'a') - ranges = enum_mapping_to_list(mapping) - self.assertEqual(ranges, [(0, 0), (5, 5), (17, 123)]) + self.assertEqual(mapping.ranges, self._ranges1) + def test_getitem_nonexistent(self): with self.assertRaises(KeyError): self._fc['doesnotexist'] - def test_contains(self): - self._fc.map_range('a', 0) - self._fc.map_range('a', 2, 23) - self._fc.map_range('b', 2) - self._fc.map_range('c', 5) - - a_mapping = self._fc['a'] - b_mapping = self._fc['b'] - first_range = next(iter(a_mapping)) - - self.assertIn(first_range, a_mapping) - self.assertNotIn(first_range, b_mapping) - def test_iter(self): - self._fc.map_range('a', 1, 5) - self._fc.map_range('b', 10, 17) - self._fc.map_range('c', 20, 1504) - - self._fc.map_range('d', 22510, 99999) + self._fc.add_mapping('a', self._ranges1) + self._fc.add_mapping('b', self._ranges2) + self._fc.add_mapping('c', self._ranges3) # This exercises iteration. labels = sorted(self._fc) - self.assertEqual(labels, ['a', 'b', 'c', 'd']) + self.assertEqual(labels, ['a', 'b', 'c']) def test_find_by_value(self): - self._fc.map_range('a', 0) - self._fc.map_range('b', 1, 3) - self._fc.map_range('c', 5, 19) - self._fc.map_range('d', 8, 15) - self._fc.map_range('e', 10, 21) - self._fc.map_range('f', 0) - self._fc.map_range('g', 14) + self._fc.add_mapping('a', self._ranges1) + self._fc.add_mapping('b', self._ranges2) + self._fc.add_mapping('c', self._ranges3) + mappings = self._fc.mappings_for_value(self._value_in_range_1_and_3) + labels = set([mapping.label for mapping in mappings]) + expected_labels = set(['a', 'c']) + self.assertEqual(labels, expected_labels) + + +class UnsignedEnumerationFieldClassTestCase( + _EnumerationFieldClassTestCase, _TestFieldClass, unittest.TestCase +): + def _spec_set_up(self): + self._ranges1 = bt2.UnsignedIntegerRangeSet([(1, 4), (18, 47)]) + self._ranges2 = bt2.UnsignedIntegerRangeSet([(5, 5)]) + self._ranges3 = bt2.UnsignedIntegerRangeSet([(8, 22), (48, 99)]) + self._inval_ranges = bt2.SignedIntegerRangeSet([(-8, -5), (48, 1928)]) + self._value_in_range_1_and_3 = 20 + + @staticmethod + def _const_value_setter(field): + field = 0 + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_unsigned_enumeration_field_class(*args, **kwargs) - labels = self._fc.labels_for_value(14) + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_unsigned_enumeration_field_class(*args, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) - expected_labels = ['c', 'd', 'e', 'g'] + _create_default_field_class = _create_field_class - self.assertTrue(all(label in labels for label in expected_labels)) +class SignedEnumerationFieldClassTestCase( + _EnumerationFieldClassTestCase, _TestFieldClass, unittest.TestCase +): + def _spec_set_up(self): + self._ranges1 = bt2.SignedIntegerRangeSet([(-10, -4), (18, 47)]) + self._ranges2 = bt2.SignedIntegerRangeSet([(-3, -3)]) + self._ranges3 = bt2.SignedIntegerRangeSet([(-100, -1), (8, 16), (48, 99)]) + self._inval_ranges = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) + self._value_in_range_1_and_3 = -7 -class UnsignedEnumerationFieldClassTestCase(EnumerationFieldClassTestCase, unittest.TestCase): - def setUp(self): - super().setUp() - self._create_func = self._tc.create_unsigned_enumeration_field_class - self._fc = self._tc.create_unsigned_enumeration_field_class() + @staticmethod + def _const_value_setter(field): + field = 0 - def test_add_mapping_invalid_signedness_lower(self): - with self.assertRaises(ValueError): - self._fc.map_range('hello', -21, 199) + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_signed_enumeration_field_class(*args, **kwargs) - def test_add_mapping_invalid_signedness_upper(self): - with self.assertRaises(ValueError): - self._fc.map_range('hello', 21, -199) + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_signed_enumeration_field_class(*args, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) + _create_default_field_class = _create_field_class -class SignedEnumerationFieldClassTestCase(EnumerationFieldClassTestCase, unittest.TestCase): - def setUp(self): - super().setUp() - self._create_func = self._tc.create_signed_enumeration_field_class - self._fc = self._tc.create_signed_enumeration_field_class() - def test_add_mapping_simple_signed(self): - self._fc.map_range('hello', -24) - mapping = self._fc['hello'] - self.assertEqual(mapping.label, 'hello') +class StringFieldClassTestCase(_TestFieldClass, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field = 'chaine' - ranges = enum_mapping_to_list(mapping) - self.assertEqual(ranges, [(-24, -24)]) + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_string_field_class(*args, **kwargs) - def test_add_mapping_range_signed(self): - self._fc.map_range('hello', -21, 199) - mapping = self._fc['hello'] - self.assertEqual(mapping.label, 'hello') - ranges = enum_mapping_to_list(mapping) - self.assertEqual(ranges, [(-21, 199)]) + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_string_field_class(*args, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) + _create_default_field_class = _create_field_class -class StringFieldClassTestCase(unittest.TestCase): def setUp(self): - tc = get_default_trace_class() - self._fc = tc.create_string_field_class() + self._fc = self._create_default_field_class() def test_create_default(self): self.assertIsNotNone(self._fc) + self.assertEqual(len(self._fc.user_attributes), 0) -class _TestFieldContainer(): +class _TestElementContainer: + def setUp(self): + self._tc = get_default_trace_class() + self._fc = self._create_default_field_class() + self._fc_const = self._create_default_const_field_class() + + def test_create_default(self): + self.assertIsNotNone(self._fc) + self.assertEqual(len(self._fc.user_attributes), 0) + def test_append_element(self): int_field_class = self._tc.create_signed_integer_field_class(32) self._append_element_method(self._fc, 'int32', int_field_class) - field_class = self._fc['int32'] + field_class = self._fc['int32'].field_class self.assertEqual(field_class.addr, int_field_class.addr) - def test_append_elemenbt_kwargs(self): + def test_append_element_kwargs(self): int_field_class = self._tc.create_signed_integer_field_class(32) self._append_element_method(self._fc, name='int32', field_class=int_field_class) - field_class = self._fc['int32'] + field_class = self._fc['int32'].field_class self.assertEqual(field_class.addr, int_field_class.addr) def test_append_element_invalid_name(self): @@ -293,24 +495,62 @@ class _TestFieldContainer(): with self.assertRaises(TypeError): self._append_element_method(self._fc, 'yes', object()) + def test_append_element_dup_name(self): + sub_fc1 = self._tc.create_string_field_class() + sub_fc2 = self._tc.create_string_field_class() + + with self.assertRaises(ValueError): + self._append_element_method(self._fc, 'yes', sub_fc1) + self._append_element_method(self._fc, 'yes', sub_fc2) + + def test_attr_field_class(self): + int_field_class = self._tc.create_signed_integer_field_class(32) + self._append_element_method(self._fc, 'int32', int_field_class) + field_class = self._fc['int32'].field_class + + self.assertIs(type(field_class), bt2_field_class._SignedIntegerFieldClass) + + def test_const_attr_field_class(self): + int_field_class = self._tc.create_signed_integer_field_class(32) + self._append_element_method(self._fc, 'int32', int_field_class) + field_class = self._fc['int32'].field_class + const_fc = _create_const_field_class( + self._tc, self._fc, self._const_value_setter + ) + field_class = const_fc['int32'].field_class + + self.assertIs(type(field_class), bt2_field_class._SignedIntegerFieldClassConst) + def test_iadd(self): - struct_fc = self._tc.create_structure_field_class() - c_field_class = self._tc.create_string_field_class() - d_field_class = self._tc.create_signed_enumeration_field_class(field_value_range=32) - e_field_class = self._tc.create_structure_field_class() - self._append_element_method(struct_fc, 'c_string', c_field_class) - self._append_element_method(struct_fc, 'd_enum', d_field_class) - self._append_element_method(struct_fc, 'e_struct', e_field_class) a_field_class = self._tc.create_real_field_class() b_field_class = self._tc.create_signed_integer_field_class(17) self._append_element_method(self._fc, 'a_float', a_field_class) self._append_element_method(self._fc, 'b_int', b_field_class) - self._fc += struct_fc - self.assertEqual(self._fc['a_float'].addr, a_field_class.addr) - self.assertEqual(self._fc['b_int'].addr, b_field_class.addr) - self.assertEqual(self._fc['c_string'].addr, c_field_class.addr) - self.assertEqual(self._fc['d_enum'].addr, d_field_class.addr) - self.assertEqual(self._fc['e_struct'].addr, e_field_class.addr) + c_field_class = self._tc.create_string_field_class() + d_field_class = self._tc.create_signed_enumeration_field_class( + field_value_range=32 + ) + e_field_class = self._tc.create_structure_field_class() + self._fc += [ + ('c_string', c_field_class), + ('d_enum', d_field_class), + ('e_struct', e_field_class), + ] + self.assertEqual(self._fc['a_float'].field_class.addr, a_field_class.addr) + self.assertEqual(self._fc['a_float'].name, 'a_float') + self.assertEqual(self._fc['b_int'].field_class.addr, b_field_class.addr) + self.assertEqual(self._fc['b_int'].name, 'b_int') + self.assertEqual(self._fc['c_string'].field_class.addr, c_field_class.addr) + self.assertEqual(self._fc['c_string'].name, 'c_string') + self.assertEqual(self._fc['d_enum'].field_class.addr, d_field_class.addr) + self.assertEqual(self._fc['d_enum'].name, 'd_enum') + self.assertEqual(self._fc['e_struct'].field_class.addr, e_field_class.addr) + self.assertEqual(self._fc['e_struct'].name, 'e_struct') + + def test_const_iadd(self): + a_field_class = self._tc.create_real_field_class() + with self.assertRaises(TypeError): + self._fc_const += a_field_class def test_bool_op(self): self.assertFalse(self._fc) @@ -318,10 +558,9 @@ class _TestFieldContainer(): self.assertTrue(self._fc) def test_len(self): - fc = self._tc.create_string_field_class() - self._append_element_method(self._fc, 'a', fc) - self._append_element_method(self._fc, 'b', fc) - self._append_element_method(self._fc, 'c', fc) + self._append_element_method(self._fc, 'a', self._tc.create_string_field_class()) + self._append_element_method(self._fc, 'b', self._tc.create_string_field_class()) + self._append_element_method(self._fc, 'c', self._tc.create_string_field_class()) self.assertEqual(len(self._fc), 3) def test_getitem(self): @@ -331,7 +570,8 @@ class _TestFieldContainer(): self._append_element_method(self._fc, 'a', a_fc) self._append_element_method(self._fc, 'b', b_fc) self._append_element_method(self._fc, 'c', c_fc) - self.assertEqual(self._fc['b'].addr, b_fc.addr) + self.assertEqual(self._fc['b'].field_class.addr, b_fc.addr) + self.assertEqual(self._fc['b'].name, 'b') def test_getitem_invalid_key_type(self): with self.assertRaises(TypeError): @@ -350,18 +590,16 @@ class _TestFieldContainer(): a_fc = self._tc.create_signed_integer_field_class(32) b_fc = self._tc.create_string_field_class() c_fc = self._tc.create_real_field_class() - fields = ( - ('a', a_fc), - ('b', b_fc), - ('c', c_fc), - ) + elements = (('a', a_fc), ('b', b_fc), ('c', c_fc)) - for field in fields: - self._append_element_method(self._fc, *field) + for elem in elements: + self._append_element_method(self._fc, *elem) - for (name, fc_field_class), field in zip(self._fc.items(), fields): - self.assertEqual(name, field[0]) - self.assertEqual(fc_field_class.addr, field[1].addr) + for (name, element), test_elem in zip(self._fc.items(), elements): + self.assertEqual(element.name, test_elem[0]) + self.assertEqual(name, element.name) + self.assertEqual(element.field_class.addr, test_elem[1].addr) + self.assertEqual(len(element.user_attributes), 0) def test_at_index(self): a_fc = self._tc.create_signed_integer_field_class(32) @@ -370,80 +608,503 @@ class _TestFieldContainer(): self._append_element_method(self._fc, 'c', c_fc) self._append_element_method(self._fc, 'a', a_fc) self._append_element_method(self._fc, 'b', b_fc) - self.assertEqual(self._at_index_method(self._fc, 1).addr, a_fc.addr) + elem = self._at_index_method(self._fc, 1) + self.assertEqual(elem.field_class.addr, a_fc.addr) + self.assertEqual(elem.name, 'a') def test_at_index_invalid(self): - self._append_element_method(self._fc, 'c', self._tc.create_signed_integer_field_class(32)) + self._append_element_method( + self._fc, 'c', self._tc.create_signed_integer_field_class(32) + ) with self.assertRaises(TypeError): self._at_index_method(self._fc, 'yes') def test_at_index_out_of_bounds_after(self): - self._append_element_method(self._fc, 'c', self._tc.create_signed_integer_field_class(32)) + self._append_element_method( + self._fc, 'c', self._tc.create_signed_integer_field_class(32) + ) with self.assertRaises(IndexError): self._at_index_method(self._fc, len(self._fc)) + def test_user_attributes(self): + self._append_element_method( + self._fc, + 'c', + self._tc.create_string_field_class(), + user_attributes={'salut': 23}, + ) + self.assertEqual(self._fc['c'].user_attributes, {'salut': 23}) + self.assertIs(type(self._fc.user_attributes), bt2_value.MapValue) + self.assertIs(type(self._fc['c'].user_attributes), bt2_value.MapValue) + + def test_invalid_user_attributes(self): + with self.assertRaises(TypeError): + self._append_element_method( + self._fc, + 'c', + self._tc.create_string_field_class(), + user_attributes=object(), + ) + + def test_invalid_user_attributes_value_type(self): + with self.assertRaises(TypeError): + self._append_element_method( + self._fc, 'c', self._tc.create_string_field_class(), user_attributes=23 + ) + + +class StructureFieldClassTestCase( + _TestFieldClass, _TestElementContainer, unittest.TestCase +): + _append_element_method = staticmethod(bt2._StructureFieldClass.append_member) + _at_index_method = staticmethod(bt2._StructureFieldClass.member_at_index) + + @staticmethod + def _const_value_setter(field): + field.value = {} + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_structure_field_class(*args, **kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_structure_field_class(*args, **kwargs) + return _create_const_field_class(tc, fc, self._const_value_setter) + + _create_default_field_class = _create_field_class + + def test_const_member_field_class(self): + def _real_value_setter(field): + field.value = {'real': 0} + + tc = get_default_trace_class() + fc = tc.create_structure_field_class() + member_fc = self._tc.create_real_field_class() + fc.append_member('real', member_fc) + const_fc = _create_const_field_class(tc, fc, _real_value_setter) + + self.assertIs( + type(const_fc['real'].field_class), bt2_field_class._RealFieldClassConst + ) + + def test_member_field_class(self): + tc = get_default_trace_class() + fc = tc.create_structure_field_class() + member_fc = self._tc.create_real_field_class() + fc.append_member('real', member_fc) + + self.assertIs(type(fc['real'].field_class), bt2_field_class._RealFieldClass) + + +class OptionFieldClassTestCase(_TestFieldClass, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field.has_field = True + field.value = 12 + + def _create_default_field_class(self, *args, **kwargs): + return self._tc.create_option_field_class(self._content_fc, **kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + fc = self._tc.create_option_field_class(self._content_fc, **kwargs) + return _create_const_field_class(self._tc, fc, self._const_value_setter) -class StructureFieldClassTestCase(_TestFieldContainer, unittest.TestCase): def setUp(self): - self._append_element_method = bt2.field_class._StructureFieldClass.append_member - self._at_index_method = bt2.field_class._StructureFieldClass.member_at_index self._tc = get_default_trace_class() - self._fc = self._tc.create_structure_field_class() + self._content_fc = self._tc.create_signed_integer_field_class(23) + self._tag_fc = self._tc.create_bool_field_class() def test_create_default(self): - self.assertIsNotNone(self._fc) + fc = self._create_default_field_class() + self.assertEqual(fc.field_class.addr, self._content_fc.addr) + self.assertIsNone(fc.selector_field_path, None) + self.assertEqual(len(fc.user_attributes), 0) + + def test_attr_field_class(self): + fc = self._create_default_field_class() + self.assertIs(type(fc.field_class), bt2_field_class._SignedIntegerFieldClass) + + def test_const_attr_field_class(self): + fc = self._create_default_const_field_class() + self.assertIs( + type(fc.field_class), bt2_field_class._SignedIntegerFieldClassConst + ) + def _create_field_class_for_field_path_test(self): + fc = self._create_default_field_class(selector_fc=self._tag_fc) + + foo_fc = self._tc.create_real_field_class() + bar_fc = self._tc.create_string_field_class() + baz_fc = self._tc.create_string_field_class() + + inner_struct_fc = self._tc.create_structure_field_class() + inner_struct_fc.append_member('bar', bar_fc) + inner_struct_fc.append_member('baz', baz_fc) + inner_struct_fc.append_member('tag', self._tag_fc) + inner_struct_fc.append_member('opt', fc) + + opt_struct_array_fc = self._tc.create_option_field_class(inner_struct_fc) + + outer_struct_fc = self._tc.create_structure_field_class() + outer_struct_fc.append_member('foo', foo_fc) + outer_struct_fc.append_member('inner_opt', opt_struct_array_fc) + + # The path to the selector field class is resolved when the + # option field class is actually used, for example in a packet + # context. + self._tc.create_stream_class( + packet_context_field_class=outer_struct_fc, supports_packets=True + ) + + return fc + + def test_field_path_len(self): + fc = self._create_field_class_for_field_path_test() + self.assertEqual(len(fc.selector_field_path), 3) + + def test_field_path_iter(self): + fc = self._create_field_class_for_field_path_test() + path_items = list(fc.selector_field_path) + + self.assertEqual(len(path_items), 3) + + self.assertIsInstance(path_items[0], bt2._IndexFieldPathItem) + self.assertEqual(path_items[0].index, 1) + + self.assertIsInstance(path_items[1], bt2._CurrentOptionContentFieldPathItem) + + self.assertIsInstance(path_items[2], bt2._IndexFieldPathItem) + self.assertEqual(path_items[2].index, 2) + + def test_field_path_root_scope(self): + fc = self._create_field_class_for_field_path_test() + self.assertEqual( + fc.selector_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT + ) + + def test_create_invalid_field_class(self): + with self.assertRaises(TypeError): + self._tc.create_option_field_class(object()) + + def test_create_invalid_selector_type(self): + with self.assertRaises(TypeError): + self._tc.create_option_field_class(self._content_fc, 17) + + +class VariantFieldClassWithoutSelectorTestCase( + _TestFieldClass, _TestElementContainer, unittest.TestCase +): + _append_element_method = staticmethod( + bt2._VariantFieldClassWithoutSelector.append_option + ) + _at_index_method = staticmethod( + bt2._VariantFieldClassWithoutSelector.option_at_index + ) + + @staticmethod + def _const_value_setter(variant_field): + variant_field.selected_option_index = 0 + variant_field.value = 12 + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_variant_field_class(*args, **kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_variant_field_class(*args, **kwargs) + int_field_class = self._tc.create_signed_integer_field_class(32) + fc.append_option('int32', int_field_class) + + return _create_const_field_class(tc, fc, self._const_value_setter) + + _create_default_field_class = _create_field_class + + +class _VariantFieldClassWithSelectorTestCase: + @staticmethod + def _const_value_setter(field): + field['variant'].selected_option_index = 0 + field['variant'] = 12 + + def _create_default_field_class(self, *args, **kwargs): + return self._tc.create_variant_field_class( + *args, selector_fc=self._selector_fc, **kwargs + ) + + def _create_default_const_field_class(self, *args, **kwargs): + # Create a struct to contain the variant and its selector else we can't + # create the non-const field necessary to get the the const field_class + struct_fc = self._tc.create_structure_field_class() + struct_fc.append_member('selecteux', self._selector_fc) + variant_fc = self._tc.create_variant_field_class( + *args, selector_fc=self._selector_fc + ) + variant_fc.append_option( + 'a', self._tc.create_signed_integer_field_class(32), self._ranges1 + ) + struct_fc.append_member('variant', variant_fc, **kwargs) + + return _create_const_field_class(self._tc, struct_fc, self._const_value_setter)[ + 'variant' + ].field_class -class VariantFieldClassTestCase(_TestFieldContainer, unittest.TestCase): def setUp(self): - self._append_element_method = bt2.field_class._VariantFieldClass.append_option - self._at_index_method = bt2.field_class._VariantFieldClass.option_at_index self._tc = get_default_trace_class() - self._fc = self._tc.create_variant_field_class() + self._spec_set_up() + self._fc = self._create_default_field_class() def test_create_default(self): - fc = self._tc.create_variant_field_class() + self.assertIsNotNone(self._fc) + self.assertEqual(len(self._fc.user_attributes), 0) - self.assertIsNone(fc.selector_field_path) + def test_append_element(self): + str_field_class = self._tc.create_string_field_class() + self._fc.append_option('str', str_field_class, self._ranges1) + opt = self._fc['str'] + self.assertEqual(opt.field_class.addr, str_field_class.addr) + self.assertEqual(opt.name, 'str') + self.assertEqual(opt.ranges.addr, self._ranges1.addr) + + def test_const_append(self): + fc_const = self._create_default_const_field_class() + with self.assertRaises(AttributeError): + fc_const.append_option('str', str_field_class, self._ranges1) + + def test_append_element_kwargs(self): + int_field_class = self._tc.create_signed_integer_field_class(32) + self._fc.append_option( + name='int32', field_class=int_field_class, ranges=self._ranges1 + ) + opt = self._fc['int32'] + self.assertEqual(opt.field_class.addr, int_field_class.addr) + self.assertEqual(opt.name, 'int32') + self.assertEqual(opt.ranges.addr, self._ranges1.addr) - def _create_field_class_for_field_path_test(self): + def test_append_element_invalid_name(self): + sub_fc = self._tc.create_string_field_class() + + with self.assertRaises(TypeError): + self._fc.append_option(self._fc, 23, sub_fc) + + def test_append_element_invalid_field_class(self): + with self.assertRaises(TypeError): + self._fc.append_option(self._fc, 'yes', object()) + + def test_append_element_invalid_ranges(self): + sub_fc = self._tc.create_string_field_class() + + with self.assertRaises(TypeError): + self._fc.append_option(self._fc, sub_fc, 'lel') + + def test_append_element_dup_name(self): + sub_fc1 = self._tc.create_string_field_class() + sub_fc2 = self._tc.create_string_field_class() + + with self.assertRaises(ValueError): + self._fc.append_option('yes', sub_fc1, self._ranges1) + self._fc.append_option('yes', sub_fc2, self._ranges2) + + def test_append_element_invalid_ranges_signedness(self): + sub_fc = self._tc.create_string_field_class() + + with self.assertRaises(TypeError): + self._fc.append_option(self._fc, sub_fc, self._inval_ranges) + + def test_user_attributes(self): + self._fc.append_option( + 'c', + self._tc.create_string_field_class(), + self._ranges1, + user_attributes={'salut': 23}, + ) + self.assertEqual(self._fc['c'].user_attributes, {'salut': 23}) + self.assertIs(type(self._fc.user_attributes), bt2_value.MapValue) + + def test_const_user_attributes(self): + fc_const = self._create_default_const_field_class() + self.assertIs(type(fc_const.user_attributes), bt2_value._MapValueConst) + + def test_invalid_user_attributes(self): + with self.assertRaises(TypeError): + self._fc.append_option( + 'c', + self._tc.create_string_field_class(), + self._ranges1, + user_attributes=object(), + ) + + def test_invalid_user_attributes_value_type(self): + with self.assertRaises(TypeError): + self._fc.append_option( + 'c', + self._tc.create_string_field_class(), + self._ranges1, + user_attributes=23, + ) + + def test_iadd(self): + a_field_class = self._tc.create_real_field_class() + self._fc.append_option('a_float', a_field_class, self._ranges1) + c_field_class = self._tc.create_string_field_class() + d_field_class = self._tc.create_signed_enumeration_field_class( + field_value_range=32 + ) + self._fc += [ + ('c_string', c_field_class, self._ranges2), + ('d_enum', d_field_class, self._ranges3), + ] + self.assertEqual(self._fc['a_float'].field_class.addr, a_field_class.addr) + self.assertEqual(self._fc['a_float'].name, 'a_float') + self.assertEqual(self._fc['a_float'].ranges, self._ranges1) + self.assertEqual(self._fc['c_string'].field_class.addr, c_field_class.addr) + self.assertEqual(self._fc['c_string'].name, 'c_string') + self.assertEqual(self._fc['c_string'].ranges, self._ranges2) + self.assertEqual(self._fc['d_enum'].field_class.addr, d_field_class.addr) + self.assertEqual(self._fc['d_enum'].name, 'd_enum') + self.assertEqual(self._fc['d_enum'].ranges, self._ranges3) + + def test_const_iadd(self): + fc_const = self._create_default_const_field_class() + a_field_class = self._tc.create_real_field_class() + with self.assertRaises(TypeError): + fc_const += [('a_float', a_field_class, self._ranges1)] + + def test_bool_op(self): + self.assertFalse(self._fc) + self._fc.append_option('a', self._tc.create_string_field_class(), self._ranges1) + self.assertTrue(self._fc) + + def test_len(self): + self._fc.append_option('a', self._tc.create_string_field_class(), self._ranges1) + self._fc.append_option('b', self._tc.create_string_field_class(), self._ranges2) + self._fc.append_option('c', self._tc.create_string_field_class(), self._ranges3) + self.assertEqual(len(self._fc), 3) + + def test_getitem(self): + a_fc = self._tc.create_signed_integer_field_class(32) + b_fc = self._tc.create_string_field_class() + c_fc = self._tc.create_real_field_class() + self._fc.append_option('a', a_fc, self._ranges1) + self._fc.append_option('b', b_fc, self._ranges2) + self._fc.append_option('c', c_fc, self._ranges3) + self.assertEqual(self._fc['b'].field_class.addr, b_fc.addr) + self.assertEqual(self._fc['b'].name, 'b') + self.assertEqual(self._fc['b'].ranges.addr, self._ranges2.addr) + + def test_option_field_class(self): + a_fc = self._tc.create_signed_integer_field_class(32) + self._fc.append_option('a', a_fc, self._ranges1) + self.assertIs( + type(self._fc['a'].field_class), bt2_field_class._SignedIntegerFieldClass + ) + + def test_const_option_field_class(self): + fc_const = self._create_default_const_field_class() + self.assertIs( + type(fc_const['a'].field_class), + bt2_field_class._SignedIntegerFieldClassConst, + ) + + def test_getitem_invalid_key_type(self): + with self.assertRaises(TypeError): + self._fc[0] + + def test_getitem_invalid_key(self): + with self.assertRaises(KeyError): + self._fc['no way'] + + def test_contains(self): + self.assertFalse('a' in self._fc) + self._fc.append_option('a', self._tc.create_string_field_class(), self._ranges1) + self.assertTrue('a' in self._fc) + + def test_iter(self): + a_fc = self._tc.create_signed_integer_field_class(32) + b_fc = self._tc.create_string_field_class() + c_fc = self._tc.create_real_field_class() + opts = ( + ('a', a_fc, self._ranges1), + ('b', b_fc, self._ranges2), + ('c', c_fc, self._ranges3), + ) + + for opt in opts: + self._fc.append_option(*opt) + + for (name, opt), test_opt in zip(self._fc.items(), opts): + self.assertEqual(opt.name, test_opt[0]) + self.assertEqual(name, opt.name) + self.assertEqual(opt.field_class.addr, test_opt[1].addr) + self.assertEqual(opt.ranges.addr, test_opt[2].addr) + + def test_at_index(self): + a_fc = self._tc.create_signed_integer_field_class(32) + b_fc = self._tc.create_string_field_class() + c_fc = self._tc.create_real_field_class() + self._fc.append_option('c', c_fc, self._ranges1) + self._fc.append_option('a', a_fc, self._ranges2) + self._fc.append_option('b', b_fc, self._ranges3) + self.assertEqual(self._fc.option_at_index(1).field_class.addr, a_fc.addr) + self.assertEqual(self._fc.option_at_index(1).name, 'a') + self.assertEqual(self._fc.option_at_index(1).ranges.addr, self._ranges2.addr) + + def test_at_index_invalid(self): + self._fc.append_option( + 'c', self._tc.create_signed_integer_field_class(32), self._ranges3 + ) + + with self.assertRaises(TypeError): + self._fc.option_at_index('yes') + + def test_at_index_out_of_bounds_after(self): + self._fc.append_option( + 'c', self._tc.create_signed_integer_field_class(32), self._ranges3 + ) + + with self.assertRaises(IndexError): + self._fc.option_at_index(len(self._fc)) + + def _fill_default_fc_for_field_path_test(self): # Create something equivalent to: # # struct outer_struct_fc { # real foo; # struct inner_struct_fc { - # enum { first = 1, second = 2..434 } selector; + # [u]int64_t selector; # string bar; # string baz; - # variant { - # real a; - # int21_t b; - # uint34_t c; + # variant { + # real a; // selected with self._ranges1 + # int21_t b; // selected with self._ranges2 + # uint34_t c; // selected with self._ranges3 # } variant; # } inner_struct[2]; # }; - selector_fc = self._tc.create_unsigned_enumeration_field_class(field_value_range=42) - selector_fc.map_range('first', 1) - selector_fc.map_range('second', 2, 434) - - fc = self._tc.create_variant_field_class(selector_fc) - fc.append_option('a', self._tc.create_real_field_class()) - fc.append_option('b', self._tc.create_signed_integer_field_class(21)) - fc.append_option('c', self._tc.create_unsigned_integer_field_class(34)) + self._fc.append_option('a', self._tc.create_real_field_class(), self._ranges1) + self._fc.append_option( + 'b', self._tc.create_signed_integer_field_class(21), self._ranges2 + ) + self._fc.append_option( + 'c', self._tc.create_unsigned_integer_field_class(34), self._ranges3 + ) foo_fc = self._tc.create_real_field_class() bar_fc = self._tc.create_string_field_class() baz_fc = self._tc.create_string_field_class() inner_struct_fc = self._tc.create_structure_field_class() - inner_struct_fc.append_member('selector', selector_fc) + inner_struct_fc.append_member('selector', self._selector_fc) inner_struct_fc.append_member('bar', bar_fc) inner_struct_fc.append_member('baz', baz_fc) - inner_struct_fc.append_member('variant', fc) + inner_struct_fc.append_member('variant', self._fc) - inner_struct_array_fc = self._tc.create_static_array_field_class(inner_struct_fc, 2) + inner_struct_array_fc = self._tc.create_static_array_field_class( + inner_struct_fc, 2 + ) outer_struct_fc = self._tc.create_structure_field_class() outer_struct_fc.append_member('foo', foo_fc) @@ -451,34 +1112,83 @@ class VariantFieldClassTestCase(_TestFieldContainer, unittest.TestCase): # The path to the selector field is resolved when the sequence is # actually used, for example in a packet context. - self._tc.create_stream_class(supports_packets=True, packet_context_field_class=outer_struct_fc) - - return fc + self._tc.create_stream_class( + supports_packets=True, packet_context_field_class=outer_struct_fc + ) def test_selector_field_path_length(self): - fc = self._create_field_class_for_field_path_test() - self.assertEqual(len(fc.selector_field_path), 3) + self._fill_default_fc_for_field_path_test() + self.assertEqual(len(self._fc.selector_field_path), 3) def test_selector_field_path_iter(self): - fc = self._create_field_class_for_field_path_test() - path_items = list(fc.selector_field_path) + self._fill_default_fc_for_field_path_test() + path_items = list(self._fc.selector_field_path) self.assertEqual(len(path_items), 3) - self.assertIsInstance(path_items[0], bt2.field_path._IndexFieldPathItem) + self.assertIsInstance(path_items[0], bt2._IndexFieldPathItem) self.assertEqual(path_items[0].index, 1) - self.assertIsInstance(path_items[1], bt2.field_path._CurrentArrayElementFieldPathItem) + self.assertIsInstance(path_items[1], bt2._CurrentArrayElementFieldPathItem) - self.assertIsInstance(path_items[2], bt2.field_path._IndexFieldPathItem) + self.assertIsInstance(path_items[2], bt2._IndexFieldPathItem) self.assertEqual(path_items[2].index, 0) def test_selector_field_path_root_scope(self): - fc = self._create_field_class_for_field_path_test() - self.assertEqual(fc.selector_field_path.root_scope, bt2.field_path.Scope.PACKET_CONTEXT) + self._fill_default_fc_for_field_path_test() + self.assertEqual( + self._fc.selector_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT + ) + + +class VariantFieldClassWithUnsignedSelectorTestCase( + _VariantFieldClassWithSelectorTestCase, unittest.TestCase +): + def _spec_set_up(self): + self._ranges1 = bt2.UnsignedIntegerRangeSet([(1, 4), (18, 47)]) + self._ranges2 = bt2.UnsignedIntegerRangeSet([(5, 5)]) + self._ranges3 = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) + self._inval_ranges = bt2.SignedIntegerRangeSet([(-8, 16), (48, 99)]) + self._selector_fc = self._tc.create_unsigned_integer_field_class() + + +class VariantFieldClassWithSignedSelectorTestCase( + _VariantFieldClassWithSelectorTestCase, unittest.TestCase +): + def _spec_set_up(self): + self._ranges1 = bt2.SignedIntegerRangeSet([(-10, -4), (18, 47)]) + self._ranges2 = bt2.SignedIntegerRangeSet([(-3, -3)]) + self._ranges3 = bt2.SignedIntegerRangeSet([(8, 16), (48, 99)]) + self._inval_ranges = bt2.UnsignedIntegerRangeSet([(8, 16), (48, 99)]) + self._selector_fc = self._tc.create_signed_integer_field_class() + + +class _ArrayFieldClassTestCase: + def test_attr_element_field_class(self): + fc = self._create_array() + self.assertIs( + type(fc.element_field_class), bt2_field_class._SignedIntegerFieldClass + ) + + def test_const_attr_element_field_class(self): + fc = self._create_const_array() + self.assertIs( + type(fc.element_field_class), bt2_field_class._SignedIntegerFieldClassConst + ) + +class StaticArrayFieldClassTestCase(_ArrayFieldClassTestCase, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field = [] + + def _create_array(self): + return self._tc.create_static_array_field_class(self._elem_fc, 45) + + def _create_const_array(self): + fc = self._tc.create_static_array_field_class(self._elem_fc, 45) + return _create_const_field_class(self._tc, fc, self._const_value_setter) -class StaticArrayFieldClassTestCase(unittest.TestCase): def setUp(self): self._tc = get_default_trace_class() self._elem_fc = self._tc.create_signed_integer_field_class(23) @@ -487,6 +1197,7 @@ class StaticArrayFieldClassTestCase(unittest.TestCase): fc = self._tc.create_static_array_field_class(self._elem_fc, 45) self.assertEqual(fc.element_field_class.addr, self._elem_fc.addr) self.assertEqual(fc.length, 45) + self.assertEqual(len(fc.user_attributes), 0) def test_create_invalid_elem_field_class(self): with self.assertRaises(TypeError): @@ -494,14 +1205,29 @@ class StaticArrayFieldClassTestCase(unittest.TestCase): def test_create_invalid_length(self): with self.assertRaises(ValueError): - self._tc.create_static_array_field_class(self._tc.create_string_field_class(), -17) + self._tc.create_static_array_field_class( + self._tc.create_string_field_class(), -17 + ) def test_create_invalid_length_type(self): with self.assertRaises(TypeError): - self._tc.create_static_array_field_class(self._tc.create_string_field_class(), 'the length') + self._tc.create_static_array_field_class( + self._tc.create_string_field_class(), 'the length' + ) + + +class DynamicArrayFieldClassTestCase(_ArrayFieldClassTestCase, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field = [] + def _create_array(self): + return self._tc.create_dynamic_array_field_class(self._elem_fc) + + def _create_const_array(self): + fc = self._tc.create_dynamic_array_field_class(self._elem_fc) + return _create_const_field_class(self._tc, fc, self._const_value_setter) -class DynamicArrayFieldClassTestCase(unittest.TestCase): def setUp(self): self._tc = get_default_trace_class() self._elem_fc = self._tc.create_signed_integer_field_class(23) @@ -511,6 +1237,7 @@ class DynamicArrayFieldClassTestCase(unittest.TestCase): fc = self._tc.create_dynamic_array_field_class(self._elem_fc) self.assertEqual(fc.element_field_class.addr, self._elem_fc.addr) self.assertIsNone(fc.length_field_path, None) + self.assertEqual(len(fc.user_attributes), 0) def _create_field_class_for_field_path_test(self): # Create something a field class that is equivalent to: @@ -537,7 +1264,9 @@ class DynamicArrayFieldClassTestCase(unittest.TestCase): inner_struct_fc.append_member('len', self._len_fc) inner_struct_fc.append_member('dyn_array', fc) - inner_struct_array_fc = self._tc.create_static_array_field_class(inner_struct_fc, 2) + inner_struct_array_fc = self._tc.create_static_array_field_class( + inner_struct_fc, 2 + ) outer_struct_fc = self._tc.create_structure_field_class() outer_struct_fc.append_member('foo', foo_fc) @@ -545,8 +1274,9 @@ class DynamicArrayFieldClassTestCase(unittest.TestCase): # The path to the length field is resolved when the sequence is # actually used, for example in a packet context. - self._tc.create_stream_class(packet_context_field_class=outer_struct_fc, - supports_packets=True) + self._tc.create_stream_class( + packet_context_field_class=outer_struct_fc, supports_packets=True + ) return fc @@ -560,17 +1290,19 @@ class DynamicArrayFieldClassTestCase(unittest.TestCase): self.assertEqual(len(path_items), 3) - self.assertIsInstance(path_items[0], bt2.field_path._IndexFieldPathItem) + self.assertIsInstance(path_items[0], bt2._IndexFieldPathItem) self.assertEqual(path_items[0].index, 1) - self.assertIsInstance(path_items[1], bt2.field_path._CurrentArrayElementFieldPathItem) + self.assertIsInstance(path_items[1], bt2._CurrentArrayElementFieldPathItem) - self.assertIsInstance(path_items[2], bt2.field_path._IndexFieldPathItem) + self.assertIsInstance(path_items[2], bt2._IndexFieldPathItem) self.assertEqual(path_items[2].index, 2) def test_field_path_root_scope(self): fc = self._create_field_class_for_field_path_test() - self.assertEqual(fc.length_field_path.root_scope, bt2.field_path.Scope.PACKET_CONTEXT) + self.assertEqual( + fc.length_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT + ) def test_create_invalid_field_class(self): with self.assertRaises(TypeError): @@ -578,7 +1310,9 @@ class DynamicArrayFieldClassTestCase(unittest.TestCase): def test_create_invalid_length_type(self): with self.assertRaises(TypeError): - self._tc.create_dynamic_array_field_class(self._tc.create_string_field_class(), 17) + self._tc.create_dynamic_array_field_class( + self._tc.create_string_field_class(), 17 + ) if __name__ == "__main__":