X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=tests%2Fbindings%2Fpython%2Fbt2%2Ftest_field_class.py;h=4f6aab2415309fb4acf180ab4243dfa121da2c5b;hp=2b05f0096cfab2bc8213d98834c6bc2033e0b377;hb=0235b0db7de5bcacdb3650c92461f2ce5eb2143d;hpb=cfbd7cf3bde05e8a6606478889dcd663604ef7b5 diff --git a/tests/bindings/python/bt2/test_field_class.py b/tests/bindings/python/bt2/test_field_class.py index 2b05f009..4f6aab24 100644 --- a/tests/bindings/python/bt2/test_field_class.py +++ b/tests/bindings/python/bt2/test_field_class.py @@ -1,95 +1,277 @@ +# SPDX-License-Identifier: GPL-2.0-only # # Copyright (C) 2019 EfficiOS Inc. # -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License -# as published by the Free Software Foundation; only version 2 -# of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -# -import bt2.field import unittest import bt2 -import collections -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, config, 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, config, 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.value = 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.value = [] + + 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( + 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.value = -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.value = 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 SingleRealFieldClassTestCase(_TestFieldClass, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field.value = -18.0 + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_single_precision_real_field_class(*args, **kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_single_precision_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() - self.assertFalse(fc.is_single_precision) + fc = self._create_field_class() + 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) - 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') +class DoubleRealFieldClassTestCase(_TestFieldClass, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field.value = -18.0 + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_double_precision_real_field_class(*args, **kwargs) + + def _create_default_const_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + fc = tc.create_double_precision_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._create_field_class() + self.assertEqual(len(fc.user_attributes), 0) # Converts an _EnumerationFieldClassMapping to a list of ranges: @@ -103,13 +285,13 @@ def enum_mapping_to_set(mapping): class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): def setUp(self): - self._tc = get_default_trace_class() self._spec_set_up() - self._fc = self._create_func() + 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.add_mapping('hello', self._ranges1) @@ -117,6 +299,10 @@ class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): self.assertEqual(mapping.label, 'hello') self.assertEqual(mapping.ranges, self._ranges1) + 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.add_mapping(label='hello', ranges=self._ranges1) mapping = self._fc['hello'] @@ -132,7 +318,7 @@ class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): self._fc.add_mapping('allo', 'meow') def test_add_mapping_dup_label(self): - with self.assertRaises(bt2.Error): + with self.assertRaises(ValueError): self._fc.add_mapping('a', self._ranges1) self._fc.add_mapping('a', self._ranges2) @@ -153,6 +339,10 @@ class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): self.assertEqual(self._fc['e'].label, 'e') 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.add_mapping('a', self._ranges1) @@ -171,6 +361,8 @@ class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): mapping = self._fc['a'] self.assertEqual(mapping.label, 'a') self.assertEqual(mapping.ranges, self._ranges1) + self.assertIs(type(mapping), self._MAPPING_CLASS) + self.assertIs(type(mapping.ranges), self._CONST_RANGE_SET_CLASS) def test_getitem_nonexistent(self): with self.assertRaises(KeyError): @@ -197,45 +389,98 @@ class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps): class UnsignedEnumerationFieldClassTestCase( - _EnumerationFieldClassTestCase, unittest.TestCase + _EnumerationFieldClassTestCase, _TestFieldClass, unittest.TestCase ): + _MAPPING_CLASS = bt2_field_class._UnsignedEnumerationFieldClassMappingConst + _RANGE_SET_CLASS = bt2.UnsignedIntegerRangeSet + _CONST_RANGE_SET_CLASS = bt2._UnsignedIntegerRangeSetConst + 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 - self._create_func = self._tc.create_unsigned_enumeration_field_class + + @staticmethod + def _const_value_setter(field): + field.value = 0 + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_unsigned_enumeration_field_class(*args, **kwargs) + + 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) + + _create_default_field_class = _create_field_class class SignedEnumerationFieldClassTestCase( - _EnumerationFieldClassTestCase, unittest.TestCase + _EnumerationFieldClassTestCase, _TestFieldClass, unittest.TestCase ): + _MAPPING_CLASS = bt2_field_class._SignedEnumerationFieldClassMappingConst + _RANGE_SET_CLASS = bt2.SignedIntegerRangeSet + _CONST_RANGE_SET_CLASS = bt2._SignedIntegerRangeSetConst + 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 - self._create_func = self._tc.create_signed_enumeration_field_class + @staticmethod + def _const_value_setter(field): + field.value = 0 -class StringFieldClassTestCase(unittest.TestCase): - def setUp(self): + def _create_field_class(self, *args, **kwargs): tc = get_default_trace_class() - self._fc = tc.create_string_field_class() + return tc.create_signed_enumeration_field_class(*args, **kwargs) + + 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 StringFieldClassTestCase(_TestFieldClass, unittest.TestCase): + @staticmethod + def _const_value_setter(field): + field.value = 'chaine' + + def _create_field_class(self, *args, **kwargs): + tc = get_default_trace_class() + return tc.create_string_field_class(*args, **kwargs) + + 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 + + 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) class _TestElementContainer: def setUp(self): self._tc = get_default_trace_class() - self._fc = self._create_default_fc() + 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) @@ -263,13 +508,30 @@ class _TestElementContainer: sub_fc1 = self._tc.create_string_field_class() sub_fc2 = self._tc.create_string_field_class() - with self.assertRaises(bt2.Error): + 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): - other_fc = self._create_default_fc() - a_field_class = self._tc.create_real_field_class() + a_field_class = self._tc.create_single_precision_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) @@ -294,6 +556,11 @@ class _TestElementContainer: 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_single_precision_real_field_class() + with self.assertRaises(TypeError): + self._fc_const += a_field_class + def test_bool_op(self): self.assertFalse(self._fc) self._append_element_method(self._fc, 'a', self._tc.create_string_field_class()) @@ -308,7 +575,7 @@ class _TestElementContainer: 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() + c_fc = self._tc.create_single_precision_real_field_class() 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) @@ -331,7 +598,7 @@ class _TestElementContainer: 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() + c_fc = self._tc.create_single_precision_real_field_class() elements = (('a', a_fc), ('b', b_fc), ('c', c_fc)) for elem in elements: @@ -341,11 +608,12 @@ class _TestElementContainer: 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) b_fc = self._tc.create_string_field_class() - c_fc = self._tc.create_real_field_class() + c_fc = self._tc.create_single_precision_real_field_class() 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) @@ -369,44 +637,350 @@ class _TestElementContainer: 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) -class StructureFieldClassTestCase(_TestElementContainer, unittest.TestCase): - _append_element_method = staticmethod( - bt2.field_class._StructureFieldClass.append_member - ) - _at_index_method = staticmethod( - bt2.field_class._StructureFieldClass.member_at_index - ) + 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_single_precision_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._SinglePrecisionRealFieldClassConst, + ) + + def test_member_field_class(self): + tc = get_default_trace_class() + fc = tc.create_structure_field_class() + member_fc = self._tc.create_single_precision_real_field_class() + fc.append_member('real', member_fc) + + self.assertIs( + type(fc['real'].field_class), bt2_field_class._SinglePrecisionRealFieldClass + ) + + +class OptionWithoutSelectorFieldClassTestCase(_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_without_selector_field_class( + self._content_fc, *args, **kwargs + ) + + def _create_default_const_field_class(self, *args, **kwargs): + fc = self._tc.create_option_without_selector_field_class( + self._content_fc, *args, **kwargs + ) + return _create_const_field_class(self._tc, fc, self._const_value_setter) + + def setUp(self): + self._tc = get_default_trace_class() + self._content_fc = self._tc.create_signed_integer_field_class(23) + + def test_create_default(self): + fc = self._create_default_field_class() + self.assertEqual(fc.field_class.addr, self._content_fc.addr) + self.assertEqual(len(fc.user_attributes), 0) + + def test_create_invalid_field_class(self): + with self.assertRaises(TypeError): + self._tc.create_option_without_selector_field_class(object()) + + 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 + ) + + +class _OptionWithSelectorFieldClassTestCase(_TestFieldClass): + @staticmethod + def _const_value_setter(field): + field['opt'].has_field = True + field['opt'].value = 12 + + def _create_default_const_field_class(self, *args, **kwargs): + # Create a struct to contain the option 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._tag_fc) + opt_fc = self._create_default_field_class(*args, **kwargs) + struct_fc.append_member('opt', opt_fc) + + return _create_const_field_class(self._tc, struct_fc, self._const_value_setter)[ + 'opt' + ].field_class + + def setUp(self): + self._tc = get_default_trace_class() + self._content_fc = self._tc.create_signed_integer_field_class(23) + self._tag_fc = self._create_tag_fc() + + def _create_field_class_for_field_path_test(self): + fc = self._create_default_field_class() + + foo_fc = self._tc.create_single_precision_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_without_selector_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 + ) + + +class OptionWithBoolSelectorFieldClassTestCase( + _OptionWithSelectorFieldClassTestCase, unittest.TestCase +): + def _create_default_field_class(self, *args, **kwargs): + return self._tc.create_option_with_bool_selector_field_class( + self._content_fc, self._tag_fc, *args, **kwargs + ) + + def _create_tag_fc(self): + return self._tc.create_bool_field_class() + + def test_create_default(self): + fc = self._create_default_field_class() + self.assertEqual(fc.field_class.addr, self._content_fc.addr) + self.assertFalse(fc.selector_is_reversed) + self.assertEqual(len(fc.user_attributes), 0) + + def test_create_selector_is_reversed_wrong_type(self): + with self.assertRaises(TypeError): + self._create_default_field_class(selector_is_reversed=23) + + def test_create_invalid_selector_type(self): + with self.assertRaises(TypeError): + self._tc.create_option_with_bool_selector_field_class(self._content_fc, 17) + + def test_attr_selector_is_reversed(self): + fc = self._create_default_field_class(selector_is_reversed=True) + self.assertTrue(fc.selector_is_reversed) + + def test_const_attr_selector_is_reversed(self): + fc = self._create_default_const_field_class(selector_is_reversed=True) + self.assertTrue(fc.selector_is_reversed) + + +class _OptionWithIntegerSelectorFieldClassTestCase( + _OptionWithSelectorFieldClassTestCase +): + def _create_default_field_class(self, *args, **kwargs): + return self._tc.create_option_with_integer_selector_field_class( + self._content_fc, self._tag_fc, self._ranges, *args, **kwargs + ) + + def test_create_default(self): + fc = self._create_default_field_class() + self.assertEqual(fc.field_class.addr, self._content_fc.addr) + self.assertEqual(fc.ranges, self._ranges) + self.assertEqual(len(fc.user_attributes), 0) + + def test_create_ranges_wrong_type(self): + with self.assertRaises(TypeError): + self._tc.create_option_with_integer_selector_field_class( + self._content_fc, self._tag_fc, 23 + ) + + def test_create_ranges_empty(self): + with self.assertRaises(ValueError): + self._tc.create_option_with_integer_selector_field_class( + self._content_fc, self._tag_fc, type(self._ranges)() + ) + + def test_create_invalid_selector_type(self): + with self.assertRaises(TypeError): + self._tc.create_option_with_bool_selector_field_class(self._content_fc, 17) + + def test_attr_ranges(self): + fc = self._create_default_field_class() + print(type(fc.ranges), type(self._ranges)) + self.assertEqual(fc.ranges, self._ranges) - def _create_default_fc(self): - return self._tc.create_structure_field_class() + def test_const_attr_ranges(self): + fc = self._create_default_const_field_class() + self.assertEqual(fc.ranges, self._ranges) + + +class OptionWithUnsignedIntegerSelectorFieldClassTestCase( + _OptionWithIntegerSelectorFieldClassTestCase, unittest.TestCase +): + def setUp(self): + self._ranges = bt2.UnsignedIntegerRangeSet([(1, 3), (18, 44)]) + super().setUp() + + def _create_tag_fc(self): + return self._tc.create_unsigned_integer_field_class() class VariantFieldClassWithoutSelectorTestCase( - _TestElementContainer, unittest.TestCase + _TestFieldClass, _TestElementContainer, unittest.TestCase ): _append_element_method = staticmethod( - bt2.field_class._VariantFieldClassWithoutSelector.append_option + bt2._VariantFieldClassWithoutSelector.append_option ) _at_index_method = staticmethod( - bt2.field_class._VariantFieldClassWithoutSelector.option_at_index + bt2._VariantFieldClassWithoutSelector.option_at_index ) - def _create_default_fc(self): - return self._tc.create_variant_field_class() + @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 _VariantFieldClassWithIntegerSelectorTestCase: + @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 _VariantFieldClassWithSelectorTestCase: def setUp(self): self._tc = get_default_trace_class() self._spec_set_up() - self._fc = self._create_default_fc() - - def _create_default_fc(self): - return self._tc.create_variant_field_class(self._selector_fc) + 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_append_element(self): str_field_class = self._tc.create_string_field_class() @@ -416,6 +990,12 @@ class _VariantFieldClassWithSelectorTestCase: 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() + str_field_class = self._tc.create_string_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( @@ -446,7 +1026,7 @@ class _VariantFieldClassWithSelectorTestCase: sub_fc1 = self._tc.create_string_field_class() sub_fc2 = self._tc.create_string_field_class() - with self.assertRaises(bt2.Error): + with self.assertRaises(ValueError): self._fc.append_option('yes', sub_fc1, self._ranges1) self._fc.append_option('yes', sub_fc2, self._ranges2) @@ -456,9 +1036,40 @@ class _VariantFieldClassWithSelectorTestCase: 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): - other_fc = self._create_default_fc() - a_field_class = self._tc.create_real_field_class() + a_field_class = self._tc.create_single_precision_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( @@ -478,6 +1089,12 @@ class _VariantFieldClassWithSelectorTestCase: 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_single_precision_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) @@ -492,7 +1109,7 @@ class _VariantFieldClassWithSelectorTestCase: 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() + c_fc = self._tc.create_single_precision_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) @@ -500,6 +1117,20 @@ class _VariantFieldClassWithSelectorTestCase: 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] @@ -516,7 +1147,7 @@ class _VariantFieldClassWithSelectorTestCase: 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() + c_fc = self._tc.create_single_precision_real_field_class() opts = ( ('a', a_fc, self._ranges1), ('b', b_fc, self._ranges2), @@ -535,7 +1166,7 @@ class _VariantFieldClassWithSelectorTestCase: 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() + c_fc = self._tc.create_single_precision_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) @@ -575,7 +1206,9 @@ class _VariantFieldClassWithSelectorTestCase: # } variant; # } inner_struct[2]; # }; - self._fc.append_option('a', self._tc.create_real_field_class(), self._ranges1) + self._fc.append_option( + 'a', self._tc.create_single_precision_real_field_class(), self._ranges1 + ) self._fc.append_option( 'b', self._tc.create_signed_integer_field_class(21), self._ranges2 ) @@ -583,7 +1216,7 @@ class _VariantFieldClassWithSelectorTestCase: 'c', self._tc.create_unsigned_integer_field_class(34), self._ranges3 ) - foo_fc = self._tc.create_real_field_class() + foo_fc = self._tc.create_single_precision_real_field_class() bar_fc = self._tc.create_string_field_class() baz_fc = self._tc.create_string_field_class() @@ -617,25 +1250,23 @@ class _VariantFieldClassWithSelectorTestCase: 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): self._fill_default_fc_for_field_path_test() self.assertEqual( - self._fc.selector_field_path.root_scope, bt2.field_path.Scope.PACKET_CONTEXT + self._fc.selector_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT ) class VariantFieldClassWithUnsignedSelectorTestCase( - _VariantFieldClassWithSelectorTestCase, unittest.TestCase + _VariantFieldClassWithIntegerSelectorTestCase, unittest.TestCase ): def _spec_set_up(self): self._ranges1 = bt2.UnsignedIntegerRangeSet([(1, 4), (18, 47)]) @@ -646,7 +1277,7 @@ class VariantFieldClassWithUnsignedSelectorTestCase( class VariantFieldClassWithSignedSelectorTestCase( - _VariantFieldClassWithSelectorTestCase, unittest.TestCase + _VariantFieldClassWithIntegerSelectorTestCase, unittest.TestCase ): def _spec_set_up(self): self._ranges1 = bt2.SignedIntegerRangeSet([(-10, -4), (18, 47)]) @@ -656,7 +1287,36 @@ class VariantFieldClassWithSignedSelectorTestCase( self._selector_fc = self._tc.create_signed_integer_field_class() -class StaticArrayFieldClassTestCase(unittest.TestCase): +class _ArrayFieldClassTestCase: + def test_attr_element_field_class(self): + fc = self._create_array() + self.assertIs( + type(fc.element_field_class), bt2_field_class._SignedIntegerFieldClass + ) + + +class _ArrayFieldClassConstTestCase: + 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, _ArrayFieldClassConstTestCase, unittest.TestCase +): + @staticmethod + def _const_value_setter(field): + field.value = [9] * 45 + + 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) + def setUp(self): self._tc = get_default_trace_class() self._elem_fc = self._tc.create_signed_integer_field_class(23) @@ -665,6 +1325,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): @@ -683,16 +1344,54 @@ class StaticArrayFieldClassTestCase(unittest.TestCase): ) -class DynamicArrayFieldClassTestCase(unittest.TestCase): +class DynamicArrayFieldClassTestCase( + _ArrayFieldClassTestCase, _ArrayFieldClassConstTestCase, unittest.TestCase +): + @staticmethod + def _const_value_setter(field): + field.value = [] + + 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) + def setUp(self): self._tc = get_default_trace_class() self._elem_fc = self._tc.create_signed_integer_field_class(23) - self._len_fc = self._tc.create_unsigned_integer_field_class(12) def test_create_default(self): fc = self._tc.create_dynamic_array_field_class(self._elem_fc) self.assertEqual(fc.element_field_class.addr, self._elem_fc.addr) + self.assertEqual(len(fc.user_attributes), 0) + + def test_create_invalid_field_class(self): + with self.assertRaises(TypeError): + self._tc.create_dynamic_array_field_class(object()) + + +class DynamicArrayWithLengthFieldFieldClassTestCase( + _ArrayFieldClassTestCase, unittest.TestCase +): + @staticmethod + def _const_value_setter(field): + field.value = [] + + def _create_array(self): + return self._tc.create_dynamic_array_field_class(self._elem_fc, self._len_fc) + + def setUp(self): + self._tc = get_default_trace_class() + self._elem_fc = self._tc.create_signed_integer_field_class(23) + self._len_fc = self._tc.create_unsigned_integer_field_class(12) + + def test_create_default(self): + fc = self._create_array() + 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: @@ -707,9 +1406,9 @@ class DynamicArrayFieldClassTestCase(unittest.TestCase): # } inner_struct[2]; # }; - fc = self._tc.create_dynamic_array_field_class(self._elem_fc, self._len_fc) + fc = self._create_array() - foo_fc = self._tc.create_real_field_class() + foo_fc = self._tc.create_single_precision_real_field_class() bar_fc = self._tc.create_string_field_class() baz_fc = self._tc.create_string_field_class() @@ -745,26 +1444,20 @@ 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 + fc.length_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT ) - def test_create_invalid_field_class(self): - with self.assertRaises(TypeError): - self._tc.create_dynamic_array_field_class(object()) - def test_create_invalid_length_type(self): with self.assertRaises(TypeError): self._tc.create_dynamic_array_field_class(