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

Author: josecelano

Cargo.lock

@@ -74,7 +74,6 @@ torrust-tracker-torrent-repository = { version = "3.0.0-develop", path = "packag
 torrust-udp-tracker-server = { version = "3.0.0-develop", path = "packages/udp-tracker-server" }
 tracing = "0"
 tracing-subscriber = { version = "0", features = ["json"] }
-url = { version = "2", features = ["serde"] }
 uuid = { version = "1", features = ["v4"] }
 zerocopy = "0.7"
 

Cargo.toml

@@ -33,6 +33,7 @@ thiserror = "2"
 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-api-client = { version = "3.0.0-develop", path = "../tracker-api-client" }
 torrust-tracker-api-core = { version = "3.0.0-develop", path = "../tracker-api-core" }
 torrust-tracker-clock = { version = "3.0.0-develop", path = "../clock" }
 torrust-tracker-configuration = { version = "3.0.0-develop", path = "../configuration" }
@@ -46,3 +47,5 @@ local-ip-address = "0"
 mockall = "0"
 torrust-tracker-api-client = { version = "3.0.0-develop", path = "../tracker-api-client" }
 torrust-tracker-test-helpers = { version = "3.0.0-develop", path = "../test-helpers" }
+url = { version = "2", features = ["serde"] }
+uuid = { version = "1", features = ["v4"] }

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

@@ -7,13 +7,16 @@ use bittorrent_tracker_core::container::TrackerCoreContainer;
 use bittorrent_udp_tracker_core::container::UdpTrackerCoreContainer;
 use futures::executor::block_on;
 use torrust_axum_server::tsl::make_rust_tls;
-use torrust_axum_tracker_api_server::server::{ApiServer, Launcher, Running, Stopped};
 use torrust_server_lib::registar::Registar;
 use torrust_tracker_api_client::connection_info::{ConnectionInfo, Origin};
 use torrust_tracker_api_core::container::TrackerHttpApiCoreContainer;
 use torrust_tracker_configuration::{logging, Configuration};
 use torrust_tracker_primitives::peer;
 
+use crate::server::{ApiServer, Launcher, Running, Stopped};
+
+pub type Started = Environment<Running>;
+
 pub struct Environment<S>
 where
     S: std::fmt::Debug + std::fmt::Display,
@@ -38,6 +41,11 @@ where
 }
 
 impl Environment<Stopped> {
+    /// # Panics
+    ///
+    /// Will panic if it cannot make the TSL configuration from the provided
+    /// configuration.
+    #[must_use]
     pub fn new(configuration: &Arc<Configuration>) -> Self {
         initialize_global_services(configuration);
 
@@ -59,6 +67,9 @@ impl Environment<Stopped> {
         }
     }
 
+    /// # Panics
+    ///
+    /// Will panic if the server cannot be started.
     pub async fn start(self) -> Environment<Running> {
         let access_tokens = Arc::new(
             self.container
@@ -89,6 +100,9 @@ impl Environment<Running> {
         Environment::<Stopped>::new(configuration).start().await
     }
 
+    /// # Panics
+    ///
+    /// Will panic if the server cannot be stopped.
     pub async fn stop(self) -> Environment<Stopped> {
         Environment {
             container: self.container,
@@ -97,6 +111,11 @@ impl Environment<Running> {
         }
     }
 
+    /// # Panics
+    ///
+    /// Will panic if it cannot build the origin for the connection info from the
+    /// server local socket address.
+    #[must_use]
     pub fn get_connection_info(&self) -> ConnectionInfo {
         let origin = Origin::new(&format!("http://{}/", self.server.state.local_addr)).unwrap(); // DevSkim: ignore DS137138
 
@@ -112,6 +131,7 @@ impl Environment<Running> {
         }
     }
 
+    #[must_use]
     pub fn bind_address(&self) -> SocketAddr {
         self.server.state.local_addr
     }
@@ -123,6 +143,14 @@ pub struct EnvContainer {
 }
 
 impl EnvContainer {
+    /// # Panics
+    ///
+    /// Will panic if:
+    ///
+    /// - The configuration does not contain a HTTP tracker configuration.
+    /// - The configuration does not contain a UDP tracker configuration.
+    /// - The configuration does not contain a HTTP API configuration.
+    #[must_use]
     pub fn initialize(configuration: &Configuration) -> Self {
         let core_config = Arc::new(configuration.core.clone());
 

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

@@ -153,6 +153,7 @@
 //! > **NOTICE**: we are using [curl](https://curl.se/) in the API examples.
 //! > And you have to use quotes around the URL in order to avoid unexpected
 //! > errors. For example: `curl "http://127.0.0.1:1212/api/v1/stats?token=MyAccessToken"`.
+pub mod environment;
 pub mod routes;
 pub mod server;
 pub mod v1;

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

@@ -0,0 +1,11 @@
+pub fn invalid_info_hashes() -> Vec<String> {
+    [
+        "0".to_string(),
+        "-1".to_string(),
+        "1.1".to_string(),
+        "INVALID INFOHASH".to_string(),
+        "9c38422213e30bff212b30c360d26f9a0213642".to_string(), // 39-char length instead of 40. DevSkim: ignore DS173237
+        "9c38422213e30bff212b30c360d26f9a0213642&".to_string(), // Invalid char
+    ]
+    .to_vec()
+}

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

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

packages/axum-tracker-api-server/tests/common/mod.rs

@@ -0,0 +1,20 @@
+//! Integration tests.
+//!
+//! ```text
+//! cargo test --test integration
+//! ```
+
+use torrust_tracker_clock::clock;
+mod common;
+mod server;
+
+/// 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-tracker-api-server/tests/integration.rs

@@ -1,13 +1,9 @@
-use std::sync::Arc;
-
-use bittorrent_tracker_core::databases::Database;
-use torrust_axum_tracker_api_server::server;
-
 pub mod connection_info;
-pub mod environment;
 pub mod v1;
 
-pub type Started = environment::Environment<server::Running>;
+use std::sync::Arc;
+
+use bittorrent_tracker_core::databases::Database;
 
 /// It forces a database error by dropping all tables. That makes all queries
 /// fail.

tests/servers/api/connection_info.rs packages/axum-tracker-api-server/tests/server/connection_info.rs

@@ -1,11 +1,11 @@
+use torrust_axum_tracker_api_server::environment::Started;
 use torrust_tracker_api_client::common::http::{Query, QueryParam};
 use torrust_tracker_api_client::v1::client::{headers_with_request_id, Client};
-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 uuid::Uuid;
 
-use crate::common::logging::{self, logs_contains_a_line_with};
-use crate::servers::api::v1::asserts::{assert_token_not_valid, assert_unauthorized};
-use crate::servers::api::Started;
+use crate::server::v1::asserts::{assert_token_not_valid, assert_unauthorized};
 
 #[tokio::test]
 async fn should_authenticate_requests_by_using_a_token_query_param() {

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

@@ -2,18 +2,19 @@ use std::time::Duration;
 
 use bittorrent_tracker_core::authentication::Key;
 use serde::Serialize;
+use torrust_axum_tracker_api_server::environment::Started;
 use torrust_tracker_api_client::v1::client::{headers_with_request_id, AddKeyForm, Client};
-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 uuid::Uuid;
 
-use crate::common::logging::{self, logs_contains_a_line_with};
-use crate::servers::api::connection_info::{connection_with_invalid_token, connection_with_no_token};
-use crate::servers::api::v1::asserts::{
+use crate::server::connection_info::{connection_with_invalid_token, connection_with_no_token};
+use crate::server::force_database_error;
+use crate::server::v1::asserts::{
     assert_auth_key_utf8, assert_failed_to_delete_key, assert_failed_to_generate_key, assert_failed_to_reload_keys,
     assert_invalid_auth_key_get_param, assert_invalid_auth_key_post_param, assert_ok, assert_token_not_valid,
     assert_unauthorized, assert_unprocessable_auth_key_duration_param,
 };
-use crate::servers::api::{force_database_error, Started};
 
 #[tokio::test]
 async fn should_allow_generating_a_new_random_auth_key() {
@@ -481,17 +482,18 @@ async fn should_not_allow_reloading_keys_for_unauthenticated_users() {
 mod deprecated_generate_key_endpoint {
 
     use bittorrent_tracker_core::authentication::Key;
+    use torrust_axum_tracker_api_server::environment::Started;
     use torrust_tracker_api_client::v1::client::{headers_with_request_id, Client};
-    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 uuid::Uuid;
 
-    use crate::common::logging::{self, logs_contains_a_line_with};
-    use crate::servers::api::connection_info::{connection_with_invalid_token, connection_with_no_token};
-    use crate::servers::api::v1::asserts::{
+    use crate::server::connection_info::{connection_with_invalid_token, connection_with_no_token};
+    use crate::server::force_database_error;
+    use crate::server::v1::asserts::{
         assert_auth_key_utf8, assert_failed_to_generate_key, assert_invalid_key_duration_param, assert_token_not_valid,
         assert_unauthorized,
     };
-    use crate::servers::api::{force_database_error, Started};
 
     #[tokio::test]
     async fn should_allow_generating_a_new_auth_key() {

tests/servers/api/v1/asserts.rs packages/axum-tracker-api-server/tests/server/v1/asserts.rs

@@ -1,11 +1,9 @@
+use torrust_axum_tracker_api_server::environment::Started;
 use torrust_axum_tracker_api_server::v1::context::health_check::resources::{Report, Status};
 use torrust_tracker_api_client::v1::client::get;
-use torrust_tracker_test_helpers::configuration;
+use torrust_tracker_test_helpers::{configuration, logging};
 use url::Url;
 
-use crate::common::logging;
-use crate::servers::api::Started;
-
 #[tokio::test]
 async fn health_check_endpoint_should_return_status_ok_if_api_is_running() {
     logging::setup();

tests/servers/api/v1/contract/authentication.rs packages/axum-tracker-api-server/tests/server/v1/contract/authentication.rs

@@ -1,16 +1,16 @@
 use std::str::FromStr;
 
 use bittorrent_primitives::info_hash::InfoHash;
+use torrust_axum_tracker_api_server::environment::Started;
 use torrust_axum_tracker_api_server::v1::context::stats::resources::Stats;
 use torrust_tracker_api_client::v1::client::{headers_with_request_id, Client};
 use torrust_tracker_primitives::peer::fixture::PeerBuilder;
-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 uuid::Uuid;
 
-use crate::common::logging::{self, logs_contains_a_line_with};
-use crate::servers::api::connection_info::{connection_with_invalid_token, connection_with_no_token};
-use crate::servers::api::v1::asserts::{assert_stats, assert_token_not_valid, assert_unauthorized};
-use crate::servers::api::Started;
+use crate::server::connection_info::{connection_with_invalid_token, connection_with_no_token};
+use crate::server::v1::asserts::{assert_stats, assert_token_not_valid, assert_unauthorized};
 
 #[tokio::test]
 async fn should_allow_getting_tracker_statistics() {

tests/servers/api/v1/contract/context/auth_key.rs packages/axum-tracker-api-server/tests/server/v1/contract/context/auth_key.rs

@@ -1,24 +1,22 @@
 use std::str::FromStr;
 
 use bittorrent_primitives::info_hash::InfoHash;
+use torrust_axum_tracker_api_server::environment::Started;
 use torrust_axum_tracker_api_server::v1::context::torrent::resources::peer::Peer;
 use torrust_axum_tracker_api_server::v1::context::torrent::resources::torrent::{self, Torrent};
 use torrust_tracker_api_client::common::http::{Query, QueryParam};
 use torrust_tracker_api_client::v1::client::{headers_with_request_id, Client};
 use torrust_tracker_primitives::peer::fixture::PeerBuilder;
-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 uuid::Uuid;
 
-use crate::common::logging::{self, logs_contains_a_line_with};
-use crate::servers::api::connection_info::{connection_with_invalid_token, connection_with_no_token};
-use crate::servers::api::v1::asserts::{
+use crate::server::connection_info::{connection_with_invalid_token, connection_with_no_token};
+use crate::server::v1::asserts::{
     assert_bad_request, assert_invalid_infohash_param, assert_not_found, assert_token_not_valid, assert_torrent_info,
     assert_torrent_list, assert_torrent_not_known, assert_unauthorized,
 };
-use crate::servers::api::v1::contract::fixtures::{
-    invalid_infohashes_returning_bad_request, invalid_infohashes_returning_not_found,
-};
-use crate::servers::api::Started;
+use crate::server::v1::contract::fixtures::{invalid_infohashes_returning_bad_request, invalid_infohashes_returning_not_found};
 
 #[tokio::test]
 async fn should_allow_getting_all_torrents() {

tests/servers/api/v1/contract/context/health_check.rs packages/axum-tracker-api-server/tests/server/v1/contract/context/health_check.rs

@@ -1,20 +1,19 @@
 use std::str::FromStr;
 
 use bittorrent_primitives::info_hash::InfoHash;
+use torrust_axum_tracker_api_server::environment::Started;
 use torrust_tracker_api_client::v1::client::{headers_with_request_id, Client};
-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 uuid::Uuid;
 
-use crate::common::logging::{self, logs_contains_a_line_with};
-use crate::servers::api::connection_info::{connection_with_invalid_token, connection_with_no_token};
-use crate::servers::api::v1::asserts::{
+use crate::server::connection_info::{connection_with_invalid_token, connection_with_no_token};
+use crate::server::force_database_error;
+use crate::server::v1::asserts::{
     assert_failed_to_reload_whitelist, assert_failed_to_remove_torrent_from_whitelist, assert_failed_to_whitelist_torrent,
     assert_invalid_infohash_param, assert_not_found, assert_ok, assert_token_not_valid, assert_unauthorized,
 };
-use crate::servers::api::v1::contract::fixtures::{
-    invalid_infohashes_returning_bad_request, invalid_infohashes_returning_not_found,
-};
-use crate::servers::api::{force_database_error, Started};
+use crate::server::v1::contract::fixtures::{invalid_infohashes_returning_bad_request, invalid_infohashes_returning_not_found};
 
 #[tokio::test]
 async fn should_allow_whitelisting_a_torrent() {

tests/servers/api/v1/contract/context/mod.rs packages/axum-tracker-api-server/tests/server/v1/contract/context/mod.rs

@@ -1,4 +1,3 @@
 pub mod authentication;
-pub mod configuration;
 pub mod context;
 pub mod fixtures;