X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Fbindings%2Fpython%2Fbt2%2Ftest_component_class.py;h=d944c909bec7b9c8dd92adc982926e699d9204a5;hb=f5567ea88d172767b34373bc6e402da8bfd85ef8;hp=92d051f7ee8a1224a1474caf6d2deb750a6f4de1;hpb=d14ddbbab48ce07804d4252228fceee692d5dea4;p=babeltrace.git diff --git a/tests/bindings/python/bt2/test_component_class.py b/tests/bindings/python/bt2/test_component_class.py index 92d051f7..d944c909 100644 --- a/tests/bindings/python/bt2/test_component_class.py +++ b/tests/bindings/python/bt2/test_component_class.py @@ -1,20 +1,7 @@ +# SPDX-License-Identifier: GPL-2.0-only # # Copyright (C) 2019 EfficiOS Inc. # -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License -# as published by the Free Software Foundation; only version 2 -# of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -# import unittest import bt2 @@ -26,21 +13,17 @@ class UserComponentClassTestCase(unittest.TestCase): cls() def test_no_init_source(self): - class MyIter(bt2._UserMessageIterator): - def __next__(self): - raise bt2.Stop - - class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): + class MySource( + bt2._UserSourceComponent, message_iterator_class=bt2._UserMessageIterator + ): pass self._test_no_init(MySource) def test_no_init_filter(self): - class MyIter(bt2._UserMessageIterator): - def __next__(self): - raise bt2.Stop - - class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyIter): + class MyFilter( + bt2._UserFilterComponent, message_iterator_class=bt2._UserMessageIterator + ): pass self._test_no_init(MyFilter) @@ -53,53 +36,39 @@ class UserComponentClassTestCase(unittest.TestCase): self._test_no_init(MySink) def test_incomplete_source_no_msg_iter_cls(self): - class MyIter(bt2._UserMessageIterator): - pass - with self.assertRaises(bt2._IncompleteUserClass): class MySource(bt2._UserSourceComponent): pass def test_incomplete_source_wrong_msg_iter_cls_type(self): - class MyIter(bt2._UserMessageIterator): - pass - with self.assertRaises(bt2._IncompleteUserClass): class MySource(bt2._UserSourceComponent, message_iterator_class=int): pass def test_incomplete_filter_no_msg_iter_cls(self): - class MyIter(bt2._UserMessageIterator): - pass - with self.assertRaises(bt2._IncompleteUserClass): class MyFilter(bt2._UserFilterComponent): pass def test_incomplete_sink_no_consume_method(self): - class MyIter(bt2._UserMessageIterator): - pass - with self.assertRaises(bt2._IncompleteUserClass): class MySink(bt2._UserSinkComponent): pass def test_minimal_source(self): - class MyIter(bt2._UserMessageIterator): - pass - - class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): + class MySource( + bt2._UserSourceComponent, message_iterator_class=bt2._UserMessageIterator + ): pass def test_minimal_filter(self): - class MyIter(bt2._UserMessageIterator): - pass - - class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyIter): + class MyFilter( + bt2._UserFilterComponent, message_iterator_class=bt2._UserMessageIterator + ): pass def test_minimal_sink(self): @@ -112,14 +81,14 @@ class UserComponentClassTestCase(unittest.TestCase): def _user_consume(self): pass - self.assertEqual(MySink.name, 'MySink') + self.assertEqual(MySink.name, "MySink") def test_custom_name(self): - class MySink(bt2._UserSinkComponent, name='salut'): + class MySink(bt2._UserSinkComponent, name="salut"): def _user_consume(self): pass - self.assertEqual(MySink.name, 'salut') + self.assertEqual(MySink.name, "salut") def test_invalid_custom_name(self): with self.assertRaises(TypeError): @@ -143,18 +112,40 @@ class UserComponentClassTestCase(unittest.TestCase): def _user_consume(self): pass - self.assertEqual(MySink.description, 'The description.') + 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(self): + 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): """ @@ -168,7 +159,7 @@ class UserComponentClassTestCase(unittest.TestCase): def _user_consume(self): pass - self.assertEqual(MySink.help, 'The help\ntext is\nhere.') + self.assertEqual(MySink.help, "The help\ntext is\nhere.") def test_addr(self): class MySink(bt2._UserSinkComponent): @@ -184,7 +175,7 @@ class UserComponentClassTestCase(unittest.TestCase): pass with self.assertRaises(bt2.UnknownObject): - bt2.QueryExecutor(MySink, 'obj', 23).query() + bt2.QueryExecutor(MySink, "obj", 23).query() def test_query_raises(self): class MySink(bt2._UserSinkComponent): @@ -196,7 +187,7 @@ class UserComponentClassTestCase(unittest.TestCase): raise ValueError with self.assertRaises(bt2._Error): - bt2.QueryExecutor(MySink, 'obj', 23).query() + bt2.QueryExecutor(MySink, "obj", 23).query() def test_query_wrong_return_type(self): class MySink(bt2._UserSinkComponent): @@ -208,7 +199,7 @@ class UserComponentClassTestCase(unittest.TestCase): return ... with self.assertRaises(bt2._Error): - bt2.QueryExecutor(MySink, 'obj', 23).query() + bt2.QueryExecutor(MySink, "obj", 23).query() def test_query_params_none(self): class MySink(bt2._UserSinkComponent): @@ -223,7 +214,7 @@ class UserComponentClassTestCase(unittest.TestCase): query_params = None params = None - res = bt2.QueryExecutor(MySink, 'obj', params).query() + res = bt2.QueryExecutor(MySink, "obj", params).query() self.assertEqual(query_params, params) self.assertIsNone(res) del query_params @@ -239,7 +230,7 @@ class UserComponentClassTestCase(unittest.TestCase): query_log_level = priv_query_exec.logging_level query_log_level = None - query_exec = bt2.QueryExecutor(MySink, 'obj', 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) @@ -254,7 +245,7 @@ class UserComponentClassTestCase(unittest.TestCase): def _user_query(priv_query_exec, obj, params, method_obj): return - res = bt2.QueryExecutor(MySink, 'obj', None).query() + res = bt2.QueryExecutor(MySink, "obj", None).query() self.assertIsNone(res) def test_query_simple(self): @@ -269,8 +260,8 @@ class UserComponentClassTestCase(unittest.TestCase): return 17.5 query_params = None - params = ['coucou', 23, None] - res = bt2.QueryExecutor(MySink, 'obj', params).query() + params = ["coucou", 23, None] + res = bt2.QueryExecutor(MySink, "obj", params).query() self.assertEqual(query_params, params) self.assertEqual(res, 17.5) del query_params @@ -284,18 +275,18 @@ class UserComponentClassTestCase(unittest.TestCase): def _user_query(cls, priv_query_exec, obj, params, method_obj): nonlocal query_params query_params = params - return {'null': None, 'bt2': 'BT2'} + 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, + "array": ["coucou", 23, None], + "other_map": {"yes": "yeah", "19": 19, "minus 1.5": -1.5}, + "null": None, } - res = bt2.QueryExecutor(MySink, 'obj', params).query() + res = bt2.QueryExecutor(MySink, "obj", params).query() self.assertEqual(query_params, params) - self.assertEqual(res, {'null': None, 'bt2': 'BT2'}) + self.assertEqual(res, {"null": None, "bt2": "BT2"}) del query_params def test_eq(self): @@ -309,11 +300,11 @@ class UserComponentClassTestCase(unittest.TestCase): class ComponentClassTestCase(unittest.TestCase): def setUp(self): class MySink(bt2._UserSinkComponent): - ''' + """ The description. The help. - ''' + """ def _user_consume(self): pass @@ -324,7 +315,7 @@ class ComponentClassTestCase(unittest.TestCase): self._py_comp_cls = MySink graph = bt2.Graph() - comp = graph.add_component(MySink, 'salut') + comp = graph.add_component(MySink, "salut") self._comp_cls = comp.cls self.assertIs(type(self._comp_cls), bt2._SinkComponentClassConst) @@ -333,13 +324,13 @@ class ComponentClassTestCase(unittest.TestCase): del self._comp_cls def test_description(self): - self.assertEqual(self._comp_cls.description, 'The description.') + self.assertEqual(self._comp_cls.description, "The description.") def test_help(self): - self.assertEqual(self._comp_cls.help, 'The help.') + self.assertEqual(self._comp_cls.help, "The help.") def test_name(self): - self.assertEqual(self._comp_cls.name, 'MySink') + self.assertEqual(self._comp_cls.name, "MySink") def test_addr(self): self.assertIsInstance(self._comp_cls.addr, int) @@ -354,11 +345,11 @@ class ComponentClassTestCase(unittest.TestCase): def test_query(self): res = bt2.QueryExecutor( - self._comp_cls, 'an object', {'yes': 'no', 'book': -17} + self._comp_cls, "an object", {"yes": "no", "book": -17} ).query() - expected = ['an object', {'yes': 'no', 'book': -17}, 23] + expected = ["an object", {"yes": "no", "book": -17}, 23] self.assertEqual(res, expected) -if __name__ == '__main__': +if __name__ == "__main__": unittest.main()