refactor: [torrust#1316] UDP tracker integration tests to pkg

Author: josecelano

Cargo.lock

@@ -38,7 +38,6 @@ aquatic_udp_protocol = "0"
 axum-server = { version = "0", features = ["tls-rustls-no-provider"] }
 bittorrent-http-tracker-core = { version = "3.0.0-develop", path = "packages/http-tracker-core" }
 bittorrent-primitives = "0.1.0"
-bittorrent-tracker-client = { version = "3.0.0-develop", path = "packages/tracker-client" }
 bittorrent-tracker-core = { version = "3.0.0-develop", path = "packages/tracker-core" }
 bittorrent-udp-tracker-core = { version = "3.0.0-develop", path = "packages/udp-tracker-core" }
 chrono = { version = "0", default-features = false, features = ["clock"] }

Cargo.toml

@@ -38,4 +38,5 @@ zerocopy = "0.7"
 [dev-dependencies]
 local-ip-address = "0"
 mockall = "0"
+rand = "0"
 torrust-tracker-test-helpers = { version = "3.0.0-develop", path = "../test-helpers" }

packages/udp-tracker-server/Cargo.toml

@@ -7,9 +7,12 @@ use bittorrent_udp_tracker_core::container::UdpTrackerCoreContainer;
 use torrust_server_lib::registar::Registar;
 use torrust_tracker_configuration::{logging, Configuration, DEFAULT_TIMEOUT};
 use torrust_tracker_primitives::peer;
-use torrust_udp_tracker_server::server::spawner::Spawner;
-use torrust_udp_tracker_server::server::states::{Running, Stopped};
-use torrust_udp_tracker_server::server::Server;
+
+use crate::server::spawner::Spawner;
+use crate::server::states::{Running, Stopped};
+use crate::server::Server;
+
+pub type Started = Environment<Running>;
 
 pub struct Environment<S>
 where
@@ -37,6 +40,7 @@ where
 
 impl Environment<Stopped> {
     #[allow(dead_code)]
+    #[must_use]
     pub fn new(configuration: &Arc<Configuration>) -> Self {
         initialize_global_services(configuration);
 
@@ -53,6 +57,9 @@ impl Environment<Stopped> {
         }
     }
 
+    /// # Panics
+    ///
+    /// Will panic if it cannot start the server.
     #[allow(dead_code)]
     pub async fn start(self) -> Environment<Running> {
         let cookie_lifetime = self.container.udp_tracker_core_container.udp_tracker_config.cookie_lifetime;
@@ -74,12 +81,18 @@ impl Environment<Stopped> {
 }
 
 impl Environment<Running> {
+    /// # Panics
+    ///
+    /// Will panic if it cannot start the server within the timeout.
     pub async fn new(configuration: &Arc<Configuration>) -> Self {
         tokio::time::timeout(DEFAULT_TIMEOUT, Environment::<Stopped>::new(configuration).start())
             .await
             .expect("it should create an environment within the timeout")
     }
 
+    /// # Panics
+    ///
+    /// Will panic if it cannot stop the service within the timeout.
     #[allow(dead_code)]
     pub async fn stop(self) -> Environment<Stopped> {
         let stopped = tokio::time::timeout(DEFAULT_TIMEOUT, self.server.stop())
@@ -89,10 +102,11 @@ impl Environment<Running> {
         Environment {
             container: self.container,
             registar: Registar::default(),
-            server: stopped.expect("it stop the udp tracker service"),
+            server: stopped.expect("it should stop the udp tracker service"),
         }
     }
 
+    #[must_use]
     pub fn bind_address(&self) -> SocketAddr {
         self.server.state.local_addr
     }
@@ -104,6 +118,10 @@ pub struct EnvContainer {
 }
 
 impl EnvContainer {
+    /// # Panics
+    ///
+    /// Will panic if the configuration is missing the UDP tracker configuration.
+    #[must_use]
     pub fn initialize(configuration: &Configuration) -> Self {
         let core_config = Arc::new(configuration.core.clone());
         let udp_tracker_configurations = configuration.udp_trackers.clone().expect("missing UDP tracker configuration");
@@ -134,10 +152,9 @@ mod tests {
     use std::time::Duration;
 
     use tokio::time::sleep;
-    use torrust_tracker_test_helpers::configuration;
+    use torrust_tracker_test_helpers::{configuration, logging};
 
-    use crate::common::logging;
-    use crate::servers::udp::Started;
+    use crate::environment::Started;
 
     #[tokio::test]
     async fn it_should_make_and_stop_udp_server() {

tests/servers/udp/environment.rs packages/udp-tracker-server/src/environment.rs

@@ -634,15 +634,15 @@
 //! documentation by [Arvid Norberg](https://github.com/arvidn) was very
 //! supportive in the development of this documentation. Some descriptions were
 //! taken from the [libtorrent](https://www.rasterbar.com/products/libtorrent/udp_tracker_protocol.html).
+pub mod environment;
+pub mod error;
+pub mod handlers;
+pub mod server;
 
 use std::net::SocketAddr;
 
 use torrust_tracker_clock::clock;
 
-pub mod error;
-pub mod handlers;
-pub mod server;
-
 /// The maximum number of bytes in a UDP packet.
 pub const MAX_PACKET_SIZE: usize = 1496;
 

packages/udp-tracker-server/src/lib.rs

@@ -0,0 +1,17 @@
+use aquatic_udp_protocol::TransactionId;
+use bittorrent_primitives::info_hash::InfoHash;
+use rand::prelude::*;
+
+/// Returns a random info hash.
+pub fn random_info_hash() -> InfoHash {
+    let mut rng = rand::thread_rng();
+    let random_bytes: [u8; 20] = rng.gen();
+
+    InfoHash::from_bytes(&random_bytes)
+}
+
+/// Returns a random transaction id.
+pub fn random_transaction_id() -> TransactionId {
+    let random_value = rand::thread_rng().gen();
+    TransactionId::new(random_value)
+}

packages/udp-tracker-server/tests/common/fixtures.rs

@@ -0,0 +1,2 @@
+pub mod fixtures;
+pub mod udp;

packages/udp-tracker-server/tests/common/mod.rs

@@ -0,0 +1,41 @@
+use std::net::SocketAddr;
+use std::sync::Arc;
+
+use tokio::net::UdpSocket;
+
+/// A generic UDP client
+pub struct Client {
+    pub socket: Arc<UdpSocket>,
+}
+
+impl Client {
+    #[allow(dead_code)]
+    pub async fn connected(remote_socket_addr: &SocketAddr, local_socket_addr: &SocketAddr) -> Client {
+        let client = Client::bind(local_socket_addr).await;
+        client.connect(remote_socket_addr).await;
+        client
+    }
+
+    pub async fn bind(local_socket_addr: &SocketAddr) -> Self {
+        let socket = UdpSocket::bind(local_socket_addr).await.unwrap();
+        Self {
+            socket: Arc::new(socket),
+        }
+    }
+
+    pub async fn connect(&self, remote_address: &SocketAddr) {
+        self.socket.connect(remote_address).await.unwrap();
+    }
+
+    #[allow(dead_code)]
+    pub async fn send(&self, bytes: &[u8]) -> usize {
+        self.socket.writable().await.unwrap();
+        self.socket.send(bytes).await.unwrap()
+    }
+
+    #[allow(dead_code)]
+    pub async fn receive(&self, bytes: &mut [u8]) -> usize {
+        self.socket.readable().await.unwrap();
+        self.socket.recv(bytes).await.unwrap()
+    }
+}

packages/udp-tracker-server/tests/common/udp.rs

@@ -0,0 +1,20 @@
+//! Integration tests.
+//!
+//! ```text
+//! cargo test --test integration
+//! ```
+mod common;
+mod server;
+
+use torrust_tracker_clock::clock;
+
+/// This code needs to be copied into each crate.
+/// Working version, for production.
+#[cfg(not(test))]
+#[allow(dead_code)]
+pub(crate) type CurrentClock = clock::Working;
+
+/// Stopped version, for testing.
+#[cfg(test)]
+#[allow(dead_code)]
+pub(crate) type CurrentClock = clock::Stopped;

packages/udp-tracker-server/tests/integration.rs

@@ -8,12 +8,10 @@ use core::panic;
 use aquatic_udp_protocol::{ConnectRequest, ConnectionId, Response, TransactionId};
 use bittorrent_tracker_client::udp::client::UdpTrackerClient;
 use torrust_tracker_configuration::DEFAULT_TIMEOUT;
-use torrust_tracker_test_helpers::configuration;
+use torrust_tracker_test_helpers::{configuration, logging};
 use torrust_udp_tracker_server::MAX_PACKET_SIZE;
 
-use crate::common::logging;
-use crate::servers::udp::asserts::get_error_response_message;
-use crate::servers::udp::Started;
+use crate::server::asserts::get_error_response_message;
 
 fn empty_udp_request() -> [u8; MAX_PACKET_SIZE] {
     [0; MAX_PACKET_SIZE]
@@ -42,7 +40,7 @@ async fn send_connection_request(transaction_id: TransactionId, client: &UdpTrac
 async fn should_return_a_bad_request_response_when_the_client_sends_an_empty_request() {
     logging::setup();
 
-    let env = Started::new(&configuration::ephemeral().into()).await;
+    let env = torrust_udp_tracker_server::environment::Started::new(&configuration::ephemeral().into()).await;
 
     let client = match UdpTrackerClient::new(env.bind_address(), DEFAULT_TIMEOUT).await {
         Ok(udp_client) => udp_client,
@@ -70,17 +68,15 @@ mod receiving_a_connection_request {
     use aquatic_udp_protocol::{ConnectRequest, TransactionId};
     use bittorrent_tracker_client::udp::client::UdpTrackerClient;
     use torrust_tracker_configuration::DEFAULT_TIMEOUT;
-    use torrust_tracker_test_helpers::configuration;
+    use torrust_tracker_test_helpers::{configuration, logging};
 
-    use crate::common::logging;
-    use crate::servers::udp::asserts::is_connect_response;
-    use crate::servers::udp::Started;
+    use crate::server::asserts::is_connect_response;
 
     #[tokio::test]
     async fn should_return_a_connect_response() {
         logging::setup();
 
-        let env = Started::new(&configuration::ephemeral().into()).await;
+        let env = torrust_udp_tracker_server::environment::Started::new(&configuration::ephemeral().into()).await;
 
         let client = match UdpTrackerClient::new(env.bind_address(), DEFAULT_TIMEOUT).await {
             Ok(udp_tracker_client) => udp_tracker_client,
@@ -116,13 +112,12 @@ mod receiving_an_announce_request {
     };
     use bittorrent_tracker_client::udp::client::UdpTrackerClient;
     use torrust_tracker_configuration::DEFAULT_TIMEOUT;
-    use torrust_tracker_test_helpers::configuration;
+    use torrust_tracker_test_helpers::logging::logs_contains_a_line_with;
+    use torrust_tracker_test_helpers::{configuration, logging};
 
     use crate::common::fixtures::{random_info_hash, random_transaction_id};
-    use crate::common::logging::{self, logs_contains_a_line_with};
-    use crate::servers::udp::asserts::is_ipv4_announce_response;
-    use crate::servers::udp::contract::send_connection_request;
-    use crate::servers::udp::Started;
+    use crate::server::asserts::is_ipv4_announce_response;
+    use crate::server::contract::send_connection_request;
 
     pub async fn assert_send_and_get_announce(
         tx_id: TransactionId,
@@ -181,7 +176,7 @@ mod receiving_an_announce_request {
     async fn should_return_an_announce_response() {
         logging::setup();
 
-        let env = Started::new(&configuration::ephemeral().into()).await;
+        let env = torrust_udp_tracker_server::environment::Started::new(&configuration::ephemeral().into()).await;
 
         let client = match UdpTrackerClient::new(env.bind_address(), DEFAULT_TIMEOUT).await {
             Ok(udp_tracker_client) => udp_tracker_client,
@@ -203,7 +198,7 @@ mod receiving_an_announce_request {
     async fn should_return_many_announce_response() {
         logging::setup();
 
-        let env = Started::new(&configuration::ephemeral().into()).await;
+        let env = torrust_udp_tracker_server::environment::Started::new(&configuration::ephemeral().into()).await;
 
         let client = match UdpTrackerClient::new(env.bind_address(), DEFAULT_TIMEOUT).await {
             Ok(udp_tracker_client) => udp_tracker_client,
@@ -228,7 +223,7 @@ mod receiving_an_announce_request {
     async fn should_ban_the_client_ip_if_it_sends_more_than_10_requests_with_a_cookie_value_not_normal() {
         logging::setup();
 
-        let env = Started::new(&configuration::ephemeral().into()).await;
+        let env = torrust_udp_tracker_server::environment::Started::new(&configuration::ephemeral().into()).await;
         let ban_service = env.container.udp_tracker_core_container.ban_service.clone();
 
         let client = match UdpTrackerClient::new(env.bind_address(), DEFAULT_TIMEOUT).await {
@@ -309,18 +304,16 @@ mod receiving_an_scrape_request {
     use aquatic_udp_protocol::{ConnectionId, InfoHash, ScrapeRequest, TransactionId};
     use bittorrent_tracker_client::udp::client::UdpTrackerClient;
     use torrust_tracker_configuration::DEFAULT_TIMEOUT;
-    use torrust_tracker_test_helpers::configuration;
+    use torrust_tracker_test_helpers::{configuration, logging};
 
-    use crate::common::logging;
-    use crate::servers::udp::asserts::is_scrape_response;
-    use crate::servers::udp::contract::send_connection_request;
-    use crate::servers::udp::Started;
+    use crate::server::asserts::is_scrape_response;
+    use crate::server::contract::send_connection_request;
 
     #[tokio::test]
     async fn should_return_a_scrape_response() {
         logging::setup();
 
-        let env = Started::new(&configuration::ephemeral().into()).await;
+        let env = torrust_udp_tracker_server::environment::Started::new(&configuration::ephemeral().into()).await;
 
         let client = match UdpTrackerClient::new(env.bind_address(), DEFAULT_TIMEOUT).await {
             Ok(udp_tracker_client) => udp_tracker_client,

tests/servers/udp/asserts.rs packages/udp-tracker-server/tests/server/asserts.rs

@@ -0,0 +1,2 @@
+pub mod asserts;
+pub mod contract;

tests/servers/udp/contract.rs packages/udp-tracker-server/tests/server/contract.rs

@@ -1,4 +1,3 @@
-use aquatic_udp_protocol::TransactionId;
 use bittorrent_primitives::info_hash::InfoHash;
 
 #[allow(dead_code)]
@@ -21,9 +20,3 @@ pub fn random_info_hash() -> InfoHash {
 
     InfoHash::from_bytes(&random_bytes)
 }
-
-/// Returns a random transaction id.
-pub fn random_transaction_id() -> TransactionId {
-    let random_value = rand::Rng::random::<i32>(&mut rand::rng());
-    TransactionId::new(random_value)
-}

packages/udp-tracker-server/tests/server/mod.rs

@@ -225,15 +225,14 @@ mod udp {
 
     use crate::common::logging;
     use crate::servers::health_check_api::client::get;
-    use crate::servers::udp;
 
     #[tokio::test]
     pub(crate) async fn it_should_return_good_health_for_udp_service() {
         logging::setup();
 
         let configuration = Arc::new(configuration::ephemeral());
 
-        let service = udp::Started::new(&configuration).await;
+        let service = torrust_udp_tracker_server::environment::Started::new(&configuration).await;
 
         let registar = service.registar.clone();
 
@@ -276,7 +275,7 @@ mod udp {
 
         let configuration = Arc::new(configuration::ephemeral());
 
-        let service = udp::Started::new(&configuration).await;
+        let service = torrust_udp_tracker_server::environment::Started::new(&configuration).await;
 
         let binding = service.bind_address();
 

tests/common/fixtures.rs

@@ -1,3 +1,2 @@
 mod health_check_api;
 mod http;
-mod udp;