Merge #1583: Add new "tracker demo" section to README

4cb5648 fix: [#1579] clippy errors (Jose Celano)
15b8025 docs: [#1579] add tracker demo section to README (Jose Celano)

Pull request description:

  Add new "tracker demo" section to README.

ACKs for top commit:
  josecelano:
    ACK 4cb5648

Tree-SHA512: 21bd221f8c2eaa26e9cc88d0cd61f2c1765ff1f05d2909f0e60eebf246b82ac48dbc9c1d992bc73eb66b1767dbde38375b3d87ff317b6aab706bcf7fb62e1071

Author: josecelano

README.md

@@ -19,6 +19,24 @@
 - [x] Support [newTrackon][newtrackon] checks.
 - [x] Persistent `SQLite3` or `MySQL` Databases.
 
+## Tracker Demo
+
+Experience the **Torrust Tracker** in action with our comprehensive demo environment! The [Torrust Demo][torrust-demo] repository provides a complete setup showcasing the tracker's capabilities in a real-world scenario.
+
+The demo takes full advantage of the tracker's powerful metrics system and seamless integration with [Prometheus][prometheus]. This allows you to monitor tracker performance, peer statistics, and system health in real-time. You can build sophisticated Grafana dashboards to visualize all aspects of your tracker's operation.
+
+![Sample Grafana Dashboard](./docs/media/demo/torrust-tracker-grafana-dashboard.png)
+
+**Demo Features:**
+
+- Complete Docker Compose setup.
+- Pre-configured Prometheus metrics collection.
+- Sample Grafana dashboards for monitoring.
+- Real-time tracker statistics and performance metrics.
+- Easy deployment for testing and evaluation.
+
+Visit the [Torrust Demo repository][torrust-demo] to get started with your own tracker instance and explore the monitoring capabilities.
+
 ## Roadmap
 
 Core:
@@ -49,7 +67,7 @@ Utils:
 
 Others:
 
-- [ ] Support for Windows.
+- [ ] Intensive testing for Windows.
 - [ ] Docker images for other architectures.
 
 <https://github.com/orgs/torrust/projects/10/views/6>
@@ -274,3 +292,5 @@ This project was a joint effort by [Nautilus Cyberneering GmbH][nautilus] and [D
 [Naim A.]: https://github.com/naim94a/udpt
 [greatest-ape]: https://github.com/greatest-ape/aquatic
 [Power2All]: https://github.com/power2all
+[torrust-demo]: https://github.com/torrust/torrust-demo
+[prometheus]: https://prometheus.io/

console/tracker-client/src/console/clients/checker/checks/udp.rs

@@ -117,8 +117,8 @@ mod tests {
         let socket_addr = resolve_socket_addr(&Url::parse("udp://localhost:8080").unwrap());
 
         assert!(
-            socket_addr == SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080)
-                || socket_addr == SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), 8080)
+            socket_addr == SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 8080)
+                || socket_addr == SocketAddr::new(IpAddr::V6(Ipv6Addr::LOCALHOST), 8080)
         );
     }
 
@@ -127,8 +127,8 @@ mod tests {
         let socket_addr = resolve_socket_addr(&Url::parse("udp://localhost:8080").unwrap());
 
         assert!(
-            socket_addr == SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080)
-                || socket_addr == SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), 8080)
+            socket_addr == SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 8080)
+                || socket_addr == SocketAddr::new(IpAddr::V6(Ipv6Addr::LOCALHOST), 8080)
         );
     }
 }

console/tracker-client/src/console/clients/udp/checker.rs

@@ -116,7 +116,7 @@ impl Client {
             bytes_uploaded: NumberOfBytes(0i64.into()),
             bytes_left: NumberOfBytes(0i64.into()),
             event: AnnounceEvent::Started.into(),
-            ip_address: Ipv4Addr::new(0, 0, 0, 0).into(),
+            ip_address: Ipv4Addr::UNSPECIFIED.into(),
             key: PeerKey::new(0i32),
             peers_wanted: NumberOfPeers(1i32.into()),
             port: Port::new(port),

docs/media/demo/torrust-tracker-grafana-dashboard.png

@@ -234,7 +234,7 @@ mod tests {
         async fn it_should_fail_when_the_authentication_key_is_missing() {
             let http_core_tracker_services = initialize_private_tracker();
 
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let maybe_key = None;
@@ -265,7 +265,7 @@ mod tests {
 
             let unregistered_key = authentication::Key::from_str("YZSl4lMZupRuOpSRC3krIKR5BPB14nrJ").unwrap();
 
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let maybe_key = Some(unregistered_key);
@@ -308,7 +308,7 @@ mod tests {
 
             let announce_request = sample_announce_request();
 
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let response = handle_announce(
@@ -356,7 +356,7 @@ mod tests {
                 connection_info_socket_address: None,
             };
 
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let response = handle_announce(
@@ -401,7 +401,7 @@ mod tests {
                 connection_info_socket_address: None,
             };
 
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let response = handle_announce(

packages/axum-http-tracker-server/src/v1/handlers/announce.rs

@@ -192,7 +192,7 @@ mod tests {
 
         #[tokio::test]
         async fn it_should_return_zeroed_swarm_metadata_when_the_authentication_key_is_missing() {
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let (core_tracker_services, core_http_tracker_services) = initialize_private_tracker();
@@ -224,7 +224,7 @@ mod tests {
 
         #[tokio::test]
         async fn it_should_return_zeroed_swarm_metadata_when_the_authentication_key_is_invalid() {
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let (core_tracker_services, core_http_tracker_services) = initialize_private_tracker();
@@ -272,7 +272,7 @@ mod tests {
 
             let scrape_request = sample_scrape_request();
 
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let scrape_service = ScrapeService::new(
@@ -314,7 +314,7 @@ mod tests {
                 connection_info_socket_address: None,
             };
 
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let scrape_service = ScrapeService::new(
@@ -361,7 +361,7 @@ mod tests {
                 connection_info_socket_address: None,
             };
 
-            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 7070);
+            let server_socket_addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 7070);
             let server_service_binding = ServiceBinding::new(Protocol::HTTP, server_socket_addr).unwrap();
 
             let scrape_service = ScrapeService::new(

packages/axum-http-tracker-server/src/v1/handlers/scrape.rs

@@ -748,7 +748,7 @@ mod for_all_config_modes {
             Client::new(*env.bind_address())
                 .announce(
                     &QueryBuilder::default()
-                        .with_peer_addr(&IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)))
+                        .with_peer_addr(&IpAddr::V6(Ipv6Addr::LOCALHOST))
                         .query(),
                 )
                 .await;

packages/axum-http-tracker-server/tests/server/v1/contract.rs

@@ -25,6 +25,6 @@ impl Default for HealthCheckApi {
 
 impl HealthCheckApi {
     fn default_bind_address() -> SocketAddr {
-        SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 1313)
+        SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), 1313)
     }
 }

packages/configuration/src/v2_0_0/health_check_api.rs

@@ -37,7 +37,7 @@ impl Default for HttpTracker {
 
 impl HttpTracker {
     fn default_bind_address() -> SocketAddr {
-        SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), 7070)
+        SocketAddr::new(IpAddr::V4(Ipv4Addr::UNSPECIFIED), 7070)
     }
 
     fn default_tsl_config() -> Option<TslConfig> {

packages/configuration/src/v2_0_0/http_tracker.rs

@@ -492,10 +492,7 @@ mod tests {
     fn configuration_should_contain_the_external_ip() {
         let configuration = Configuration::default();
 
-        assert_eq!(
-            configuration.core.net.external_ip,
-            Some(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)))
-        );
+        assert_eq!(configuration.core.net.external_ip, Some(IpAddr::V4(Ipv4Addr::UNSPECIFIED)));
     }
 
     #[test]