Add a basic mock implementation of generic traits

Author: Carter12s

Cargo.lock

@@ -8,5 +8,6 @@ members = [
     "roslibrust_codegen_macro",
     "roslibrust_genmsg",
     "roslibrust_test",
+    "roslibrust_mock",
 ]
 resolver = "2"

Cargo.toml

@@ -100,7 +100,11 @@
 
 mod rosbridge;
 pub use rosbridge::*;
-use roslibrust_codegen::RosServiceType;
+
+// Re export the codegen traits so that crates that only interact with abstract messages
+// don't need to depend on the codegen crate
+pub use roslibrust_codegen::RosMessageType;
+pub use roslibrust_codegen::RosServiceType;
 
 #[cfg(feature = "rosapi")]
 pub mod rosapi;

roslibrust/src/lib.rs

@@ -0,0 +1,16 @@
+[package]
+name = "roslibrust_mock"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+roslibrust = { path = "../roslibrust", features = ["topic_provider"] }
+tokio = { version = "1.41", features = ["sync", "rt-multi-thread", "macros"] }
+# Used for serializing messages
+bincode = "1.3"
+# We add logging to aid in debugging tests
+log = "0.4"
+
+[dev-dependencies]
+roslibrust_codegen = { path = "../roslibrust_codegen" }
+roslibrust_codegen_macro = { path = "../roslibrust_codegen_macro" }

roslibrust_mock/Cargo.toml

@@ -0,0 +1,3 @@
+# RosLibRust Mock
+
+A mock implementation of roslibrust's generic traits for use in building automated testing of nodes.

roslibrust_mock/README.md

@@ -0,0 +1,259 @@
+use std::collections::BTreeMap;
+use std::sync::Arc;
+
+use roslibrust::topic_provider::*;
+use roslibrust::RosLibRustError;
+use roslibrust::RosLibRustResult;
+use roslibrust::RosMessageType;
+
+use roslibrust::RosServiceType;
+use roslibrust::ServiceFn;
+use tokio::sync::broadcast as Channel;
+use tokio::sync::RwLock;
+
+use log::*;
+
+type TypeErasedCallback = Arc<
+    dyn Fn(Vec<u8>) -> Result<Vec<u8>, Box<dyn std::error::Error + Send + Sync>>
+        + Send
+        + Sync
+        + 'static,
+>;
+
+pub struct MockRos {
+    // We could probably achieve some fancier type erasure than actually serializing the data
+    // but this ends up being pretty simple
+    topics: RwLock<BTreeMap<String, (Channel::Sender<Vec<u8>>, Channel::Receiver<Vec<u8>>)>>,
+    services: RwLock<BTreeMap<String, TypeErasedCallback>>,
+}
+
+impl MockRos {
+    pub fn new() -> Self {
+        Self {
+            topics: RwLock::new(BTreeMap::new()),
+            services: RwLock::new(BTreeMap::new()),
+        }
+    }
+}
+
+// This is a very basic mocking of sending and receiving messages over topics
+// It does not implement automatic shutdown of topics on dropping
+impl TopicProvider for MockRos {
+    type Publisher<T: RosMessageType> = MockPublisher<T>;
+    type Subscriber<T: RosMessageType> = MockSubscriber<T>;
+
+    async fn advertise<T: RosMessageType>(
+        &self,
+        topic: &str,
+    ) -> RosLibRustResult<Self::Publisher<T>> {
+        // Check if we already have this channel
+        {
+            let topics = self.topics.read().await;
+            if let Some((sender, _)) = topics.get(topic) {
+                debug!("Issued new publisher to existing topic {}", topic);
+                return Ok(MockPublisher {
+                    sender: sender.clone(),
+                    _marker: Default::default(),
+                });
+            }
+        } // Drop read lock here
+          // Create a new channel
+        let tx_rx = Channel::channel(10);
+        let tx_copy = tx_rx.0.clone();
+        let mut topics = self.topics.write().await;
+        topics.insert(topic.to_string(), tx_rx);
+        debug!("Created new publisher and channel for topic {}", topic);
+        Ok(MockPublisher {
+            sender: tx_copy,
+            _marker: Default::default(),
+        })
+    }
+
+    async fn subscribe<T: RosMessageType>(
+        &self,
+        topic: &str,
+    ) -> RosLibRustResult<Self::Subscriber<T>> {
+        // Check if we already have this channel
+        {
+            let topics = self.topics.read().await;
+            if let Some((_, receiver)) = topics.get(topic) {
+                debug!("Issued new subscriber to existing topic {}", topic);
+                return Ok(MockSubscriber {
+                    receiver: receiver.resubscribe(),
+                    _marker: Default::default(),
+                });
+            }
+        } // Drop read lock here
+          // Create a new channel
+        let tx_rx = Channel::channel(10);
+        let rx_copy = tx_rx.1.resubscribe();
+        let mut topics = self.topics.write().await;
+        topics.insert(topic.to_string(), tx_rx);
+        debug!("Created new subscriber and channel for topic {}", topic);
+        Ok(MockSubscriber {
+            receiver: rx_copy,
+            _marker: Default::default(),
+        })
+    }
+}
+
+pub struct MockServiceClient<T: RosServiceType> {
+    callback: TypeErasedCallback,
+    _marker: std::marker::PhantomData<T>,
+}
+
+impl<T: RosServiceType> Service<T> for MockServiceClient<T> {
+    async fn call(&self, request: &T::Request) -> RosLibRustResult<T::Response> {
+        let data = bincode::serialize(request)
+            .map_err(|e| RosLibRustError::SerializationError(e.to_string()))?;
+        let response = (self.callback)(data)
+            .map_err(|e| RosLibRustError::SerializationError(e.to_string()))?;
+        let response = bincode::deserialize(&response[..])
+            .map_err(|e| RosLibRustError::SerializationError(e.to_string()))?;
+        Ok(response)
+    }
+}
+
+impl ServiceProvider for MockRos {
+    type ServiceClient<T: RosServiceType> = MockServiceClient<T>;
+    type ServiceServer = ();
+
+    async fn service_client<T: RosServiceType + 'static>(
+        &self,
+        topic: &str,
+    ) -> RosLibRustResult<Self::ServiceClient<T>> {
+        let services = self.services.read().await;
+        if let Some(callback) = services.get(topic) {
+            return Ok(MockServiceClient {
+                callback: callback.clone(),
+                _marker: Default::default(),
+            });
+        }
+        Err(RosLibRustError::Disconnected)
+    }
+
+    async fn advertise_service<T: RosServiceType + 'static, F>(
+        &self,
+        topic: &str,
+        server: F,
+    ) -> RosLibRustResult<Self::ServiceServer>
+    where
+        F: ServiceFn<T>,
+    {
+        // Type erase the service function here
+        let erased_closure =
+            move |message: Vec<u8>| -> Result<Vec<u8>, Box<dyn std::error::Error + Send + Sync>> {
+                let request = bincode::deserialize(&message[..])
+                    .map_err(|e| RosLibRustError::SerializationError(e.to_string()))?;
+                let response = server(request)?;
+                let bytes = bincode::serialize(&response)
+                    .map_err(|e| RosLibRustError::SerializationError(e.to_string()))?;
+                Ok(bytes)
+            };
+        let erased_closure = Arc::new(erased_closure);
+        let mut services = self.services.write().await;
+        services.insert(topic.to_string(), erased_closure);
+
+        // We technically need to hand back a token that shuts the service down here
+        // But we haven't implemented that yet in this mock
+        Ok(())
+    }
+}
+
+pub struct MockPublisher<T: RosMessageType> {
+    sender: Channel::Sender<Vec<u8>>,
+    _marker: std::marker::PhantomData<T>,
+}
+
+impl<T: RosMessageType> Publish<T> for MockPublisher<T> {
+    async fn publish(&self, data: &T) -> RosLibRustResult<()> {
+        let data = bincode::serialize(data)
+            .map_err(|e| RosLibRustError::SerializationError(e.to_string()))?;
+        self.sender
+            .send(data)
+            .map_err(|_e| RosLibRustError::Disconnected)?;
+        debug!("Sent data on topic {}", T::ROS_TYPE_NAME);
+        Ok(())
+    }
+}
+
+pub struct MockSubscriber<T: RosMessageType> {
+    receiver: Channel::Receiver<Vec<u8>>,
+    _marker: std::marker::PhantomData<T>,
+}
+
+impl<T: RosMessageType> Subscribe<T> for MockSubscriber<T> {
+    async fn next(&mut self) -> RosLibRustResult<T> {
+        let data = self
+            .receiver
+            .recv()
+            .await
+            .map_err(|_| RosLibRustError::Disconnected)?;
+        let msg = bincode::deserialize(&data[..])
+            .map_err(|e| RosLibRustError::SerializationError(e.to_string()))?;
+        debug!("Received data on topic {}", T::ROS_TYPE_NAME);
+        Ok(msg)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    roslibrust_codegen_macro::find_and_generate_ros_messages!(
+        "assets/ros1_common_interfaces/std_msgs",
+        "assets/ros1_common_interfaces/ros_comm_msgs/std_srvs"
+    );
+
+    #[tokio::test(flavor = "multi_thread")]
+    async fn test_mock_topics() {
+        let mock_ros = MockRos::new();
+
+        let pub_handle = mock_ros
+            .advertise::<std_msgs::String>("test_topic")
+            .await
+            .unwrap();
+        let mut sub_handle = mock_ros
+            .subscribe::<std_msgs::String>("test_topic")
+            .await
+            .unwrap();
+
+        let msg = std_msgs::String {
+            data: "Hello, world!".to_string(),
+        };
+
+        pub_handle.publish(&msg).await.unwrap();
+
+        let received_msg = sub_handle.next().await.unwrap();
+
+        assert_eq!(msg, received_msg);
+    }
+
+    #[tokio::test(flavor = "multi_thread")]
+    async fn test_mock_services() {
+        let mock_topics = MockRos::new();
+
+        let server_fn = |request: std_srvs::SetBoolRequest| {
+            Ok(std_srvs::SetBoolResponse {
+                success: request.data,
+                message: "You set my bool!".to_string(),
+            })
+        };
+
+        mock_topics
+            .advertise_service::<std_srvs::SetBool, _>("test_service", server_fn)
+            .await
+            .unwrap();
+
+        let client = mock_topics
+            .service_client::<std_srvs::SetBool>("test_service")
+            .await
+            .unwrap();
+
+        let request = std_srvs::SetBoolRequest { data: true };
+
+        let response = client.call(&request).await.unwrap();
+        assert_eq!(response.success, true);
+        assert_eq!(response.message, "You set my bool!");
+    }
+}