2 # Copyright (C) 2019 EfficiOS Inc.
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
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.
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.
19 from collections
import OrderedDict
24 class EventTestCase(unittest
.TestCase
):
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,
29 with_ep
=False, with_packet
=False):
31 class MyIter(bt2
._UserMessageIterator
):
32 def __init__(self
, self_output_port
):
35 self
._create
_stream
_beginning
_message
(test_obj
.stream
),
39 assert test_obj
.packet
40 self
._msgs
.append(self
._create
_packet
_beginning
_message
(test_obj
.packet
))
42 default_clock_snapshot
= 789 if with_clockclass
else None
45 assert test_obj
.packet
46 ev_parent
= test_obj
.packet
48 assert test_obj
.stream
49 ev_parent
= test_obj
.stream
51 msg
= self
._create
_event
_message
(test_obj
.event_class
, ev_parent
, default_clock_snapshot
)
53 if event_fields_config
is not None:
54 event_fields_config(msg
.event
)
56 self
._msgs
.append(msg
)
59 self
._msgs
.append(self
._create
_packet
_end
_message
(test_obj
.packet
))
61 self
._msgs
.append(self
._create
_stream
_end
_message
(test_obj
.stream
))
64 if self
._at
== len(self
._msgs
):
67 msg
= self
._msgs
[self
._at
]
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
()
78 clock_class
= self
._create
_clock
_class
(frequency
=1000)
80 # event common context (stream-class-defined)
83 cc
= tc
.create_structure_field_class()
85 ('cpu_id', tc
.create_signed_integer_field_class(8)),
86 ('stuff', tc
.create_real_field_class()),
89 # packet context (stream-class-defined)
93 pc
= tc
.create_structure_field_class()
95 ('something', tc
.create_unsigned_integer_field_class(8)),
96 ('something_else', tc
.create_real_field_class()),
99 stream_class
= tc
.create_stream_class(default_clock_class
=clock_class
,
100 event_common_context_field_class
=cc
,
101 packet_context_field_class
=pc
,
102 supports_packets
=with_packet
)
104 # specific context (event-class-defined)
107 sc
= tc
.create_structure_field_class()
109 ('ant', tc
.create_signed_integer_field_class(16)),
110 ('msg', tc
.create_string_field_class()),
116 ep
= tc
.create_structure_field_class()
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)),
123 event_class
= stream_class
.create_event_class(name
='garou',
124 specific_context_field_class
=sc
,
125 payload_field_class
=ep
)
128 stream
= trace
.create_stream(stream_class
)
131 packet
= stream
.create_packet()
133 if packet_fields_config
is not None:
135 packet_fields_config(packet
)
138 test_obj
.packet
= packet
140 test_obj
.stream
= stream
141 test_obj
.event_class
= event_class
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'])
148 for msg
in self
._msg
_iter
:
149 if type(msg
) is bt2
._EventMessage
:
152 def test_attr_event_class(self
):
153 msg
= self
._create
_test
_event
_message
()
154 self
.assertEqual(msg
.event
.cls
.addr
, self
.event_class
.addr
)
156 def test_attr_name(self
):
157 msg
= self
._create
_test
_event
_message
()
158 self
.assertEqual(msg
.event
.name
, self
.event_class
.name
)
160 def test_attr_id(self
):
161 msg
= self
._create
_test
_event
_message
()
162 self
.assertEqual(msg
.event
.id, self
.event_class
.id)
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
169 msg
= self
._create
_test
_event
_message
(event_fields_config
=event_fields_config
, with_cc
=True)
171 self
.assertEqual(msg
.event
.common_context_field
['cpu_id'], 1)
172 self
.assertEqual(msg
.event
.common_context_field
['stuff'], 13.194)
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
)
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'
183 msg
= self
._create
_test
_event
_message
(event_fields_config
=event_fields_config
, with_sc
=True)
185 self
.assertEqual(msg
.event
.specific_context_field
['ant'], -1)
186 self
.assertEqual(msg
.event
.specific_context_field
['msg'], 'hellooo')
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
)
192 def test_get_event_payload_field(self
):
193 def event_fields_config(event
):
194 event
.payload_field
['giraffe'] = 1
195 event
.payload_field
['gnu'] = 23
196 event
.payload_field
['mosquito'] = 42
198 msg
= self
._create
_test
_event
_message
(event_fields_config
=event_fields_config
, with_ep
=True)
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)
204 def test_no_payload_field(self
):
205 msg
= self
._create
_test
_event
_message
(with_ep
=False)
206 self
.assertIsNone(msg
.event
.payload_field
)
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)
212 def test_no_clock_value(self
):
213 msg
= self
._create
_test
_event
_message
(with_clockclass
=False)
214 with self
.assertRaises(bt2
.NonexistentClockSnapshot
):
215 msg
.default_clock_snapshot
217 def test_stream(self
):
218 msg
= self
._create
_test
_event
_message
()
219 self
.assertEqual(msg
.event
.stream
.addr
, self
.stream
.addr
)
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
231 def packet_fields_config(packet
):
232 packet
.context_field
['something'] = 154
233 packet
.context_field
['something_else'] = 17.2
235 msg
= self
._create
_test
_event
_message
(packet_fields_config
=packet_fields_config
,
236 event_fields_config
=event_fields_config
,
237 with_cc
=True, with_sc
=True, with_ep
=True,
242 self
.assertEqual(ev
['giraffe'], 1)
243 self
.assertEqual(ev
['gnu'], 23)
244 self
.assertEqual(ev
['mosquito'], 42)
245 self
.assertEqual(ev
['ant'], -1)
246 self
.assertEqual(ev
['msg'], 'hellooo')
247 self
.assertEqual(ev
['cpu_id'], 1)
248 self
.assertEqual(ev
['stuff'], 13.194)
251 self
.assertEqual(ev
['something'], 154)
252 self
.assertEqual(ev
['something_else'], 17.2)
254 with self
.assertRaises(KeyError):
258 if __name__
== "__main__":