Move to kernel style SPDX license identifiers
[babeltrace.git] / tests / bindings / python / bt2 / test_field_class.py
index e6380474126cc6dd32b55d9bf5fbc588ca780354..4f6aab2415309fb4acf180ab4243dfa121da2c5b 100644 (file)
@@ -1,20 +1,7 @@
+# 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 unittest
 import bt2
@@ -245,34 +232,46 @@ class UnsignedIntegerFieldClassTestCase(
     _create_default_field_class = _create_field_class
 
 
-class RealFieldClassTestCase(_TestFieldClass, unittest.TestCase):
+class SingleRealFieldClassTestCase(_TestFieldClass, unittest.TestCase):
     @staticmethod
     def _const_value_setter(field):
-        field.value = -18
+        field.value = -18.0
 
     def _create_field_class(self, *args, **kwargs):
         tc = get_default_trace_class()
-        return tc.create_real_field_class(*args, **kwargs)
+        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_real_field_class(*args, **kwargs)
+        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._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):
-            self._create_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:
@@ -362,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):
@@ -390,6 +391,10 @@ class _EnumerationFieldClassTestCase(_TestIntegerFieldClassProps):
 class UnsignedEnumerationFieldClassTestCase(
     _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)])
@@ -416,6 +421,10 @@ class UnsignedEnumerationFieldClassTestCase(
 class SignedEnumerationFieldClassTestCase(
     _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)])
@@ -522,7 +531,7 @@ class _TestElementContainer:
         self.assertIs(type(field_class), bt2_field_class._SignedIntegerFieldClassConst)
 
     def test_iadd(self):
-        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)
@@ -548,7 +557,7 @@ class _TestElementContainer:
         self.assertEqual(self._fc['e_struct'].name, 'e_struct')
 
     def test_const_iadd(self):
-        a_field_class = self._tc.create_real_field_class()
+        a_field_class = self._tc.create_single_precision_real_field_class()
         with self.assertRaises(TypeError):
             self._fc_const += a_field_class
 
@@ -566,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)
@@ -589,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:
@@ -604,7 +613,7 @@ class _TestElementContainer:
     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)
@@ -682,47 +691,56 @@ class StructureFieldClassTestCase(
 
         tc = get_default_trace_class()
         fc = tc.create_structure_field_class()
-        member_fc = self._tc.create_real_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._RealFieldClassConst
+            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_real_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._RealFieldClass)
+        self.assertIs(
+            type(fc['real'].field_class), bt2_field_class._SinglePrecisionRealFieldClass
+        )
 
 
-class OptionFieldClassTestCase(_TestFieldClass, unittest.TestCase):
+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_field_class(self._content_fc, **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_field_class(self._content_fc, **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)
-        self._tag_fc = 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.assertIsNone(fc.selector_field_path, None)
         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)
@@ -733,10 +751,34 @@ class OptionFieldClassTestCase(_TestFieldClass, unittest.TestCase):
             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(selector_fc=self._tag_fc)
+        fc = self._create_default_field_class()
 
-        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()
 
@@ -746,7 +788,9 @@ class OptionFieldClassTestCase(_TestFieldClass, unittest.TestCase):
         inner_struct_fc.append_member('tag', self._tag_fc)
         inner_struct_fc.append_member('opt', fc)
 
-        opt_struct_array_fc = self._tc.create_option_field_class(inner_struct_fc)
+        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)
@@ -785,13 +829,90 @@ class OptionFieldClassTestCase(_TestFieldClass, unittest.TestCase):
             fc.selector_field_path.root_scope, bt2.FieldPathScope.PACKET_CONTEXT
         )
 
-    def test_create_invalid_field_class(self):
+
+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._tc.create_option_field_class(object())
+            self._create_default_field_class(selector_is_reversed=23)
 
     def test_create_invalid_selector_type(self):
         with self.assertRaises(TypeError):
-            self._tc.create_option_field_class(self._content_fc, 17)
+            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 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(
@@ -824,7 +945,7 @@ class VariantFieldClassWithoutSelectorTestCase(
     _create_default_field_class = _create_field_class
 
 
-class _VariantFieldClassWithSelectorTestCase:
+class _VariantFieldClassWithIntegerSelectorTestCase:
     @staticmethod
     def _const_value_setter(field):
         field['variant'].selected_option_index = 0
@@ -948,7 +1069,7 @@ class _VariantFieldClassWithSelectorTestCase:
             )
 
     def test_iadd(self):
-        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(
@@ -970,7 +1091,7 @@ class _VariantFieldClassWithSelectorTestCase:
 
     def test_const_iadd(self):
         fc_const = self._create_default_const_field_class()
-        a_field_class = self._tc.create_real_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)]
 
@@ -988,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)
@@ -1026,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),
@@ -1045,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)
@@ -1085,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
         )
@@ -1093,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()
 
@@ -1143,7 +1266,7 @@ class _VariantFieldClassWithSelectorTestCase:
 
 
 class VariantFieldClassWithUnsignedSelectorTestCase(
-    _VariantFieldClassWithSelectorTestCase, unittest.TestCase
+    _VariantFieldClassWithIntegerSelectorTestCase, unittest.TestCase
 ):
     def _spec_set_up(self):
         self._ranges1 = bt2.UnsignedIntegerRangeSet([(1, 4), (18, 47)])
@@ -1154,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)])
@@ -1171,6 +1294,8 @@ class _ArrayFieldClassTestCase:
             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(
@@ -1178,7 +1303,9 @@ class _ArrayFieldClassTestCase:
         )
 
 
-class StaticArrayFieldClassTestCase(_ArrayFieldClassTestCase, unittest.TestCase):
+class StaticArrayFieldClassTestCase(
+    _ArrayFieldClassTestCase, _ArrayFieldClassConstTestCase, unittest.TestCase
+):
     @staticmethod
     def _const_value_setter(field):
         field.value = [9] * 45
@@ -1217,7 +1344,9 @@ class StaticArrayFieldClassTestCase(_ArrayFieldClassTestCase, unittest.TestCase)
             )
 
 
-class DynamicArrayFieldClassTestCase(_ArrayFieldClassTestCase, unittest.TestCase):
+class DynamicArrayFieldClassTestCase(
+    _ArrayFieldClassTestCase, _ArrayFieldClassConstTestCase, unittest.TestCase
+):
     @staticmethod
     def _const_value_setter(field):
         field.value = []
@@ -1232,11 +1361,35 @@ class DynamicArrayFieldClassTestCase(_ArrayFieldClassTestCase, unittest.TestCase
     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)
 
@@ -1253,9 +1406,9 @@ class DynamicArrayFieldClassTestCase(_ArrayFieldClassTestCase, 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()
 
@@ -1305,10 +1458,6 @@ class DynamicArrayFieldClassTestCase(_ArrayFieldClassTestCase, unittest.TestCase
             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(
This page took 0.030818 seconds and 4 git commands to generate.