File: test_component_class.py

package info (click to toggle)
babeltrace2 2.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 42,660 kB
  • sloc: cpp: 106,162; ansic: 78,276; python: 27,115; sh: 9,053; makefile: 1,807; xml: 46
file content (356 lines) | stat: -rw-r--r-- 10,352 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
# SPDX-License-Identifier: GPL-2.0-only
#
# Copyright (C) 2019 EfficiOS Inc.
#

import unittest

import bt2


class UserComponentClassTestCase(unittest.TestCase):
    def _test_no_init(self, cls):
        with self.assertRaises(RuntimeError):
            cls()

    def test_no_init_source(self):
        class MySource(
            bt2._UserSourceComponent, message_iterator_class=bt2._UserMessageIterator
        ):
            pass

        self._test_no_init(MySource)

    def test_no_init_filter(self):
        class MyFilter(
            bt2._UserFilterComponent, message_iterator_class=bt2._UserMessageIterator
        ):
            pass

        self._test_no_init(MyFilter)

    def test_no_init_sink(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

        self._test_no_init(MySink)

    def test_incomplete_source_no_msg_iter_cls(self):
        with self.assertRaises(bt2._IncompleteUserClass):

            class MySource(bt2._UserSourceComponent):
                pass

    def test_incomplete_source_wrong_msg_iter_cls_type(self):
        with self.assertRaises(bt2._IncompleteUserClass):

            class MySource(bt2._UserSourceComponent, message_iterator_class=int):
                pass

    def test_incomplete_filter_no_msg_iter_cls(self):
        with self.assertRaises(bt2._IncompleteUserClass):

            class MyFilter(bt2._UserFilterComponent):
                pass

    def test_incomplete_sink_no_consume_method(self):
        with self.assertRaises(bt2._IncompleteUserClass):

            class MySink(bt2._UserSinkComponent):
                pass

    def test_minimal_source(self):
        class MySource(
            bt2._UserSourceComponent, message_iterator_class=bt2._UserMessageIterator
        ):
            pass

    def test_minimal_filter(self):
        class MyFilter(
            bt2._UserFilterComponent, message_iterator_class=bt2._UserMessageIterator
        ):
            pass

    def test_minimal_sink(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

    def test_default_name(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

        self.assertEqual(MySink.name, "MySink")

    def test_custom_name(self):
        class MySink(bt2._UserSinkComponent, name="salut"):
            def _user_consume(self):
                pass

        self.assertEqual(MySink.name, "salut")

    def test_invalid_custom_name(self):
        with self.assertRaises(TypeError):

            class MySink(bt2._UserSinkComponent, name=23):
                def _user_consume(self):
                    pass

    def test_description(self):
        class MySink(bt2._UserSinkComponent):
            """
            The description.

            Bacon ipsum dolor amet ribeye t-bone corned beef, beef jerky
            porchetta burgdoggen prosciutto chicken frankfurter boudin
            hamburger doner bacon turducken. Sirloin shank sausage,
            boudin meatloaf alcatra meatball t-bone tongue pastrami
            cupim flank tenderloin.
            """

            def _user_consume(self):
                pass

        self.assertEqual(MySink.description, "The description.")

    def test_empty_description_no_lines(self):
        class MySink(bt2._UserSinkComponent):
            # fmt: off
            """"""
            # fmt: on

            def _user_consume(self):
                pass

        self.assertIsNone(MySink.description)

    def test_empty_description_no_contents(self):
        class MySink(bt2._UserSinkComponent):
            # fmt: off
            """
            """
            # fmt: on

            def _user_consume(self):
                pass

        self.assertIsNone(MySink.description)

    def test_empty_description_single_line(self):
        class MySink(bt2._UserSinkComponent):
            """my description"""

            def _user_consume(self):
                pass

        self.assertEqual(MySink.description, "my description")

    def test_help(self):
        class MySink(bt2._UserSinkComponent):
            """
            The description.

            The help
            text is
            here.
            """

            def _user_consume(self):
                pass

        self.assertEqual(MySink.help, "The help\ntext is\nhere.")

    def test_addr(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

        self.assertIsInstance(MySink.addr, int)
        self.assertNotEqual(MySink.addr, 0)

    def test_query_not_implemented(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

        with self.assertRaises(bt2.UnknownObject):
            bt2.QueryExecutor(MySink, "obj", 23).query()

    def test_query_raises(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

            @classmethod
            def _user_query(cls, priv_query_exec, obj, params):
                raise ValueError

        with self.assertRaises(bt2._Error):
            bt2.QueryExecutor(MySink, "obj", 23).query()

    def test_query_wrong_return_type(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

            @classmethod
            def _user_query(cls, priv_query_exec, obj, params, method_obj):
                return ...

        with self.assertRaises(bt2._Error):
            bt2.QueryExecutor(MySink, "obj", 23).query()

    def test_query_params_none(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

            @classmethod
            def _user_query(cls, priv_query_exec, obj, params, method_obj):
                nonlocal query_params
                query_params = params
                return None

        query_params = None
        params = None
        res = bt2.QueryExecutor(MySink, "obj", params).query()
        self.assertEqual(query_params, params)
        self.assertIsNone(res)
        del query_params

    def test_query_logging_level(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

            @classmethod
            def _user_query(cls, priv_query_exec, obj, params, method_obj):
                nonlocal query_log_level
                query_log_level = priv_query_exec.logging_level

        query_log_level = None
        query_exec = bt2.QueryExecutor(MySink, "obj", None)
        query_exec.logging_level = bt2.LoggingLevel.WARNING
        query_exec.query()
        self.assertEqual(query_log_level, bt2.LoggingLevel.WARNING)
        del query_log_level

    def test_query_returns_none(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

            @staticmethod
            def _user_query(priv_query_exec, obj, params, method_obj):
                return

        res = bt2.QueryExecutor(MySink, "obj", None).query()
        self.assertIsNone(res)

    def test_query_simple(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

            @classmethod
            def _user_query(cls, priv_query_exec, obj, params, method_obj):
                nonlocal query_params
                query_params = params
                return 17.5

        query_params = None
        params = ["coucou", 23, None]
        res = bt2.QueryExecutor(MySink, "obj", params).query()
        self.assertEqual(query_params, params)
        self.assertEqual(res, 17.5)
        del query_params

    def test_query_complex(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

            @classmethod
            def _user_query(cls, priv_query_exec, obj, params, method_obj):
                nonlocal query_params
                query_params = params
                return {"null": None, "bt2": "BT2"}

        query_params = None
        params = {
            "array": ["coucou", 23, None],
            "other_map": {"yes": "yeah", "19": 19, "minus 1.5": -1.5},
            "null": None,
        }

        res = bt2.QueryExecutor(MySink, "obj", params).query()
        self.assertEqual(query_params, params)
        self.assertEqual(res, {"null": None, "bt2": "BT2"})
        del query_params

    def test_eq(self):
        class MySink(bt2._UserSinkComponent):
            def _user_consume(self):
                pass

        self.assertEqual(MySink, MySink)


class ComponentClassTestCase(unittest.TestCase):
    def setUp(self):
        class MySink(bt2._UserSinkComponent):
            """
            The description.

            The help.
            """

            def _user_consume(self):
                pass

            @classmethod
            def _user_query(cls, priv_query_exec, obj, params, method_obj):
                return [obj, params, 23]

        self._py_comp_cls = MySink
        graph = bt2.Graph()
        comp = graph.add_component(MySink, "salut")
        self._comp_cls = comp.cls
        self.assertIs(type(self._comp_cls), bt2._SinkComponentClassConst)

    def tearDown(self):
        del self._py_comp_cls
        del self._comp_cls

    def test_description(self):
        self.assertEqual(self._comp_cls.description, "The description.")

    def test_help(self):
        self.assertEqual(self._comp_cls.help, "The help.")

    def test_name(self):
        self.assertEqual(self._comp_cls.name, "MySink")

    def test_addr(self):
        self.assertIsInstance(self._comp_cls.addr, int)
        self.assertNotEqual(self._comp_cls.addr, 0)

    def test_eq_invalid(self):
        self.assertFalse(self._comp_cls == 23)

    def test_eq(self):
        self.assertEqual(self._comp_cls, self._comp_cls)
        self.assertEqual(self._py_comp_cls, self._comp_cls)

    def test_query(self):
        res = bt2.QueryExecutor(
            self._comp_cls, "an object", {"yes": "no", "book": -17}
        ).query()
        expected = ["an object", {"yes": "no", "book": -17}, 23]
        self.assertEqual(res, expected)


if __name__ == "__main__":
    unittest.main()