Move to kernel style SPDX license identifiers
[babeltrace.git] / tests / bindings / python / bt2 / test_field.py
index 7c00b3060e0a20c9b24114db018a70db9d75562a..37afffb54a422ee2e7ec0e362fefa6b342958359 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.
-#
 
 from functools import partial, partialmethod
 import operator
@@ -24,7 +11,7 @@ import copy
 import itertools
 import collections
 import bt2
-from utils import get_default_trace_class, TestOutputPortMessageIterator
+from utils import get_default_trace_class, create_const_field
 
 
 _COMP_BINOPS = (operator.eq, operator.ne)
@@ -63,50 +50,6 @@ def _create_field(tc, field_class):
     return packet.context_field[field_name]
 
 
-# Create a const field of the given field class.
-#
-# The field is part of a dummy stream, itself part of a dummy trace created
-# from trace class `tc`.
-
-
-def _create_const_field(tc, field_class, field_value_setter_fn):
-    field_name = 'const field'
-
-    class MyIter(bt2._UserMessageIterator):
-        def __init__(self, self_port_output):
-            nonlocal field_class
-            nonlocal field_value_setter_fn
-            stream = _create_stream(tc, [(field_name, field_class)])
-            packet = stream.create_packet()
-
-            field_value_setter_fn(packet.context_field[field_name])
-
-            self._msgs = [
-                self._create_stream_beginning_message(stream),
-                self._create_packet_beginning_message(packet),
-            ]
-
-        def __next__(self):
-            if len(self._msgs) == 0:
-                raise StopIteration
-
-            return self._msgs.pop(0)
-
-    class MySrc(bt2._UserSourceComponent, message_iterator_class=MyIter):
-        def __init__(self, params, obj):
-            self._add_output_port('out', params)
-
-    graph = bt2.Graph()
-    src_comp = graph.add_component(MySrc, 'my_source', None)
-    msg_iter = TestOutputPortMessageIterator(graph, src_comp.output_ports['out'])
-
-    # Ignore first message, stream beginning
-    _ = next(msg_iter)
-    packet_beg_msg = next(msg_iter)
-
-    return packet_beg_msg.packet.context_field[field_name]
-
-
 # Create a field of type string.
 #
 # The field is part of a dummy stream, itself part of a dummy trace created
@@ -367,9 +310,8 @@ class _TestNumericField:
 
     # Tests that the binary operation `op`, when applied to `self._def`,
     # does not change its value.
-    @unittest.skip('copy is not implemented')
     def _test_binop_lhs_value_same(self, op, rhs):
-        value_before = copy.copy(self._def)
+        value_before = copy.copy(self._def_value)
         r, rv = self._binop(op, rhs)
         self.assertEqual(self._def, value_before)
 
@@ -388,22 +330,31 @@ class _TestNumericField:
     # `vint` and `vfloat` mean a signed integer value object and a real
     # value object.
 
-    def _test_binop_invalid_unknown(self, op):
-        if op in _COMP_BINOPS:
-            self.skipTest('not testing')
-
+    def _test_binop_unknown(self, op):
         class A:
             pass
 
-        with self.assertRaises(TypeError):
-            op(self._def, A())
-
-    def _test_binop_invalid_none(self, op):
-        if op in _COMP_BINOPS:
-            self.skipTest('not testing')
-
-        with self.assertRaises(TypeError):
-            op(self._def, None)
+        # Operators == and != are defined when comparing the field to an
+        # arbitrary object.
+        if op is operator.eq:
+            self.assertIs(op(self._def, A()), False)
+        elif op is operator.ne:
+            self.assertIs(op(self._def, A()), True)
+        else:
+            # But not other operators.
+            with self.assertRaises(TypeError):
+                op(self._def, A())
+
+    def _test_binop_none(self, op):
+        # Operators == and != are defined when comparing the field to None.
+        if op is operator.eq:
+            self.assertIs(op(self._def, None), False)
+        elif op is operator.ne:
+            self.assertIs(op(self._def, None), True)
+        else:
+            # But not other operators.
+            with self.assertRaises(TypeError):
+                op(self._def, None)
 
     def _test_binop_rhs_false(self, test_cb, op):
         test_cb(op, False)
@@ -770,13 +721,13 @@ def _inject_numeric_testing_methods(cls):
     for name, binop in _BINOPS:
         setattr(
             cls,
-            test_binop_name('invalid_unknown'),
-            partialmethod(_TestNumericField._test_binop_invalid_unknown, op=binop),
+            test_binop_name('unknown'),
+            partialmethod(_TestNumericField._test_binop_unknown, op=binop),
         )
         setattr(
             cls,
-            test_binop_name('invalid_none'),
-            partialmethod(_TestNumericField._test_binop_invalid_none, op=binop),
+            test_binop_name('none'),
+            partialmethod(_TestNumericField._test_binop_none, op=binop),
         )
         setattr(
             cls,
@@ -1192,7 +1143,7 @@ class BoolFieldTestCase(_TestNumericField, unittest.TestCase):
         self._def = _create_field(self._tc, self._create_fc(self._tc))
         self._def.value = True
         self._def_value = True
-        self._def_const = _create_const_field(
+        self._def_const = create_const_field(
             self._tc, self._tc.create_bool_field_class(), self._const_value_setter
         )
         self._def_new_value = False
@@ -1284,12 +1235,35 @@ class _TestIntegerFieldCommon(_TestNumericField):
         field.value = (2 ** 53) + 1
         self.assertEqual(field, raw)
 
-    def test_assign_uint_invalid_neg(self):
-        uint_fc = self._tc.create_unsigned_integer_field_class(32)
+    def test_assign_uint_out_of_range(self):
+        uint_fc = self._tc.create_unsigned_integer_field_class(8)
         field = _create_field(self._tc, uint_fc)
 
-        with self.assertRaises(ValueError):
-            field.value = -23
+        with self.assertRaises(ValueError) as ctx:
+            field.value = 256
+        self.assertEqual(
+            str(ctx.exception), 'Value 256 is outside valid range [0, 255]'
+        )
+
+        with self.assertRaises(ValueError) as ctx:
+            field.value = -1
+        self.assertEqual(str(ctx.exception), 'Value -1 is outside valid range [0, 255]')
+
+    def test_assign_int_out_of_range(self):
+        int_fc = self._tc.create_signed_integer_field_class(8)
+        field = _create_field(self._tc, int_fc)
+
+        with self.assertRaises(ValueError) as ctx:
+            field.value = 128
+        self.assertEqual(
+            str(ctx.exception), 'Value 128 is outside valid range [-128, 127]'
+        )
+
+        with self.assertRaises(ValueError) as ctx:
+            field.value = -129
+        self.assertEqual(
+            str(ctx.exception), 'Value -129 is outside valid range [-128, 127]'
+        )
 
     def test_str_op(self):
         self.assertEqual(str(self._def), str(self._def_value))
@@ -1313,7 +1287,7 @@ class SignedIntegerFieldTestCase(_TestIntegerFieldCommon, unittest.TestCase):
         self._def = _create_field(self._tc, self._create_fc(self._tc))
         self._def.value = 17
         self._def_value = 17
-        self._def_const = _create_const_field(
+        self._def_const = create_const_field(
             self._tc, self._create_fc(self._tc), self._const_value_setter
         )
         self._def_new_value = -101
@@ -1341,7 +1315,7 @@ class SignedEnumerationFieldTestCase(_TestIntegerFieldCommon, unittest.TestCase)
         self._def = _create_field(self._tc, self._create_fc(self._tc))
         self._def.value = 17
         self._def_value = 17
-        self._def_const = _create_const_field(
+        self._def_const = create_const_field(
             self._tc, self._create_fc(self._tc), self._const_value_setter
         )
         self._def_new_value = -101
@@ -1367,20 +1341,118 @@ class SignedEnumerationFieldTestCase(_TestIntegerFieldCommon, unittest.TestCase)
         self.assertEqual(labels, ['something', 'whole range', 'zip'])
 
 
-class RealFieldTestCase(_TestNumericField, unittest.TestCase):
+class SingleRealFieldTestCase(_TestNumericField, unittest.TestCase):
+    @staticmethod
+    def _const_value_setter(field):
+        field.value = 52.0
+
+    def _create_fc(self, tc):
+        return tc.create_single_precision_real_field_class()
+
+    def setUp(self):
+        self._tc = get_default_trace_class()
+        self._field = _create_field(self._tc, self._create_fc(self._tc))
+        self._def = _create_field(self._tc, self._create_fc(self._tc))
+        self._def_const = create_const_field(
+            self._tc,
+            self._tc.create_single_precision_real_field_class(),
+            self._const_value_setter,
+        )
+        self._def.value = 52.0
+        self._def_value = 52.0
+        self._def_new_value = -17.0
+
+    def _test_invalid_op(self, cb):
+        with self.assertRaises(TypeError):
+            cb()
+
+    def test_assign_true(self):
+        self._def.value = True
+        self.assertTrue(self._def)
+
+    def test_assign_false(self):
+        self._def.value = False
+        self.assertFalse(self._def)
+
+    def test_assign_pos_int(self):
+        raw = 477
+        self._def.value = raw
+        self.assertEqual(self._def, float(raw))
+
+    def test_assign_neg_int(self):
+        raw = -13
+        self._def.value = raw
+        self.assertEqual(self._def, float(raw))
+
+    def test_assign_int_field(self):
+        int_fc = self._tc.create_signed_integer_field_class(32)
+        int_field = _create_field(self._tc, int_fc)
+        raw = 999
+        int_field.value = raw
+        self._def.value = int_field
+        self.assertEqual(self._def, float(raw))
+
+    def test_assign_float(self):
+        raw = -19.23
+        self._def.value = raw
+        # It's expected to have some lost of precision because of the field
+        # that is in single precision.
+        self.assertEqual(round(self._def, 5), raw)
+
+    def test_assign_float_field(self):
+        field = _create_field(self._tc, self._create_fc(self._tc))
+        raw = 101.32
+        field.value = raw
+        self._def.value = field
+        # It's expected to have some lost of precision because of the field
+        # that is in single precision.
+        self.assertEqual(round(self._def, 5), raw)
+
+    def test_assign_invalid_type(self):
+        with self.assertRaises(TypeError):
+            self._def.value = 'yes'
+
+    def test_invalid_lshift(self):
+        self._test_invalid_op(lambda: self._def << 23)
+
+    def test_invalid_rshift(self):
+        self._test_invalid_op(lambda: self._def >> 23)
+
+    def test_invalid_and(self):
+        self._test_invalid_op(lambda: self._def & 23)
+
+    def test_invalid_or(self):
+        self._test_invalid_op(lambda: self._def | 23)
+
+    def test_invalid_xor(self):
+        self._test_invalid_op(lambda: self._def ^ 23)
+
+    def test_invalid_invert(self):
+        self._test_invalid_op(lambda: ~self._def)
+
+    def test_str_op(self):
+        self.assertEqual(str(round(self._def, 5)), str(self._def_value))
+
+
+_inject_numeric_testing_methods(SingleRealFieldTestCase)
+
+
+class DoubleRealFieldTestCase(_TestNumericField, unittest.TestCase):
     @staticmethod
     def _const_value_setter(field):
         field.value = 52.7
 
     def _create_fc(self, tc):
-        return tc.create_real_field_class()
+        return tc.create_double_precision_real_field_class()
 
     def setUp(self):
         self._tc = get_default_trace_class()
         self._field = _create_field(self._tc, self._create_fc(self._tc))
         self._def = _create_field(self._tc, self._create_fc(self._tc))
-        self._def_const = _create_const_field(
-            self._tc, self._tc.create_real_field_class(), self._const_value_setter
+        self._def_const = create_const_field(
+            self._tc,
+            self._tc.create_double_precision_real_field_class(),
+            self._const_value_setter,
         )
         self._def.value = 52.7
         self._def_value = 52.7
@@ -1454,7 +1526,7 @@ class RealFieldTestCase(_TestNumericField, unittest.TestCase):
         self.assertEqual(str(self._def), str(self._def_value))
 
 
-_inject_numeric_testing_methods(RealFieldTestCase)
+_inject_numeric_testing_methods(DoubleRealFieldTestCase)
 
 
 class StringFieldTestCase(unittest.TestCase):
@@ -1466,7 +1538,7 @@ class StringFieldTestCase(unittest.TestCase):
         self._tc = get_default_trace_class()
         self._def_value = 'Hello, World!'
         self._def = _create_string_field(self._tc)
-        self._def_const = _create_const_field(
+        self._def_const = create_const_field(
             self._tc, self._tc.create_string_field_class(), self._const_value_setter
         )
         self._def.value = self._def_value
@@ -1742,7 +1814,7 @@ class StaticArrayFieldTestCase(_TestArrayFieldCommon, unittest.TestCase):
         self._def[1] = 1847
         self._def[2] = 1948754
         self._def_value = [45, 1847, 1948754]
-        self._def_const = _create_const_field(
+        self._def_const = create_const_field(
             self._tc,
             self._tc.create_static_array_field_class(
                 self._tc.create_signed_integer_field_class(32), 3
@@ -1768,7 +1840,7 @@ class DynamicArrayFieldTestCase(_TestArrayFieldCommon, unittest.TestCase):
         self._def[1] = 1847
         self._def[2] = 1948754
         self._def_value = [45, 1847, 1948754]
-        self._def_const = _create_const_field(
+        self._def_const = create_const_field(
             self._tc,
             self._tc.create_dynamic_array_field_class(
                 self._tc.create_signed_integer_field_class(32)
@@ -1824,7 +1896,7 @@ class StructureFieldTestCase(unittest.TestCase):
         self._tc = get_default_trace_class()
         self._fc0_fn = self._tc.create_signed_integer_field_class
         self._fc1_fn = self._tc.create_string_field_class
-        self._fc2_fn = self._tc.create_real_field_class
+        self._fc2_fn = self._tc.create_double_precision_real_field_class
         self._fc3_fn = self._tc.create_signed_integer_field_class
         self._fc4_fn = self._tc.create_structure_field_class
         self._fc5_fn = self._tc.create_structure_field_class
@@ -1847,7 +1919,7 @@ class StructureFieldTestCase(unittest.TestCase):
             'F': {'F_1': 52},
         }
 
-        self._def_const = _create_const_field(
+        self._def_const = create_const_field(
             self._tc, self._create_fc(self._tc), self._const_value_setter
         )
 
@@ -1878,7 +1950,7 @@ class StructureFieldTestCase(unittest.TestCase):
         self.assertIs(type(field2), bt2._StringField)
         self.assertEqual(field2, 'salut')
 
-        self.assertIs(type(field3), bt2._RealField)
+        self.assertIs(type(field3), bt2._DoublePrecisionRealField)
         self.assertEqual(field3, 17.5)
 
         self.assertIs(type(field4), bt2._SignedIntegerField)
@@ -1904,7 +1976,7 @@ class StructureFieldTestCase(unittest.TestCase):
         self.assertIs(type(field2), bt2._StringFieldConst)
         self.assertEqual(field2, 'salut')
 
-        self.assertIs(type(field3), bt2._RealFieldConst)
+        self.assertIs(type(field3), bt2._DoublePrecisionRealFieldConst)
         self.assertEqual(field3, 17.5)
 
         self.assertIs(type(field4), bt2._SignedIntegerFieldConst)
@@ -2113,7 +2185,9 @@ class OptionFieldTestCase(unittest.TestCase):
         field.value = {'opt_field': 'hiboux'}
 
     def _create_fc(self, tc):
-        fc = tc.create_option_field_class(tc.create_string_field_class())
+        fc = tc.create_option_without_selector_field_class(
+            tc.create_string_field_class()
+        )
         top_fc = tc.create_structure_field_class()
         top_fc.append_member('opt_field', fc)
         return top_fc
@@ -2123,7 +2197,7 @@ class OptionFieldTestCase(unittest.TestCase):
         fld = _create_field(self._tc, self._create_fc(self._tc))
         self._def = fld['opt_field']
         self._def_value = 'hiboux'
-        self._def_const = _create_const_field(
+        self._def_const = create_const_field(
             self._tc, self._create_fc(self._tc), self._const_value_setter
         )['opt_field']
 
@@ -2144,7 +2218,7 @@ class OptionFieldTestCase(unittest.TestCase):
         self._def.has_field = True
         self.assertTrue(self._def.has_field)
 
-    def test_has_field_prop_true(self):
+    def test_has_field_prop_false(self):
         self._def.has_field = False
         self.assertFalse(self._def.has_field)
 
@@ -2152,7 +2226,7 @@ class OptionFieldTestCase(unittest.TestCase):
         self._def.value = 'allo'
         self.assertTrue(self._def)
 
-    def test_bool_op_true(self):
+    def test_bool_op_false(self):
         self._def.has_field = False
         self.assertFalse(self._def)
 
@@ -2217,7 +2291,7 @@ class VariantFieldTestCase(unittest.TestCase):
     def _create_fc(self, tc):
         ft0 = tc.create_signed_integer_field_class(32)
         ft1 = tc.create_string_field_class()
-        ft2 = tc.create_real_field_class()
+        ft2 = tc.create_double_precision_real_field_class()
         ft3 = tc.create_signed_integer_field_class(17)
         fc = tc.create_variant_field_class()
         fc.append_option('corner', ft0)
@@ -2237,7 +2311,7 @@ class VariantFieldTestCase(unittest.TestCase):
         self._def_selected_index = 3
         const_fc = self._create_fc(self._tc)['variant_field']
 
-        fld_const = _create_const_field(
+        fld_const = create_const_field(
             self._tc, const_fc.field_class, self._const_value_setter
         )
         self._def_const = fld_const
@@ -2269,7 +2343,7 @@ class VariantFieldTestCase(unittest.TestCase):
         self._def.selected_option_index = 2
         self._def.value = -17.34
         self.assertEqual(self._def.selected_option, -17.34)
-        self.assertEqual(type(self._def.selected_option), bt2._RealField)
+        self.assertEqual(type(self._def.selected_option), bt2._DoublePrecisionRealField)
 
         self._def.selected_option_index = 3
         self._def.value = 1921
This page took 0.028575 seconds and 4 git commands to generate.