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

Author: josecelano

Cargo.lock

@@ -34,10 +34,8 @@ version = "3.0.0-develop"
 
 [dependencies]
 anyhow = "1"
-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-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"] }
@@ -47,18 +45,15 @@ dashmap = "6"
 figment = "0"
 futures = "0"
 parking_lot = "0"
-percent-encoding = "2"
 r2d2 = "0"
 r2d2_mysql = "25"
 r2d2_sqlite = { version = "0", features = ["bundled"] }
 rand = "0"
 regex = "1"
 reqwest = { version = "0", features = ["json"] }
 serde = { version = "1", features = ["derive"] }
-serde_bencode = "0"
 serde_bytes = "0"
 serde_json = { version = "1", features = ["preserve_order"] }
-serde_repr = "0"
 tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
 torrust-axum-health-check-api-server = { version = "3.0.0-develop", path = "packages/axum-health-check-api-server" }
 torrust-axum-http-tracker-server = { version = "3.0.0-develop", path = "packages/axum-http-tracker-server" }
@@ -68,13 +63,10 @@ torrust-server-lib = { version = "3.0.0-develop", path = "packages/server-lib" }
 torrust-tracker-api-core = { version = "3.0.0-develop", path = "packages/tracker-api-core" }
 torrust-tracker-clock = { version = "3.0.0-develop", path = "packages/clock" }
 torrust-tracker-configuration = { version = "3.0.0-develop", path = "packages/configuration" }
-torrust-tracker-primitives = { version = "3.0.0-develop", path = "packages/primitives" }
 torrust-tracker-torrent-repository = { version = "3.0.0-develop", path = "packages/torrent-repository" }
 torrust-udp-tracker-server = { version = "3.0.0-develop", path = "packages/udp-tracker-server" }
 tracing = "0"
 tracing-subscriber = { version = "0", features = ["json"] }
-uuid = { version = "1", features = ["v4"] }
-zerocopy = "0.7"
 
 [package.metadata.cargo-machete]
 ignored = [

Cargo.toml

@@ -30,12 +30,21 @@ serde = { version = "1", features = ["derive"] }
 tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
 torrust-axum-server = { version = "3.0.0-develop", path = "../axum-server" }
 torrust-server-lib = { version = "3.0.0-develop", path = "../server-lib" }
+torrust-tracker-clock = { version = "3.0.0-develop", path = "../clock" }
 torrust-tracker-configuration = { version = "3.0.0-develop", path = "../configuration" }
 torrust-tracker-primitives = { version = "3.0.0-develop", path = "../primitives" }
 tower = { version = "0", features = ["timeout"] }
 tower-http = { version = "0", features = ["compression-full", "cors", "propagate-header", "request-id", "trace"] }
 tracing = "0"
 
 [dev-dependencies]
+local-ip-address = "0"
+percent-encoding = "2"
+rand = "0"
+serde_bencode = "0"
+serde_bytes = "0"
+serde_repr = "0"
 torrust-tracker-clock = { version = "3.0.0-develop", path = "../clock" }
 torrust-tracker-test-helpers = { version = "3.0.0-develop", path = "../test-helpers" }
+uuid = { version = "1", features = ["v4"] }
+zerocopy = "0.7"

packages/axum-http-tracker-server/Cargo.toml

@@ -4,12 +4,15 @@ use bittorrent_http_tracker_core::container::HttpTrackerCoreContainer;
 use bittorrent_primitives::info_hash::InfoHash;
 use bittorrent_tracker_core::container::TrackerCoreContainer;
 use futures::executor::block_on;
-use torrust_axum_http_tracker_server::server::{HttpServer, Launcher, Running, Stopped};
 use torrust_axum_server::tsl::make_rust_tls;
 use torrust_server_lib::registar::Registar;
 use torrust_tracker_configuration::{logging, Configuration};
 use torrust_tracker_primitives::peer;
 
+use crate::server::{HttpServer, Launcher, Running, Stopped};
+
+pub type Started = Environment<Running>;
+
 pub struct Environment<S> {
     pub container: Arc<EnvContainer>,
     pub registar: Registar,
@@ -28,7 +31,11 @@ impl<S> Environment<S> {
 }
 
 impl Environment<Stopped> {
+    /// # Panics
+    ///
+    /// Will panic if it fails to make the TSL config from the configuration.
     #[allow(dead_code)]
+    #[must_use]
     pub fn new(configuration: &Arc<Configuration>) -> Self {
         initialize_global_services(configuration);
 
@@ -50,6 +57,9 @@ impl Environment<Stopped> {
         }
     }
 
+    /// # Panics
+    ///
+    /// Will panic if the server fails to start.    
     #[allow(dead_code)]
     pub async fn start(self) -> Environment<Running> {
         Environment {
@@ -69,6 +79,9 @@ impl Environment<Running> {
         Environment::<Stopped>::new(configuration).start().await
     }
 
+    /// # Panics
+    ///
+    /// Will panic if the server fails to stop.
     pub async fn stop(self) -> Environment<Stopped> {
         Environment {
             container: self.container,
@@ -77,6 +90,7 @@ impl Environment<Running> {
         }
     }
 
+    #[must_use]
     pub fn bind_address(&self) -> &std::net::SocketAddr {
         &self.server.state.binding
     }
@@ -88,6 +102,10 @@ pub struct EnvContainer {
 }
 
 impl EnvContainer {
+    /// # Panics
+    ///
+    /// Will panic if the configuration is missing the HTTP tracker configuration.
+    #[must_use]
     pub fn initialize(configuration: &Configuration) -> Self {
         let core_config = Arc::new(configuration.core.clone());
         let http_tracker_config = configuration

tests/servers/http/environment.rs packages/axum-http-tracker-server/src/environment.rs

@@ -303,11 +303,12 @@
 //!
 //! - [Bencode](https://en.wikipedia.org/wiki/Bencode).
 //! - [Bencode to Json Online converter](https://chocobo1.github.io/bencode_online).
-use serde::{Deserialize, Serialize};
-
+pub mod environment;
 pub mod server;
 pub mod v1;
 
+use serde::{Deserialize, Serialize};
+
 pub const HTTP_TRACKER_LOG_TARGET: &str = "HTTP TRACKER";
 
 /// The version of the HTTP tracker.

packages/axum-http-tracker-server/src/lib.rs

@@ -1,6 +1,6 @@
 use bittorrent_primitives::info_hash::InfoHash;
+use rand::prelude::*;
 
-#[allow(dead_code)]
 pub fn invalid_info_hashes() -> Vec<String> {
     [
         "0".to_string(),
@@ -15,8 +15,8 @@ pub fn invalid_info_hashes() -> Vec<String> {
 
 /// Returns a random info hash.
 pub fn random_info_hash() -> InfoHash {
-    let mut rng = rand::rng();
-    let random_bytes: [u8; 20] = rand::Rng::random(&mut rng);
+    let mut rng = rand::thread_rng();
+    let random_bytes: [u8; 20] = rng.gen();
 
     InfoHash::from_bytes(&random_bytes)
 }

tests/common/fixtures.rs packages/axum-http-tracker-server/tests/common/fixtures.rs

@@ -0,0 +1,54 @@
+pub type ReqwestQuery = Vec<ReqwestQueryParam>;
+pub type ReqwestQueryParam = (String, String);
+
+/// URL Query component
+#[derive(Default, Debug)]
+pub struct Query {
+    params: Vec<QueryParam>,
+}
+
+impl Query {
+    pub fn empty() -> Self {
+        Self { params: vec![] }
+    }
+
+    pub fn params(params: Vec<QueryParam>) -> Self {
+        Self { params }
+    }
+
+    pub fn add_param(&mut self, param: QueryParam) {
+        self.params.push(param);
+    }
+}
+
+impl From<Query> for ReqwestQuery {
+    fn from(url_search_params: Query) -> Self {
+        url_search_params
+            .params
+            .iter()
+            .map(|param| ReqwestQueryParam::from((*param).clone()))
+            .collect()
+    }
+}
+
+/// URL query param
+#[derive(Clone, Debug)]
+pub struct QueryParam {
+    name: String,
+    value: String,
+}
+
+impl QueryParam {
+    pub fn new(name: &str, value: &str) -> Self {
+        Self {
+            name: name.to_string(),
+            value: value.to_string(),
+        }
+    }
+}
+
+impl From<QueryParam> for ReqwestQueryParam {
+    fn from(param: QueryParam) -> Self {
+        (param.name, param.value)
+    }
+}

packages/axum-http-tracker-server/tests/common/http.rs

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

packages/axum-http-tracker-server/tests/common/mod.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/axum-http-tracker-server/tests/integration.rs

@@ -4,7 +4,7 @@ use reqwest::Response;
 
 use super::responses::announce::{Announce, Compact, DeserializedCompact};
 use super::responses::scrape;
-use crate::servers::http::responses::error::Error;
+use crate::server::responses::error::Error;
 
 pub fn assert_bencoded_error(response_text: &String, expected_failure_reason: &str, location: &'static Location<'static>) {
     let error_failure_reason = serde_bencode::from_str::<Error>(response_text)

tests/servers/http/asserts.rs packages/axum-http-tracker-server/tests/server/asserts.rs

@@ -1,14 +1,10 @@
 pub mod asserts;
 pub mod client;
-pub mod environment;
 pub mod requests;
 pub mod responses;
 pub mod v1;
 
 use percent_encoding::NON_ALPHANUMERIC;
-use torrust_axum_http_tracker_server::server;
-
-pub type Started = environment::Environment<server::Running>;
 
 pub type ByteArray20 = [u8; 20];
 

tests/servers/http/client.rs packages/axum-http-tracker-server/tests/server/client.rs

@@ -6,7 +6,7 @@ use aquatic_udp_protocol::PeerId;
 use bittorrent_primitives::info_hash::InfoHash;
 use serde_repr::Serialize_repr;
 
-use crate::servers::http::{percent_encode_byte_array, ByteArray20};
+use crate::server::{percent_encode_byte_array, ByteArray20};
 
 pub struct Query {
     pub info_hash: ByteArray20,

tests/servers/http/mod.rs packages/axum-http-tracker-server/tests/server/mod.rs

@@ -3,7 +3,7 @@ use std::str::FromStr;
 
 use bittorrent_primitives::info_hash::InfoHash;
 
-use crate::servers::http::{percent_encode_byte_array, ByteArray20};
+use crate::server::{percent_encode_byte_array, ByteArray20};
 
 pub struct Query {
     pub info_hash: Vec<ByteArray20>,

tests/servers/http/requests/announce.rs packages/axum-http-tracker-server/tests/server/requests/announce.rs

@@ -4,7 +4,7 @@ use std::str;
 use serde::{Deserialize, Serialize};
 use serde_bencode::value::Value;
 
-use crate::servers::http::{ByteArray20, InfoHash};
+use crate::server::{ByteArray20, InfoHash};
 
 #[derive(Debug, PartialEq, Default)]
 pub struct Response {