feat: [#950] use lowercase for database driver values in configuration

```toml [core.database] driver = "sqlite3" ``` We are normalizing all enum variants in configration to lowercase.
torrust · Jul 5, 2024 · 9d72f51 · 9d72f51
1 parent d970bb8
commit 9d72f51
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 17 deletions.
diff --git a/Containerfile b/Containerfile
@@ -96,7 +96,7 @@ RUN ["/busybox/cp", "-sp", "/busybox/sh","/busybox/cat","/busybox/ls","/busybox/
 COPY --from=gcc --chmod=0555 /usr/local/bin/su-exec /bin/su-exec
 
 ARG TORRUST_TRACKER_CONFIG_TOML_PATH="/etc/torrust/tracker/tracker.toml"
-ARG TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER="Sqlite3"
+ARG TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER="sqlite3"
 ARG USER_ID=1000
 ARG UDP_PORT=6969
 ARG HTTP_PORT=7070

diff --git a/compose.yaml b/compose.yaml
@@ -4,7 +4,7 @@ services:
  image: torrust-tracker:release
  tty: true
  environment:
- - TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER=${TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER:-MySQL}
+ - TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER=${TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER:-mysql}
  - TORRUST_TRACKER_CONFIG_OVERRIDE_HTTP_API__ACCESS_TOKENS__ADMIN=${TORRUST_TRACKER_CONFIG_OVERRIDE_HTTP_API__ACCESS_TOKENS__ADMIN:-MyAccessToken}
  networks:
  - server_side

diff --git a/docs/containers.md b/docs/containers.md
@@ -149,7 +149,7 @@ The following environmental variables can be set:
 
 - `TORRUST_TRACKER_CONFIG_TOML_PATH` - The in-container path to the tracker configuration file, (default: `"/etc/torrust/tracker/tracker.toml"`).
 - `TORRUST_TRACKER_CONFIG_OVERRIDE_HTTP_API__ACCESS_TOKENS__ADMIN` - Override of the admin token. If set, this value overrides any value set in the config.
-- `TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER` - The database type used for the container, (options: `Sqlite3`, `MySQL`, default `Sqlite3`). Please Note: This dose not override the database configuration within the `.toml` config file.
+- `TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER` - The database type used for the container, (options: `sqlite3`, `mysql`, default `sqlite3`). Please Note: This dose not override the database configuration within the `.toml` config file.
 - `TORRUST_TRACKER_CONFIG_TOML` - Load config from this environmental variable instead from a file, (i.e: `TORRUST_TRACKER_CONFIG_TOML=$(cat tracker-tracker.toml)`).
 - `USER_ID` - The user id for the runtime crated `torrust` user. Please Note: This user id should match the ownership of the host-mapped volumes, (default `1000`).
 - `UDP_PORT` - The port for the UDP tracker. This should match the port used in the configuration, (default `6969`).
@@ -244,7 +244,7 @@ The docker-compose configuration includes the MySQL service configuration. If yo
 
 ```toml
 [core.database]
-driver = "MySQL"
+driver = "mysql"
 path = "mysql://db_user:db_user_secret_password@mysql:3306/torrust_tracker"
 ```
 

diff --git a/packages/configuration/src/v2/database.rs b/packages/configuration/src/v2/database.rs
@@ -5,12 +5,12 @@ use url::Url;
 #[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
 pub struct Database {
  // Database configuration
- /// Database driver. Possible values are: `Sqlite3`, and `MySQL`.
+ /// Database driver. Possible values are: `sqlite3`, and `mysql`.
  #[serde(default = "Database::default_driver")]
  pub driver: Driver,
 
  /// Database connection string. The format depends on the database driver.
- /// For `Sqlite3`, the format is `path/to/database.db`, for example:
+ /// For `sqlite3`, the format is `path/to/database.db`, for example:
  /// `./storage/tracker/lib/database/sqlite3.db`.
  /// For `Mysql`, the format is `mysql://db_user:db_user_password:port/db_name`, for
  /// example: `mysql://root:password@localhost:3306/torrust`.
@@ -57,10 +57,8 @@ impl Database {
 
 /// The database management system used by the tracker.
 #[derive(Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Debug, Hash, Clone)]
+#[serde(rename_all = "lowercase")]
 pub enum Driver {
- // todo:
- // - Rename serialized values to lowercase: `sqlite3` and `mysql`.
- // - Add serde default values.
  /// The `Sqlite3` database driver.
  Sqlite3,
  /// The `MySQL` database driver.

diff --git a/packages/configuration/src/v2/mod.rs b/packages/configuration/src/v2/mod.rs
@@ -209,7 +209,7 @@
 //! interval_min = 120
 //!
 //! [core.database]
-//! driver = "Sqlite3"
+//! driver = "sqlite3"
 //! path = "./storage/tracker/lib/database/sqlite3.db"
 //!
 //! [core.net]
@@ -420,7 +420,7 @@ mod tests {
  interval_min = 120
 
  [core.database]
- driver = "Sqlite3"
+ driver = "sqlite3"
  path = "./storage/tracker/lib/database/sqlite3.db"
 
  [core.net]

diff --git a/share/container/entry_script_sh b/share/container/entry_script_sh
@@ -27,15 +27,15 @@ chmod -R 2770 /var/lib/torrust /var/log/torrust /etc/torrust
 
 # Install the database and config:
 if [ -n "$TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER" ]; then
- if cmp_lc "$TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER" "Sqlite3"; then
+ if cmp_lc "$TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER" "sqlite3"; then
 
  # Select Sqlite3 empty database
  default_database="/usr/share/torrust/default/database/tracker.sqlite3.db"
 
  # Select Sqlite3 default configuration
  default_config="/usr/share/torrust/default/config/tracker.container.sqlite3.toml"
 
- elif cmp_lc "$TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER" "MySQL"; then
+ elif cmp_lc "$TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER" "mysql"; then
 
  # (no database file needed for MySQL)
 
@@ -44,7 +44,7 @@ if [ -n "$TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER" ]; then
 
  else 
  echo "Error: Unsupported Database Type: \"$TORRUST_TRACKER_CONFIG_OVERRIDE_CORE__DATABASE__DRIVER\"."
- echo "Please Note: Supported Database Types: \"Sqlite3\", \"MySQL\"."
+ echo "Please Note: Supported Database Types: \"sqlite3\", \"mysql\"."
  exit 1
  fi
 else

diff --git a/share/default/config/tracker.container.mysql.toml b/share/default/config/tracker.container.mysql.toml
@@ -1,7 +1,7 @@
 version = "2"
 
 [core.database]
-driver = "MySQL"
+driver = "mysql"
 path = "mysql://db_user:db_user_secret_password@mysql:3306/torrust_tracker"
 
 # Uncomment to enable services

diff --git a/src/core/mod.rs b/src/core/mod.rs
@@ -326,7 +326,7 @@
 //! interval_min = 120
 //!
 //! [core.database]
-//! driver = "Sqlite3"
+//! driver = "sqlite3"
 //! path = "./storage/tracker/lib/database/sqlite3.db"
 //!
 //! [core.net]

diff --git a/src/lib.rs b/src/lib.rs
@@ -181,7 +181,7 @@
 //! interval_min = 120
 //!
 //! [core.database]
-//! driver = "Sqlite3"
+//! driver = "sqlite3"
 //! path = "./storage/tracker/lib/database/sqlite3.db"
 //!
 //! [core.net]