[babeltrace.git] / tests / bindings / python / bt2 / test_field.py

#
# 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
import unittest
import math
import copy
import itertools
import collections
import bt2
from utils import get_default_trace_class, TestOutputPortMessageIterator


_COMP_BINOPS = (operator.eq, operator.ne)


# Create and return a stream with the field classes part of its stream packet
# context.
#
# The stream is part of a dummy trace created from trace class `tc`.


def _create_stream(tc, ctx_field_classes):
    packet_context_fc = tc.create_structure_field_class()
    for name, fc in ctx_field_classes:
        packet_context_fc.append_member(name, fc)

    trace = tc()
    stream_class = tc.create_stream_class(
        packet_context_field_class=packet_context_fc, supports_packets=True
    )

    stream = trace.create_stream(stream_class)
    return stream


# Create a 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_field(tc, field_class):
    field_name = 'field'
    stream = _create_stream(tc, [(field_name, field_class)])
    packet = stream.create_packet()
    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
# from trace class `tc`.  It is made out of a dummy string field class.


def _create_string_field(tc):
    field_name = 'string_field'
    stream = _create_stream(tc, [(field_name, tc.create_string_field_class())])
    packet = stream.create_packet()
    return packet.context_field[field_name]


# Create a field of type static array of ints.
#
# The field is part of a dummy stream, itself part of a dummy trace created
# from trace class `tc`.  It is made out of a dummy static array field class,
# with a dummy integer field class as element class.


def _create_int_array_field(tc, length):
    elem_fc = tc.create_signed_integer_field_class(32)
    fc = tc.create_static_array_field_class(elem_fc, length)
    field_name = 'int_array'
    stream = _create_stream(tc, [(field_name, fc)])
    packet = stream.create_packet()
    return packet.context_field[field_name]


# Create a field of type dynamic array of ints.
#
# The field is part of a dummy stream, itself part of a dummy trace created
# from trace class `tc`.  It is made out of a dummy static array field class,
# with a dummy integer field class as element and length classes.


def _create_dynamic_array(tc):
    elem_fc = tc.create_signed_integer_field_class(32)
    len_fc = tc.create_signed_integer_field_class(32)
    fc = tc.create_dynamic_array_field_class(elem_fc)
    field_name = 'int_dyn_array'
    stream = _create_stream(tc, [('thelength', len_fc), (field_name, fc)])
    packet = stream.create_packet()
    packet.context_field[field_name].length = 3
    return packet.context_field[field_name]


# Create a field of type array of (empty) structures.
#
# The field is part of a dummy stream, itself part of a dummy trace created
# from trace class `tc`.  It is made out of a dummy static array field class,
# with a dummy struct field class as element class.


def _create_struct_array_field(tc, length):
    elem_fc = tc.create_structure_field_class()
    fc = tc.create_static_array_field_class(elem_fc, length)
    field_name = 'struct_array'
    stream = _create_stream(tc, [(field_name, fc)])
    packet = stream.create_packet()
    return packet.context_field[field_name]


class BitArrayFieldTestCase(unittest.TestCase):
    def _create_field(self):
        return _create_field(self._tc, self._tc.create_bit_array_field_class(24))

    def setUp(self):
        self._tc = get_default_trace_class()
        self._def_value = 15497
        self._def = self._create_field()
        self._def.value_as_integer = self._def_value
        self._def_new_value = 101542

    def test_assign_invalid_type(self):
        with self.assertRaises(TypeError):
            self._def.value_as_integer = 'onze'

    def test_assign(self):
        self._def.value_as_integer = 199
        self.assertEqual(self._def.value_as_integer, 199)

    def test_assign_masked(self):
        self._def.value_as_integer = 0xE1549BB
        self.assertEqual(self._def.value_as_integer, 0xE1549BB & ((1 << 24) - 1))

    def test_eq(self):
        other = self._create_field()
        other.value_as_integer = self._def_value
        self.assertEqual(self._def, other)

    def test_ne_same_type(self):
        other = self._create_field()
        other.value_as_integer = self._def_value - 1
        self.assertNotEqual(self._def, other)

    def test_ne_diff_type(self):
        self.assertNotEqual(self._def, self._def_value)

    def test_len(self):
        self.assertEqual(len(self._def), 24)

    def test_str(self):
        self.assertEqual(str(self._def), str(self._def_value))

    def test_repr(self):
        self.assertEqual(repr(self._def), repr(self._def_value))


# Base class for numeric field test cases.
#
# To be compatible with this base class, a derived class must, in its
# setUp() method:
#
# * Set `self._def` to a field object with an arbitrary value.
# * Set `self._def_value` to the equivalent value of `self._def`.
class _TestNumericField:
    # Tries the binary operation `op`:
    #
    # 1. Between `self._def`, which is a field object, and `rhs`.
    # 2. Between `self._def_value`, which is the raw value of
    #    `self._def`, and `rhs`.
    #
    # Returns the results of 1. and 2.
    #
    # If there's an exception while performing 1. or 2., asserts that
    # both operations raised exceptions, that both exceptions have the
    # same type, and returns `None` for both results.
    def _binop(self, op, rhs):
        type_rexc = None
        type_rvexc = None
        comp_value = rhs

        # try with field object
        try:
            r = op(self._def, rhs)
        except Exception as e:
            type_rexc = type(e)

        # try with value
        try:
            rv = op(self._def_value, comp_value)
        except Exception as e:
            type_rvexc = type(e)

        if type_rexc is not None or type_rvexc is not None:
            # at least one of the operations raised an exception: in
            # this case both operations should have raised the same
            # type of exception (division by zero, bit shift with a
            # floating point number operand, etc.)
            self.assertIs(type_rexc, type_rvexc)
            return None, None

        return r, rv

    # Tries the unary operation `op`:
    #
    # 1. On `self._def`, which is a field object.
    # 2. On `self._def_value`, which is the value of `self._def`.
    #
    # Returns the results of 1. and 2.
    #
    # If there's an exception while performing 1. or 2., asserts that
    # both operations raised exceptions, that both exceptions have the
    # same type, and returns `None` for both results.
    def _unaryop(self, op):
        type_rexc = None
        type_rvexc = None

        # try with field object
        try:
            r = op(self._def)
        except Exception as e:
            type_rexc = type(e)

        # try with value
        try:
            rv = op(self._def_value)
        except Exception as e:
            type_rvexc = type(e)

        if type_rexc is not None or type_rvexc is not None:
            # at least one of the operations raised an exception: in
            # this case both operations should have raised the same
            # type of exception (division by zero, bit shift with a
            # floating point number operand, etc.)
            self.assertIs(type_rexc, type_rvexc)
            return None, None

        return r, rv

    # Tests that the unary operation `op` gives results with the same
    # type for both `self._def` and `self._def_value`.
    def _test_unaryop_type(self, op):
        r, rv = self._unaryop(op)

        if r is None:
            return

        self.assertIsInstance(r, type(rv))

    # Tests that the unary operation `op` gives results with the same
    # value for both `self._def` and `self._def_value`. This uses the
    # __eq__() operator of `self._def`.
    def _test_unaryop_value(self, op):
        r, rv = self._unaryop(op)

        if r is None:
            return

        self.assertEqual(r, rv)

    # Tests that the unary operation `op`, when applied to `self._def`,
    # does not change its underlying BT object address.
    def _test_unaryop_addr_same(self, op):
        addr_before = self._def.addr
        self._unaryop(op)
        self.assertEqual(self._def.addr, addr_before)

    # Tests that the unary operation `op`, when applied to `self._def`,
    # does not change its value.
    def _test_unaryop_value_same(self, op):
        value_before = copy.copy(self._def_value)
        self._unaryop(op)
        self.assertEqual(self._def, value_before)

    # Tests that the binary operation `op` gives results with the same
    # type for both `self._def` and `self._def_value`.
    def _test_binop_type(self, op, rhs):
        r, rv = self._binop(op, rhs)

        if r is None:
            return

        if op in _COMP_BINOPS:
            # __eq__() and __ne__() always return a 'bool' object
            self.assertIsInstance(r, bool)
        else:
            self.assertIsInstance(r, type(rv))

    # Tests that the binary operation `op` gives results with the same
    # value for both `self._def` and `self._def_value`. This uses the
    # __eq__() operator of `self._def`.
    def _test_binop_value(self, op, rhs):
        r, rv = self._binop(op, rhs)

        if r is None:
            return

        self.assertEqual(r, rv)

    # Tests that the binary operation `op`, when applied to `self._def`,
    # does not change its underlying BT object address.
    def _test_binop_lhs_addr_same(self, op, rhs):
        addr_before = self._def.addr
        r, rv = self._binop(op, rhs)
        self.assertEqual(self._def.addr, addr_before)

    # 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)
        r, rv = self._binop(op, rhs)
        self.assertEqual(self._def, value_before)

    # The methods below which take the `test_cb` and/or `op` parameters
    # are meant to be used with one of the _test_binop_*() functions
    # above as `test_cb` and a binary operator function as `op`.
    #
    # For example:
    #
    #     self._test_binop_rhs_pos_int(self._test_binop_value,
    #                                  operator.add)
    #
    # This tests that a numeric field object added to a positive integer
    # value gives a result with the expected value.
    #
    # `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')

        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)

    def _test_binop_rhs_false(self, test_cb, op):
        test_cb(op, False)

    def _test_binop_rhs_true(self, test_cb, op):
        test_cb(op, True)

    def _test_binop_rhs_pos_int(self, test_cb, op):
        test_cb(op, 2)

    def _test_binop_rhs_neg_int(self, test_cb, op):
        test_cb(op, -23)

    def _test_binop_rhs_zero_int(self, test_cb, op):
        test_cb(op, 0)

    def _test_binop_rhs_pos_vint(self, test_cb, op):
        test_cb(op, bt2.create_value(2))

    def _test_binop_rhs_neg_vint(self, test_cb, op):
        test_cb(op, bt2.create_value(-23))

    def _test_binop_rhs_zero_vint(self, test_cb, op):
        test_cb(op, bt2.create_value(0))

    def _test_binop_rhs_pos_float(self, test_cb, op):
        test_cb(op, 2.2)

    def _test_binop_rhs_neg_float(self, test_cb, op):
        test_cb(op, -23.4)

    def _test_binop_rhs_zero_float(self, test_cb, op):
        test_cb(op, 0.0)

    def _test_binop_rhs_pos_vfloat(self, test_cb, op):
        test_cb(op, bt2.create_value(2.2))

    def _test_binop_rhs_neg_vfloat(self, test_cb, op):
        test_cb(op, bt2.create_value(-23.4))

    def _test_binop_rhs_zero_vfloat(self, test_cb, op):
        test_cb(op, bt2.create_value(0.0))

    def _test_binop_rhs_complex(self, test_cb, op):
        test_cb(op, -23 + 19j)

    def _test_binop_rhs_zero_complex(self, test_cb, op):
        test_cb(op, 0j)

    def _test_binop_type_false(self, op):
        self._test_binop_rhs_false(self._test_binop_type, op)

    def _test_binop_type_true(self, op):
        self._test_binop_rhs_true(self._test_binop_type, op)

    def _test_binop_type_pos_int(self, op):
        self._test_binop_rhs_pos_int(self._test_binop_type, op)

    def _test_binop_type_neg_int(self, op):
        self._test_binop_rhs_neg_int(self._test_binop_type, op)

    def _test_binop_type_zero_int(self, op):
        self._test_binop_rhs_zero_int(self._test_binop_type, op)

    def _test_binop_type_pos_vint(self, op):
        self._test_binop_rhs_pos_vint(self._test_binop_type, op)

    def _test_binop_type_neg_vint(self, op):
        self._test_binop_rhs_neg_vint(self._test_binop_type, op)

    def _test_binop_type_zero_vint(self, op):
        self._test_binop_rhs_zero_vint(self._test_binop_type, op)

    def _test_binop_type_pos_float(self, op):
        self._test_binop_rhs_pos_float(self._test_binop_type, op)

    def _test_binop_type_neg_float(self, op):
        self._test_binop_rhs_neg_float(self._test_binop_type, op)

    def _test_binop_type_zero_float(self, op):
        self._test_binop_rhs_zero_float(self._test_binop_type, op)

    def _test_binop_type_pos_vfloat(self, op):
        self._test_binop_rhs_pos_vfloat(self._test_binop_type, op)

    def _test_binop_type_neg_vfloat(self, op):
        self._test_binop_rhs_neg_vfloat(self._test_binop_type, op)

    def _test_binop_type_zero_vfloat(self, op):
        self._test_binop_rhs_zero_vfloat(self._test_binop_type, op)

    def _test_binop_type_complex(self, op):
        self._test_binop_rhs_complex(self._test_binop_type, op)

    def _test_binop_type_zero_complex(self, op):
        self._test_binop_rhs_zero_complex(self._test_binop_type, op)

    def _test_binop_value_false(self, op):
        self._test_binop_rhs_false(self._test_binop_value, op)

    def _test_binop_value_true(self, op):
        self._test_binop_rhs_true(self._test_binop_value, op)

    def _test_binop_value_pos_int(self, op):
        self._test_binop_rhs_pos_int(self._test_binop_value, op)

    def _test_binop_value_neg_int(self, op):
        self._test_binop_rhs_neg_int(self._test_binop_value, op)

    def _test_binop_value_zero_int(self, op):
        self._test_binop_rhs_zero_int(self._test_binop_value, op)

    def _test_binop_value_pos_vint(self, op):
        self._test_binop_rhs_pos_vint(self._test_binop_value, op)

    def _test_binop_value_neg_vint(self, op):
        self._test_binop_rhs_neg_vint(self._test_binop_value, op)

    def _test_binop_value_zero_vint(self, op):
        self._test_binop_rhs_zero_vint(self._test_binop_value, op)

    def _test_binop_value_pos_float(self, op):
        self._test_binop_rhs_pos_float(self._test_binop_value, op)

    def _test_binop_value_neg_float(self, op):
        self._test_binop_rhs_neg_float(self._test_binop_value, op)

    def _test_binop_value_zero_float(self, op):
        self._test_binop_rhs_zero_float(self._test_binop_value, op)

    def _test_binop_value_pos_vfloat(self, op):
        self._test_binop_rhs_pos_vfloat(self._test_binop_value, op)

    def _test_binop_value_neg_vfloat(self, op):
        self._test_binop_rhs_neg_vfloat(self._test_binop_value, op)

    def _test_binop_value_zero_vfloat(self, op):
        self._test_binop_rhs_zero_vfloat(self._test_binop_value, op)

    def _test_binop_value_complex(self, op):
        self._test_binop_rhs_complex(self._test_binop_value, op)

    def _test_binop_value_zero_complex(self, op):
        self._test_binop_rhs_zero_complex(self._test_binop_value, op)

    def _test_binop_lhs_addr_same_false(self, op):
        self._test_binop_rhs_false(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_true(self, op):
        self._test_binop_rhs_true(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_pos_int(self, op):
        self._test_binop_rhs_pos_int(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_neg_int(self, op):
        self._test_binop_rhs_neg_int(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_zero_int(self, op):
        self._test_binop_rhs_zero_int(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_pos_vint(self, op):
        self._test_binop_rhs_pos_vint(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_neg_vint(self, op):
        self._test_binop_rhs_neg_vint(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_zero_vint(self, op):
        self._test_binop_rhs_zero_vint(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_pos_float(self, op):
        self._test_binop_rhs_pos_float(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_neg_float(self, op):
        self._test_binop_rhs_neg_float(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_zero_float(self, op):
        self._test_binop_rhs_zero_float(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_pos_vfloat(self, op):
        self._test_binop_rhs_pos_vfloat(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_neg_vfloat(self, op):
        self._test_binop_rhs_neg_vfloat(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_zero_vfloat(self, op):
        self._test_binop_rhs_zero_vfloat(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_complex(self, op):
        self._test_binop_rhs_complex(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_addr_same_zero_complex(self, op):
        self._test_binop_rhs_zero_complex(self._test_binop_lhs_addr_same, op)

    def _test_binop_lhs_value_same_false(self, op):
        self._test_binop_rhs_false(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_true(self, op):
        self._test_binop_rhs_true(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_pos_int(self, op):
        self._test_binop_rhs_pos_int(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_neg_int(self, op):
        self._test_binop_rhs_neg_int(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_zero_int(self, op):
        self._test_binop_rhs_zero_int(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_pos_vint(self, op):
        self._test_binop_rhs_pos_vint(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_neg_vint(self, op):
        self._test_binop_rhs_neg_vint(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_zero_vint(self, op):
        self._test_binop_rhs_zero_vint(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_pos_float(self, op):
        self._test_binop_rhs_pos_float(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_neg_float(self, op):
        self._test_binop_rhs_neg_float(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_zero_float(self, op):
        self._test_binop_rhs_zero_float(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_pos_vfloat(self, op):
        self._test_binop_rhs_pos_vfloat(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_neg_vfloat(self, op):
        self._test_binop_rhs_neg_vfloat(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_zero_vfloat(self, op):
        self._test_binop_rhs_zero_vfloat(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_complex(self, op):
        self._test_binop_rhs_complex(self._test_binop_lhs_value_same, op)

    def _test_binop_lhs_value_same_zero_complex(self, op):
        self._test_binop_rhs_zero_complex(self._test_binop_lhs_value_same, op)

    def test_bool_op(self):
        self.assertEqual(bool(self._def), bool(self._def_value))

    def test_int_op(self):
        self.assertEqual(int(self._def), int(self._def_value))

    def test_float_op(self):
        self.assertEqual(float(self._def), float(self._def_value))

    def test_complex_op(self):
        self.assertEqual(complex(self._def), complex(self._def_value))

    def test_str_op(self):
        self.assertEqual(str(self._def), str(self._def_value))

    def test_eq_none(self):
        # Ignore this lint error:
        #   E711 comparison to None should be 'if cond is None:'
        # since this is what we want to test (even though not good practice).
        self.assertFalse(self._def == None)  # noqa: E711

    def test_ne_none(self):
        # Ignore this lint error:
        #   E711 comparison to None should be 'if cond is not None:'
        # since this is what we want to test (even though not good practice).
        self.assertTrue(self._def != None)  # noqa: E711


# This is a list of binary operators used for
# _inject_numeric_testing_methods().
#
# Each entry is a pair of binary operator name (used as part of the
# created testing method's name) and operator function.
_BINOPS = (
    ('lt', operator.lt),
    ('le', operator.le),
    ('eq', operator.eq),
    ('ne', operator.ne),
    ('ge', operator.ge),
    ('gt', operator.gt),
    ('add', operator.add),
    ('radd', lambda a, b: operator.add(b, a)),
    ('and', operator.and_),
    ('rand', lambda a, b: operator.and_(b, a)),
    ('floordiv', operator.floordiv),
    ('rfloordiv', lambda a, b: operator.floordiv(b, a)),
    ('lshift', operator.lshift),
    ('rlshift', lambda a, b: operator.lshift(b, a)),
    ('mod', operator.mod),
    ('rmod', lambda a, b: operator.mod(b, a)),
    ('mul', operator.mul),
    ('rmul', lambda a, b: operator.mul(b, a)),
    ('or', operator.or_),
    ('ror', lambda a, b: operator.or_(b, a)),
    ('pow', operator.pow),
    ('rpow', lambda a, b: operator.pow(b, a)),
    ('rshift', operator.rshift),
    ('rrshift', lambda a, b: operator.rshift(b, a)),
    ('sub', operator.sub),
    ('rsub', lambda a, b: operator.sub(b, a)),
    ('truediv', operator.truediv),
    ('rtruediv', lambda a, b: operator.truediv(b, a)),
    ('xor', operator.xor),
    ('rxor', lambda a, b: operator.xor(b, a)),
)


# This is a list of unary operators used for
# _inject_numeric_testing_methods().
#
# Each entry is a pair of unary operator name (used as part of the
# created testing method's name) and operator function.
_UNARYOPS = (
    ('neg', operator.neg),
    ('pos', operator.pos),
    ('abs', operator.abs),
    ('invert', operator.invert),
    ('round', round),
    ('round_0', partial(round, ndigits=0)),
    ('round_1', partial(round, ndigits=1)),
    ('round_2', partial(round, ndigits=2)),
    ('round_3', partial(round, ndigits=3)),
    ('ceil', math.ceil),
    ('floor', math.floor),
    ('trunc', math.trunc),
)


# This function injects a bunch of testing methods to a numeric
# field test case.
#
# It is meant to be used like this:
#
#     _inject_numeric_testing_methods(MyNumericFieldTestCase)
#
# This function injects:
#
# * One testing method for each _TestNumericField._test_binop_*()
#   method, for each binary operator in the _BINOPS tuple.
#
# * One testing method for each _TestNumericField._test_unaryop*()
#   method, for each unary operator in the _UNARYOPS tuple.
def _inject_numeric_testing_methods(cls):
    def test_binop_name(suffix):
        return 'test_binop_{}_{}'.format(name, suffix)

    def test_unaryop_name(suffix):
        return 'test_unaryop_{}_{}'.format(name, suffix)

    # inject testing methods for each binary operation
    for name, binop in _BINOPS:
        setattr(
            cls,
            test_binop_name('invalid_unknown'),
            partialmethod(_TestNumericField._test_binop_invalid_unknown, op=binop),
        )
        setattr(
            cls,
            test_binop_name('invalid_none'),
            partialmethod(_TestNumericField._test_binop_invalid_none, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_true'),
            partialmethod(_TestNumericField._test_binop_type_true, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_pos_int'),
            partialmethod(_TestNumericField._test_binop_type_pos_int, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_pos_vint'),
            partialmethod(_TestNumericField._test_binop_type_pos_vint, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_true'),
            partialmethod(_TestNumericField._test_binop_value_true, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_pos_int'),
            partialmethod(_TestNumericField._test_binop_value_pos_int, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_pos_vint'),
            partialmethod(_TestNumericField._test_binop_value_pos_vint, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_true'),
            partialmethod(_TestNumericField._test_binop_lhs_addr_same_true, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_pos_int'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_pos_int, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_pos_vint'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_pos_vint, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_true'),
            partialmethod(_TestNumericField._test_binop_lhs_value_same_true, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_pos_int'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_pos_int, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_pos_vint'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_pos_vint, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('type_neg_int'),
            partialmethod(_TestNumericField._test_binop_type_neg_int, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_neg_vint'),
            partialmethod(_TestNumericField._test_binop_type_neg_vint, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_neg_int'),
            partialmethod(_TestNumericField._test_binop_value_neg_int, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_neg_vint'),
            partialmethod(_TestNumericField._test_binop_value_neg_vint, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_neg_int'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_neg_int, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_neg_vint'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_neg_vint, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_neg_int'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_neg_int, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_neg_vint'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_neg_vint, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('type_false'),
            partialmethod(_TestNumericField._test_binop_type_false, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_zero_int'),
            partialmethod(_TestNumericField._test_binop_type_zero_int, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_zero_vint'),
            partialmethod(_TestNumericField._test_binop_type_zero_vint, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_false'),
            partialmethod(_TestNumericField._test_binop_value_false, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_zero_int'),
            partialmethod(_TestNumericField._test_binop_value_zero_int, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_zero_vint'),
            partialmethod(_TestNumericField._test_binop_value_zero_vint, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_false'),
            partialmethod(_TestNumericField._test_binop_lhs_addr_same_false, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_zero_int'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_zero_int, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_zero_vint'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_zero_vint, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_false'),
            partialmethod(_TestNumericField._test_binop_lhs_value_same_false, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_zero_int'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_zero_int, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_zero_vint'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_zero_vint, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('type_pos_float'),
            partialmethod(_TestNumericField._test_binop_type_pos_float, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_neg_float'),
            partialmethod(_TestNumericField._test_binop_type_neg_float, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_pos_vfloat'),
            partialmethod(_TestNumericField._test_binop_type_pos_vfloat, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_neg_vfloat'),
            partialmethod(_TestNumericField._test_binop_type_neg_vfloat, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_pos_float'),
            partialmethod(_TestNumericField._test_binop_value_pos_float, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_neg_float'),
            partialmethod(_TestNumericField._test_binop_value_neg_float, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_pos_vfloat'),
            partialmethod(_TestNumericField._test_binop_value_pos_vfloat, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_neg_vfloat'),
            partialmethod(_TestNumericField._test_binop_value_neg_vfloat, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_pos_float'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_pos_float, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_neg_float'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_neg_float, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_pos_vfloat'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_pos_vfloat, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_neg_vfloat'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_neg_vfloat, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_pos_float'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_pos_float, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_neg_float'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_neg_float, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_pos_vfloat'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_pos_vfloat, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_neg_vfloat'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_neg_vfloat, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('type_zero_float'),
            partialmethod(_TestNumericField._test_binop_type_zero_float, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_zero_vfloat'),
            partialmethod(_TestNumericField._test_binop_type_zero_vfloat, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_zero_float'),
            partialmethod(_TestNumericField._test_binop_value_zero_float, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_zero_vfloat'),
            partialmethod(_TestNumericField._test_binop_value_zero_vfloat, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_zero_float'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_zero_float, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_zero_vfloat'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_zero_vfloat, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_zero_float'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_zero_float, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_zero_vfloat'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_zero_vfloat, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('type_complex'),
            partialmethod(_TestNumericField._test_binop_type_complex, op=binop),
        )
        setattr(
            cls,
            test_binop_name('type_zero_complex'),
            partialmethod(_TestNumericField._test_binop_type_zero_complex, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_complex'),
            partialmethod(_TestNumericField._test_binop_value_complex, op=binop),
        )
        setattr(
            cls,
            test_binop_name('value_zero_complex'),
            partialmethod(_TestNumericField._test_binop_value_zero_complex, op=binop),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_complex'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_complex, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_addr_same_zero_complex'),
            partialmethod(
                _TestNumericField._test_binop_lhs_addr_same_zero_complex, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_complex'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_complex, op=binop
            ),
        )
        setattr(
            cls,
            test_binop_name('lhs_value_same_zero_complex'),
            partialmethod(
                _TestNumericField._test_binop_lhs_value_same_zero_complex, op=binop
            ),
        )

    # inject testing methods for each unary operation
    for name, unaryop in _UNARYOPS:
        setattr(
            cls,
            test_unaryop_name('type'),
            partialmethod(_TestNumericField._test_unaryop_type, op=unaryop),
        )
        setattr(
            cls,
            test_unaryop_name('value'),
            partialmethod(_TestNumericField._test_unaryop_value, op=unaryop),
        )
        setattr(
            cls,
            test_unaryop_name('addr_same'),
            partialmethod(_TestNumericField._test_unaryop_addr_same, op=unaryop),
        )
        setattr(
            cls,
            test_unaryop_name('value_same'),
            partialmethod(_TestNumericField._test_unaryop_value_same, op=unaryop),
        )


class BoolFieldTestCase(_TestNumericField, unittest.TestCase):
    @staticmethod
    def _const_value_setter(field):
        field.value = True

    def _create_fc(self, tc):
        return tc.create_bool_field_class()

    def setUp(self):
        self._tc = get_default_trace_class()
        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._tc, self._tc.create_bool_field_class(), self._const_value_setter
        )
        self._def_new_value = False

    def test_classes(self):
        self.assertIs(type(self._def), bt2._BoolField)
        self.assertIs(type(self._def_const), bt2._BoolFieldConst)

    def test_assign_true(self):
        raw = True
        self._def.value = raw
        self.assertEqual(self._def, raw)

    def test_assign_false(self):
        raw = False
        self._def.value = raw
        self.assertEqual(self._def, raw)

    def test_assign_field_true(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        raw = True
        field.value = raw
        self._def.value = field
        self.assertEqual(self._def, raw)

    def test_assign_field_false(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        raw = False
        field.value = raw
        self._def.value = field
        self.assertEqual(self._def, raw)

    def test_assign_invalid_type(self):
        with self.assertRaises(TypeError):
            self._def.value = 17

    def test_str_op(self):
        self.assertEqual(str(self._def), str(self._def_value))


_inject_numeric_testing_methods(BoolFieldTestCase)


class _TestIntegerFieldCommon(_TestNumericField):
    def test_assign_true(self):
        raw = True
        self._def.value = raw
        self.assertEqual(self._def, raw)

    def test_assign_false(self):
        raw = False
        self._def.value = raw
        self.assertEqual(self._def, raw)

    def test_assign_pos_int(self):
        raw = 477
        self._def.value = raw
        self.assertEqual(self._def, raw)

    def test_assign_neg_int(self):
        raw = -13
        self._def.value = raw
        self.assertEqual(self._def, raw)

    def test_assign_int_field(self):
        raw = 999
        field = _create_field(self._tc, self._create_fc(self._tc))
        field.value = raw
        self._def.value = field
        self.assertEqual(self._def, raw)

    def test_assign_invalid_type(self):
        with self.assertRaises(TypeError):
            self._def.value = 'yes'

    def test_assign_uint(self):
        uint_fc = self._tc.create_unsigned_integer_field_class(32)
        field = _create_field(self._tc, uint_fc)
        raw = 1777
        field.value = 1777
        self.assertEqual(field, raw)

    def test_assign_big_uint(self):
        uint_fc = self._tc.create_unsigned_integer_field_class(64)
        field = _create_field(self._tc, uint_fc)
        # Larger than the IEEE 754 double-precision exact representation of
        # integers.
        raw = (2 ** 53) + 1
        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)
        field = _create_field(self._tc, uint_fc)

        with self.assertRaises(ValueError):
            field.value = -23

    def test_str_op(self):
        self.assertEqual(str(self._def), str(self._def_value))


_inject_numeric_testing_methods(_TestIntegerFieldCommon)


class SignedIntegerFieldTestCase(_TestIntegerFieldCommon, unittest.TestCase):
    def _create_fc(self, tc):
        return tc.create_signed_integer_field_class(25)

    def setUp(self):
        self._tc = get_default_trace_class()
        self._field = _create_field(self._tc, self._create_fc(self._tc))
        self._field.value = 17
        self._def = _create_field(self._tc, self._create_fc(self._tc))
        self._def.value = 17
        self._def_value = 17
        self._def_new_value = -101


class SignedEnumerationFieldTestCase(_TestIntegerFieldCommon, unittest.TestCase):
    def _create_fc(self, tc):
        fc = tc.create_signed_enumeration_field_class(32)
        fc.add_mapping('something', bt2.SignedIntegerRangeSet([(17, 17)]))
        fc.add_mapping('speaker', bt2.SignedIntegerRangeSet([(12, 16)]))
        fc.add_mapping('can', bt2.SignedIntegerRangeSet([(18, 2540)]))
        fc.add_mapping(
            'whole range', bt2.SignedIntegerRangeSet([(-(2 ** 31), (2 ** 31) - 1)])
        )
        fc.add_mapping('zip', bt2.SignedIntegerRangeSet([(-45, 1001)]))
        return fc

    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.value = 17
        self._def_value = 17
        self._def_new_value = -101

    def test_str_op(self):
        expected_string_found = False
        s = str(self._def)

        # Establish all permutations of the three expected matches since
        # the order in which mappings are enumerated is not explicitly part of
        # the API.
        for p in itertools.permutations(['whole range', 'something', 'zip']):
            candidate = '{} ({})'.format(self._def_value, ', '.join(p))
            if candidate == s:
                expected_string_found = True
                break

        self.assertTrue(expected_string_found)

    def test_labels(self):
        self._field.value = 17
        labels = sorted(self._field.labels)
        self.assertEqual(labels, ['something', 'whole range', 'zip'])


class RealFieldTestCase(_TestNumericField, unittest.TestCase):
    def _create_fc(self, tc):
        return tc.create_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.value = 52.7
        self._def_value = 52.7
        self._def_new_value = -17.164857

    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
        self.assertEqual(self._def, 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
        self.assertEqual(self._def, 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(self._def), str(self._def_value))


_inject_numeric_testing_methods(RealFieldTestCase)


class StringFieldTestCase(unittest.TestCase):
    @staticmethod
    def _const_value_setter(field):
        field.value = 'Hello, World!'

    def setUp(self):
        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._tc, self._tc.create_string_field_class(), self._const_value_setter
        )
        self._def.value = self._def_value
        self._def_new_value = 'Yes!'

    def test_assign_int(self):
        with self.assertRaises(TypeError):
            self._def.value = 283

    def test_assign_string_field(self):
        field = _create_string_field(self._tc)
        raw = 'zorg'
        field.value = raw
        self.assertEqual(field, raw)

    def test_eq(self):
        self.assertEqual(self._def, self._def_value)

    def test_const_eq(self):
        self.assertEqual(self._def_const, self._def_value)

    def test_not_eq(self):
        self.assertNotEqual(self._def, 23)

    def test_lt_vstring(self):
        s1 = _create_string_field(self._tc)
        s1.value = 'allo'
        s2 = _create_string_field(self._tc)
        s2.value = 'bateau'
        self.assertLess(s1, s2)

    def test_lt_string(self):
        s1 = _create_string_field(self._tc)
        s1.value = 'allo'
        self.assertLess(s1, 'bateau')

    def test_le_vstring(self):
        s1 = _create_string_field(self._tc)
        s1.value = 'allo'
        s2 = _create_string_field(self._tc)
        s2.value = 'bateau'
        self.assertLessEqual(s1, s2)

    def test_le_string(self):
        s1 = _create_string_field(self._tc)
        s1.value = 'allo'
        self.assertLessEqual(s1, 'bateau')

    def test_gt_vstring(self):
        s1 = _create_string_field(self._tc)
        s1.value = 'allo'
        s2 = _create_string_field(self._tc)
        s2.value = 'bateau'
        self.assertGreater(s2, s1)

    def test_gt_string(self):
        s1 = _create_string_field(self._tc)
        s1.value = 'allo'
        self.assertGreater('bateau', s1)

    def test_ge_vstring(self):
        s1 = _create_string_field(self._tc)
        s1.value = 'allo'
        s2 = _create_string_field(self._tc)
        s2.value = 'bateau'
        self.assertGreaterEqual(s2, s1)

    def test_ge_string(self):
        s1 = _create_string_field(self._tc)
        s1.value = 'allo'
        self.assertGreaterEqual('bateau', s1)

    def test_bool_op(self):
        self.assertEqual(bool(self._def), bool(self._def_value))

    def test_str_op(self):
        self.assertEqual(str(self._def), str(self._def_value))

    def test_len(self):
        self.assertEqual(len(self._def), len(self._def_value))

    def test_getitem(self):
        self.assertEqual(self._def[5], self._def_value[5])

    def test_const_getitem(self):
        self.assertEqual(self._def_const[5], self._def_value[5])

    def test_append_str(self):
        to_append = 'meow meow meow'
        self._def += to_append
        self._def_value += to_append
        self.assertEqual(self._def, self._def_value)

    def test_const_append_str(self):
        to_append = 'meow meow meow'
        with self.assertRaises(TypeError):
            self._def_const += to_append
        self.assertEqual(self._def_const, self._def_value)

    def test_append_string_field(self):
        field = _create_string_field(self._tc)
        to_append = 'meow meow meow'
        field.value = to_append
        self._def += field
        self._def_value += to_append
        self.assertEqual(self._def, self._def_value)


class _TestArrayFieldCommon:
    def _modify_def(self):
        self._def[2] = 23

    def test_bool_op_true(self):
        self.assertTrue(self._def)

    def test_len(self):
        self.assertEqual(len(self._def), 3)

    def test_length(self):
        self.assertEqual(self._def.length, 3)

    def test_getitem(self):
        field = self._def[1]
        self.assertIs(type(field), bt2._SignedIntegerField)
        self.assertEqual(field, 1847)

    def test_const_getitem(self):
        field = self._def_const[1]
        self.assertIs(type(field), bt2._SignedIntegerFieldConst)
        self.assertEqual(field, 1847)

    def test_eq(self):
        field = _create_int_array_field(self._tc, 3)
        field[0] = 45
        field[1] = 1847
        field[2] = 1948754
        self.assertEqual(self._def, field)

    def test_eq_invalid_type(self):
        self.assertNotEqual(self._def, 23)

    def test_eq_diff_len(self):
        field = _create_int_array_field(self._tc, 2)
        field[0] = 45
        field[1] = 1847
        self.assertNotEqual(self._def, field)

    def test_eq_diff_content_same_len(self):
        field = _create_int_array_field(self._tc, 3)
        field[0] = 45
        field[1] = 1846
        field[2] = 1948754
        self.assertNotEqual(self._def, field)

    def test_eq_non_sequence_iterable(self):
        dct = collections.OrderedDict([(1, 2), (3, 4), (5, 6)])
        field = _create_int_array_field(self._tc, 3)
        field[0] = 1
        field[1] = 3
        field[2] = 5
        self.assertEqual(field, list(dct.keys()))
        self.assertNotEqual(field, dct)

    def test_setitem(self):
        self._def[2] = 24
        self.assertEqual(self._def[2], 24)

    def test_setitem_int_field(self):
        int_fc = self._tc.create_signed_integer_field_class(32)
        int_field = _create_field(self._tc, int_fc)
        int_field.value = 19487
        self._def[1] = int_field
        self.assertEqual(self._def[1], 19487)

    def test_setitem_non_basic_field(self):
        array_field = _create_struct_array_field(self._tc, 2)
        with self.assertRaises(TypeError):
            array_field[1] = 23

    def test_setitem_none(self):
        with self.assertRaises(TypeError):
            self._def[1] = None

    def test_setitem_index_wrong_type(self):
        with self.assertRaises(TypeError):
            self._def['yes'] = 23

    def test_setitem_index_neg(self):
        with self.assertRaises(IndexError):
            self._def[-2] = 23

    def test_setitem_index_out_of_range(self):
        with self.assertRaises(IndexError):
            self._def[len(self._def)] = 134679

    def test_const_setitem(self):
        with self.assertRaises(TypeError):
            self._def_const[0] = 134679

    def test_iter(self):
        for field, value in zip(self._def, (45, 1847, 1948754)):
            self.assertEqual(field, value)

    def test_const_iter(self):
        for field, value in zip(self._def_const, (45, 1847, 1948754)):
            self.assertEqual(field, value)

    def test_value_int_field(self):
        values = [45646, 145, 12145]
        self._def.value = values
        self.assertEqual(values, self._def)

    def test_value_check_sequence(self):
        values = 42
        with self.assertRaises(TypeError):
            self._def.value = values

    def test_value_wrong_type_in_sequence(self):
        values = [32, 'hello', 11]
        with self.assertRaises(TypeError):
            self._def.value = values

    def test_value_complex_type(self):
        struct_fc = self._tc.create_structure_field_class()
        int_fc = self._tc.create_signed_integer_field_class(32)
        another_int_fc = self._tc.create_signed_integer_field_class(32)
        str_fc = self._tc.create_string_field_class()
        struct_fc.append_member(field_class=int_fc, name='an_int')
        struct_fc.append_member(field_class=str_fc, name='a_string')
        struct_fc.append_member(field_class=another_int_fc, name='another_int')
        array_fc = self._tc.create_static_array_field_class(struct_fc, 3)
        stream = _create_stream(self._tc, [('array_field', array_fc)])
        values = [
            {'an_int': 42, 'a_string': 'hello', 'another_int': 66},
            {'an_int': 1, 'a_string': 'goodbye', 'another_int': 488},
            {'an_int': 156, 'a_string': 'or not', 'another_int': 4648},
        ]

        array = stream.create_packet().context_field['array_field']
        array.value = values
        self.assertEqual(values, array)
        values[0]['an_int'] = 'a string'
        with self.assertRaises(TypeError):
            array.value = values

    def test_str_op(self):
        s = str(self._def)
        expected_string = '[{}]'.format(', '.join([repr(v) for v in self._def_value]))
        self.assertEqual(expected_string, s)


class StaticArrayFieldTestCase(_TestArrayFieldCommon, unittest.TestCase):
    @staticmethod
    def _const_value_setter(field):
        field.value = [45, 1847, 1948754]

    def setUp(self):
        self._tc = get_default_trace_class()
        self._def = _create_int_array_field(self._tc, 3)
        self._def[0] = 45
        self._def[1] = 1847
        self._def[2] = 1948754
        self._def_value = [45, 1847, 1948754]
        self._def_const = _create_const_field(
            self._tc,
            self._tc.create_static_array_field_class(
                self._tc.create_signed_integer_field_class(32), 3
            ),
            self._const_value_setter,
        )

    def test_value_wrong_len(self):
        values = [45, 1847]
        with self.assertRaises(ValueError):
            self._def.value = values


class DynamicArrayFieldTestCase(_TestArrayFieldCommon, unittest.TestCase):
    @staticmethod
    def _const_value_setter(field):
        field.value = [45, 1847, 1948754]

    def setUp(self):
        self._tc = get_default_trace_class()
        self._def = _create_dynamic_array(self._tc)
        self._def[0] = 45
        self._def[1] = 1847
        self._def[2] = 1948754
        self._def_value = [45, 1847, 1948754]
        self._def_const = _create_const_field(
            self._tc,
            self._tc.create_dynamic_array_field_class(
                self._tc.create_signed_integer_field_class(32)
            ),
            self._const_value_setter,
        )

    def test_value_resize(self):
        new_values = [1, 2, 3, 4]
        self._def.value = new_values
        self.assertCountEqual(self._def, new_values)

    def test_set_length(self):
        self._def.length = 4
        self._def[3] = 0
        self.assertEqual(len(self._def), 4)

    def test_const_set_length(self):
        with self.assertRaises(AttributeError):
            self._def_const.length = 4
        self.assertEqual(len(self._def), 3)

    def test_set_invalid_length(self):
        with self.assertRaises(TypeError):
            self._def.length = 'cheval'


class StructureFieldTestCase(unittest.TestCase):
    @staticmethod
    def _const_value_setter(field):
        field.value = {
            'A': -1872,
            'B': 'salut',
            'C': 17.5,
            'D': 16497,
            'E': {},
            'F': {'F_1': 52},
        }

    def _create_fc(self, tc):
        fc = tc.create_structure_field_class()
        fc.append_member('A', self._fc0_fn())
        fc.append_member('B', self._fc1_fn())
        fc.append_member('C', self._fc2_fn())
        fc.append_member('D', self._fc3_fn())
        fc.append_member('E', self._fc4_fn())
        fc5 = self._fc5_fn()
        fc5.append_member('F_1', self._fc5_inner_fn())
        fc.append_member('F', fc5)
        return fc

    def setUp(self):
        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._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
        self._fc5_inner_fn = self._tc.create_signed_integer_field_class

        self._fc = self._create_fc(self._tc)
        self._def = _create_field(self._tc, self._fc)
        self._def['A'] = -1872
        self._def['B'] = 'salut'
        self._def['C'] = 17.5
        self._def['D'] = 16497
        self._def['E'] = {}
        self._def['F'] = {'F_1': 52}
        self._def_value = {
            'A': -1872,
            'B': 'salut',
            'C': 17.5,
            'D': 16497,
            'E': {},
            'F': {'F_1': 52},
        }

        self._def_const = _create_const_field(
            self._tc, self._create_fc(self._tc), self._const_value_setter
        )

    def _modify_def(self):
        self._def['B'] = 'hola'

    def test_bool_op_true(self):
        self.assertTrue(self._def)

    def test_bool_op_false(self):
        field = self._def['E']
        self.assertFalse(field)

    def test_len(self):
        self.assertEqual(len(self._def), len(self._def_value))

    def test_getitem(self):
        field1 = self._def['A']
        field2 = self._def['B']
        field3 = self._def['C']
        field4 = self._def['D']
        field5 = self._def['E']
        field6 = self._def['F']

        self.assertIs(type(field1), bt2._SignedIntegerField)
        self.assertEqual(field1, -1872)

        self.assertIs(type(field2), bt2._StringField)
        self.assertEqual(field2, 'salut')

        self.assertIs(type(field3), bt2._RealField)
        self.assertEqual(field3, 17.5)

        self.assertIs(type(field4), bt2._SignedIntegerField)
        self.assertEqual(field4, 16497)

        self.assertIs(type(field5), bt2._StructureField)
        self.assertEqual(field5, {})

        self.assertIs(type(field6), bt2._StructureField)
        self.assertEqual(field6, {'F_1': 52})

    def test_const_getitem(self):
        field1 = self._def_const['A']
        field2 = self._def_const['B']
        field3 = self._def_const['C']
        field4 = self._def_const['D']
        field5 = self._def_const['E']
        field6 = self._def_const['F']

        self.assertIs(type(field1), bt2._SignedIntegerFieldConst)
        self.assertEqual(field1, -1872)

        self.assertIs(type(field2), bt2._StringFieldConst)
        self.assertEqual(field2, 'salut')

        self.assertIs(type(field3), bt2._RealFieldConst)
        self.assertEqual(field3, 17.5)

        self.assertIs(type(field4), bt2._SignedIntegerFieldConst)
        self.assertEqual(field4, 16497)

        self.assertIs(type(field5), bt2._StructureFieldConst)
        self.assertEqual(field5, {})

        self.assertIs(type(field6), bt2._StructureFieldConst)
        self.assertEqual(field6, {'F_1': 52})

    def test_member_at_index_out_of_bounds_after(self):
        with self.assertRaises(IndexError):
            self._def.member_at_index(len(self._def_value))

    def test_eq(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field['A'] = -1872
        field['B'] = 'salut'
        field['C'] = 17.5
        field['D'] = 16497
        field['E'] = {}
        field['F'] = {'F_1': 52}
        self.assertEqual(self._def, field)

    def test_const_eq(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field['A'] = -1872
        field['B'] = 'salut'
        field['C'] = 17.5
        field['D'] = 16497
        field['E'] = {}
        field['F'] = {'F_1': 52}
        self.assertEqual(self._def_const, field)

    def test_eq_invalid_type(self):
        self.assertNotEqual(self._def, 23)

    def test_eq_diff_len(self):
        fc = self._tc.create_structure_field_class()
        fc.append_member('A', self._fc0_fn())
        fc.append_member('B', self._fc1_fn())
        fc.append_member('C', self._fc2_fn())

        field = _create_field(self._tc, fc)
        field['A'] = -1872
        field['B'] = 'salut'
        field['C'] = 17.5
        self.assertNotEqual(self._def, field)

    def test_eq_diff_keys(self):
        fc = self._tc.create_structure_field_class()
        fc.append_member('U', self._fc0_fn())
        fc.append_member('V', self._fc1_fn())
        fc.append_member('W', self._fc2_fn())
        fc.append_member('X', self._fc3_fn())
        fc.append_member('Y', self._fc4_fn())
        fc.append_member('Z', self._fc5_fn())
        field = _create_field(self._tc, fc)
        field['U'] = -1871
        field['V'] = "gerry"
        field['W'] = 18.19
        field['X'] = 16497
        field['Y'] = {}
        field['Z'] = {}
        self.assertNotEqual(self._def, field)

    def test_eq_diff_content_same_len(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field['A'] = -1872
        field['B'] = 'salut'
        field['C'] = 17.4
        field['D'] = 16497
        field['E'] = {}
        field['F'] = {'F_1': 0}
        self.assertNotEqual(self._def, field)

    def test_eq_same_content_diff_keys(self):
        fc = self._tc.create_structure_field_class()
        fc.append_member('A', self._fc0_fn())
        fc.append_member('B', self._fc1_fn())
        fc.append_member('E', self._fc2_fn())
        fc.append_member('D', self._fc3_fn())
        fc.append_member('C', self._fc4_fn())
        fc.append_member('F', self._fc5_fn())
        field = _create_field(self._tc, fc)
        field['A'] = -1872
        field['B'] = 'salut'
        field['E'] = 17.5
        field['D'] = 16497
        field['C'] = {}
        field['F'] = {}
        self.assertNotEqual(self._def, field)

    def test_setitem(self):
        self._def['C'] = -18.47
        self.assertEqual(self._def['C'], -18.47)

    def test_const_setitem(self):
        with self.assertRaises(TypeError):
            self._def_const['A'] = 134679

    def test_setitem_int_field(self):
        int_fc = self._tc.create_signed_integer_field_class(32)
        int_field = _create_field(self._tc, int_fc)
        int_field.value = 19487
        self._def['D'] = int_field
        self.assertEqual(self._def['D'], 19487)

    def test_setitem_non_basic_field(self):
        elem_fc = self._tc.create_structure_field_class()
        struct_fc = self._tc.create_structure_field_class()
        struct_fc.append_member('A', elem_fc)
        struct_field = _create_field(self._tc, struct_fc)

        # Will fail on access to .items() of the value
        with self.assertRaises(AttributeError):
            struct_field['A'] = 23

    def test_setitem_none(self):
        with self.assertRaises(TypeError):
            self._def['C'] = None

    def test_setitem_key_wrong_type(self):
        with self.assertRaises(TypeError):
            self._def[3] = 23

    def test_setitem_wrong_key(self):
        with self.assertRaises(KeyError):
            self._def['hi'] = 134679

    def test_member_at_index(self):
        self.assertEqual(self._def.member_at_index(1), 'salut')

    def test_const_member_at_index(self):
        self.assertEqual(self._def_const.member_at_index(1), 'salut')

    def test_iter(self):
        orig_values = {
            'A': -1872,
            'B': 'salut',
            'C': 17.5,
            'D': 16497,
            'E': {},
            'F': {'F_1': 52},
        }

        for vkey, vval in self._def.items():
            val = orig_values[vkey]
            self.assertEqual(vval, val)

    def test_value(self):
        orig_values = {
            'A': -1872,
            'B': 'salut',
            'C': 17.5,
            'D': 16497,
            'E': {},
            'F': {'F_1': 52},
        }
        self.assertEqual(self._def, orig_values)

    def test_set_value(self):
        int_fc = self._tc.create_signed_integer_field_class(32)
        another_int_fc = self._tc.create_signed_integer_field_class(32)
        str_fc = self._tc.create_string_field_class()
        struct_fc = self._tc.create_structure_field_class()
        struct_fc.append_member(field_class=int_fc, name='an_int')
        struct_fc.append_member(field_class=str_fc, name='a_string')
        struct_fc.append_member(field_class=another_int_fc, name='another_int')
        values = {'an_int': 42, 'a_string': 'hello', 'another_int': 66}

        struct = _create_field(self._tc, struct_fc)
        struct.value = values
        self.assertEqual(values, struct)

        bad_type_values = copy.deepcopy(values)
        bad_type_values['an_int'] = 'a string'
        with self.assertRaises(TypeError):
            struct.value = bad_type_values

        unknown_key_values = copy.deepcopy(values)
        unknown_key_values['unknown_key'] = 16546
        with self.assertRaises(KeyError):
            struct.value = unknown_key_values

    def test_str_op(self):
        expected_string_found = False
        s = str(self._def)
        # Establish all permutations of the three expected matches since
        # the order in which mappings are enumerated is not explicitly part of
        # the API.
        for p in itertools.permutations([(k, v) for k, v in self._def.items()]):
            items = ['{}: {}'.format(repr(k), repr(v)) for k, v in p]
            candidate = '{{{}}}'.format(', '.join(items))
            if candidate == s:
                expected_string_found = True
                break

        self.assertTrue(expected_string_found)


class OptionFieldTestCase(unittest.TestCase):
    @staticmethod
    def _const_value_setter(field):
        field.value = {'opt_field': 'hiboux'}

    def _create_fc(self, tc):
        fc = tc.create_option_field_class(tc.create_string_field_class())
        top_fc = tc.create_structure_field_class()
        top_fc.append_member('opt_field', fc)
        return top_fc

    def setUp(self):
        self._tc = get_default_trace_class()
        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._tc, self._create_fc(self._tc), self._const_value_setter
        )['opt_field']

    def test_value_prop(self):
        self._def.value = 'hiboux'
        self.assertEqual(self._def.field, 'hiboux')
        self.assertIs(type(self._def), bt2._OptionField)
        self.assertIs(type(self._def.field), bt2._StringField)
        self.assertTrue(self._def.has_field)

    def test_const_value_prop(self):
        self.assertEqual(self._def_const.field, 'hiboux')
        self.assertIs(type(self._def_const), bt2._OptionFieldConst)
        self.assertIs(type(self._def_const.field), bt2._StringFieldConst)
        self.assertTrue(self._def_const.has_field)

    def test_has_field_prop_true(self):
        self._def.has_field = True
        self.assertTrue(self._def.has_field)

    def test_has_field_prop_true(self):
        self._def.has_field = False
        self.assertFalse(self._def.has_field)

    def test_bool_op_true(self):
        self._def.value = 'allo'
        self.assertTrue(self._def)

    def test_bool_op_true(self):
        self._def.has_field = False
        self.assertFalse(self._def)

    def test_field_prop_existing(self):
        self._def.value = 'meow'
        field = self._def.field
        self.assertEqual(field, 'meow')

    def test_field_prop_none(self):
        self._def.has_field = False
        field = self._def.field
        self.assertIsNone(field)

    def test_const_field_prop(self):
        with self.assertRaises(AttributeError):
            self._def_const.has_field = False

        self.assertEqual(self._def_const, self._def_value)
        self.assertTrue(self._def_const.has_field)

    def test_field_prop_existing_then_none(self):
        self._def.value = 'meow'
        field = self._def.field
        self.assertEqual(field, 'meow')
        self._def.has_field = False
        field = self._def.field
        self.assertIsNone(field)

    def test_eq(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field = field['opt_field']
        field.value = 'walk'
        self._def.value = 'walk'
        self.assertEqual(self._def, field)

    def test_const_eq(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field = field['opt_field']
        field.value = 'hiboux'
        self.assertEqual(self._def_const, field)
        self.assertEqual(self._def_const, self._def_value)

    def test_eq_invalid_type(self):
        self._def.value = 'gerry'
        self.assertNotEqual(self._def, 23)

    def test_str_op(self):
        self._def.value = 'marcel'
        self.assertEqual(str(self._def), str(self._def.field))

    def test_repr_op(self):
        self._def.value = 'mireille'
        self.assertEqual(repr(self._def), repr(self._def.field))


class VariantFieldTestCase(unittest.TestCase):
    @staticmethod
    def _const_value_setter(field):
        field.selected_option_index = 3
        field.value = 1334

    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()
        ft3 = tc.create_signed_integer_field_class(17)
        fc = tc.create_variant_field_class()
        fc.append_option('corner', ft0)
        fc.append_option('zoom', ft1)
        fc.append_option('mellotron', ft2)
        fc.append_option('giorgio', ft3)
        top_fc = tc.create_structure_field_class()
        top_fc.append_member('variant_field', fc)
        return top_fc

    def setUp(self):
        self._tc = get_default_trace_class()
        fld = _create_field(self._tc, self._create_fc(self._tc))
        self._def = fld['variant_field']

        self._def_value = 1334
        self._def_selected_index = 3
        const_fc = self._create_fc(self._tc)['variant_field']

        fld_const = _create_const_field(
            self._tc, const_fc.field_class, self._const_value_setter
        )
        self._def_const = fld_const

    def test_bool_op(self):
        self._def.selected_option_index = 2
        self._def.value = -17.34
        with self.assertRaises(NotImplementedError):
            bool(self._def)

    def test_selected_option_index(self):
        self._def.selected_option_index = 2
        self.assertEqual(self._def.selected_option_index, 2)

    def test_selected_option_index_above_range(self):
        with self.assertRaises(IndexError):
            self._def.selected_option_index = 4

    def test_selected_option_index_below_range(self):
        with self.assertRaises(IndexError):
            self._def.selected_option_index = -1

    def test_const_selected_option_index(self):
        with self.assertRaises(AttributeError):
            self._def_const.selected_option_index = 2
        self.assertEqual(self._def_const.selected_option_index, 3)

    def test_selected_option(self):
        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._def.selected_option_index = 3
        self._def.value = 1921
        self.assertEqual(self._def.selected_option, 1921)
        self.assertEqual(type(self._def.selected_option), bt2._SignedIntegerField)

    def test_const_selected_option(self):
        self.assertEqual(self._def_const.selected_option, 1334)
        self.assertEqual(
            type(self._def_const.selected_option), bt2._SignedIntegerFieldConst
        )

    def test_eq(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field = field['variant_field']
        field.selected_option_index = 0
        field.value = 1774
        self._def.selected_option_index = 0
        self._def.value = 1774
        self.assertEqual(self._def, field)

    def test_const_eq(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field = field['variant_field']
        field.selected_option_index = 3
        field.value = 1334
        self.assertEqual(self._def_const, field)

    def test_len(self):
        self.assertEqual(len(self._def), 4)

    def test_eq_invalid_type(self):
        self._def.selected_option_index = 1
        self._def.value = 'gerry'
        self.assertNotEqual(self._def, 23)

    def test_str_op_int(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field = field['variant_field']
        field.selected_option_index = 0
        field.value = 1774
        other_field = _create_field(self._tc, self._create_fc(self._tc))
        other_field = other_field['variant_field']
        other_field.selected_option_index = 0
        other_field.value = 1774
        self.assertEqual(str(field), str(other_field))

    def test_str_op_str(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field = field['variant_field']
        field.selected_option_index = 1
        field.value = 'un beau grand bateau'
        other_field = _create_field(self._tc, self._create_fc(self._tc))
        other_field = other_field['variant_field']
        other_field.selected_option_index = 1
        other_field.value = 'un beau grand bateau'
        self.assertEqual(str(field), str(other_field))

    def test_str_op_float(self):
        field = _create_field(self._tc, self._create_fc(self._tc))
        field = field['variant_field']
        field.selected_option_index = 2
        field.value = 14.4245
        other_field = _create_field(self._tc, self._create_fc(self._tc))
        other_field = other_field['variant_field']
        other_field.selected_option_index = 2
        other_field.value = 14.4245
        self.assertEqual(str(field), str(other_field))