refactor: [torrust#852] enrich field types in Configuration struct

Author: josecelano

Cargo.lock

@@ -18,6 +18,7 @@ version.workspace = true
 camino = { version = "1.1.6", features = ["serde"] }
 derive_more = "0"
 figment = { version = "0.10.18", features = ["env", "test", "toml"] }
+log = "0.4.21"
 serde = { version = "1", features = ["derive"] }
 serde_with = "3"
 thiserror = "1"

packages/configuration/Cargo.toml

@@ -171,3 +171,20 @@ pub struct TslConfig {
     #[serde_as(as = "NoneAsEmptyString")]
     pub ssl_key_path: Option<Utf8PathBuf>,
 }
+
+#[derive(Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
+#[serde(rename_all = "lowercase")]
+pub enum LogLevel {
+    /// A level lower than all log levels.
+    Off,
+    /// Corresponds to the `Error` log level.
+    Error,
+    /// Corresponds to the `Warn` log level.
+    Warn,
+    /// Corresponds to the `Info` log level.
+    Info,
+    /// Corresponds to the `Debug` log level.
+    Debug,
+    /// Corresponds to the `Trace` log level.
+    Trace,
+}

packages/configuration/src/lib.rs

@@ -248,15 +248,15 @@ use self::health_check_api::HealthCheckApi;
 use self::http_tracker::HttpTracker;
 use self::tracker_api::HttpApi;
 use self::udp_tracker::UdpTracker;
-use crate::{AnnouncePolicy, Error, Info};
+use crate::{AnnouncePolicy, Error, Info, LogLevel};
 
 /// Core configuration for the tracker.
 #[allow(clippy::struct_excessive_bools)]
 #[derive(Serialize, Deserialize, PartialEq, Eq, Debug)]
 pub struct Configuration {
     /// Logging level. Possible values are: `Off`, `Error`, `Warn`, `Info`,
     /// `Debug` and `Trace`. Default is `Info`.
-    pub log_level: Option<String>,
+    pub log_level: Option<LogLevel>,
     /// Tracker mode. See [`TrackerMode`] for more information.
     pub mode: TrackerMode,
 
@@ -330,7 +330,7 @@ impl Default for Configuration {
         let announce_policy = AnnouncePolicy::default();
 
         let mut configuration = Configuration {
-            log_level: Option::from(String::from("info")),
+            log_level: Some(LogLevel::Info),
             mode: TrackerMode::Public,
             db_driver: DatabaseDriver::Sqlite3,
             db_path: String::from("./storage/tracker/lib/database/sqlite3.db"),

packages/configuration/src/v1/mod.rs

@@ -2,7 +2,7 @@
 use std::env;
 use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr};
 
-use torrust_tracker_configuration::Configuration;
+use torrust_tracker_configuration::{Configuration, LogLevel};
 use torrust_tracker_primitives::TrackerMode;
 
 use crate::random;
@@ -28,7 +28,7 @@ pub fn ephemeral() -> Configuration {
     // For example: a test for the UDP tracker should disable the API and HTTP tracker.
 
     let mut config = Configuration {
-        log_level: Some("off".to_owned()), // Change to `debug` for tests debugging
+        log_level: Some(LogLevel::Off), // Change to `debug` for tests debugging
         ..Default::default()
     };
 

packages/test-helpers/src/configuration.rs

@@ -10,11 +10,10 @@
 //! - `Trace`
 //!
 //! Refer to the [configuration crate documentation](https://docs.rs/torrust-tracker-configuration) to know how to change log settings.
-use std::str::FromStr;
 use std::sync::Once;
 
 use log::{info, LevelFilter};
-use torrust_tracker_configuration::Configuration;
+use torrust_tracker_configuration::{Configuration, LogLevel};
 
 static INIT: Once = Once::new();
 
@@ -31,10 +30,17 @@ pub fn setup(cfg: &Configuration) {
     });
 }
 
-fn config_level_or_default(log_level: &Option<String>) -> LevelFilter {
+fn config_level_or_default(log_level: &Option<LogLevel>) -> LevelFilter {
     match log_level {
         None => log::LevelFilter::Info,
-        Some(level) => LevelFilter::from_str(level).unwrap(),
+        Some(level) => match level {
+            LogLevel::Off => LevelFilter::Off,
+            LogLevel::Error => LevelFilter::Error,
+            LogLevel::Warn => LevelFilter::Warn,
+            LogLevel::Info => LevelFilter::Info,
+            LogLevel::Debug => LevelFilter::Debug,
+            LogLevel::Trace => LevelFilter::Trace,
+        },
     }
 }
 

src/bootstrap/logging.rs

@@ -130,8 +130,8 @@
 //! > **NOTICE**: You can generate a self-signed certificate for localhost using
 //! OpenSSL. See [Let's Encrypt](https://letsencrypt.org/docs/certificates-for-localhost/).
 //! That's particularly useful for testing purposes. Once you have the certificate
-//! you need to set the [`ssl_cert_path`](torrust_tracker_configuration::HttpApi::ssl_cert_path)
-//! and [`ssl_key_path`](torrust_tracker_configuration::HttpApi::ssl_key_path)
+//! you need to set the [`ssl_cert_path`](torrust_tracker_configuration::HttpApi::tsl_config.ssl_cert_path)
+//! and [`ssl_key_path`](torrust_tracker_configuration::HttpApi::tsl_config.ssl_key_path)
 //! options in the configuration file with the paths to the certificate
 //! (`localhost.crt`) and key (`localhost.key`) files.
 //!