Check the entity store after a sequence of registrations

Signed-off-by: Didier Wenzek <[email protected]>

Author: didier-wenzek

crates/core/tedge_agent/proptest-regressions/entity_manager/tests.txt

@@ -5,3 +5,4 @@
 # It is recommended to check this file in to source control so that
 # everyone who runs the test benefits from these saved cases.
 cc eb284ae3160cf4a071a3ca80175b2c72680b7c8ba19b8d577805ef1317eca2db # shrinks to registrations = [(MQTT, AddService { topic: "ac", props: [] }), (MQTT, AddService { topic: "ac", props: [] }), (MQTT, AddDevice { topic: "ac", props: [] }), (HTTP, AddService { topic: "ac", props: [("x", "4")] }), (HTTP, AddDevice { topic: "a", props: [] })]
+cc 6e3a5e19daf6c3a4732a0504822f2164c5d0f49ed5652e1e67c779a23aedbe77 # shrinks to registrations = [(HTTP, AddService { topic: "a", props: [] }), (MQTT, AddDevice { topic: "abc", props: [("z", "0")] }), (MQTT, AddDevice { topic: "abc", props: [("z", "8")] }), (HTTP, AddService { topic: "aa", props: [] }), (MQTT, AddDevice { topic: "abc", props: [("y", "3")] }), (MQTT, AddDevice { topic: "ab", props: [] }), (HTTP, AddService { topic: "a", props: [] }), (HTTP, AddDevice { topic: "abc", props: [("y", "7")] }), (MQTT, AddDevice { topic: "a", props: [] })]

crates/core/tedge_agent/src/entity_manager/server.rs

@@ -57,6 +57,16 @@ impl EntityStoreServer {
             entity_auto_register,
         }
     }
+
+    #[cfg(test)]
+    pub fn entity_topic_ids(&self) -> impl Iterator<Item = &EntityTopicId> {
+        self.entity_store.entity_topic_ids()
+    }
+
+    #[cfg(test)]
+    pub fn get(&self, entity_topic_id: &EntityTopicId) -> Option<&EntityMetadata> {
+        self.entity_store.get(entity_topic_id)
+    }
 }
 
 #[async_trait]

crates/core/tedge_agent/src/entity_manager/tests.rs

@@ -15,8 +15,9 @@ async fn new_entity_store() {
 }
 
 proptest! {
+    #![proptest_config(proptest::prelude::ProptestConfig::with_cases(1000))]
     #[test]
-    fn it_works_for_any_registration_order(registrations in model::walk(6)) {
+    fn it_works_for_any_registration_order(registrations in model::walk(10)) {
         tokio::runtime::Builder::new_current_thread()
         .enable_all()
         .build()
@@ -39,6 +40,21 @@ proptest! {
                 };
                 assert_eq!(actual_updates, expected_updates);
             }
+
+            let mut registered_topics : Vec<_> = entity_store.entity_topic_ids().collect();
+            registered_topics.sort_by(|a,b| a.as_ref().cmp(b.as_ref()));
+
+            let mut expected_topics : Vec<_> = state.entity_topic_ids().collect();
+            expected_topics.sort_by(|a,b| a.as_ref().cmp(b.as_ref()));
+
+            assert_eq!(registered_topics, expected_topics);
+
+            for topic in registered_topics {
+                let registered = entity_store.get(topic).unwrap();
+                let (entity_type, parent, _) = state.get(topic).unwrap();
+                assert_eq!(&registered.r#type, entity_type);
+                assert_eq!(registered.parent.as_ref(), parent.as_ref());
+            }
         })
     }
 }
@@ -277,6 +293,23 @@ mod model {
             state
         }
 
+        pub fn entity_topic_ids(&self) -> impl Iterator<Item = &EntityTopicId> {
+            self.entities
+                .keys()
+                .filter(|topic| self.is_registered(topic))
+        }
+
+        pub fn get(
+            &self,
+            topic: &EntityTopicId,
+        ) -> Option<&(EntityType, Option<EntityTopicId>, PropMap)> {
+            self.entities.get(topic)
+        }
+
+        pub fn is_registered(&self, topic: &EntityTopicId) -> bool {
+            self.registered.contains(topic)
+        }
+
         pub fn apply(&mut self, protocol: Protocol, action: Action) -> HashSet<EntityTopicId> {
             let topic = action.topic_id();
 

crates/core/tedge_api/src/entity_store.rs

@@ -229,6 +229,11 @@ impl EntityStore {
         }
     }
 
+    /// Iterates over the entity topic ids
+    pub fn entity_topic_ids(&self) -> impl Iterator<Item = &EntityTopicId> {
+        self.entities.entity_topic_ids()
+    }
+
     /// Returns information about an entity under a given MQTT entity topic identifier.
     pub fn get(&self, entity_topic_id: &EntityTopicId) -> Option<&EntityMetadata> {
         self.entities.get(entity_topic_id)
@@ -564,6 +569,11 @@ impl EntityTree {
         self.entities.contains_key(topic_id)
     }
 
+    /// Iterate over the entity topic ids
+    pub fn entity_topic_ids(&self) -> impl Iterator<Item = &EntityTopicId> {
+        self.entities.keys()
+    }
+
     /// Returns information about an entity under a given MQTT entity topic identifier.
     pub fn get(&self, entity_topic_id: &EntityTopicId) -> Option<&EntityMetadata> {
         self.entities.get(entity_topic_id).map(EntityNode::metadata)

crates/core/tedge_api/src/mqtt_topics.rs

@@ -288,7 +288,7 @@ pub enum EntityTopicError {
 ///
 /// # Reference
 /// https://thin-edge.github.io/thin-edge.io/next/references/mqtt-api/#group-identifier
-#[derive(Debug, Clone, Hash, PartialEq, Eq, Deserialize, Serialize)]
+#[derive(Debug, Clone, Hash, Eq, Deserialize, Serialize)]
 #[serde(transparent)]
 pub struct EntityTopicId(String);
 
@@ -309,6 +309,12 @@ impl Display for EntityTopicId {
     }
 }
 
+impl AsRef<str> for EntityTopicId {
+    fn as_ref(&self) -> &str {
+        self.0.as_ref()
+    }
+}
+
 impl FromStr for EntityTopicId {
     type Err = TopicIdError;
 

crates/core/tedge_api/src/store/pending_entity_store.rs

@@ -125,7 +125,7 @@ impl PendingEntityStore {
         for message in telemetry_cache.into_iter() {
             match self.mqtt_schema.entity_channel_of(&message.topic) {
                 Ok((tid, _)) => {
-                    if &tid == entity_tid {
+                    if tid == entity_tid {
                         messages.push(message);
                     } else {
                         self.telemetry_cache.push(message)