test: [#1358] add tests for events in torrent-repository pkg

Author: josecelano

packages/torrent-repository/src/event.rs

@@ -83,3 +83,29 @@ pub mod bus {
 
     pub type EventBus = torrust_tracker_events::bus::EventBus<Event>;
 }
+
+#[cfg(test)]
+pub mod test {
+
+    use torrust_tracker_primitives::peer::Peer;
+
+    use super::Event;
+    use crate::tests::sample_info_hash;
+
+    #[test]
+    fn events_should_be_comparable() {
+        let info_hash = sample_info_hash();
+
+        let event1 = Event::TorrentAdded {
+            info_hash,
+            announcement: Peer::default(),
+        };
+
+        let event2 = Event::TorrentRemoved { info_hash };
+
+        let event1_clone = event1.clone();
+
+        assert!(event1 == event1_clone);
+        assert!(event1 != event2);
+    }
+}

packages/torrent-repository/src/statistics/event/handler.rs

@@ -13,6 +13,7 @@ use crate::statistics::{
 
 pub async fn handle_event(event: Event, stats_repository: &Arc<Repository>, now: DurationSinceUnixEpoch) {
     match event {
+        // Torrent events
         Event::TorrentAdded { info_hash, .. } => {
             tracing::debug!(info_hash = ?info_hash, "Torrent added",);
 
@@ -27,6 +28,8 @@ pub async fn handle_event(event: Event, stats_repository: &Arc<Repository>, now:
                 .decrement_gauge(&metric_name!(TORRENT_REPOSITORY_TORRENTS_TOTAL), &LabelSet::default(), now)
                 .await;
         }
+
+        // Peer events
         Event::PeerAdded { info_hash, peer } => {
             tracing::debug!(info_hash = ?info_hash, peer = ?peer, "Peer added", );
 
@@ -96,3 +99,168 @@ fn label_set_for_peer(peer: &Peer) -> LabelSet {
         (label_name!("peer_role"), LabelValue::new("leecher")).into()
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use std::sync::Arc;
+
+    use torrust_tracker_metrics::label::LabelSet;
+    use torrust_tracker_metrics::metric::MetricName;
+
+    use crate::statistics::repository::Repository;
+
+    async fn expect_metric_to_be(
+        stats_repository: &Arc<Repository>,
+        metric_name: &MetricName,
+        label_set: &LabelSet,
+        expected_value: f64,
+    ) {
+        let torrents_total = stats_repository
+            .get_metrics()
+            .await
+            .metric_collection
+            .get_gauge_value(metric_name, label_set)
+            .unwrap()
+            .value();
+
+        assert_eq!(torrents_total.to_string(), expected_value.to_string());
+    }
+
+    mod for_torrent_events {
+
+        use std::sync::Arc;
+
+        use torrust_tracker_clock::clock::stopped::Stopped;
+        use torrust_tracker_clock::clock::{self, Time};
+        use torrust_tracker_metrics::label::LabelSet;
+        use torrust_tracker_metrics::metric_name;
+
+        use crate::event::Event;
+        use crate::statistics::event::handler::handle_event;
+        use crate::statistics::event::handler::tests::expect_metric_to_be;
+        use crate::statistics::repository::Repository;
+        use crate::statistics::TORRENT_REPOSITORY_TORRENTS_TOTAL;
+        use crate::tests::{sample_info_hash, sample_peer};
+        use crate::CurrentClock;
+
+        #[tokio::test]
+        async fn it_should_increment_the_number_of_torrents_when_a_torrent_added_event_is_received() {
+            clock::Stopped::local_set_to_unix_epoch();
+
+            let stats_repository = Arc::new(Repository::new());
+
+            handle_event(
+                Event::TorrentAdded {
+                    info_hash: sample_info_hash(),
+                    announcement: sample_peer(),
+                },
+                &stats_repository,
+                CurrentClock::now(),
+            )
+            .await;
+
+            expect_metric_to_be(
+                &stats_repository,
+                &metric_name!(TORRENT_REPOSITORY_TORRENTS_TOTAL),
+                &LabelSet::default(),
+                1.0,
+            )
+            .await;
+        }
+
+        #[tokio::test]
+        async fn it_should_decrement_the_number_of_torrents_when_a_torrent_removed_event_is_received() {
+            clock::Stopped::local_set_to_unix_epoch();
+
+            let stats_repository = Arc::new(Repository::new());
+            let metric_name = metric_name!(TORRENT_REPOSITORY_TORRENTS_TOTAL);
+            let label_set = LabelSet::default();
+
+            // Increment the gauge first to simulate a torrent being added.
+            stats_repository
+                .increment_gauge(&metric_name, &label_set, CurrentClock::now())
+                .await
+                .unwrap();
+
+            handle_event(
+                Event::TorrentRemoved {
+                    info_hash: sample_info_hash(),
+                },
+                &stats_repository,
+                CurrentClock::now(),
+            )
+            .await;
+
+            expect_metric_to_be(&stats_repository, &metric_name, &label_set, 0.0).await;
+        }
+    }
+
+    mod for_peer_events {
+
+        use std::sync::Arc;
+
+        use torrust_tracker_clock::clock::stopped::Stopped;
+        use torrust_tracker_clock::clock::{self, Time};
+        use torrust_tracker_metrics::label::LabelValue;
+        use torrust_tracker_metrics::{label_name, metric_name};
+
+        use crate::event::Event;
+        use crate::statistics::event::handler::handle_event;
+        use crate::statistics::event::handler::tests::expect_metric_to_be;
+        use crate::statistics::repository::Repository;
+        use crate::statistics::TORRENT_REPOSITORY_PEER_CONNECTIONS_TOTAL;
+        use crate::tests::{sample_info_hash, sample_peer, seeder};
+        use crate::CurrentClock;
+
+        #[tokio::test]
+        async fn it_should_increment_the_number_of_peer_connections_from_seeders_when_a_peer_added_event_is_received_from_a_seeder(
+        ) {
+            clock::Stopped::local_set_to_unix_epoch();
+
+            let stats_repository = Arc::new(Repository::new());
+            let metric_name = metric_name!(TORRENT_REPOSITORY_PEER_CONNECTIONS_TOTAL);
+            let label_set = (label_name!("peer_role"), LabelValue::new("seeder")).into();
+
+            handle_event(
+                Event::PeerAdded {
+                    info_hash: sample_info_hash(),
+                    peer: seeder(),
+                },
+                &stats_repository,
+                CurrentClock::now(),
+            )
+            .await;
+
+            expect_metric_to_be(&stats_repository, &metric_name, &label_set, 1.0).await;
+        }
+
+        #[tokio::test]
+        async fn it_should_decrement_the_number_of_peer_connections_from_seeders_when_a_peer_removed_event_is_received_from_a_seeder(
+        ) {
+            clock::Stopped::local_set_to_unix_epoch();
+
+            let stats_repository = Arc::new(Repository::new());
+
+            let metric_name = metric_name!(TORRENT_REPOSITORY_PEER_CONNECTIONS_TOTAL);
+            let label_set = (label_name!("peer_role"), LabelValue::new("seeder")).into();
+
+            // Increment the gauge first to simulate a peer being added.
+            stats_repository
+                .increment_gauge(&metric_name, &label_set, CurrentClock::now())
+                .await
+                .unwrap();
+
+            handle_event(
+                Event::PeerRemoved {
+                    info_hash: sample_info_hash(),
+                    peer: sample_peer(),
+                },
+                &stats_repository,
+                CurrentClock::now(),
+            )
+            .await;
+
+            expect_metric_to_be(&stats_repository, &metric_name, &label_set, 0.0).await;
+        }
+    }
+}