update to embedded-hal-mock = "0.10.0-rc.2"

also ensure that `done()` is called on all mocks (otherwise the tests
now fail). this also unearthed 1-2 bugs where the expectations were
wrong.

Author: rursprung

Cargo.toml

@@ -16,4 +16,4 @@ embedded-hal = "0.2"
 defmt = { version = "0.3", optional = true }
 
 [dev-dependencies]
-embedded-hal-mock = "0.9"
+embedded-hal-mock = "0.10.0-rc.2"

src/lib.rs

@@ -79,17 +79,22 @@ where
     ///
     /// Usage example:
     /// ```
-    /// # use embedded_hal_mock::pin::Mock as PinMock;
-    /// # use embedded_hal_mock::pin::Transaction as PinTransaction;
+    /// # use embedded_hal_mock::eh0::pin::Mock as PinMock;
+    /// # use embedded_hal_mock::eh0::pin::Transaction as PinTransaction;
     /// # let motor_a_in1 = PinMock::new([]);
+    /// # let mut motor_a_in1_ = motor_a_in1.clone();
     /// # let motor_a_in2 = PinMock::new([]);
-    /// # let motor_a_pwm_expectations = [PinTransaction::enable()];
-    /// # let motor_a_pwm = PinMock::new(&motor_a_pwm_expectations);
+    /// # let mut motor_a_in2_ = motor_a_in2.clone();
+    /// # let motor_a_pwm = PinMock::new(&[PinTransaction::enable()]);
+    /// # let mut motor_a_pwm_ = motor_a_pwm.clone();
     /// # let motor_b_in1 = PinMock::new([]);
+    /// # let mut motor_b_in1_ = motor_b_in1.clone();
     /// # let motor_b_in2 = PinMock::new([]);
-    /// # let motor_b_pwm_expectations = [PinTransaction::enable()];
-    /// # let motor_b_pwm = PinMock::new(&motor_a_pwm_expectations);
+    /// # let mut motor_b_in2_ = motor_b_in2.clone();
+    /// # let motor_b_pwm = PinMock::new(&[PinTransaction::enable()]);
+    /// # let mut motor_b_pwm_ = motor_b_pwm.clone();
     /// # let standby = PinMock::new([]);
+    /// # let mut standby_ = standby.clone();
     /// use tb6612fng::Tb6612fng;
     ///
     /// let controller = Tb6612fng::new(
@@ -101,6 +106,14 @@ where
     ///     motor_b_pwm,
     ///     standby,
     /// );
+    ///
+    /// # motor_a_in1_.done();
+    /// # motor_a_in2_.done();
+    /// # motor_a_pwm_.done();
+    /// # motor_b_in1_.done();
+    /// # motor_b_in2_.done();
+    /// # motor_b_pwm_.done();
+    /// # standby_.done();
     /// ```
     pub fn new(
         motor_a_in1: MAIN1,
@@ -156,19 +169,25 @@ where
     ///
     /// Usage example:
     /// ```
-    /// # use embedded_hal_mock::pin::Mock as PinMock;
-    /// # use embedded_hal_mock::pin::Transaction as PinTransaction;
+    /// # use embedded_hal_mock::eh0::pin::Mock as PinMock;
+    /// # use embedded_hal_mock::eh0::pin::Transaction as PinTransaction;
     /// # let motor_in1 = PinMock::new([]);
+    /// # let mut motor_in1_ = motor_in1.clone();
     /// # let motor_in2 = PinMock::new([]);
-    /// # let motor_pwm_expectations = [PinTransaction::enable()];
-    /// # let motor_pwm = PinMock::new(&motor_pwm_expectations);
+    /// # let mut motor_in2_ = motor_in2.clone();
+    /// # let motor_pwm = PinMock::new(&[PinTransaction::enable()]);
+    /// # let mut motor_pwm_ = motor_pwm.clone();
     /// use tb6612fng::Motor;
     ///
     /// let motor = Motor::new(
     ///     motor_in1,
     ///     motor_in2,
     ///     motor_pwm,
     /// );
+    ///
+    /// # motor_in1_.done();
+    /// # motor_in2_.done();
+    /// # motor_pwm_.done();
     /// ```
     pub fn new(in1: IN1, in2: IN2, mut pwm: PWM) -> Motor<IN1, IN2, PWM> {
         pwm.enable();
@@ -275,9 +294,9 @@ where
 #[cfg(test)]
 mod tests {
     use crate::{DriveCommand, DriveError, Motor};
-    use embedded_hal_mock::pin::State::{High, Low};
-    use embedded_hal_mock::pin::Transaction as PinTransaction;
-    use embedded_hal_mock::pin::{Mock as PinMock, PwmDuty};
+    use embedded_hal_mock::eh0::pin::State::{High, Low};
+    use embedded_hal_mock::eh0::pin::Transaction as PinTransaction;
+    use embedded_hal_mock::eh0::pin::{Mock as PinMock, PwmDuty};
 
     #[test]
     fn test_motor_stop() {
@@ -289,16 +308,20 @@ mod tests {
             PinTransaction::get_max_duty(max_duty),
             PinTransaction::set_duty(0),
         ];
-        let motor_in1 = PinMock::new(&motor_in1_expectations);
-        let motor_in2 = PinMock::new(&motor_in2_expectations);
-        let motor_pwm = PinMock::new(&motor_pwm_expectations);
+        let mut motor_in1 = PinMock::new(&motor_in1_expectations);
+        let mut motor_in2 = PinMock::new(&motor_in2_expectations);
+        let mut motor_pwm = PinMock::new(&motor_pwm_expectations);
 
-        let mut motor = Motor::new(motor_in1, motor_in2, motor_pwm);
+        let mut motor = Motor::new(motor_in1.clone(), motor_in2.clone(), motor_pwm.clone());
 
         motor.stop();
 
         assert_eq!(*motor.current_drive_command(), DriveCommand::Stop);
         assert_eq!(motor.current_speed(), 0);
+
+        motor_in1.done();
+        motor_in2.done();
+        motor_pwm.done();
     }
 
     #[test]
@@ -311,16 +334,20 @@ mod tests {
             PinTransaction::get_max_duty(max_duty),
             PinTransaction::set_duty(0),
         ];
-        let motor_in1 = PinMock::new(&motor_in1_expectations);
-        let motor_in2 = PinMock::new(&motor_in2_expectations);
-        let motor_pwm = PinMock::new(&motor_pwm_expectations);
+        let mut motor_in1 = PinMock::new(&motor_in1_expectations);
+        let mut motor_in2 = PinMock::new(&motor_in2_expectations);
+        let mut motor_pwm = PinMock::new(&motor_pwm_expectations);
 
-        let mut motor = Motor::new(motor_in1, motor_in2, motor_pwm);
+        let mut motor = Motor::new(motor_in1.clone(), motor_in2.clone(), motor_pwm.clone());
 
         motor.brake();
 
         assert_eq!(*motor.current_drive_command(), DriveCommand::Brake);
         assert_eq!(motor.current_speed(), 0);
+
+        motor_in1.done();
+        motor_in2.done();
+        motor_pwm.done();
     }
 
     #[test]
@@ -334,16 +361,20 @@ mod tests {
             PinTransaction::get_max_duty(max_duty),
             PinTransaction::set_duty(speed as PwmDuty),
         ];
-        let motor_in1 = PinMock::new(&motor_in1_expectations);
-        let motor_in2 = PinMock::new(&motor_in2_expectations);
-        let motor_pwm = PinMock::new(&motor_pwm_expectations);
+        let mut motor_in1 = PinMock::new(&motor_in1_expectations);
+        let mut motor_in2 = PinMock::new(&motor_in2_expectations);
+        let mut motor_pwm = PinMock::new(&motor_pwm_expectations);
 
-        let mut motor = Motor::new(motor_in1, motor_in2, motor_pwm);
+        let mut motor = Motor::new(motor_in1.clone(), motor_in2.clone(), motor_pwm.clone());
 
         motor.drive_forward(speed).expect("speed can be set");
 
         assert_eq!(*motor.current_drive_command(), DriveCommand::Forward(100));
         assert_eq!(motor.current_speed(), speed as i8);
+
+        motor_in1.done();
+        motor_in2.done();
+        motor_pwm.done();
     }
 
     #[test]
@@ -357,33 +388,32 @@ mod tests {
             PinTransaction::get_max_duty(max_duty),
             PinTransaction::set_duty(speed as PwmDuty),
         ];
-        let motor_in1 = PinMock::new(&motor_in1_expectations);
-        let motor_in2 = PinMock::new(&motor_in2_expectations);
-        let motor_pwm = PinMock::new(&motor_pwm_expectations);
+        let mut motor_in1 = PinMock::new(&motor_in1_expectations);
+        let mut motor_in2 = PinMock::new(&motor_in2_expectations);
+        let mut motor_pwm = PinMock::new(&motor_pwm_expectations);
 
-        let mut motor = Motor::new(motor_in1, motor_in2, motor_pwm);
+        let mut motor = Motor::new(motor_in1.clone(), motor_in2.clone(), motor_pwm.clone());
 
         motor.drive_backwards(speed).expect("speed can be set");
 
         assert_eq!(*motor.current_drive_command(), DriveCommand::Backwards(100));
         assert_eq!(motor.current_speed(), -(speed as i8));
+
+        motor_in1.done();
+        motor_in2.done();
+        motor_pwm.done();
     }
 
     #[test]
     fn test_motor_drive_invalid_speed() {
-        let max_duty = 100;
-        let motor_in1_expectations = [PinTransaction::set(Low)];
-        let motor_in2_expectations = [PinTransaction::set(High)];
-        let motor_pwm_expectations = [
-            PinTransaction::enable(),
-            PinTransaction::get_max_duty(max_duty),
-            PinTransaction::set_duty(100),
-        ];
-        let motor_in1 = PinMock::new(&motor_in1_expectations);
-        let motor_in2 = PinMock::new(&motor_in2_expectations);
-        let motor_pwm = PinMock::new(&motor_pwm_expectations);
+        let motor_in1_expectations = [];
+        let motor_in2_expectations = [];
+        let motor_pwm_expectations = [PinTransaction::enable()];
+        let mut motor_in1 = PinMock::new(&motor_in1_expectations);
+        let mut motor_in2 = PinMock::new(&motor_in2_expectations);
+        let mut motor_pwm = PinMock::new(&motor_pwm_expectations);
 
-        let mut motor = Motor::new(motor_in1, motor_in2, motor_pwm);
+        let mut motor = Motor::new(motor_in1.clone(), motor_in2.clone(), motor_pwm.clone());
 
         let current_drive_command = motor.current_drive_command().clone();
         let current_speed = motor.current_speed();
@@ -398,5 +428,9 @@ mod tests {
         // this should still be what was set before the invalid command
         assert_eq!(*motor.current_drive_command(), current_drive_command);
         assert_eq!(motor.current_speed(), current_speed);
+
+        motor_in1.done();
+        motor_in2.done();
+        motor_pwm.done();
     }
 }