Merge pull request #5 from marcelbuesing/assert-range

Add check for range of value parameter when setting signal

Author: Pascal Hertleif

src/includes/errors.rs

@@ -1,6 +1,12 @@
-#[derive(Clone, Copy, PartialEq, Eq)]
+#[derive(Clone, Copy, PartialEq)]
 #[cfg_attr(feature = "debug", derive(Debug))]
 pub enum CanError {
     UnknownMessageId(u32),
+    /// Signal parameter is not within the range
+    /// defined in the dbc
+    ParameterOutOfRange {
+        /// dbc message id
+        message_id: u32,
+    },
     InvalidPayloadSize,
 }

src/main.rs

@@ -379,6 +379,15 @@ fn render_signal(mut w: impl Write, signal: &Signal, dbc: &DBC, msg: &Message) -
     )?;
     {
         let mut w = PadAdapter::wrap(&mut w);
+        writeln!(w, r##"#[cfg(feature = "range_checked")]"##)?;
+        writeln!(
+            w,
+            r##"if value < {min}_{typ} || {max}_{typ} < value {{ return Err(CanError::ParameterOutOfRange{{ message_id: {message_id} }}); }}"##,
+            typ = signal_to_rust_type(&signal),
+            message_id = msg.message_id().0,
+            min = signal.min(),
+            max = signal.max(),
+        )?;
         signal_to_payload(&mut w, signal)?;
     }
     writeln!(&mut w, "}}")?;

testing/can-messages/Cargo.toml

@@ -10,3 +10,4 @@ bitsh = { git = "https://github.com/bitbleep/bitsh/" }
 [features]
 default = ["debug"]
 debug = []
+range_checked = []

testing/can-messages/src/lib.rs

@@ -1,2 +1,19 @@
 mod messages;
 pub use messages::*;
+
+#[test]
+#[cfg(feature = "range_checked")]
+fn check_range_value_error() {
+    let result = messages::Bar::new(1, 2.0, 3, 4);
+    assert!(matches!(
+        result,
+        Err(CanError::ParameterOutOfRange { message_id: 512 })
+    ));
+}
+
+#[test]
+#[cfg(feature = "range_checked")]
+fn check_range_value_valid() {
+    let result = messages::Bar::new(1, 2.0, 3, 3);
+    assert!(result.is_ok());
+}

testing/can-messages/src/messages.rs

@@ -91,6 +91,10 @@ impl Foo {
     /// Set value of Voltage
     #[inline(always)]
     pub fn set_voltage(&mut self, value: f32) -> Result<(), CanError> {
+        #[cfg(feature = "range_checked")]
+        if value < 0_f32 || 63.9990234375_f32 < value {
+            return Err(CanError::ParameterOutOfRange { message_id: 256 });
+        }
         let factor = 0.000976562_f32;
         let offset = 0_f32;
         let value = ((value - offset) / factor) as u16;
@@ -132,6 +136,10 @@ impl Foo {
     /// Set value of Current
     #[inline(always)]
     pub fn set_current(&mut self, value: f32) -> Result<(), CanError> {
+        #[cfg(feature = "range_checked")]
+        if value < -2048_f32 || 2047.9375_f32 < value {
+            return Err(CanError::ParameterOutOfRange { message_id: 256 });
+        }
         let factor = 0.0625_f32;
         let offset = 0_f32;
         let value = ((value - offset) / factor) as i16;
@@ -215,6 +223,10 @@ impl Bar {
     /// Set value of One
     #[inline(always)]
     pub fn set_one(&mut self, value: u8) -> Result<(), CanError> {
+        #[cfg(feature = "range_checked")]
+        if value < 0_u8 || 3_u8 < value {
+            return Err(CanError::ParameterOutOfRange { message_id: 512 });
+        }
         let start_bit = 15;
         let bits = 2;
         value.pack_be_bits(&mut self.raw, start_bit, bits);
@@ -252,6 +264,10 @@ impl Bar {
     /// Set value of Two
     #[inline(always)]
     pub fn set_two(&mut self, value: f32) -> Result<(), CanError> {
+        #[cfg(feature = "range_checked")]
+        if value < 0_f32 || 100_f32 < value {
+            return Err(CanError::ParameterOutOfRange { message_id: 512 });
+        }
         let factor = 0.39_f32;
         let offset = 0_f32;
         let value = ((value - offset) / factor) as u8;
@@ -297,6 +313,10 @@ impl Bar {
     /// Set value of Three
     #[inline(always)]
     pub fn set_three(&mut self, value: u8) -> Result<(), CanError> {
+        #[cfg(feature = "range_checked")]
+        if value < 0_u8 || 7_u8 < value {
+            return Err(CanError::ParameterOutOfRange { message_id: 512 });
+        }
         let start_bit = 13;
         let bits = 3;
         value.pack_be_bits(&mut self.raw, start_bit, bits);
@@ -338,6 +358,10 @@ impl Bar {
     /// Set value of Four
     #[inline(always)]
     pub fn set_four(&mut self, value: u8) -> Result<(), CanError> {
+        #[cfg(feature = "range_checked")]
+        if value < 0_u8 || 3_u8 < value {
+            return Err(CanError::ParameterOutOfRange { message_id: 512 });
+        }
         let start_bit = 10;
         let bits = 2;
         value.pack_be_bits(&mut self.raw, start_bit, bits);
@@ -360,7 +384,7 @@ impl core::convert::TryFrom<&[u8]> for Bar {
 }
 
 /// Defined values for Three
-#[derive(Clone, Copy)]
+#[derive(Clone, Copy, PartialEq)]
 #[cfg_attr(feature = "debug", derive(Debug))]
 pub enum BarThree {
     Off,
@@ -383,9 +407,15 @@ pub enum BarFour {
 /// This is just to make testing easier
 fn main() {}
 
-#[derive(Clone, Copy, PartialEq, Eq)]
+#[derive(Clone, Copy, PartialEq)]
 #[cfg_attr(feature = "debug", derive(Debug))]
 pub enum CanError {
     UnknownMessageId(u32),
+    /// Signal parameter is not within the range
+    /// defined in the dbc
+    ParameterOutOfRange {
+        /// dbc message id
+        message_id: u32,
+    },
     InvalidPayloadSize,
 }