feat: extract new package bittorrent-tracker-client

This will allow other projects to reuse the tracker lib clients and
console clients.

Author: josecelano

Cargo.lock

@@ -37,6 +37,7 @@ axum-client-ip = "0"
 axum-extra = { version = "0", features = ["query"] }
 axum-server = { version = "0", features = ["tls-rustls"] }
 bittorrent-primitives = "0.1.0"
+bittorrent-tracker-client = { version = "3.0.0-develop", path = "packages/tracker-client" }
 camino = { version = "1", features = ["serde", "serde1"] }
 chrono = { version = "0", default-features = false, features = ["clock"] }
 clap = { version = "4", features = ["derive", "env"] }
@@ -100,6 +101,7 @@ members = [
     "packages/primitives",
     "packages/test-helpers",
     "packages/torrent-repository",
+    "packages/tracker-client",
 ]
 
 [profile.dev]

Cargo.toml

@@ -0,0 +1,42 @@
+[package]
+description = "A library with the primitive types shared by the Torrust tracker packages."
+keywords = ["bittorrent", "client", "tracker"]
+license = "LGPL-3.0"
+name = "bittorrent-tracker-client"
+readme = "README.md"
+
+authors.workspace = true
+documentation.workspace = true
+edition.workspace = true
+homepage.workspace = true
+publish.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+version.workspace = true
+
+[dependencies]
+anyhow = "1"
+aquatic_udp_protocol = "0"
+bittorrent-primitives = "0.1.0"
+clap = { version = "4", features = ["derive", "env"] }
+derive_more = { version = "1", features = ["as_ref", "constructor", "from"] }
+futures = "0"
+futures-util = "0"
+hex-literal = "0"
+hyper = "1"
+percent-encoding = "2"
+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"
+thiserror = "1"
+tokio = { version = "1", features = ["macros", "net", "rt-multi-thread", "signal", "sync"] }
+torrust-tracker-configuration = { version = "3.0.0-develop", path = "../configuration" }
+torrust-tracker-located-error = { version = "3.0.0-develop", path = "../located-error" }
+torrust-tracker-primitives = { version = "3.0.0-develop", path = "../primitives" }
+tracing = "0"
+tracing-subscriber = { version = "0", features = ["json"] }
+url = { version = "2", features = ["serde"] }
+zerocopy = "0.7"

packages/tracker-client/Cargo.toml

@@ -0,0 +1,25 @@
+# BitTorrent Tracker Client
+
+A library an console applications to interact with a BitTorrent tracker.
+
+> **Disclaimer**: This project is actively under development. We’re currently extracting and refining common types from the ][Torrust Tracker](https://github.com/torrust/torrust-tracker) to make them available to the BitTorrent community in Rust. While these types are functional, they are not yet ready for use in production or third-party projects.
+
+## License
+
+**Copyright (c) 2024 The Torrust Developers.**
+
+This program is free software: you can redistribute it and/or modify it under the terms of the [GNU Lesser General Public License][LGPL_3_0] as published by the [Free Software Foundation][FSF], version 3.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU Lesser General Public License][LGPL_3_0] for more details.
+
+You should have received a copy of the *GNU Lesser General Public License* along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Some files include explicit copyright notices and/or license notices.
+
+### Legacy Exception
+
+For prosperity, versions of Torrust BitTorrent Tracker Client that are older than five years are automatically granted the [MIT-0][MIT_0] license in addition to the existing [LGPL-3.0-only][LGPL_3_0] license.
+
+[LGPL_3_0]: ./LICENSE
+[MIT_0]: ./docs/licenses/LICENSE-MIT_0
+[FSF]: https://www.fsf.org/

packages/tracker-client/README.md

@@ -0,0 +1,14 @@
+MIT No Attribution
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/tracker-client/docs/licenses/LICENSE-MIT_0

@@ -0,0 +1,7 @@
+//! Program to make request to HTTP trackers.
+use bittorrent_tracker_client::console::clients::http::app;
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    app::run().await
+}

packages/tracker-client/src/bin/http_tracker_client.rs

@@ -0,0 +1,7 @@
+//! Program to check running trackers.
+use bittorrent_tracker_client::console::clients::checker::app;
+
+#[tokio::main]
+async fn main() {
+    app::run().await.expect("Some checks fail");
+}

packages/tracker-client/src/bin/tracker_checker.rs

@@ -0,0 +1,7 @@
+//! Program to make request to UDP trackers.
+use bittorrent_tracker_client::console::clients::udp::app;
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    app::run().await
+}

packages/tracker-client/src/bin/udp_tracker_client.rs

@@ -0,0 +1,120 @@
+//! Program to run checks against running trackers.
+//!
+//! Run providing a config file path:
+//!
+//! ```text
+//! cargo run --bin tracker_checker -- --config-path "./share/default/config/tracker_checker.json"
+//! TORRUST_CHECKER_CONFIG_PATH="./share/default/config/tracker_checker.json" cargo run --bin tracker_checker
+//! ```
+//!
+//! Run providing the configuration:
+//!
+//! ```text
+//! TORRUST_CHECKER_CONFIG=$(cat "./share/default/config/tracker_checker.json") cargo run --bin tracker_checker
+//! ```
+//!
+//! Another real example to test the Torrust demo tracker:
+//!
+//! ```text
+//! TORRUST_CHECKER_CONFIG='{
+//!     "udp_trackers": ["144.126.245.19:6969"],
+//!     "http_trackers": ["https://tracker.torrust-demo.com"],
+//!     "health_checks": ["https://tracker.torrust-demo.com/api/health_check"]
+//! }' cargo run --bin tracker_checker
+//! ```
+//!
+//! The output should be something like the following:
+//!
+//! ```json
+//! {
+//!   "udp_trackers": [
+//!     {
+//!       "url": "144.126.245.19:6969",
+//!       "status": {
+//!         "code": "ok",
+//!         "message": ""
+//!       }
+//!     }
+//!   ],
+//!   "http_trackers": [
+//!     {
+//!       "url": "https://tracker.torrust-demo.com/",
+//!       "status": {
+//!         "code": "ok",
+//!         "message": ""
+//!       }
+//!     }
+//!   ],
+//!   "health_checks": [
+//!     {
+//!       "url": "https://tracker.torrust-demo.com/api/health_check",
+//!       "status": {
+//!         "code": "ok",
+//!         "message": ""
+//!       }
+//!     }
+//!   ]
+//! }
+//! ```
+use std::path::PathBuf;
+use std::sync::Arc;
+
+use anyhow::{Context, Result};
+use clap::Parser;
+use tracing::level_filters::LevelFilter;
+
+use super::config::Configuration;
+use super::console::Console;
+use super::service::{CheckResult, Service};
+use crate::console::clients::checker::config::parse_from_json;
+
+#[derive(Parser, Debug)]
+#[clap(author, version, about, long_about = None)]
+struct Args {
+    /// Path to the JSON configuration file.
+    #[clap(short, long, env = "TORRUST_CHECKER_CONFIG_PATH")]
+    config_path: Option<PathBuf>,
+
+    /// Direct configuration content in JSON.
+    #[clap(env = "TORRUST_CHECKER_CONFIG", hide_env_values = true)]
+    config_content: Option<String>,
+}
+
+/// # Errors
+///
+/// Will return an error if the configuration was not provided.
+pub async fn run() -> Result<Vec<CheckResult>> {
+    tracing_stdout_init(LevelFilter::INFO);
+
+    let args = Args::parse();
+
+    let config = setup_config(args)?;
+
+    let console_printer = Console {};
+
+    let service = Service {
+        config: Arc::new(config),
+        console: console_printer,
+    };
+
+    service.run_checks().await.context("it should run the check tasks")
+}
+
+fn tracing_stdout_init(filter: LevelFilter) {
+    tracing_subscriber::fmt().with_max_level(filter).init();
+    tracing::debug!("Logging initialized");
+}
+
+fn setup_config(args: Args) -> Result<Configuration> {
+    match (args.config_path, args.config_content) {
+        (Some(config_path), _) => load_config_from_file(&config_path),
+        (_, Some(config_content)) => parse_from_json(&config_content).context("invalid config format"),
+        _ => Err(anyhow::anyhow!("no configuration provided")),
+    }
+}
+
+fn load_config_from_file(path: &PathBuf) -> Result<Configuration> {
+    let file_content = std::fs::read_to_string(path).with_context(|| format!("can't read config file {path:?}"))?;
+
+    parse_from_json(&file_content).context("invalid config format")
+}

packages/tracker-client/src/console/clients/checker/app.rs

@@ -0,0 +1,77 @@
+use std::sync::Arc;
+use std::time::Duration;
+
+use anyhow::Result;
+use hyper::StatusCode;
+use reqwest::{Client as HttpClient, Response};
+use serde::Serialize;
+use thiserror::Error;
+use url::Url;
+
+#[derive(Debug, Clone, Error, Serialize)]
+#[serde(into = "String")]
+pub enum Error {
+    #[error("Failed to Build a Http Client: {err:?}")]
+    ClientBuildingError { err: Arc<reqwest::Error> },
+    #[error("Heath check failed to get a response: {err:?}")]
+    ResponseError { err: Arc<reqwest::Error> },
+    #[error("Http check returned a non-success code: \"{code}\" with the response: \"{response:?}\"")]
+    UnsuccessfulResponse { code: StatusCode, response: Arc<Response> },
+}
+
+impl From<Error> for String {
+    fn from(value: Error) -> Self {
+        value.to_string()
+    }
+}
+
+#[derive(Debug, Clone, Serialize)]
+pub struct Checks {
+    url: Url,
+    result: Result<String, Error>,
+}
+
+pub async fn run(health_checks: Vec<Url>, timeout: Duration) -> Vec<Result<Checks, Checks>> {
+    let mut results = Vec::default();
+
+    tracing::debug!("Health checks ...");
+
+    for url in health_checks {
+        let result = match run_health_check(url.clone(), timeout).await {
+            Ok(response) => Ok(response.status().to_string()),
+            Err(err) => Err(err),
+        };
+
+        let check = Checks { url, result };
+
+        if check.result.is_err() {
+            results.push(Err(check));
+        } else {
+            results.push(Ok(check));
+        }
+    }
+
+    results
+}
+
+async fn run_health_check(url: Url, timeout: Duration) -> Result<Response, Error> {
+    let client = HttpClient::builder()
+        .timeout(timeout)
+        .build()
+        .map_err(|e| Error::ClientBuildingError { err: e.into() })?;
+
+    let response = client
+        .get(url.clone())
+        .send()
+        .await
+        .map_err(|e| Error::ResponseError { err: e.into() })?;
+
+    if response.status().is_success() {
+        Ok(response)
+    } else {
+        Err(Error::UnsuccessfulResponse {
+            code: response.status(),
+            response: response.into(),
+        })
+    }
+}