test: [#628] add failing test for bug. Duplicate slash in announce URL

josecelano · josecelano · commit 96269cd4e2d8 · 2024-06-11T16:42:55.000+01:00
When the tracker is running in private mode the announce URL in the
torrent file includes a double slash '/'. For example:

http://tracker:7070//KEY

This commit adds a failing test.

It needed scaffolding to run E2E tests with a tracker running in
"private" mode. We have been only running E2E tests for public trackers so
far. The new tests is only execute with Sqlite3. It would be easy to run
it also for MySQL. It was not cinluded in order to avoid making tests to
slow. It requires to start the docker E2E shared environment twice (for
public and private tracker configurations).
diff --git a/contrib/dev-tools/container/e2e/sqlite/e2e-env-down.sh b/contrib/dev-tools/container/e2e/sqlite/e2e-env-down.sh
diff --git a/contrib/dev-tools/container/e2e/sqlite/mode/private/e2e-env-down.sh b/contrib/dev-tools/container/e2e/sqlite/mode/private/e2e-env-down.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.private.e2e.container.sqlite3.toml) \
+TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.private.e2e.container.sqlite3.toml) \
+    docker compose down
diff --git a/contrib/dev-tools/container/e2e/sqlite/mode/private/e2e-env-up.sh b/contrib/dev-tools/container/e2e/sqlite/mode/private/e2e-env-up.sh
@@ -0,0 +1,16 @@
+#!/bin/bash
+
+TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.private.e2e.container.sqlite3.toml) \
+    docker compose build
+
+USER_ID=${USER_ID:-1000} \
+    TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.private.e2e.container.sqlite3.toml) \
+    TORRUST_INDEX_DATABASE="e2e_testing_sqlite3" \
+    TORRUST_INDEX_DATABASE_DRIVER="sqlite3" \
+    TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN="MyAccessToken" \
+    TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY="MaxVerstappenWC2021" \
+    TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.private.e2e.container.sqlite3.toml) \
+    TORRUST_TRACKER_DATABASE="e2e_testing_sqlite3" \
+    TORRUST_TRACKER_CONFIG_OVERRIDE_DB_DRIVER="Sqlite3" \
+    TORRUST_TRACKER_CONFIG_OVERRIDE_HTTP_API__ACCESS_TOKENS__ADMIN="MyAccessToken" \
+    docker compose up --detach --pull always --remove-orphans
diff --git a/contrib/dev-tools/container/e2e/sqlite/mode/public/e2e-env-down.sh b/contrib/dev-tools/container/e2e/sqlite/mode/public/e2e-env-down.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.public.e2e.container.sqlite3.toml) \
+TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.public.e2e.container.sqlite3.toml) \
+    docker compose down
diff --git a/contrib/dev-tools/container/e2e/sqlite/mode/public/e2e-env-up.sh b/contrib/dev-tools/container/e2e/sqlite/mode/public/e2e-env-up.sh
@@ -1,15 +1,15 @@
 #!/bin/bash
 
-TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.e2e.container.sqlite3.toml) \
+TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.public.e2e.container.sqlite3.toml) \
     docker compose build
 
 USER_ID=${USER_ID:-1000} \
-    TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.e2e.container.sqlite3.toml) \
+    TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.public.e2e.container.sqlite3.toml) \
     TORRUST_INDEX_DATABASE="e2e_testing_sqlite3" \
     TORRUST_INDEX_DATABASE_DRIVER="sqlite3" \
     TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN="MyAccessToken" \
     TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY="MaxVerstappenWC2021" \
-    TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.e2e.container.sqlite3.toml) \
+    TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.public.e2e.container.sqlite3.toml) \
     TORRUST_TRACKER_DATABASE="e2e_testing_sqlite3" \
     TORRUST_TRACKER_CONFIG_OVERRIDE_DB_DRIVER="Sqlite3" \
     TORRUST_TRACKER_CONFIG_OVERRIDE_HTTP_API__ACCESS_TOKENS__ADMIN="MyAccessToken" \
diff --git a/contrib/dev-tools/container/e2e/sqlite/run-e2e-tests.sh b/contrib/dev-tools/container/e2e/sqlite/run-e2e-tests.sh
@@ -25,8 +25,38 @@ cp .env.local .env || exit 1
 # TEST USING SQLITE
 echo "Running E2E tests using SQLite ..."
 
+# TEST USING A PUBLIC TRACKER
+echo "Running E2E tests with a public tracker ..."
+
+# Start E2E testing environment
+./contrib/dev-tools/container/e2e/sqlite/mode/public/e2e-env-up.sh || exit 1
+
+# Wait for conatiners to be healthy
+./contrib/dev-tools/container/functions/wait_for_container_to_be_healthy.sh torrust-mysql-1 10 3 || exit 1
+./contrib/dev-tools/container/functions/wait_for_container_to_be_healthy.sh torrust-tracker-1 10 3 || exit 1
+./contrib/dev-tools/container/functions/wait_for_container_to_be_healthy.sh torrust-index-1 10 3 || exit 1
+
+# Just to make sure that everything is up and running
+docker ps
+
+# Run E2E tests with shared app instance
+TORRUST_INDEX_E2E_SHARED=true \
+    TORRUST_INDEX_CONFIG_TOML_PATH="./share/default/config/index.public.e2e.container.sqlite3.toml" \
+    TORRUST_INDEX_E2E_DB_CONNECT_URL="sqlite://./storage/index/lib/database/e2e_testing_sqlite3.db?mode=rwc" \
+    cargo test ||
+    {
+        ./contrib/dev-tools/container/e2e/sqlite/mode/public/e2e-env-down.sh
+        exit 1
+    }
+
+# Stop E2E testing environment
+./contrib/dev-tools/container/e2e/sqlite/mode/public/e2e-env-down.sh || exit 1
+
+# TEST USING A PUBLIC TRACKER
+echo "Running E2E tests with a private tracker ..."
+
 # Start E2E testing environment
-./contrib/dev-tools/container/e2e/sqlite/e2e-env-up.sh || exit 1
+./contrib/dev-tools/container/e2e/sqlite/mode/private/e2e-env-up.sh || exit 1
 
 # Wait for conatiners to be healthy
 ./contrib/dev-tools/container/functions/wait_for_container_to_be_healthy.sh torrust-mysql-1 10 3 || exit 1
@@ -38,13 +68,13 @@ docker ps
 
 # Run E2E tests with shared app instance
 TORRUST_INDEX_E2E_SHARED=true \
-    TORRUST_INDEX_CONFIG_TOML_PATH="./share/default/config/index.e2e.container.sqlite3.toml" \
+    TORRUST_INDEX_CONFIG_TOML_PATH="./share/default/config/index.private.e2e.container.sqlite3.toml" \
     TORRUST_INDEX_E2E_DB_CONNECT_URL="sqlite://./storage/index/lib/database/e2e_testing_sqlite3.db?mode=rwc" \
     cargo test ||
     {
-        ./contrib/dev-tools/container/e2e/sqlite/e2e-env-down.sh
+        ./contrib/dev-tools/container/e2e/sqlite/mode/private/e2e-env-down.sh
         exit 1
     }
 
 # Stop E2E testing environment
-./contrib/dev-tools/container/e2e/sqlite/e2e-env-down.sh || exit 1
+./contrib/dev-tools/container/e2e/sqlite/mode/private/e2e-env-down.sh || exit 1
diff --git a/share/default/config/index.private.e2e.container.sqlite3.toml b/share/default/config/index.private.e2e.container.sqlite3.toml
@@ -0,0 +1,17 @@
+# Please override the following settings with environmental variable!
+# tracker::token   -> `TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN`
+# auth::secret_key -> `TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY`
+
+log_level = "info"
+
+[tracker]
+api_url = "http://tracker:1212"
+mode = "Private"
+url = "http://tracker:7070"
+
+[database]
+connect_url = "sqlite:///var/lib/torrust/index/database/e2e_testing_sqlite3.db?mode=rwc"
+
+[mail]
+port = 1025
+server = "mailcatcher"
diff --git a/share/default/config/index.public.e2e.container.mysql.toml b/share/default/config/index.public.e2e.container.mysql.toml
diff --git a/share/default/config/index.public.e2e.container.sqlite3.toml b/share/default/config/index.public.e2e.container.sqlite3.toml
diff --git a/share/default/config/tracker.private.e2e.container.sqlite3.toml b/share/default/config/tracker.private.e2e.container.sqlite3.toml
@@ -0,0 +1,37 @@
+announce_interval = 120
+db_driver = "Sqlite3"
+db_path = "/var/lib/torrust/tracker/database/e2e_testing_sqlite3.db"
+external_ip = "0.0.0.0"
+inactive_peer_cleanup_interval = 600
+log_level = "info"
+max_peer_timeout = 900
+min_announce_interval = 120
+mode = "private"
+on_reverse_proxy = false
+persistent_torrent_completed_stat = false
+remove_peerless_torrents = true
+tracker_usage_statistics = true
+
+[[udp_trackers]]
+bind_address = "0.0.0.0:6969"
+enabled = false
+
+[[http_trackers]]
+bind_address = "0.0.0.0:7070"
+enabled = false
+ssl_cert_path = "/var/lib/torrust/tracker/tls/localhost.crt"
+ssl_enabled = false
+ssl_key_path = "/var/lib/torrust/tracker/tls/localhost.key"
+
+[http_api]
+bind_address = "0.0.0.0:1212"
+enabled = true
+ssl_cert_path = "/var/lib/torrust/tracker/tls/localhost.crt"
+ssl_enabled = false
+ssl_key_path = "/var/lib/torrust/tracker/tls/localhost.key"
+
+[http_api.access_tokens]
+admin = "MyAccessToken"
+
+[health_check_api]
+bind_address = "127.0.0.1:1313"
diff --git a/share/default/config/tracker.public.e2e.container.sqlite3.toml b/share/default/config/tracker.public.e2e.container.sqlite3.toml
diff --git a/src/config/mod.rs b/src/config/mod.rs
@@ -3,6 +3,7 @@ pub mod v1;
 pub mod validator;
 
 use std::env;
+use std::str::FromStr;
 use std::sync::Arc;
 
 use camino::Utf8PathBuf;
@@ -122,15 +123,17 @@ impl From<figment::Error> for Error {
 
 Use https://crates.io/crates/torrust-tracker-primitives for TrackerMode.
 
-Enum variants (Index -> Tracker):
+Enum variants:
 
+  In Index                In Tracker
 - `Public`             -> `Public`
 - `Private`            -> `Private`
 - `Whitelisted`        -> `Listed`
 - `PrivateWhitelisted` -> `PrivateListed`
 
-Enum serialized values (Index -> Tracker):
+Enum serialized values:
 
+  In Index                In Tracker
 - `Public`             -> `public`
 - `Private`            -> `private`
 - `Whitelisted`        -> `listed`
@@ -163,6 +166,22 @@ impl Default for TrackerMode {
     }
 }
 
+impl FromStr for TrackerMode {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "Public" => Ok(TrackerMode::Public),
+            "Private" => Ok(TrackerMode::Private),
+            "Whitelisted" => Ok(TrackerMode::Whitelisted),
+            "PrivateWhitelisted" => Ok(TrackerMode::PrivateWhitelisted),
+            _ => Err(format!(
+                "{s} is not a valid tracker mode. Valid values: 'Public', 'Private', 'Whitelisted', 'PrivateWhitelisted' "
+            )),
+        }
+    }
+}
+
 impl TrackerMode {
     #[must_use]
     pub fn is_open(&self) -> bool {
diff --git a/tests/e2e/environment.rs b/tests/e2e/environment.rs
@@ -1,6 +1,8 @@
 use std::env;
+use std::str::FromStr;
 
 use torrust_index::config::v1::tracker::ApiToken;
+use torrust_index::config::TrackerMode;
 use torrust_index::web::api::Version;
 use url::Url;
 
@@ -75,10 +77,23 @@ impl TestEnv {
         }
     }
 
-    /// Some test requires the real tracker to be running, so they can only
-    /// be run in shared mode.
+    /// Some test requires a real tracker running.
     pub fn provides_a_tracker(&self) -> bool {
-        self.is_shared()
+        self.is_shared() && self.server_settings().is_some()
+    }
+
+    /// Some test requires a real tracker running in `private` mode.
+    pub fn provides_a_private_tracker(&self) -> bool {
+        if !self.is_shared() {
+            return false;
+        };
+
+        match self.server_settings() {
+            Some(settings) => {
+                TrackerMode::from_str(&settings.tracker.mode).expect("it should be a valid tracker mode") == TrackerMode::Private
+            }
+            None => false,
+        }
     }
 
     /// Returns the server starting settings if the servers was already started.
diff --git a/tests/e2e/web/api/v1/contexts/torrent/contract.rs b/tests/e2e/web/api/v1/contexts/torrent/contract.rs
@@ -765,6 +765,47 @@ mod for_authenticated_users {
         }
     }
 
+    mod downloading_a_torrent {
+
+        use regex::Regex;
+        use torrust_index::utils::parse_torrent::decode_torrent;
+        use torrust_index::web::api;
+        use url::Url;
+
+        use crate::common::client::Client;
+        use crate::e2e::environment::TestEnv;
+        use crate::e2e::web::api::v1::contexts::torrent::steps::upload_random_torrent_to_index;
+        use crate::e2e::web::api::v1::contexts::user::steps::new_logged_in_user;
+
+        #[tokio::test]
+        async fn it_should_include_the_tracker_key_when_the_tracker_is_running_in_private_mode() {
+            let mut env = TestEnv::new();
+            env.start(api::Version::V1).await;
+
+            if !env.provides_a_private_tracker() {
+                println!("test skipped. It requires a private tracker to be running.");
+                return;
+            }
+
+            let uploader = new_logged_in_user(&env).await;
+            let client = Client::authenticated(&env.server_socket_addr().unwrap(), &uploader.token);
+
+            // Upload
+            let (test_torrent, _torrent_listed_in_index) = upload_random_torrent_to_index(&uploader, &env).await;
+
+            // Download
+            let response = client.download_torrent(&test_torrent.file_info_hash()).await;
+
+            let torrent = decode_torrent(&response.bytes).expect("could not decode downloaded torrent");
+
+            let announce_url = Url::parse(&torrent.announce.unwrap()).unwrap();
+
+            let re = Regex::new(r"^http://tracker:7070/[a-zA-Z0-9]{32}$").unwrap(); // DevSkim: ignore DS137138
+
+            assert!(re.is_match(announce_url.as_ref()), "Invalid announce URL: '{announce_url}'.");
+        }
+    }
+
     mod and_non_admins {
 
         use torrust_index::web::api;
