From bb090ce31217af99e8ddb0c4ac3d817eeb6443f9 Mon Sep 17 00:00:00 2001
From: Conny Duck <git@connyduck.at>
Date: Fri, 29 Nov 2024 21:31:59 +0100
Subject: [PATCH] add comments to MigrationsTest

---
 app/src/test/java/com/keylesspalace/tusky/db/MigrationsTest.kt | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/app/src/test/java/com/keylesspalace/tusky/db/MigrationsTest.kt b/app/src/test/java/com/keylesspalace/tusky/db/MigrationsTest.kt
index 32f4a31578..4db567e7de 100644
--- a/app/src/test/java/com/keylesspalace/tusky/db/MigrationsTest.kt
+++ b/app/src/test/java/com/keylesspalace/tusky/db/MigrationsTest.kt
@@ -25,6 +25,7 @@ class MigrationsTest {
 
     @Test
     fun testMigrations() {
+        /** the db name must match the one in [StorageModule.providesDatabase] */
         val db = migrationHelper.createDatabase("tuskyDB", 10)
         val moshi = Moshi.Builder().build()
 
@@ -66,6 +67,7 @@ class MigrationsTest {
 
         db.close()
 
+        // Room will run all migrations and validate the scheme afterwards
         val roomDb = StorageModule.providesDatabase(
             InstrumentationRegistry.getInstrumentation().context,
             Converters(moshi)