From: Simon Marchi Date: Tue, 19 Nov 2019 22:44:12 +0000 (-0500) Subject: bt2: validate parameters to _StreamClass.create_event_class before creating the nativ... X-Git-Tag: v2.0.0~59 X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=88cf534320b30567b480d6b434b83a1db015ca7e bt2: validate parameters to _StreamClass.create_event_class before creating the native object For the same reasons outlined in d3bf1370a437 ("bt2: validate parameters to _TraceClass.create_stream_class before creating the native object"), validate the parameters when creating an event class before creating the native object. Change-Id: I435b21c145e663a373f3e989feac3e1d5de626c8 Signed-off-by: Simon Marchi Reviewed-on: https://review.lttng.org/c/babeltrace/+/2415 --- diff --git a/src/bindings/python/bt2/bt2/event_class.py b/src/bindings/python/bt2/bt2/event_class.py index b165d321..e55e3019 100644 --- a/src/bindings/python/bt2/bt2/event_class.py +++ b/src/bindings/python/bt2/bt2/event_class.py @@ -147,73 +147,94 @@ class _EventClass(_EventClassConst): def _user_attributes(self, user_attributes): value = bt2_value.create_value(user_attributes) - utils._check_type(value, bt2_value.MapValue) native_bt.event_class_set_user_attributes(self._ptr, value._ptr) _user_attributes = property(fset=_user_attributes) def _name(self, name): - utils._check_str(name) return native_bt.event_class_set_name(self._ptr, name) _name = property(fset=_name) def _log_level(self, log_level): - log_levels = ( - EventClassLogLevel.EMERGENCY, - EventClassLogLevel.ALERT, - EventClassLogLevel.CRITICAL, - EventClassLogLevel.ERROR, - EventClassLogLevel.WARNING, - EventClassLogLevel.NOTICE, - EventClassLogLevel.INFO, - EventClassLogLevel.DEBUG_SYSTEM, - EventClassLogLevel.DEBUG_PROGRAM, - EventClassLogLevel.DEBUG_PROCESS, - EventClassLogLevel.DEBUG_MODULE, - EventClassLogLevel.DEBUG_UNIT, - EventClassLogLevel.DEBUG_FUNCTION, - EventClassLogLevel.DEBUG_LINE, - EventClassLogLevel.DEBUG, - ) - - if log_level not in log_levels: - raise ValueError("'{}' is not a valid log level".format(log_level)) - native_bt.event_class_set_log_level(self._ptr, log_level) _log_level = property(fset=_log_level) def _emf_uri(self, emf_uri): - utils._check_str(emf_uri) status = native_bt.event_class_set_emf_uri(self._ptr, emf_uri) utils._handle_func_status(status, "cannot set event class object's EMF URI") _emf_uri = property(fset=_emf_uri) def _specific_context_field_class(self, context_field_class): - if context_field_class is not None: - utils._check_type(context_field_class, bt2_field_class._StructureFieldClass) - status = native_bt.event_class_set_specific_context_field_class( - self._ptr, context_field_class._ptr - ) - utils._handle_func_status( - status, "cannot set event class object's context field class" - ) + status = native_bt.event_class_set_specific_context_field_class( + self._ptr, context_field_class._ptr + ) + utils._handle_func_status( + status, "cannot set event class object's context field class" + ) _specific_context_field_class = property(fset=_specific_context_field_class) def _payload_field_class(self, payload_field_class): - if payload_field_class is not None: - utils._check_type(payload_field_class, bt2_field_class._StructureFieldClass) - status = native_bt.event_class_set_payload_field_class( - self._ptr, payload_field_class._ptr + status = native_bt.event_class_set_payload_field_class( + self._ptr, payload_field_class._ptr + ) + utils._handle_func_status( + status, "cannot set event class object's payload field class" + ) + + _payload_field_class = property(fset=_payload_field_class) + + @staticmethod + def _validate_create_params( + name, + user_attributes, + log_level, + emf_uri, + specific_context_field_class, + payload_field_class, + ): + if name is not None: + utils._check_str(name) + + if user_attributes is not None: + value = bt2_value.create_value(user_attributes) + utils._check_type(value, bt2_value.MapValue) + + if log_level is not None: + log_levels = ( + EventClassLogLevel.EMERGENCY, + EventClassLogLevel.ALERT, + EventClassLogLevel.CRITICAL, + EventClassLogLevel.ERROR, + EventClassLogLevel.WARNING, + EventClassLogLevel.NOTICE, + EventClassLogLevel.INFO, + EventClassLogLevel.DEBUG_SYSTEM, + EventClassLogLevel.DEBUG_PROGRAM, + EventClassLogLevel.DEBUG_PROCESS, + EventClassLogLevel.DEBUG_MODULE, + EventClassLogLevel.DEBUG_UNIT, + EventClassLogLevel.DEBUG_FUNCTION, + EventClassLogLevel.DEBUG_LINE, + EventClassLogLevel.DEBUG, ) - utils._handle_func_status( - status, "cannot set event class object's payload field class" + + if log_level not in log_levels: + raise ValueError("'{}' is not a valid log level".format(log_level)) + + if emf_uri is not None: + utils._check_str(emf_uri) + + if specific_context_field_class is not None: + utils._check_type( + specific_context_field_class, bt2_field_class._StructureFieldClass ) - _payload_field_class = property(fset=_payload_field_class) + if payload_field_class is not None: + utils._check_type(payload_field_class, bt2_field_class._StructureFieldClass) _EVENT_CLASS_LOG_LEVEL_TO_OBJ = { diff --git a/src/bindings/python/bt2/bt2/stream_class.py b/src/bindings/python/bt2/bt2/stream_class.py index ecab1df8..4468d5d5 100644 --- a/src/bindings/python/bt2/bt2/stream_class.py +++ b/src/bindings/python/bt2/bt2/stream_class.py @@ -219,6 +219,16 @@ class _StreamClass(_StreamClassConst): specific_context_field_class=None, payload_field_class=None, ): + # Validate parameters before we create the object. + bt2_event_class._EventClass._validate_create_params( + name, + user_attributes, + log_level, + emf_uri, + specific_context_field_class, + payload_field_class, + ) + if self.assigns_automatic_event_class_id: if id is not None: raise ValueError( diff --git a/tests/bindings/python/bt2/test_event_class.py b/tests/bindings/python/bt2/test_event_class.py index 47606b0e..33b8dc78 100644 --- a/tests/bindings/python/bt2/test_event_class.py +++ b/tests/bindings/python/bt2/test_event_class.py @@ -99,6 +99,8 @@ class EventClassTestCase(unittest.TestCase): with self.assertRaises(TypeError): sc.create_event_class(id='lel') + self.assertEqual(len(sc), 0) + def test_create_specific_context_field_class(self): fc = self._tc.create_structure_field_class() ec = self._stream_class.create_event_class(specific_context_field_class=fc) @@ -118,6 +120,8 @@ class EventClassTestCase(unittest.TestCase): with self.assertRaises(TypeError): self._stream_class.create_event_class(specific_context_field_class='lel') + self.assertEqual(len(self._stream_class), 0) + def test_create_payload_field_class(self): fc = self._tc.create_structure_field_class() ec = self._stream_class.create_event_class(payload_field_class=fc) @@ -137,6 +141,8 @@ class EventClassTestCase(unittest.TestCase): with self.assertRaises(TypeError): self._stream_class.create_event_class(payload_field_class='lel') + self.assertEqual(len(self._stream_class), 0) + def test_create_name(self): ec = self._stream_class.create_event_class(name='viande à chien') self.assertEqual(ec.name, 'viande à chien') @@ -145,6 +151,8 @@ class EventClassTestCase(unittest.TestCase): with self.assertRaises(TypeError): self._stream_class.create_event_class(name=2) + self.assertEqual(len(self._stream_class), 0) + def test_emf_uri(self): ec = self._stream_class.create_event_class(emf_uri='salut') self.assertEqual(ec.emf_uri, 'salut') @@ -153,6 +161,8 @@ class EventClassTestCase(unittest.TestCase): with self.assertRaises(TypeError): self._stream_class.create_event_class(emf_uri=23) + self.assertEqual(len(self._stream_class), 0) + def test_create_log_level(self): ec = self._stream_class.create_event_class( log_level=bt2.EventClassLogLevel.EMERGENCY @@ -163,6 +173,8 @@ class EventClassTestCase(unittest.TestCase): with self.assertRaises(ValueError): self._stream_class.create_event_class(log_level='zoom') + self.assertEqual(len(self._stream_class), 0) + def test_create_user_attributes(self): ec = self._stream_class.create_event_class(user_attributes={'salut': 23}) self.assertEqual(ec.user_attributes, {'salut': 23}) @@ -176,10 +188,14 @@ class EventClassTestCase(unittest.TestCase): with self.assertRaises(TypeError): self._stream_class.create_event_class(user_attributes=object()) + self.assertEqual(len(self._stream_class), 0) + def test_create_invalid_user_attributes_value_type(self): with self.assertRaises(TypeError): self._stream_class.create_event_class(user_attributes=23) + self.assertEqual(len(self._stream_class), 0) + def test_stream_class(self): ec = self._stream_class.create_event_class() self.assertEqual(ec.stream_class.addr, self._stream_class.addr)