test: [torrust#1251] add tests for whitelist is DB drivers

Author: josecelano

packages/tracker-core/src/core_tests.rs

@@ -4,6 +4,7 @@ use std::sync::Arc;
 
 use aquatic_udp_protocol::{AnnounceEvent, NumberOfBytes, PeerId};
 use bittorrent_primitives::info_hash::InfoHash;
+use rand::Rng;
 use torrust_tracker_configuration::Configuration;
 #[cfg(test)]
 use torrust_tracker_configuration::Core;
@@ -20,6 +21,16 @@ use super::torrent::repository::persisted::DatabasePersistentTorrentRepository;
 use super::whitelist::repository::in_memory::InMemoryWhitelist;
 use super::whitelist::{self};
 
+/// Generates a random `InfoHash`.
+#[must_use]
+pub fn random_info_hash() -> InfoHash {
+    let mut rng = rand::rng();
+    let mut random_bytes = [0u8; 20];
+    rng.fill(&mut random_bytes);
+
+    InfoHash::from_bytes(&random_bytes)
+}
+
 /// # Panics
 ///
 /// Will panic if the string representation of the info hash is not a valid info hash.

packages/tracker-core/src/databases/driver/mod.rs

@@ -117,7 +117,10 @@ mod tests {
 
         // Whitelist (for listed trackers)
 
-        // todo
+        handling_the_whitelist::it_should_add_and_get_infohashes(driver);
+        handling_the_whitelist::it_should_remove_an_infohash_from_the_whitelist(driver);
+        handling_the_whitelist::it_should_fail_trying_to_add_the_same_infohash_twice(driver);
+        handling_the_whitelist::it_load_the_whitelist(driver);
 
         driver.drop_database_tables().unwrap();
     }
@@ -129,7 +132,7 @@ mod tests {
             }
             tokio::time::sleep(Duration::from_secs(2)).await;
         }
-        Err("MySQL is not ready after retries.".into())
+        Err("Database is not ready after retries.".into())
     }
 
     mod handling_torrent_persistence {
@@ -162,22 +165,18 @@ mod tests {
         use crate::databases::Database;
 
         pub fn it_should_save_and_load_permanent_authentication_keys(driver: &Arc<Box<dyn Database>>) {
-            // Add a new permanent key
             let peer_key = generate_permanent_key();
             driver.add_key_to_keys(&peer_key).unwrap();
 
-            // Get the key back
             let stored_peer_key = driver.get_key_from_keys(&peer_key.key()).unwrap().unwrap();
 
             assert_eq!(stored_peer_key, peer_key);
         }
 
         pub fn it_should_save_and_load_expiring_authentication_keys(driver: &Arc<Box<dyn Database>>) {
-            // Add a new expiring key
             let peer_key = generate_key(Some(Duration::from_secs(120)));
             driver.add_key_to_keys(&peer_key).unwrap();
 
-            // Get the key back
             let stored_peer_key = driver.get_key_from_keys(&peer_key.key()).unwrap().unwrap();
 
             assert_eq!(stored_peer_key, peer_key);
@@ -186,26 +185,65 @@ mod tests {
 
         pub fn it_should_remove_a_permanent_authentication_key(driver: &Arc<Box<dyn Database>>) {
             let peer_key = generate_permanent_key();
-
-            // Add a new key
             driver.add_key_to_keys(&peer_key).unwrap();
 
-            // Remove the key
             driver.remove_key_from_keys(&peer_key.key()).unwrap();
 
             assert!(driver.get_key_from_keys(&peer_key.key()).unwrap().is_none());
         }
 
         pub fn it_should_remove_an_expiring_authentication_key(driver: &Arc<Box<dyn Database>>) {
             let peer_key = generate_key(Some(Duration::from_secs(120)));
-
-            // Add a new key
             driver.add_key_to_keys(&peer_key).unwrap();
 
-            // Remove the key
             driver.remove_key_from_keys(&peer_key.key()).unwrap();
 
             assert!(driver.get_key_from_keys(&peer_key.key()).unwrap().is_none());
         }
     }
+
+    mod handling_the_whitelist {
+
+        use std::sync::Arc;
+
+        use crate::core_tests::random_info_hash;
+        use crate::databases::Database;
+
+        pub fn it_should_add_and_get_infohashes(driver: &Arc<Box<dyn Database>>) {
+            let infohash = random_info_hash();
+
+            driver.add_info_hash_to_whitelist(infohash).unwrap();
+
+            let stored_infohash = driver.get_info_hash_from_whitelist(infohash).unwrap().unwrap();
+
+            assert_eq!(stored_infohash, infohash);
+        }
+
+        pub fn it_should_remove_an_infohash_from_the_whitelist(driver: &Arc<Box<dyn Database>>) {
+            let infohash = random_info_hash();
+            driver.add_info_hash_to_whitelist(infohash).unwrap();
+
+            driver.remove_info_hash_from_whitelist(infohash).unwrap();
+
+            assert!(driver.get_info_hash_from_whitelist(infohash).unwrap().is_none());
+        }
+
+        pub fn it_should_fail_trying_to_add_the_same_infohash_twice(driver: &Arc<Box<dyn Database>>) {
+            let infohash = random_info_hash();
+
+            driver.add_info_hash_to_whitelist(infohash).unwrap();
+            let result = driver.add_info_hash_to_whitelist(infohash);
+
+            assert!(result.is_err());
+        }
+
+        pub fn it_load_the_whitelist(driver: &Arc<Box<dyn Database>>) {
+            let infohash = random_info_hash();
+            driver.add_info_hash_to_whitelist(infohash).unwrap();
+
+            let whitelist = driver.load_whitelist().unwrap();
+
+            assert!(whitelist.contains(&infohash));
+        }
+    }
 }