feat(signer): add database migrate clap command

Author: dlachaume

mithril-signer/src/commands/database_command.rs

@@ -0,0 +1,85 @@
+use std::path::PathBuf;
+
+use anyhow::Context;
+use clap::{Parser, Subcommand};
+use slog::{debug, Logger};
+
+use mithril_common::StdResult;
+
+use crate::{
+    dependency_injection::DependenciesBuilder, Configuration, SQLITE_FILE,
+    SQLITE_FILE_CARDANO_TRANSACTION,
+};
+
+/// Database tools
+#[derive(Parser, Debug, Clone)]
+pub struct DatabaseCommand {
+    /// commands
+    #[clap(subcommand)]
+    pub database_subcommand: DatabaseSubCommand,
+}
+
+impl DatabaseCommand {
+    /// Execute the database command
+    pub async fn execute(&self, root_logger: Logger) -> StdResult<()> {
+        self.database_subcommand.execute(root_logger).await
+    }
+}
+
+/// Database subcommands
+#[derive(Debug, Clone, Subcommand)]
+pub enum DatabaseSubCommand {
+    /// Migrate databases located in the given stores directory
+    Migrate(MigrateCommand),
+}
+
+impl DatabaseSubCommand {
+    /// Execute the database subcommand
+    pub async fn execute(&self, root_logger: Logger) -> StdResult<()> {
+        match self {
+            Self::Migrate(cmd) => cmd.execute(root_logger).await,
+        }
+    }
+}
+
+/// Migrate command
+#[derive(Parser, Debug, Clone)]
+pub struct MigrateCommand {
+    /// Stores directory
+    #[clap(long, env = "STORES_DIRECTORY")]
+    stores_directory: PathBuf,
+}
+
+impl MigrateCommand {
+    /// Execute the migrate command
+    pub async fn execute(&self, root_logger: Logger) -> StdResult<()> {
+        let config = Configuration {
+            data_stores_directory: self.stores_directory.clone(),
+            // Temporary solution to avoid the need to provide a full configuration
+            ..Configuration::new_sample("0")
+        };
+        debug!(root_logger, "DATABASE MIGRATE command"; "config" => format!("{config:?}"));
+        println!(
+            "Migrating databases from stores directory: {}",
+            self.stores_directory.to_string_lossy()
+        );
+        let services = DependenciesBuilder::new(&config, root_logger.clone());
+
+        services
+            .build_sqlite_connection(SQLITE_FILE, crate::database::migration::get_migrations())
+            .await
+            .with_context(|| "Dependencies Builder can not get sqlite connection")?;
+
+        services
+            .build_sqlite_connection(
+                SQLITE_FILE_CARDANO_TRANSACTION,
+                mithril_persistence::database::cardano_transaction_migration::get_migrations(),
+            )
+            .await
+            .with_context(|| {
+                "Dependencies Builder can not get cardano transaction pool sqlite connection"
+            })?;
+
+        Ok(())
+    }
+}

mithril-signer/src/commands/mod.rs

@@ -0,0 +1,3 @@
+mod database_command;
+
+pub use database_command::*;

mithril-signer/src/lib.rs

@@ -6,6 +6,7 @@
 //! See the [Mithril documentation](https://mithril.network/doc/manual/developer-docs/nodes/mithril-signer)
 //! for more information on how it works.
 
+mod commands;
 mod configuration;
 pub mod database;
 pub mod dependency_injection;
@@ -16,6 +17,7 @@ mod runtime;
 pub mod services;
 pub mod store;
 
+pub use commands::*;
 pub use configuration::{Configuration, DefaultConfiguration};
 pub use entities::SignerEpochSettings;
 pub use message_adapters::{FromEpochSettingsAdapter, ToRegisterSignerMessageAdapter};

mithril-signer/src/main.rs

@@ -15,9 +15,9 @@ use tokio::{
 use mithril_common::StdResult;
 use mithril_doc::{Documenter, DocumenterDefault, GenerateDocCommands, StructDoc};
 use mithril_metric::MetricsServer;
-use mithril_signer::dependency_injection::DependenciesBuilder;
 use mithril_signer::{
-    Configuration, DefaultConfiguration, SignerRunner, SignerState, StateMachine,
+    dependency_injection::DependenciesBuilder, Configuration, DatabaseCommand,
+    DefaultConfiguration, SignerRunner, SignerState, StateMachine,
 };
 
 /// CLI args
@@ -115,6 +115,7 @@ fn build_logger(min_level: Level) -> Logger {
 
 #[derive(Subcommand, Debug, Clone)]
 enum SignerCommands {
+    Database(DatabaseCommand),
     #[clap(alias("doc"), hide(true))]
     GenerateDoc(GenerateDocCommands),
 }
@@ -125,21 +126,26 @@ async fn main() -> StdResult<()> {
     let args = Args::parse();
     let root_logger = build_logger(args.log_level());
 
-    if let Some(SignerCommands::GenerateDoc(cmd)) = &args.command {
-        let config_infos = vec![
-            Args::extract(),
-            Configuration::extract(),
-            DefaultConfiguration::extract(),
-        ];
-        return cmd
-            .execute_with_configurations(&mut Args::command(), &config_infos)
-            .map_err(|message| anyhow!(message));
-    }
-
     debug!(root_logger, "Starting"; "node_version" => env!("CARGO_PKG_VERSION"));
 
+    if let Some(cmd) = &args.command {
+        match cmd {
+            SignerCommands::Database(cmd) => return cmd.execute(root_logger).await,
+            SignerCommands::GenerateDoc(cmd) => {
+                let config_infos = vec![
+                    Args::extract(),
+                    Configuration::extract(),
+                    DefaultConfiguration::extract(),
+                ];
+                return cmd
+                    .execute_with_configurations(&mut Args::command(), &config_infos)
+                    .map_err(|message| anyhow!(message));
+            }
+        }
+    };
+
     // Load config
-    let config: Configuration = config::Config::builder()
+    let config = config::Config::builder()
         .set_default("disable_digests_cache", args.disable_digests_cache)
         .with_context(|| "configuration error: could not set `disable_digests_cache`")?
         .set_default("reset_digests_cache", args.reset_digests_cache)