-import bt2.field
+#
+# 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 unittest
-import copy
import bt2
+from utils import get_default_trace_class, TestOutputPortMessageIterator
+from bt2 import value as bt2_value
+from bt2 import field_class as bt2_field_class
-class _TestCopySimple:
- def _test_copy(self, cpy):
- self.assertIsNot(cpy, self._fc)
- self.assertNotEqual(cpy.addr, self._fc.addr)
- self.assertEqual(cpy, self._fc)
+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)
- def test_copy(self):
- cpy = copy.copy(self._fc)
- self._test_copy(cpy)
+ trace = tc()
+ stream_class = tc.create_stream_class(
+ packet_context_field_class=packet_context_fc, supports_packets=True
+ )
- def test_deepcopy(self):
- cpy = copy.deepcopy(self._fc)
- self._test_copy(cpy)
+ stream = trace.create_stream(stream_class)
+ return stream
-class _TestAlignmentProp:
- def test_assign_alignment(self):
- self._fc.alignment = 32
- self.assertEqual(self._fc.alignment, 32)
+def _create_const_field_class(tc, field_class, value_setter_fn):
+ field_name = 'const field'
- def test_assign_invalid_alignment(self):
- with self.assertRaises(ValueError):
- self._fc.alignment = 23
+ 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])
-class _TestByteOrderProp:
- def test_assign_byte_order(self):
- self._fc.byte_order = bt2.ByteOrder.LITTLE_ENDIAN
- self.assertEqual(self._fc.byte_order, bt2.ByteOrder.LITTLE_ENDIAN)
+ self._msgs = [
+ self._create_stream_beginning_message(stream),
+ self._create_packet_beginning_message(packet),
+ ]
- def test_assign_invalid_byte_order(self):
- with self.assertRaises(TypeError):
- self._fc.byte_order = 'hey'
+ def __next__(self):
+ if len(self._msgs) == 0:
+ raise StopIteration
+ return self._msgs.pop(0)
-class _TestInvalidEq:
- def test_eq_invalid(self):
- self.assertFalse(self._fc == 23)
+ 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'])
-class _TestIntegerFieldClassProps:
- def test_size_prop(self):
- self.assertEqual(self._fc.size, 35)
+ # Ignore first message, stream beginning
+ _ = next(msg_iter)
+ packet_beg_msg = next(msg_iter)
- def test_assign_signed(self):
- self._fc.is_signed = True
- self.assertTrue(self._fc.is_signed)
+ return packet_beg_msg.packet.context_field[field_name].cls
- def test_assign_invalid_signed(self):
- with self.assertRaises(TypeError):
- self._fc.is_signed = 23
- def test_assign_base(self):
- self._fc.base = bt2.Base.HEXADECIMAL
- self.assertEqual(self._fc.base, bt2.Base.HEXADECIMAL)
+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_assign_invalid_base(self):
- with self.assertRaises(TypeError):
- self._fc.base = 'hey'
+ 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_assign_encoding(self):
- self._fc.encoding = bt2.Encoding.UTF8
- self.assertEqual(self._fc.encoding, bt2.Encoding.UTF8)
+ def test_create_invalid_user_attributes(self):
+ with self.assertRaises(TypeError):
+ self._create_default_field_class(user_attributes=object())
- def test_assign_invalid_encoding(self):
+ def test_create_invalid_user_attributes_value_type(self):
with self.assertRaises(TypeError):
- self._fc.encoding = 'hey'
+ self._create_default_field_class(user_attributes=23)
- def test_assign_mapped_clock_class(self):
- cc = bt2.ClockClass('name', 1000)
- self._fc.mapped_clock_class = cc
- self.assertEqual(self._fc.mapped_clock_class, cc)
- def test_assign_invalid_mapped_clock_class(self):
- with self.assertRaises(TypeError):
- self._fc.mapped_clock_class = object()
+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)
-@unittest.skip("this is broken")
-class IntegerFieldClassTestCase(_TestIntegerFieldClassProps, _TestCopySimple,
- _TestAlignmentProp, _TestByteOrderProp,
- _TestInvalidEq, unittest.TestCase):
- def setUp(self):
- self._fc = bt2.IntegerFieldClass(35)
+ 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 tearDown(self):
- del self._fc
+ 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.assertEqual(self._fc.size, 35)
- self.assertIsNone(self._fc.mapped_clock_class)
+ self.assertIsNotNone(self._fc)
+ self.assertEqual(len(self._fc.user_attributes), 0)
- def test_create_invalid_size(self):
- with self.assertRaises(TypeError):
- fc = bt2.IntegerFieldClass('yes')
- def test_create_neg_size(self):
+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):
- fc = bt2.IntegerFieldClass(-2)
+ self._create_field_class(65)
- def test_create_neg_zero(self):
+ def test_create_length_zero(self):
with self.assertRaises(ValueError):
- fc = bt2.IntegerFieldClass(0)
+ self._create_field_class(0)
- def test_create_full(self):
- cc = bt2.ClockClass('name', 1000)
- fc = bt2.IntegerFieldClass(24, alignment=16,
- byte_order=bt2.ByteOrder.BIG_ENDIAN,
- is_signed=True, base=bt2.Base.OCTAL,
- encoding=bt2.Encoding.NONE,
- mapped_clock_class=cc)
- self.assertEqual(fc.size, 24)
- self.assertEqual(fc.alignment, 16)
- self.assertEqual(fc.byte_order, bt2.ByteOrder.BIG_ENDIAN)
- self.assertTrue(fc.is_signed)
- self.assertEqual(fc.base, bt2.Base.OCTAL)
- self.assertEqual(fc.encoding, bt2.Encoding.NONE)
- self.assertEqual(fc.mapped_clock_class, cc)
-
- def test_create_field(self):
- field = self._fc()
- self.assertIsInstance(field, bt2.field._IntegerField)
-
- def test_create_field_init(self):
- field = self._fc(23)
- self.assertEqual(field, 23)
-
-
-@unittest.skip("this is broken")
-class FloatingPointNumberFieldClassTestCase(_TestCopySimple, _TestAlignmentProp,
- _TestByteOrderProp, _TestInvalidEq,
- unittest.TestCase):
- def setUp(self):
- self._fc = bt2.FloatingPointNumberFieldClass()
+ 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)
- def tearDown(self):
- del self._fc
+class _TestIntegerFieldClassProps:
def test_create_default(self):
- pass
+ 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_full(self):
- fc = bt2.FloatingPointNumberFieldClass(alignment=16,
- byte_order=bt2.ByteOrder.BIG_ENDIAN,
- exponent_size=11,
- mantissa_size=53)
- self.assertEqual(fc.alignment, 16)
- self.assertEqual(fc.byte_order, bt2.ByteOrder.BIG_ENDIAN)
- self.assertEqual(fc.exponent_size, 11)
- self.assertEqual(fc.mantissa_size, 53)
+ def test_create_range(self):
+ fc = self._create_field_class(field_value_range=35)
+ self.assertEqual(fc.field_value_range, 35)
- def test_assign_exponent_size(self):
- self._fc.exponent_size = 8
- self.assertEqual(self._fc.exponent_size, 8)
+ fc = self._create_field_class(36)
+ self.assertEqual(fc.field_value_range, 36)
- def test_assign_invalid_exponent_size(self):
+ def test_create_invalid_range(self):
with self.assertRaises(TypeError):
- self._fc.exponent_size = 'yes'
+ self._create_field_class('yes')
- def test_assign_mantissa_size(self):
- self._fc.mantissa_size = 24
- self.assertEqual(self._fc.mantissa_size, 24)
+ with self.assertRaises(TypeError):
+ self._create_field_class(field_value_range='yes')
+
+ with self.assertRaises(ValueError):
+ self._create_field_class(field_value_range=-2)
+
+ with self.assertRaises(ValueError):
+ self._create_field_class(field_value_range=0)
+
+ def test_create_base(self):
+ fc = self._create_field_class(
+ preferred_display_base=bt2.IntegerDisplayBase.HEXADECIMAL
+ )
+ self.assertEqual(fc.preferred_display_base, bt2.IntegerDisplayBase.HEXADECIMAL)
- def test_assign_invalid_mantissa_size(self):
+ def test_create_invalid_base_type(self):
with self.assertRaises(TypeError):
- self._fc.mantissa_size = 'no'
+ self._create_field_class(preferred_display_base='yes')
+
+ def test_create_invalid_base_value(self):
+ with self.assertRaises(ValueError):
+ self._create_field_class(preferred_display_base=444)
- def test_create_field(self):
- field = self._fc()
- self.assertIsInstance(field, bt2.field._FloatingPointNumberField)
+ def test_create_full(self):
+ 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)
- def test_create_field_init(self):
- field = self._fc(17.5)
- self.assertEqual(field, 17.5)
+class SignedIntegerFieldClassTestCase(
+ _TestIntegerFieldClassProps, _TestFieldClass, unittest.TestCase
+):
+ @staticmethod
+ def _const_value_setter(field):
+ field = -18
-@unittest.skip("this is broken")
-class EnumerationFieldClassTestCase(_TestIntegerFieldClassProps, _TestInvalidEq,
- _TestCopySimple, _TestAlignmentProp,
- _TestByteOrderProp, unittest.TestCase):
- def setUp(self):
- self._fc = bt2.EnumerationFieldClass(size=35)
+ def _create_field_class(self, *args, **kwargs):
+ tc = get_default_trace_class()
+ return tc.create_signed_integer_field_class(*args, **kwargs)
- def tearDown(self):
- del self._fc
+ 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)
- def test_create_from_int_fc(self):
- int_fc = bt2.IntegerFieldClass(23)
- self._fc = bt2.EnumerationFieldClass(int_fc)
+ _create_default_field_class = _create_field_class
- def test_create_from_invalid_type(self):
- with self.assertRaises(TypeError):
- self._fc = bt2.EnumerationFieldClass('coucou')
- def test_create_from_invalid_fc(self):
+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._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._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):
- fc = bt2.FloatingPointNumberFieldClass()
- self._fc = bt2.EnumerationFieldClass(fc)
+ self._create_field_class(is_single_precision='hohoho')
- def test_create_full(self):
- fc = bt2.EnumerationFieldClass(size=24, alignment=16,
- byte_order=bt2.ByteOrder.BIG_ENDIAN,
- is_signed=True, base=bt2.Base.OCTAL,
- encoding=bt2.Encoding.NONE,
- mapped_clock_class=None)
- self.assertEqual(fc.size, 24)
- self.assertEqual(fc.alignment, 16)
- self.assertEqual(fc.byte_order, bt2.ByteOrder.BIG_ENDIAN)
- self.assertTrue(fc.is_signed)
- self.assertEqual(fc.base, bt2.Base.OCTAL)
- self.assertEqual(fc.encoding, bt2.Encoding.NONE)
- #self.assertIsNone(fc.mapped_clock_class)
-
- def test_integer_field_class_prop(self):
- int_fc = bt2.IntegerFieldClass(23)
- enum_fc = bt2.EnumerationFieldClass(int_fc)
- self.assertEqual(enum_fc.integer_field_class.addr, int_fc.addr)
+
+# Converts an _EnumerationFieldClassMapping to a list of ranges:
+#
+# [(lower0, upper0), (lower1, upper1), ...]
+
+
+def enum_mapping_to_set(mapping):
+ return {(x.lower, x.upper) for x in mapping.ranges}
+
+
+class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps):
+ def setUp(self):
+ 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_field_class('coucou')
def test_add_mapping_simple(self):
- self._fc.add_mapping('hello', 24)
- mapping = self._fc[0]
- self.assertEqual(mapping.name, 'hello')
- self.assertEqual(mapping.lower, 24)
- self.assertEqual(mapping.upper, 24)
+ self._fc.add_mapping('hello', self._ranges1)
+ mapping = self._fc['hello']
+ 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(name='hello', lower=17, upper=23)
- mapping = self._fc[0]
- self.assertEqual(mapping.name, 'hello')
- self.assertEqual(mapping.lower, 17)
- self.assertEqual(mapping.upper, 23)
-
- def test_add_mapping_range(self):
- self._fc.add_mapping('hello', 21, 199)
- mapping = self._fc[0]
- self.assertEqual(mapping.name, 'hello')
- self.assertEqual(mapping.lower, 21)
- self.assertEqual(mapping.upper, 199)
+ self._fc.add_mapping(label='hello', ranges=self._ranges1)
+ mapping = self._fc['hello']
+ self.assertEqual(mapping.label, 'hello')
+ self.assertEqual(mapping.ranges, self._ranges1)
def test_add_mapping_invalid_name(self):
with self.assertRaises(TypeError):
- self._fc.add_mapping(17, 21, 199)
+ self._fc.add_mapping(17, self._ranges1)
- def test_add_mapping_invalid_signedness_lower(self):
- with self.assertRaises(ValueError):
- self._fc.add_mapping('hello', -21, 199)
+ def test_add_mapping_invalid_range(self):
+ with self.assertRaises(TypeError):
+ self._fc.add_mapping('allo', 'meow')
- def test_add_mapping_invalid_signedness_upper(self):
+ def test_add_mapping_dup_label(self):
with self.assertRaises(ValueError):
- self._fc.add_mapping('hello', 21, -199)
-
- def test_add_mapping_simple_signed(self):
- self._fc.is_signed = True
- self._fc.add_mapping('hello', -24)
- mapping = self._fc[0]
- self.assertEqual(mapping.name, 'hello')
- self.assertEqual(mapping.lower, -24)
- self.assertEqual(mapping.upper, -24)
-
- def test_add_mapping_range_signed(self):
- self._fc.is_signed = True
- self._fc.add_mapping('hello', -21, 199)
- mapping = self._fc[0]
- self.assertEqual(mapping.name, 'hello')
- self.assertEqual(mapping.lower, -21)
- self.assertEqual(mapping.upper, 199)
+ self._fc.add_mapping('a', self._ranges1)
+ self._fc.add_mapping('a', self._ranges2)
+
+ def test_add_mapping_invalid_ranges_signedness(self):
+ with self.assertRaises(TypeError):
+ self._fc.add_mapping('allo', self._inval_ranges)
def test_iadd(self):
- enum_fc = bt2.EnumerationFieldClass(size=16)
- enum_fc.add_mapping('c', 4, 5)
- enum_fc.add_mapping('d', 6, 18)
- enum_fc.add_mapping('e', 20, 27)
- self._fc.add_mapping('a', 0, 2)
- self._fc.add_mapping('b', 3)
- self._fc += enum_fc
- self.assertEqual(self._fc[0].name, 'a')
- self.assertEqual(self._fc[0].lower, 0)
- self.assertEqual(self._fc[0].upper, 2)
- self.assertEqual(self._fc[1].name, 'b')
- self.assertEqual(self._fc[1].lower, 3)
- self.assertEqual(self._fc[1].upper, 3)
- self.assertEqual(self._fc[2].name, 'c')
- self.assertEqual(self._fc[2].lower, 4)
- self.assertEqual(self._fc[2].upper, 5)
- self.assertEqual(self._fc[3].name, 'd')
- self.assertEqual(self._fc[3].lower, 6)
- self.assertEqual(self._fc[3].upper, 18)
- self.assertEqual(self._fc[4].name, 'e')
- self.assertEqual(self._fc[4].lower, 20)
- self.assertEqual(self._fc[4].upper, 27)
+ self._fc.add_mapping('c', self._ranges1)
+
+ self._fc += [('d', self._ranges2), ('e', self._ranges3)]
+
+ self.assertEqual(len(self._fc), 3)
+ self.assertEqual(self._fc['c'].label, 'c')
+ self.assertEqual(self._fc['c'].ranges, self._ranges1)
+ self.assertEqual(self._fc['d'].label, 'd')
+ self.assertEqual(self._fc['d'].ranges, self._ranges2)
+ 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', 0)
+ self._fc.add_mapping('a', self._ranges1)
self.assertTrue(self._fc)
def test_len(self):
- self._fc.add_mapping('a', 0)
- self._fc.add_mapping('b', 1)
- self._fc.add_mapping('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.add_mapping('a', 0)
- self._fc.add_mapping('b', 1, 3)
- self._fc.add_mapping('c', 5)
- mapping = self._fc[1]
- self.assertEqual(mapping.name, 'b')
- self.assertEqual(mapping.lower, 1)
- self.assertEqual(mapping.upper, 3)
+ 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')
+ self.assertEqual(mapping.ranges, self._ranges1)
+
+ def test_getitem_nonexistent(self):
+ with self.assertRaises(KeyError):
+ self._fc['doesnotexist']
def test_iter(self):
- mappings = (
- ('a', 1, 5),
- ('b', 10, 17),
- ('c', 20, 1504),
- ('d', 22510, 99999),
- )
-
- for mapping in mappings:
- self._fc.add_mapping(*mapping)
-
- for fc_mapping, mapping in zip(self._fc, mappings):
- self.assertEqual(fc_mapping.name, mapping[0])
- self.assertEqual(fc_mapping.lower, mapping[1])
- self.assertEqual(fc_mapping.upper, mapping[2])
-
- def test_mapping_eq(self):
- enum1 = bt2.EnumerationFieldClass(size=32)
- enum2 = bt2.EnumerationFieldClass(size=16)
- enum1.add_mapping('b', 1, 3)
- enum2.add_mapping('b', 1, 3)
- self.assertEqual(enum1[0], enum2[0])
-
- def test_mapping_eq_invalid(self):
- enum1 = bt2.EnumerationFieldClass(size=32)
- enum1.add_mapping('b', 1, 3)
- self.assertNotEqual(enum1[0], 23)
-
- def _test_find_by_name(self, fc):
- fc.add_mapping('a', 0)
- fc.add_mapping('b', 1, 3)
- fc.add_mapping('a', 5)
- fc.add_mapping('a', 17, 144)
- fc.add_mapping('C', 5)
- mapping_iter = fc.mappings_by_name('a')
- mappings = list(mapping_iter)
- a0 = False
- a5 = False
- a17_144 = False
- i = 0
-
- for mapping in mappings:
- i += 1
- self.assertEqual(mapping.name, 'a')
-
- if mapping.lower == 0 and mapping.upper == 0:
- a0 = True
- elif mapping.lower == 5 and mapping.upper == 5:
- a5 = True
- elif mapping.lower == 17 and mapping.upper == 144:
- a17_144 = True
-
- self.assertEqual(i, 3)
- self.assertTrue(a0)
- self.assertTrue(a5)
- self.assertTrue(a17_144)
-
- def test_find_by_name_signed(self):
- self._test_find_by_name(bt2.EnumerationFieldClass(size=8, is_signed=True))
-
- def test_find_by_name_unsigned(self):
- self._test_find_by_name(bt2.EnumerationFieldClass(size=8))
-
- def _test_find_by_value(self, fc):
- fc.add_mapping('a', 0)
- fc.add_mapping('b', 1, 3)
- fc.add_mapping('c', 5, 19)
- fc.add_mapping('d', 8, 15)
- fc.add_mapping('e', 10, 21)
- fc.add_mapping('f', 0)
- fc.add_mapping('g', 14)
- mapping_iter = fc.mappings_by_value(14)
- mappings = list(mapping_iter)
- c = False
- d = False
- e = False
- g = False
- i = 0
-
- for mapping in mappings:
- i += 1
-
- if mapping.name == 'c':
- c = True
- elif mapping.name == 'd':
- d = True
- elif mapping.name == 'e':
- e = True
- elif mapping.name == 'g':
- g = True
-
- self.assertEqual(i, 4)
- self.assertTrue(c)
- self.assertTrue(d)
- self.assertTrue(e)
- self.assertTrue(g)
-
- def test_find_by_value_signed(self):
- self._test_find_by_value(bt2.EnumerationFieldClass(size=8, is_signed=True))
-
- def test_find_by_value_unsigned(self):
- self._test_find_by_value(bt2.EnumerationFieldClass(size=8))
-
- def test_create_field(self):
- self._fc.add_mapping('c', 4, 5)
- field = self._fc()
- self.assertIsInstance(field, bt2.field._EnumerationField)
-
- def test_create_field_init(self):
- self._fc.add_mapping('c', 4, 5)
- field = self._fc(4)
- self.assertEqual(field, 4)
-
-
-@unittest.skip("this is broken")
-class StringFieldClassTestCase(_TestCopySimple, _TestInvalidEq,
- unittest.TestCase):
- def setUp(self):
- self._fc = bt2.StringFieldClass()
+ self._fc.add_mapping('a', self._ranges1)
+ self._fc.add_mapping('b', self._ranges2)
+ self._fc.add_mapping('c', self._ranges3)
- def tearDown(self):
- del self._fc
+ # This exercises iteration.
+ labels = sorted(self._fc)
- def test_create_default(self):
- pass
+ self.assertEqual(labels, ['a', 'b', 'c'])
- def test_create_full(self):
- fc = bt2.StringFieldClass(encoding=bt2.Encoding.UTF8)
- self.assertEqual(fc.encoding, bt2.Encoding.UTF8)
+ def test_find_by_value(self):
+ 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)
- def test_assign_encoding(self):
- self._fc.encoding = bt2.Encoding.UTF8
- self.assertEqual(self._fc.encoding, bt2.Encoding.UTF8)
- def test_assign_invalid_encoding(self):
- with self.assertRaises(TypeError):
- self._fc.encoding = 'yes'
+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)
+
+ 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, _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
+
+ @staticmethod
+ def _const_value_setter(field):
+ field = 0
- def test_create_field(self):
- field = self._fc()
- self.assertIsInstance(field, bt2.field._StringField)
+ def _create_field_class(self, *args, **kwargs):
+ tc = get_default_trace_class()
+ return tc.create_signed_enumeration_field_class(*args, **kwargs)
- def test_create_field_init(self):
- field = self._fc('hola')
- self.assertEqual(field, 'hola')
+ 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 _TestFieldContainer(_TestInvalidEq, _TestCopySimple):
- def test_append_field(self):
- int_field_class = bt2.IntegerFieldClass(32)
- self._fc.append_field('int32', int_field_class)
- field_class = self._fc['int32']
- self.assertEqual(field_class, int_field_class)
- def test_append_field_kwargs(self):
- int_field_class = bt2.IntegerFieldClass(32)
- self._fc.append_field(name='int32', field_class=int_field_class)
- field_class = self._fc['int32']
- self.assertEqual(field_class, int_field_class)
+class StringFieldClassTestCase(_TestFieldClass, unittest.TestCase):
+ @staticmethod
+ def _const_value_setter(field):
+ field = '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_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.assertEqual(field_class.addr, int_field_class.addr)
+
+ 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.assertEqual(field_class.addr, int_field_class.addr)
+
+ def test_append_element_invalid_name(self):
+ sub_fc = self._tc.create_string_field_class()
- def test_append_field_invalid_name(self):
with self.assertRaises(TypeError):
- self._fc.append_field(23, bt2.StringFieldClass())
+ self._append_element_method(self._fc, 23, sub_fc)
- def test_append_field_invalid_field_class(self):
+ def test_append_element_invalid_field_class(self):
with self.assertRaises(TypeError):
- self._fc.append_field('yes', object())
+ 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 = bt2.StructureFieldClass()
- c_field_class = bt2.StringFieldClass()
- d_field_class = bt2.EnumerationFieldClass(size=32)
- e_field_class = bt2.StructureFieldClass()
- struct_fc.append_field('c_string', c_field_class)
- struct_fc.append_field('d_enum', d_field_class)
- struct_fc.append_field('e_struct', e_field_class)
- a_field_class = bt2.FloatingPointNumberFieldClass()
- b_field_class = bt2.IntegerFieldClass(17)
- self._fc.append_field('a_float', a_field_class)
- self._fc.append_field('b_int', b_field_class)
- self._fc += struct_fc
- self.assertEqual(self._fc['a_float'], a_field_class)
- self.assertEqual(self._fc['b_int'], b_field_class)
- self.assertEqual(self._fc['c_string'], c_field_class)
- self.assertEqual(self._fc['d_enum'], d_field_class)
- self.assertEqual(self._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)
+ 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)
- self._fc.append_field('a', bt2.StringFieldClass())
+ self._append_element_method(self._fc, 'a', self._tc.create_string_field_class())
self.assertTrue(self._fc)
def test_len(self):
- fc = bt2.StringFieldClass()
- self._fc.append_field('a', fc)
- self._fc.append_field('b', fc)
- self._fc.append_field('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):
- a_fc = bt2.IntegerFieldClass(32)
- b_fc = bt2.StringFieldClass()
- c_fc = bt2.FloatingPointNumberFieldClass()
- self._fc.append_field('a', a_fc)
- self._fc.append_field('b', b_fc)
- self._fc.append_field('c', c_fc)
- self.assertEqual(self._fc['b'], b_fc)
+ 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._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'].field_class.addr, b_fc.addr)
+ self.assertEqual(self._fc['b'].name, 'b')
def test_getitem_invalid_key_type(self):
with self.assertRaises(TypeError):
def test_contains(self):
self.assertFalse('a' in self._fc)
- self._fc.append_field('a', bt2.StringFieldClass())
+ self._append_element_method(self._fc, 'a', self._tc.create_string_field_class())
self.assertTrue('a' in self._fc)
def test_iter(self):
- a_fc = bt2.IntegerFieldClass(32)
- b_fc = bt2.StringFieldClass()
- c_fc = bt2.FloatingPointNumberFieldClass()
- fields = (
- ('a', a_fc),
- ('b', b_fc),
- ('c', c_fc),
- )
+ 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()
+ elements = (('a', a_fc), ('b', b_fc), ('c', c_fc))
- for field in fields:
- self._fc.append_field(*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, field[1])
+ 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 = bt2.IntegerFieldClass(32)
- b_fc = bt2.StringFieldClass()
- c_fc = bt2.FloatingPointNumberFieldClass()
- self._fc.append_field('c', c_fc)
- self._fc.append_field('a', a_fc)
- self._fc.append_field('b', b_fc)
- self.assertEqual(self._fc.at_index(1), a_fc)
+ 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._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)
+ 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._fc.append_field('c', bt2.IntegerFieldClass(32))
+ self._append_element_method(
+ self._fc, 'c', self._tc.create_signed_integer_field_class(32)
+ )
with self.assertRaises(TypeError):
- self._fc.at_index('yes')
+ self._at_index_method(self._fc, 'yes')
def test_at_index_out_of_bounds_after(self):
- self._fc.append_field('c', bt2.IntegerFieldClass(32))
+ self._append_element_method(
+ self._fc, 'c', self._tc.create_signed_integer_field_class(32)
+ )
with self.assertRaises(IndexError):
- self._fc.at_index(len(self._fc))
+ 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
+ )
-@unittest.skip("this is broken")
-class StructureFieldClassTestCase(_TestFieldContainer, unittest.TestCase):
- def setUp(self):
- self._fc = bt2.StructureFieldClass()
- def tearDown(self):
- del self._fc
+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)
+
+ def setUp(self):
+ self._tc = get_default_trace_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.assertEqual(self._fc.alignment, 1)
+ 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)
- def test_create_with_min_alignment(self):
- fc = bt2.StructureFieldClass(8)
- self.assertEqual(fc.alignment, 8)
+ opt_struct_array_fc = self._tc.create_option_field_class(inner_struct_fc)
- def test_assign_alignment(self):
+ 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
+
+ def setUp(self):
+ self._tc = get_default_trace_class()
+ self._spec_set_up()
+ 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()
+ 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):
- self._fc.alignment = 32
+ 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 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_assign_min_alignment(self):
- self._fc.min_alignment = 64
- self.assertTrue(self._fc.alignment >= 64)
+ 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()
- def test_assign_invalid_min_alignment(self):
with self.assertRaises(ValueError):
- self._fc.min_alignment = 23
+ self._fc.append_option('yes', sub_fc1, self._ranges1)
+ self._fc.append_option('yes', sub_fc2, self._ranges2)
- def test_assign_get_min_alignment(self):
- with self.assertRaises(AttributeError):
- self._fc.min_alignment
+ def test_append_element_invalid_ranges_signedness(self):
+ sub_fc = self._tc.create_string_field_class()
- def test_create_field(self):
- field = self._fc()
- self.assertIsInstance(field, bt2.field._StructureField)
+ 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_create_field_init_invalid(self):
- with self.assertRaises(bt2.Error):
- field = self._fc(23)
+ 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,
+ )
-@unittest.skip("this is broken")
-class VariantFieldClassTestCase(_TestFieldContainer, unittest.TestCase):
- def setUp(self):
- self._fc = bt2.VariantFieldClass('path.to.tag')
+ 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 tearDown(self):
- del self._fc
+ 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_create_default(self):
- self.assertEqual(self._fc.tag_name, 'path.to.tag')
+ 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_create_invalid_tag_name(self):
+ def test_getitem_invalid_key_type(self):
with self.assertRaises(TypeError):
- self._fc = bt2.VariantFieldClass(23)
+ self._fc[0]
- def test_assign_tag_name(self):
- self._fc.tag_name = 'a.different.tag'
- self.assertEqual(self._fc.tag_name, 'a.different.tag')
+ 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
+ )
- def test_assign_invalid_tag_name(self):
with self.assertRaises(TypeError):
- self._fc.tag_name = -17
+ 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
+ )
-@unittest.skip("this is broken")
-class ArrayFieldClassTestCase(_TestInvalidEq, _TestCopySimple,
- unittest.TestCase):
- def setUp(self):
- self._elem_fc = bt2.IntegerFieldClass(23)
- self._fc = bt2.ArrayFieldClass(self._elem_fc, 45)
+ 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 {
+ # [u]int64_t selector;
+ # string bar;
+ # string baz;
+ # variant <selector> {
+ # real a; // selected with self._ranges1
+ # int21_t b; // selected with self._ranges2
+ # uint34_t c; // selected with self._ranges3
+ # } variant;
+ # } inner_struct[2];
+ # };
+ 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', 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', self._fc)
+
+ 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)
+ outer_struct_fc.append_member('inner_struct', inner_struct_array_fc)
+
+ # 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
+ )
+
+ def test_selector_field_path_length(self):
+ self._fill_default_fc_for_field_path_test()
+ self.assertEqual(len(self._fc.selector_field_path), 3)
+
+ def test_selector_field_path_iter(self):
+ self._fill_default_fc_for_field_path_test()
+ path_items = list(self._fc.selector_field_path)
- def tearDown(self):
- del self._fc
- del self._elem_fc
+ 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._CurrentArrayElementFieldPathItem)
+
+ 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.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)
+
+ def setUp(self):
+ self._tc = get_default_trace_class()
+ self._elem_fc = self._tc.create_signed_integer_field_class(23)
def test_create_default(self):
- self.assertEqual(self._fc.element_field_class, self._elem_fc)
- self.assertEqual(self._fc.length, 45)
+ 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_field_class(self):
+ def test_create_invalid_elem_field_class(self):
with self.assertRaises(TypeError):
- self._fc = bt2.ArrayFieldClass(object(), 45)
+ self._tc.create_static_array_field_class(object(), 45)
def test_create_invalid_length(self):
with self.assertRaises(ValueError):
- self._fc = bt2.ArrayFieldClass(bt2.StringFieldClass(), -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._fc = bt2.ArrayFieldClass(bt2.StringFieldClass(), 'the length')
+ self._tc.create_static_array_field_class(
+ self._tc.create_string_field_class(), 'the length'
+ )
- def test_create_field(self):
- field = self._fc()
- self.assertIsInstance(field, bt2.field._ArrayField)
- def test_create_field_init_invalid(self):
- with self.assertRaises(bt2.Error):
- field = self._fc(23)
+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)
-@unittest.skip("this is broken")
-class SequenceFieldClassTestCase(_TestInvalidEq, _TestCopySimple,
- unittest.TestCase):
- def setUp(self):
- self._elem_fc = bt2.IntegerFieldClass(23)
- self._fc = bt2.SequenceFieldClass(self._elem_fc, 'the.length')
+ 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 tearDown(self):
- del self._fc
- del self._elem_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):
- self.assertEqual(self._fc.element_field_class, self._elem_fc)
- self.assertEqual(self._fc.length_name, 'the.length')
+ 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:
+ #
+ # struct outer_struct_fc {
+ # real foo;
+ # struct inner_struct_fc {
+ # string bar;
+ # string baz;
+ # uint12_t len;
+ # uint23_t dyn_array[len];
+ # } inner_struct[2];
+ # };
+
+ fc = self._tc.create_dynamic_array_field_class(self._elem_fc, self._len_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('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
+ )
+
+ outer_struct_fc = self._tc.create_structure_field_class()
+ outer_struct_fc.append_member('foo', foo_fc)
+ outer_struct_fc.append_member('inner_struct', inner_struct_array_fc)
+
+ # 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
+ )
+
+ return fc
+
+ def test_field_path_len(self):
+ fc = self._create_field_class_for_field_path_test()
+ self.assertEqual(len(fc.length_field_path), 3)
+
+ def test_field_path_iter(self):
+ fc = self._create_field_class_for_field_path_test()
+ path_items = list(fc.length_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._CurrentArrayElementFieldPathItem)
+
+ 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.FieldPathScope.PACKET_CONTEXT
+ )
def test_create_invalid_field_class(self):
with self.assertRaises(TypeError):
- self._fc = bt2.ArrayFieldClass(object(), 'the.length')
+ self._tc.create_dynamic_array_field_class(object())
def test_create_invalid_length_type(self):
with self.assertRaises(TypeError):
- self._fc = bt2.SequenceFieldClass(bt2.StringFieldClass(), 17)
+ self._tc.create_dynamic_array_field_class(
+ self._tc.create_string_field_class(), 17
+ )
- def test_create_field(self):
- field = self._fc()
- self.assertIsInstance(field, bt2.field._SequenceField)
- def test_create_field_init_invalid(self):
- with self.assertRaises(bt2.Error):
- field = self._fc(23)
+if __name__ == "__main__":
+ unittest.main()