fix: test database (#337)

* add handling of TmpDir to prevent premature deletion of temporary database

* refactor test function

Author: frisitano

crates/database/db/src/db.rs

@@ -38,6 +38,10 @@ pub struct Database {
     write_lock: Arc<Mutex<()>>,
     /// The database metrics.
     metrics: DatabaseMetrics,
+    /// The temporary directory used for testing. We keep it here to ensure it lives as long as the
+    /// database instance as the temp directory is deleted when [`tempfile::TempDir`] is dropped.
+    #[cfg(feature = "test-utils")]
+    tmp_dir: Option<tempfile::TempDir>,
 }
 
 impl Database {
@@ -80,8 +84,20 @@ impl Database {
             connection: SqlxSqliteConnector::from_sqlx_sqlite_pool(sqlx_pool),
             write_lock: Arc::new(Mutex::new(())),
             metrics: DatabaseMetrics::default(),
+            #[cfg(feature = "test-utils")]
+            tmp_dir: None,
         })
     }
+
+    /// Creates a new [`Database`] instance for testing purposes, using the provided temporary
+    /// directory to store the database files.
+    #[cfg(feature = "test-utils")]
+    pub async fn test(dir: tempfile::TempDir) -> Result<Self, DatabaseError> {
+        let path = dir.path().join("test.db");
+        let mut db = Self::new(path.to_str().unwrap()).await?;
+        db.tmp_dir = Some(dir);
+        Ok(db)
+    }
 }
 
 #[async_trait::async_trait]
@@ -132,6 +148,8 @@ impl From<DatabaseConnection> for Database {
             connection,
             write_lock: Arc::new(Mutex::new(())),
             metrics: DatabaseMetrics::default(),
+            #[cfg(feature = "test-utils")]
+            tmp_dir: None,
         }
     }
 }

crates/database/db/src/test_utils.rs

@@ -4,13 +4,16 @@ use crate::DatabaseConnectionProvider;
 
 use super::Database;
 use scroll_migration::{Migrator, MigratorTrait, ScrollDevMigrationInfo};
-use tempfile::NamedTempFile;
 
 /// Instantiates a new in-memory database and runs the migrations
 /// to set up the schema.
 pub async fn setup_test_db() -> Database {
-    let tmp = NamedTempFile::new().unwrap();
-    let db = Database::new(tmp.path().to_str().unwrap()).await.unwrap();
+    let dir = tempfile::Builder::new()
+        .prefix("scroll-test-")
+        .rand_bytes(8)
+        .tempdir()
+        .expect("failed to create temp dir");
+    let db = Database::test(dir).await.unwrap();
     Migrator::<ScrollDevMigrationInfo>::up(db.get_connection(), None).await.unwrap();
     db
 }