check version regression

ghubertpalo · ghubertpalo · commit 67c9eff24da2 · 2022-11-16T16:19:45.000+01:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/mithril-aggregator/Cargo.toml b/mithril-aggregator/Cargo.toml
@@ -19,7 +19,6 @@ flate2 = "1.0.23"
 hex = "0.4.3"
 mithril-common = { path = "../mithril-common" }
 reqwest = { version = "0.11", features = ["json"] }
-semver = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde_yaml = "0.9.10"
diff --git a/mithril-aggregator/src/command_args.rs b/mithril-aggregator/src/command_args.rs
@@ -1,10 +1,7 @@
-use chrono::Local;
 use clap::{Parser, Subcommand};
 use config::{builder::DefaultState, ConfigBuilder, Map, Source, Value, ValueKind};
-use semver::{Version, VersionReq};
 use slog::Level;
-use slog_scope::{debug, warn};
-use sqlite::Connection;
+use slog_scope::debug;
 use std::error::Error;
 use std::fs;
 use std::path::PathBuf;
@@ -15,9 +12,7 @@ use tokio::time::Duration;
 use mithril_common::certificate_chain::MithrilCertificateVerifier;
 use mithril_common::chain_observer::{CardanoCliRunner, ChainObserver};
 use mithril_common::crypto_helper::ProtocolGenesisVerifier;
-use mithril_common::database::{
-    ApplicationNodeType, ApplicationVersion, VersionProvider, VersionUpdaterProvider,
-};
+use mithril_common::database::{ApplicationNodeType, ApplicationVersionChecker};
 use mithril_common::digesters::{CardanoImmutableDigester, ImmutableFileSystemObserver};
 use mithril_common::entities::{Epoch, HexEncodedGenesisSecretKey};
 use mithril_common::store::adapter::SQLiteAdapter;
@@ -38,52 +33,16 @@ use crate::{
     ProtocolParametersStorer, SingleSignatureStore, VerificationKeyStore,
 };
 
-fn check_database_version(filepath: &Option<PathBuf>) -> Result<(), Box<dyn Error>> {
-    let connection = match filepath {
-        Some(file) => Connection::open(file)?,
-        None => Connection::open(":memory:")?,
-    };
-    let provider = VersionProvider::new(&connection);
-    provider.create_table_if_not_exists()?;
-    let application_type = ApplicationNodeType::new("aggregator")?;
-    let maybe_option = provider.get_application_version(&application_type)?;
-    let current_version = ApplicationVersion {
-        semver: Version::parse(env!("CARGO_PKG_VERSION"))?,
-        application_type,
-        updated_at: Local::now().naive_local(),
-    };
-
-    match maybe_option {
-        None => {
-            let provider = VersionUpdaterProvider::new(&connection);
-            let _ = provider.save(current_version)?;
-            debug!("application version saved in database");
-        }
-        Some(version) => {
-            let req = VersionReq::parse(&current_version.semver.to_string()).unwrap();
-
-            if !req.matches(&version.semver) {
-                warn!(
-                    "application version '{}' is out of date, new version is '{}'. Upgrading database…",
-                    version.semver, current_version.semver
-                );
-                let upgrader_provider = VersionUpdaterProvider::new(&connection);
-                upgrader_provider.save(current_version)?;
-                debug!("database updated");
-            } else {
-                debug!("database up to date");
-            }
-        }
-    };
-
-    Ok(())
-}
-
 fn setup_genesis_dependencies(
     config: &GenesisConfiguration,
 ) -> Result<GenesisToolsDependency, Box<dyn std::error::Error>> {
     let sqlite_db_path = Some(config.get_sqlite_file());
-    check_database_version(&sqlite_db_path)?;
+    ApplicationVersionChecker::new(
+        slog_scope::logger(),
+        ApplicationNodeType::Aggregator,
+        config.get_sqlite_file(),
+    )
+    .check(env!("CARGO_PKG_VERSION"))?;
 
     let chain_observer = Arc::new(
         mithril_common::chain_observer::CardanoCliChainObserver::new(Box::new(
@@ -345,7 +304,12 @@ impl ServeCommand {
             .map_err(|e| format!("configuration deserialize error: {}", e))?;
         debug!("SERVE command"; "config" => format!("{:?}", config));
         let sqlite_db_path = Some(config.get_sqlite_file());
-        check_database_version(&sqlite_db_path)?;
+        ApplicationVersionChecker::new(
+            slog_scope::logger(),
+            ApplicationNodeType::Aggregator,
+            config.get_sqlite_file(),
+        )
+        .check(env!("CARGO_PKG_VERSION"))?;
 
         // Init dependencies
         let snapshot_store = config.build_snapshot_store()?;
diff --git a/mithril-common/src/database/db_version.rs b/mithril-common/src/database/db_version.rs
@@ -1,7 +1,8 @@
-use std::{collections::HashMap, error::Error, fmt::Display};
+use std::{cmp::Ordering, collections::HashMap, error::Error, fmt::Display, path::PathBuf};
 
-use chrono::NaiveDateTime;
+use chrono::{Local, NaiveDateTime};
 use semver::Version;
+use slog::{debug, error, warn, Logger};
 use sqlite::{Connection, Row, Value};
 
 use crate::sqlite::{HydrationError, Projection, ProjectionField, Provider, SqLiteEntity};
@@ -232,6 +233,90 @@ returning {projection}
     }
 }
 
+/// Struct to perform application version check in the database.
+#[derive(Debug)]
+pub struct ApplicationVersionChecker {
+    /// Pathbuf to the SQLite3 file.
+    sqlite_file_path: PathBuf,
+
+    /// Application type which vesion is verified.
+    application_type: ApplicationNodeType,
+
+    /// logger
+    logger: Logger,
+}
+
+impl ApplicationVersionChecker {
+    /// constructor
+    pub fn new(
+        logger: Logger,
+        application_type: ApplicationNodeType,
+        sqlite_file_path: PathBuf,
+    ) -> Self {
+        Self {
+            sqlite_file_path,
+            application_type,
+            logger,
+        }
+    }
+
+    /// Performs an actual version check in the database. This method creates a
+    /// connection to the SQLite3 file and drops it at the end.
+    pub fn check(&self, current_semver: &str) -> Result<(), Box<dyn Error>> {
+        debug!(
+            &self.logger,
+            "check application version, database file = '{}'",
+            self.sqlite_file_path.display()
+        );
+        let connection = Connection::open(&self.sqlite_file_path)?;
+        let provider = VersionProvider::new(&connection);
+        provider.create_table_if_not_exists()?;
+        let updater = VersionUpdaterProvider::new(&connection);
+        let maybe_option = provider.get_application_version(&self.application_type)?;
+        let current_version = ApplicationVersion {
+            semver: Version::parse(current_semver)?,
+            application_type: self.application_type.clone(),
+            updated_at: Local::now().naive_local(),
+        };
+
+        match maybe_option {
+            None => {
+                let current_version = updater.save(current_version)?;
+                debug!(
+                    &self.logger,
+                    "Application version '{}' saved in database.", current_version.semver
+                );
+            }
+            Some(version) => match current_version.semver.cmp(&version.semver) {
+                Ordering::Greater => {
+                    warn!(
+                            &self.logger,
+                            "Application version '{}' is out of date, new version is '{}'. Upgrading database…",
+                            version.semver, current_version.semver
+                        );
+                    updater.save(current_version)?;
+                    debug!(&self.logger, "database updated");
+                }
+                Ordering::Less => {
+                    error!(
+                        &self.logger,
+                        "Software version '{}' is older than database structure version '{}'.",
+                        current_version.semver,
+                        version.semver
+                    );
+
+                    Err("This software version is older than the database structure. Aborting launch to prevent possible data corruption.")?;
+                }
+                Ordering::Equal => {
+                    debug!(&self.logger, "database up to date");
+                }
+            },
+        };
+
+        Ok(())
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -278,4 +363,36 @@ returning app_version.semver as semver, app_version.application_type as applicat
             provider.get_definition(None)
         )
     }
+
+    fn check_database_version(filepath: &PathBuf, semver: &str) {
+        let connection = Connection::open(filepath).unwrap();
+        let provider = VersionProvider::new(&connection);
+        let version = provider
+            .get_application_version(&ApplicationNodeType::Aggregator)
+            .unwrap()
+            .expect("there should be a version in the database");
+
+        assert_eq!(semver, version.semver.to_string());
+    }
+
+    #[test]
+    fn test_application_version_checker() {
+        let filepath = std::env::temp_dir().join("test.sqlite3");
+
+        if filepath.exists() {
+            std::fs::remove_file(filepath.as_path()).unwrap();
+        }
+        let app_checker = ApplicationVersionChecker::new(
+            slog_scope::logger(),
+            ApplicationNodeType::Aggregator,
+            filepath.clone(),
+        );
+        app_checker.check("1.0.0").unwrap();
+        check_database_version(&filepath, "1.0.0");
+        app_checker.check("1.0.0").unwrap();
+        check_database_version(&filepath, "1.0.0");
+        app_checker.check("1.1.0").unwrap();
+        check_database_version(&filepath, "1.1.0");
+        app_checker.check("1.0.1").unwrap_err();
+    }
 }
diff --git a/mithril-signer/Cargo.toml b/mithril-signer/Cargo.toml
@@ -11,22 +11,19 @@ repository = { workspace = true }
 
 [dependencies]
 async-trait = "0.1.52"
-chrono = "0.4"
 clap = { version = "4.0", features = ["derive", "env"] }
 config = "0.13.1"
 hex = "0.4.3"
 mithril-common = { path = "../mithril-common" }
 rand_chacha = "0.3.1"
 rand_core   = "0.6.3"
 reqwest = { version = "0.11", features = ["json", "stream"] }
-semver = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 slog = { version = "2.7.0", features = ["max_level_trace", "release_max_level_debug"] }
 slog-async = "2.7.0"
 slog-bunyan = "2.4.0"
 slog-scope = "4.4.0"
-sqlite = "0.28.1"
 thiserror = "1.0.31"
 tokio = { version = "1.17.0", features = ["full"] }
 
diff --git a/mithril-signer/src/main.rs b/mithril-signer/src/main.rs
@@ -1,16 +1,11 @@
-use chrono::Local;
 use clap::Parser;
-use semver::{Version, VersionReq};
 use slog::{o, Drain, Level, Logger};
-use slog_scope::{debug, warn};
-use sqlite::Connection;
+use slog_scope::debug;
 use std::sync::Arc;
 use std::time::Duration;
 use std::{error::Error, path::PathBuf};
 
-use mithril_common::database::{
-    ApplicationNodeType, ApplicationVersion, VersionProvider, VersionUpdaterProvider,
-};
+use mithril_common::database::{ApplicationNodeType, ApplicationVersionChecker};
 use mithril_signer::{
     Config, ProductionServiceBuilder, ServiceBuilder, SignerRunner, SignerState, StateMachine,
 };
@@ -66,43 +61,6 @@ fn build_logger(min_level: Level) -> Logger {
     Logger::root(Arc::new(drain), o!())
 }
 
-fn check_database(filepath: &PathBuf) -> Result<(), Box<dyn Error>> {
-    let connection = Connection::open(filepath)?;
-    let provider = VersionProvider::new(&connection);
-    provider.create_table_if_not_exists()?;
-    let application_type = ApplicationNodeType::new("aggregator")?;
-    let maybe_option = provider.get_application_version(&application_type)?;
-    let current_version = ApplicationVersion {
-        semver: Version::parse(env!("CARGO_PKG_VERSION"))?,
-        application_type,
-        updated_at: Local::now().naive_local(),
-    };
-
-    match maybe_option {
-        None => {
-            let provider = VersionUpdaterProvider::new(&connection);
-            let _ = provider.save(current_version)?;
-            debug!("application version saved in database");
-        }
-        Some(version) => {
-            let req = VersionReq::parse(&current_version.semver.to_string()).unwrap();
-
-            if !req.matches(&version.semver) {
-                warn!(
-                    "application version '{}' is out of date, new version is '{}'. Upgrading database…",
-                    version.semver, current_version.semver
-                );
-                let upgrader_provider = VersionUpdaterProvider::new(&connection);
-                upgrader_provider.save(current_version)?;
-                debug!("database updated");
-            } else {
-                debug!("database up to date");
-            }
-        }
-    };
-    Ok(())
-}
-
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
     // Load args
@@ -125,7 +83,12 @@ async fn main() -> Result<(), Box<dyn Error>> {
         .try_deserialize()
         .map_err(|e| format!("configuration deserialize error: {}", e))?;
     let services = ProductionServiceBuilder::new(&config).build()?;
-    check_database(&config.data_stores_directory)?;
+    ApplicationVersionChecker::new(
+        slog_scope::logger(),
+        ApplicationNodeType::Signer,
+        config.get_sqlite_file(),
+    )
+    .check(env!("CARGO_PKG_VERSION"))?;
     debug!("Started"; "run_mode" => &args.run_mode, "config" => format!("{:?}", config));
 
     let mut state_machine = StateMachine::new(
