[babeltrace.git] / tests / bindings / python / bt2 / test_event.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 collections import OrderedDict
import unittest
import bt2


class EventTestCase(unittest.TestCase):
    def _create_test_event_message(self, packet_fields_config=None,
                                   event_fields_config=None,
                                   with_clockclass=False,
                                   with_cc=False, with_sc=False,
                                   with_ep=False, with_packet=False):

        class MyIter(bt2._UserMessageIterator):
            def __init__(self, self_output_port):
                self._at = 0
                self._msgs = [
                    self._create_stream_beginning_message(test_obj.stream),
                ]

                if with_packet:
                    assert test_obj.packet
                    self._msgs.append(self._create_packet_beginning_message(test_obj.packet))

                default_clock_snapshot = 789 if with_clockclass else None

                if with_packet:
                    assert test_obj.packet
                    ev_parent = test_obj.packet
                else:
                    assert test_obj.stream
                    ev_parent = test_obj.stream

                msg = self._create_event_message(test_obj.event_class, ev_parent, default_clock_snapshot)

                if event_fields_config is not None:
                    event_fields_config(msg.event)

                self._msgs.append(msg)

                if with_packet:
                    self._msgs.append(self._create_packet_end_message(test_obj.packet))

                self._msgs.append(self._create_stream_end_message(test_obj.stream))

            def __next__(self):
                if self._at == len(self._msgs):
                    raise bt2.Stop

                msg = self._msgs[self._at]
                self._at += 1
                return msg

        class MySrc(bt2._UserSourceComponent, message_iterator_class=MyIter):
            def __init__(self, params):
                self._add_output_port('out')
                tc = self._create_trace_class()

                clock_class = None
                if with_clockclass:
                    clock_class = self._create_clock_class(frequency=1000)

                # event common context (stream-class-defined)
                cc = None
                if with_cc:
                    cc = tc.create_structure_field_class()
                    cc += OrderedDict((
                        ('cpu_id', tc.create_signed_integer_field_class(8)),
                        ('stuff', tc.create_real_field_class()),
                    ))

                # packet context (stream-class-defined)
                pc = None

                if with_packet:
                    pc = tc.create_structure_field_class()
                    pc += OrderedDict((
                        ('something', tc.create_unsigned_integer_field_class(8)),
                        ('something_else', tc.create_real_field_class()),
                    ))

                stream_class = tc.create_stream_class(default_clock_class=clock_class,
                                                      event_common_context_field_class=cc,
                                                      packet_context_field_class=pc,
                                                      supports_packets=with_packet)

                # specific context (event-class-defined)
                sc = None
                if with_sc:
                    sc = tc.create_structure_field_class()
                    sc += OrderedDict((
                        ('ant', tc.create_signed_integer_field_class(16)),
                        ('msg', tc.create_string_field_class()),
                    ))

                # event payload
                ep = None
                if with_ep:
                    ep = tc.create_structure_field_class()
                    ep += OrderedDict((
                        ('giraffe', tc.create_signed_integer_field_class(32)),
                        ('gnu', tc.create_signed_integer_field_class(8)),
                        ('mosquito', tc.create_signed_integer_field_class(8)),
                    ))

                event_class = stream_class.create_event_class(name='garou',
                                                              specific_context_field_class=sc,
                                                              payload_field_class=ep)

                trace = tc()
                stream = trace.create_stream(stream_class)

                if with_packet:
                    packet = stream.create_packet()

                if packet_fields_config is not None:
                    assert packet
                    packet_fields_config(packet)

                if with_packet:
                    test_obj.packet = packet

                test_obj.stream = stream
                test_obj.event_class = event_class

        test_obj = self
        self._graph = bt2.Graph()
        self._src_comp = self._graph.add_component(MySrc, 'my_source')
        self._msg_iter = self._graph.create_output_port_message_iterator(self._src_comp.output_ports['out'])

        for msg in self._msg_iter:
            if type(msg) is bt2._EventMessage:
                return msg

    def test_attr_event_class(self):
        msg = self._create_test_event_message()
        self.assertEqual(msg.event.cls.addr, self.event_class.addr)

    def test_attr_name(self):
        msg = self._create_test_event_message()
        self.assertEqual(msg.event.name, self.event_class.name)

    def test_attr_id(self):
        msg = self._create_test_event_message()
        self.assertEqual(msg.event.id, self.event_class.id)

    def test_get_common_context_field(self):
        def event_fields_config(event):
            event.common_context_field['cpu_id'] = 1
            event.common_context_field['stuff'] = 13.194

        msg = self._create_test_event_message(event_fields_config=event_fields_config, with_cc=True)

        self.assertEqual(msg.event.common_context_field['cpu_id'], 1)
        self.assertEqual(msg.event.common_context_field['stuff'], 13.194)

    def test_no_common_context_field(self):
        msg = self._create_test_event_message(with_cc=False)
        self.assertIsNone(msg.event.common_context_field)

    def test_get_specific_context_field(self):
        def event_fields_config(event):
            event.specific_context_field['ant'] = -1
            event.specific_context_field['msg'] = 'hellooo'

        msg = self._create_test_event_message(event_fields_config=event_fields_config, with_sc=True)

        self.assertEqual(msg.event.specific_context_field['ant'], -1)
        self.assertEqual(msg.event.specific_context_field['msg'], 'hellooo')

    def test_no_specific_context_field(self):
        msg = self._create_test_event_message(with_sc=False)
        self.assertIsNone(msg.event.specific_context_field)

    def test_get_event_payload_field(self):
        def event_fields_config(event):
            event.payload_field['giraffe'] = 1
            event.payload_field['gnu'] = 23
            event.payload_field['mosquito'] = 42

        msg = self._create_test_event_message(event_fields_config=event_fields_config, with_ep=True)

        self.assertEqual(msg.event.payload_field['giraffe'], 1)
        self.assertEqual(msg.event.payload_field['gnu'], 23)
        self.assertEqual(msg.event.payload_field['mosquito'], 42)

    def test_no_payload_field(self):
        msg = self._create_test_event_message(with_ep=False)
        self.assertIsNone(msg.event.payload_field)

    def test_clock_value(self):
        msg = self._create_test_event_message(with_clockclass=True)
        self.assertEqual(msg.default_clock_snapshot.value, 789)

    def test_no_clock_value(self):
        msg = self._create_test_event_message(with_clockclass=False)
        with self.assertRaises(bt2.NonexistentClockSnapshot):
            msg.default_clock_snapshot

    def test_stream(self):
        msg = self._create_test_event_message()
        self.assertEqual(msg.event.stream.addr, self.stream.addr)

    def test_getitem(self):
        def event_fields_config(event):
            event.payload_field['giraffe'] = 1
            event.payload_field['gnu'] = 23
            event.payload_field['mosquito'] = 42
            event.specific_context_field['ant'] = -1
            event.specific_context_field['msg'] = 'hellooo'
            event.common_context_field['cpu_id'] = 1
            event.common_context_field['stuff'] = 13.194

        def packet_fields_config(packet):
            packet.context_field['something'] = 154
            packet.context_field['something_else'] = 17.2

        msg = self._create_test_event_message(packet_fields_config=packet_fields_config,
                                              event_fields_config=event_fields_config,
                                              with_cc=True, with_sc=True, with_ep=True,
                                              with_packet=True)
        ev = msg.event

        # Test event fields
        self.assertEqual(ev['giraffe'], 1)
        self.assertEqual(ev['gnu'], 23)
        self.assertEqual(ev['mosquito'], 42)
        self.assertEqual(ev['ant'], -1)
        self.assertEqual(ev['msg'], 'hellooo')
        self.assertEqual(ev['cpu_id'], 1)
        self.assertEqual(ev['stuff'], 13.194)

        # Test packet fields
        self.assertEqual(ev['something'], 154)
        self.assertEqual(ev['something_else'], 17.2)

        with self.assertRaises(KeyError):
            ev['yes']


if __name__ == "__main__":
    unittest.main()
Commit	Line	Data
d2d857a8 MJ	1	#
	2	# Copyright (C) 2019 EfficiOS Inc.
	3	#
	4	# This program is free software; you can redistribute it and/or
	5	# modify it under the terms of the GNU General Public License
	6	# as published by the Free Software Foundation; only version 2
	7	# of the License.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU General Public License
	15	# along with this program; if not, write to the Free Software
	16	# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	#
	18
9cf643d1	19	from collections import OrderedDict
9cf643d1	20	import unittest
9cf643d1 PP	21	import bt2
	22
	23
	24	class EventTestCase(unittest.TestCase):
2ae9f48c SM	25	def _create_test_event_message(self, packet_fields_config=None,
	26	event_fields_config=None,
	27	with_clockclass=False,
	28	with_cc=False, with_sc=False,
26fc5aed	29	with_ep=False, with_packet=False):
2ae9f48c SM	30
2ae9f48c SM	31	class MyIter(bt2._UserMessageIterator):
c5f330cd	32	def __init__(self, self_output_port):
2ae9f48c	33	self._at = 0
26fc5aed PP	34	self._msgs = [
	35	self._create_stream_beginning_message(test_obj.stream),
	36	]
2ae9f48c	37
26fc5aed	38	if with_packet:
2ae9f48c	39	assert test_obj.packet
26fc5aed PP	40	self._msgs.append(self._create_packet_beginning_message(test_obj.packet))
	41
	42	default_clock_snapshot = 789 if with_clockclass else None
	43
	44	if with_packet:
2ae9f48c	45	assert test_obj.packet
26fc5aed PP	46	ev_parent = test_obj.packet
	47	else:
	48	assert test_obj.stream
	49	ev_parent = test_obj.stream
	50
	51	msg = self._create_event_message(test_obj.event_class, ev_parent, default_clock_snapshot)
	52
	53	if event_fields_config is not None:
	54	event_fields_config(msg.event)
	55
	56	self._msgs.append(msg)
	57
	58	if with_packet:
	59	self._msgs.append(self._create_packet_end_message(test_obj.packet))
	60
	61	self._msgs.append(self._create_stream_end_message(test_obj.stream))
	62
	63	def __next__(self):
	64	if self._at == len(self._msgs):
2ae9f48c SM	65	raise bt2.Stop
2ae9f48c SM	66
26fc5aed	67	msg = self._msgs[self._at]
2ae9f48c SM	68	self._at += 1
	69	return msg
	70
	71	class MySrc(bt2._UserSourceComponent, message_iterator_class=MyIter):
	72	def __init__(self, params):
	73	self._add_output_port('out')
	74	tc = self._create_trace_class()
	75
	76	clock_class = None
	77	if with_clockclass:
	78	clock_class = self._create_clock_class(frequency=1000)
	79
	80	# event common context (stream-class-defined)
	81	cc = None
	82	if with_cc:
	83	cc = tc.create_structure_field_class()
	84	cc += OrderedDict((
	85	('cpu_id', tc.create_signed_integer_field_class(8)),
	86	('stuff', tc.create_real_field_class()),
	87	))
	88
	89	# packet context (stream-class-defined)
26fc5aed PP	90	pc = None
	91
	92	if with_packet:
	93	pc = tc.create_structure_field_class()
	94	pc += OrderedDict((
	95	('something', tc.create_unsigned_integer_field_class(8)),
	96	('something_else', tc.create_real_field_class()),
	97	))
2ae9f48c SM	98
	99	stream_class = tc.create_stream_class(default_clock_class=clock_class,
	100	event_common_context_field_class=cc,
26fc5aed PP	101	packet_context_field_class=pc,
26fc5aed PP	102	supports_packets=with_packet)
2ae9f48c SM	103
	104	# specific context (event-class-defined)
	105	sc = None
	106	if with_sc:
	107	sc = tc.create_structure_field_class()
	108	sc += OrderedDict((
	109	('ant', tc.create_signed_integer_field_class(16)),
	110	('msg', tc.create_string_field_class()),
	111	))
	112
	113	# event payload
	114	ep = None
	115	if with_ep:
	116	ep = tc.create_structure_field_class()
	117	ep += OrderedDict((
	118	('giraffe', tc.create_signed_integer_field_class(32)),
	119	('gnu', tc.create_signed_integer_field_class(8)),
	120	('mosquito', tc.create_signed_integer_field_class(8)),
	121	))
	122
	123	event_class = stream_class.create_event_class(name='garou',
	124	specific_context_field_class=sc,
	125	payload_field_class=ep)
	126
	127	trace = tc()
	128	stream = trace.create_stream(stream_class)
26fc5aed PP	129
	130	if with_packet:
	131	packet = stream.create_packet()
2ae9f48c SM	132
2ae9f48c SM	133	if packet_fields_config is not None:
26fc5aed	134	assert packet
2ae9f48c SM	135	packet_fields_config(packet)
2ae9f48c SM	136
26fc5aed PP	137	if with_packet:
	138	test_obj.packet = packet
	139
2ae9f48c SM	140	test_obj.stream = stream
	141	test_obj.event_class = event_class
	142
	143	test_obj = self
	144	self._graph = bt2.Graph()
	145	self._src_comp = self._graph.add_component(MySrc, 'my_source')
	146	self._msg_iter = self._graph.create_output_port_message_iterator(self._src_comp.output_ports['out'])
	147
26fc5aed PP	148	for msg in self._msg_iter:
26fc5aed PP	149	if type(msg) is bt2._EventMessage:
2ae9f48c	150	return msg
9cf643d1 PP	151
9cf643d1 PP	152	def test_attr_event_class(self):
2ae9f48c	153	msg = self._create_test_event_message()
e8ac1aae	154	self.assertEqual(msg.event.cls.addr, self.event_class.addr)
9cf643d1 PP	155
9cf643d1 PP	156	def test_attr_name(self):
2ae9f48c SM	157	msg = self._create_test_event_message()
2ae9f48c SM	158	self.assertEqual(msg.event.name, self.event_class.name)
9cf643d1 PP	159
9cf643d1 PP	160	def test_attr_id(self):
2ae9f48c SM	161	msg = self._create_test_event_message()
	162	self.assertEqual(msg.event.id, self.event_class.id)
	163
	164	def test_get_common_context_field(self):
	165	def event_fields_config(event):
	166	event.common_context_field['cpu_id'] = 1
	167	event.common_context_field['stuff'] = 13.194
	168
	169	msg = self._create_test_event_message(event_fields_config=event_fields_config, with_cc=True)
	170
	171	self.assertEqual(msg.event.common_context_field['cpu_id'], 1)
	172	self.assertEqual(msg.event.common_context_field['stuff'], 13.194)
	173
	174	def test_no_common_context_field(self):
	175	msg = self._create_test_event_message(with_cc=False)
	176	self.assertIsNone(msg.event.common_context_field)
	177
	178	def test_get_specific_context_field(self):
	179	def event_fields_config(event):
	180	event.specific_context_field['ant'] = -1
	181	event.specific_context_field['msg'] = 'hellooo'
	182
	183	msg = self._create_test_event_message(event_fields_config=event_fields_config, with_sc=True)
	184
	185	self.assertEqual(msg.event.specific_context_field['ant'], -1)
	186	self.assertEqual(msg.event.specific_context_field['msg'], 'hellooo')
	187
	188	def test_no_specific_context_field(self):
	189	msg = self._create_test_event_message(with_sc=False)
	190	self.assertIsNone(msg.event.specific_context_field)
9cf643d1 PP	191
9cf643d1 PP	192	def test_get_event_payload_field(self):
2ae9f48c SM	193	def event_fields_config(event):
	194	event.payload_field['giraffe'] = 1
	195	event.payload_field['gnu'] = 23
	196	event.payload_field['mosquito'] = 42
9cf643d1	197
2ae9f48c	198	msg = self._create_test_event_message(event_fields_config=event_fields_config, with_ep=True)
9cf643d1	199
2ae9f48c SM	200	self.assertEqual(msg.event.payload_field['giraffe'], 1)
	201	self.assertEqual(msg.event.payload_field['gnu'], 23)
	202	self.assertEqual(msg.event.payload_field['mosquito'], 42)
9cf643d1	203
2ae9f48c SM	204	def test_no_payload_field(self):
	205	msg = self._create_test_event_message(with_ep=False)
	206	self.assertIsNone(msg.event.payload_field)
9cf643d1	207
2ae9f48c SM	208	def test_clock_value(self):
	209	msg = self._create_test_event_message(with_clockclass=True)
	210	self.assertEqual(msg.default_clock_snapshot.value, 789)
	211
	212	def test_no_clock_value(self):
	213	msg = self._create_test_event_message(with_clockclass=False)
2e90378a	214	with self.assertRaises(bt2.NonexistentClockSnapshot):
9ec609ec	215	msg.default_clock_snapshot
2ae9f48c SM	216
	217	def test_stream(self):
	218	msg = self._create_test_event_message()
	219	self.assertEqual(msg.event.stream.addr, self.stream.addr)
	220
	221	def test_getitem(self):
	222	def event_fields_config(event):
	223	event.payload_field['giraffe'] = 1
	224	event.payload_field['gnu'] = 23
	225	event.payload_field['mosquito'] = 42
	226	event.specific_context_field['ant'] = -1
	227	event.specific_context_field['msg'] = 'hellooo'
	228	event.common_context_field['cpu_id'] = 1
	229	event.common_context_field['stuff'] = 13.194
	230
	231	def packet_fields_config(packet):
	232	packet.context_field['something'] = 154
	233	packet.context_field['something_else'] = 17.2
	234
	235	msg = self._create_test_event_message(packet_fields_config=packet_fields_config,
	236	event_fields_config=event_fields_config,
26fc5aed PP	237	with_cc=True, with_sc=True, with_ep=True,
26fc5aed PP	238	with_packet=True)
2ae9f48c SM	239	ev = msg.event
	240
	241	# Test event fields
9cf643d1	242	self.assertEqual(ev['giraffe'], 1)
2ae9f48c SM	243	self.assertEqual(ev['gnu'], 23)
2ae9f48c SM	244	self.assertEqual(ev['mosquito'], 42)
9cf643d1	245	self.assertEqual(ev['ant'], -1)
2ae9f48c	246	self.assertEqual(ev['msg'], 'hellooo')
9cf643d1	247	self.assertEqual(ev['cpu_id'], 1)
2ae9f48c SM	248	self.assertEqual(ev['stuff'], 13.194)
	249
	250	# Test packet fields
9cf643d1	251	self.assertEqual(ev['something'], 154)
2ae9f48c	252	self.assertEqual(ev['something_else'], 17.2)
9cf643d1 PP	253
	254	with self.assertRaises(KeyError):
	255	ev['yes']
	256
2ae9f48c SM	257
	258	if __name__ == "__main__":
	259	unittest.main()