Merge #1242: Overhaul core Tracker: add tests for torrent mod

21c865d test: [#1240] add tests for bittorrent_tracker_core::torrent::services (Jose Celano)
ef87954 refactor: minor changes (Jose Celano)
0d0c601 test: [#1240] add tests for TorrentsManager (Jose Celano)
6a15e06 test: [#1240] add tests for DatabasePersistentTorrentRepository (Jose Celano)
f048157 test: [#1240] add tests for InMemoryTorrentRepository (Jose Celano)
4198bc6 refactor: [#1240] reorganize InMemoryTorrentRepository tests (Jose Celano)
ed13294 docs: add testing section to README (Jose Celano)

Pull request description:

  Overhaul core Tracker: add tests for `torrent` mod

  ### Sub-tasks

  - [x] `repository` mod.
    - [x] `in_memory` mod.
    - [x] `persisted` mod.
  - [x] `manager` mod.
  - [x] `services` mod.

ACKs for top commit:
  josecelano:
    ACK 21c865d

Tree-SHA512: 17c37cd853dac1934b65fc8afd1592e3e2adccecde532c4dd477c809037d911fa195ddb79d18b5b33f9aef8a499250acdef92b1ad1c232b5aa5b31db9525ee4c

Author: josecelano

packages/primitives/src/lib.rs

@@ -18,4 +18,5 @@ use bittorrent_primitives::info_hash::InfoHash;
 /// Duration since the Unix Epoch.
 pub type DurationSinceUnixEpoch = Duration;
 
-pub type PersistentTorrents = BTreeMap<InfoHash, u32>;
+pub type PersistentTorrent = u32;
+pub type PersistentTorrents = BTreeMap<InfoHash, PersistentTorrent>;

packages/tracker-core/README.md

@@ -10,6 +10,22 @@ You usually don’t need to use this library directly. Instead, you should use t
 
 [Crate documentation](https://docs.rs/bittorrent-tracker-core).
 
+## Testing
+
+Show coverage report:
+
+```console
+cargo +stable llvm-cov
+```
+
+Export coverage report to `lcov` format:
+
+```console
+cargo +stable llvm-cov --lcov --output-path=./.coverage/lcov.info
+```
+
+If you use Visual Studio Code, you can use the [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=semasquare.vscode-coverage-gutters) extension to view the coverage lines.
+
 ## License
 
 The project is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](./LICENSE).

packages/tracker-core/src/announce_handler.rs

@@ -82,17 +82,11 @@ impl AnnounceHandler {
     /// needed for a `announce` request response.
     #[must_use]
     fn upsert_peer_and_get_stats(&self, info_hash: &InfoHash, peer: &peer::Peer) -> SwarmMetadata {
-        let swarm_metadata_before = match self.in_memory_torrent_repository.get_opt_swarm_metadata(info_hash) {
-            Some(swarm_metadata) => swarm_metadata,
-            None => SwarmMetadata::zeroed(),
-        };
+        let swarm_metadata_before = self.in_memory_torrent_repository.get_swarm_metadata(info_hash);
 
         self.in_memory_torrent_repository.upsert_peer(info_hash, peer);
 
-        let swarm_metadata_after = match self.in_memory_torrent_repository.get_opt_swarm_metadata(info_hash) {
-            Some(swarm_metadata) => swarm_metadata,
-            None => SwarmMetadata::zeroed(),
-        };
+        let swarm_metadata_after = self.in_memory_torrent_repository.get_swarm_metadata(info_hash);
 
         if swarm_metadata_before != swarm_metadata_after {
             self.persist_stats(info_hash, &swarm_metadata_after);

packages/tracker-core/src/core_tests.rs

@@ -30,10 +30,74 @@ pub fn sample_info_hash() -> InfoHash {
         .expect("String should be a valid info hash")
 }
 
+/// # Panics
+///
+/// Will panic if the string representation of the info hash is not a valid info hash.
+#[must_use]
+pub fn sample_info_hash_one() -> InfoHash {
+    "3b245504cf5f11bbdbe1201cea6a6bf45aee1bc0" // DevSkim: ignore DS173237
+        .parse::<InfoHash>()
+        .expect("String should be a valid info hash")
+}
+
+/// # Panics
+///
+/// Will panic if the string representation of the info hash is not a valid info hash.
+#[must_use]
+pub fn sample_info_hash_two() -> InfoHash {
+    "99c82bb73505a3c0b453f9fa0e881d6e5a32a0c1" // DevSkim: ignore DS173237
+        .parse::<InfoHash>()
+        .expect("String should be a valid info hash")
+}
+
+/// # Panics
+///
+/// Will panic if the string representation of the info hash is not a valid info hash.
+#[must_use]
+pub fn sample_info_hash_alphabetically_ordered_after_sample_info_hash_one() -> InfoHash {
+    "99c82bb73505a3c0b453f9fa0e881d6e5a32a0c1" // DevSkim: ignore DS173237
+        .parse::<InfoHash>()
+        .expect("String should be a valid info hash")
+}
+
 /// Sample peer whose state is not relevant for the tests.
 #[must_use]
 pub fn sample_peer() -> Peer {
-    complete_peer()
+    Peer {
+        peer_id: PeerId(*b"-qB00000000000000000"),
+        peer_addr: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(126, 0, 0, 1)), 8080),
+        updated: DurationSinceUnixEpoch::new(1_669_397_478_934, 0),
+        uploaded: NumberOfBytes::new(0),
+        downloaded: NumberOfBytes::new(0),
+        left: NumberOfBytes::new(0), // No bytes left to download
+        event: AnnounceEvent::Completed,
+    }
+}
+
+#[must_use]
+pub fn sample_peer_one() -> Peer {
+    Peer {
+        peer_id: PeerId(*b"-qB00000000000000001"),
+        peer_addr: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(126, 0, 0, 1)), 8081),
+        updated: DurationSinceUnixEpoch::new(1_669_397_478_934, 0),
+        uploaded: NumberOfBytes::new(0),
+        downloaded: NumberOfBytes::new(0),
+        left: NumberOfBytes::new(0), // No bytes left to download
+        event: AnnounceEvent::Completed,
+    }
+}
+
+#[must_use]
+pub fn sample_peer_two() -> Peer {
+    Peer {
+        peer_id: PeerId(*b"-qB00000000000000002"),
+        peer_addr: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(126, 0, 0, 2)), 8082),
+        updated: DurationSinceUnixEpoch::new(1_669_397_478_934, 0),
+        uploaded: NumberOfBytes::new(0),
+        downloaded: NumberOfBytes::new(0),
+        left: NumberOfBytes::new(0), // No bytes left to download
+        event: AnnounceEvent::Completed,
+    }
 }
 
 #[must_use]
@@ -110,7 +174,21 @@ pub fn initialize_handlers(config: &Configuration) -> (Arc<AnnounceHandler>, Arc
 
 /// # Panics
 ///
-/// Will panic if the temporary file path is not a valid UFT string.
+/// Will panic if the temporary database file path is not a valid UFT string.
+#[cfg(test)]
+#[must_use]
+pub fn ephemeral_configuration() -> Core {
+    let mut config = Core::default();
+
+    let temp_file = ephemeral_sqlite_database();
+    temp_file.to_str().unwrap().clone_into(&mut config.database.path);
+
+    config
+}
+
+/// # Panics
+///
+/// Will panic if the temporary database file path is not a valid UFT string.
 #[cfg(test)]
 #[must_use]
 pub fn ephemeral_configuration_for_listed_tracker() -> Core {

packages/tracker-core/src/torrent/manager.rs

@@ -61,3 +61,151 @@ impl TorrentsManager {
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+
+    use std::sync::Arc;
+
+    use torrust_tracker_configuration::Core;
+    use torrust_tracker_torrent_repository::entry::EntrySync;
+
+    use super::{DatabasePersistentTorrentRepository, TorrentsManager};
+    use crate::core_tests::{ephemeral_configuration, sample_info_hash};
+    use crate::databases::setup::initialize_database;
+    use crate::torrent::repository::in_memory::InMemoryTorrentRepository;
+
+    struct TorrentsManagerDeps {
+        config: Arc<Core>,
+        in_memory_torrent_repository: Arc<InMemoryTorrentRepository>,
+        database_persistent_torrent_repository: Arc<DatabasePersistentTorrentRepository>,
+    }
+
+    fn initialize_torrents_manager() -> (Arc<TorrentsManager>, Arc<TorrentsManagerDeps>) {
+        let config = ephemeral_configuration();
+        initialize_torrents_manager_with(config.clone())
+    }
+
+    fn initialize_torrents_manager_with(config: Core) -> (Arc<TorrentsManager>, Arc<TorrentsManagerDeps>) {
+        let in_memory_torrent_repository = Arc::new(InMemoryTorrentRepository::default());
+        let database = initialize_database(&config);
+        let database_persistent_torrent_repository = Arc::new(DatabasePersistentTorrentRepository::new(&database));
+
+        let torrents_manager = Arc::new(TorrentsManager::new(
+            &config,
+            &in_memory_torrent_repository,
+            &database_persistent_torrent_repository,
+        ));
+
+        (
+            torrents_manager,
+            Arc::new(TorrentsManagerDeps {
+                config: Arc::new(config),
+                in_memory_torrent_repository,
+                database_persistent_torrent_repository,
+            }),
+        )
+    }
+
+    #[test]
+    fn it_should_load_the_numbers_of_downloads_for_all_torrents_from_the_database() {
+        let (torrents_manager, services) = initialize_torrents_manager();
+
+        let infohash = sample_info_hash();
+
+        services.database_persistent_torrent_repository.save(&infohash, 1).unwrap();
+
+        torrents_manager.load_torrents_from_database().unwrap();
+
+        assert_eq!(
+            services
+                .in_memory_torrent_repository
+                .get(&infohash)
+                .unwrap()
+                .get_swarm_metadata()
+                .downloaded,
+            1
+        );
+    }
+
+    mod cleaning_torrents {
+        use std::ops::Add;
+        use std::sync::Arc;
+        use std::time::Duration;
+
+        use bittorrent_primitives::info_hash::InfoHash;
+        use torrust_tracker_clock::clock::stopped::Stopped;
+        use torrust_tracker_clock::clock::{self};
+        use torrust_tracker_primitives::DurationSinceUnixEpoch;
+
+        use crate::core_tests::{ephemeral_configuration, sample_info_hash, sample_peer};
+        use crate::torrent::manager::tests::{initialize_torrents_manager, initialize_torrents_manager_with};
+        use crate::torrent::repository::in_memory::InMemoryTorrentRepository;
+
+        #[test]
+        fn it_should_remove_peers_that_have_not_been_updated_after_a_cutoff_time() {
+            let (torrents_manager, services) = initialize_torrents_manager();
+
+            let infohash = sample_info_hash();
+
+            clock::Stopped::local_set(&Duration::from_secs(0));
+
+            // Add a peer to the torrent
+            let mut peer = sample_peer();
+            peer.updated = DurationSinceUnixEpoch::new(0, 0);
+            let () = services.in_memory_torrent_repository.upsert_peer(&infohash, &peer);
+
+            // Simulate the time has passed 1 second more than the max peer timeout.
+            clock::Stopped::local_add(&Duration::from_secs(
+                (services.config.tracker_policy.max_peer_timeout + 1).into(),
+            ))
+            .unwrap();
+
+            torrents_manager.cleanup_torrents();
+
+            assert!(services.in_memory_torrent_repository.get(&infohash).is_none());
+        }
+
+        fn add_a_peerless_torrent(infohash: &InfoHash, in_memory_torrent_repository: &Arc<InMemoryTorrentRepository>) {
+            // Add a peer to the torrent
+            let mut peer = sample_peer();
+            peer.updated = DurationSinceUnixEpoch::new(0, 0);
+            let () = in_memory_torrent_repository.upsert_peer(infohash, &peer);
+
+            // Remove the peer. The torrent is now peerless.
+            in_memory_torrent_repository.remove_inactive_peers(peer.updated.add(Duration::from_secs(1)));
+        }
+
+        #[test]
+        fn it_should_remove_torrents_that_have_no_peers_when_it_is_configured_to_do_so() {
+            let mut config = ephemeral_configuration();
+            config.tracker_policy.remove_peerless_torrents = true;
+
+            let (torrents_manager, services) = initialize_torrents_manager_with(config);
+
+            let infohash = sample_info_hash();
+
+            add_a_peerless_torrent(&infohash, &services.in_memory_torrent_repository);
+
+            torrents_manager.cleanup_torrents();
+
+            assert!(services.in_memory_torrent_repository.get(&infohash).is_none());
+        }
+
+        #[test]
+        fn it_should_retain_peerless_torrents_when_it_is_configured_to_do_so() {
+            let mut config = ephemeral_configuration();
+            config.tracker_policy.remove_peerless_torrents = false;
+
+            let (torrents_manager, services) = initialize_torrents_manager_with(config);
+
+            let infohash = sample_info_hash();
+
+            add_a_peerless_torrent(&infohash, &services.in_memory_torrent_repository);
+
+            torrents_manager.cleanup_torrents();
+
+            assert!(services.in_memory_torrent_repository.get(&infohash).is_some());
+        }
+    }
+}

packages/tracker-core/src/torrent/mod.rs

@@ -29,6 +29,8 @@ pub mod manager;
 pub mod repository;
 pub mod services;
 
-use torrust_tracker_torrent_repository::TorrentsSkipMapMutexStd;
+use torrust_tracker_torrent_repository::{EntryMutexStd, TorrentsSkipMapMutexStd};
 
-pub type Torrents = TorrentsSkipMapMutexStd; // Currently Used
+// Currently used types from the torrent repository crate.
+pub type Torrents = TorrentsSkipMapMutexStd;
+pub type TorrentEntry = EntryMutexStd;