Merge pull request getodk#5795 from seadowg/migrate-old-settings

Migrate old finalize key correctly
seadowg · Oct 26, 2023 · c5ca8a8 · c5ca8a8
1 parent accb428
commit c5ca8a8
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 9 deletions.
diff --git a/settings/src/main/java/org/odk/collect/settings/ODKAppSettingsMigrator.java b/settings/src/main/java/org/odk/collect/settings/ODKAppSettingsMigrator.java
@@ -155,30 +155,35 @@ public List<Migration> getProtectedMigrations() {
                         .withValues(false, false)
                         .toPairs(
                                 ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, true,
-                                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, false
+                                "finalize", false
                         )
                         .withValues(false, true)
                         .toPairs(
                                 ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, false,
-                                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, true
+                                "finalize", true
                         )
                         .withValues(false, null)
                         .toPairs(
                                 ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, false,
-                                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, true
+                                "finalize", true
                         ),
                 removeKey("mark_as_finalized"),
                 removeKey("default_completed"),
                 updateKeys(ProtectedProjectKeys.ALLOW_OTHER_WAYS_OF_EDITING_FORM)
                         .withValues(false)
                         .toPairs(
                                 ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, false,
-                                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, true
+                                "finalize", true
                         ),
                 updateKeys("finalize").withValues(false)
                         .toPairs(
                                 ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, false,
                                 ProtectedProjectKeys.KEY_BULK_FINALIZE, false
+                        )
+                        .withValues(true)
+                        .toPairs(
+                                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, true,
+                                ProtectedProjectKeys.KEY_BULK_FINALIZE, true
                         ),
                 removeKey("finalize")
         );

diff --git a/settings/src/test/java/org/odk/collect/settings/ODKAppSettingsMigratorTest.java b/settings/src/test/java/org/odk/collect/settings/ODKAppSettingsMigratorTest.java
@@ -260,7 +260,11 @@ public void when_markAsFinalized_wasDisabled_and_defaultCompleted_wasDisabled_th
 
         runMigrations();
 
-        assertSettings(protectedSettings, ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, true, ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, false);
+        assertSettings(protectedSettings,
+                ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, true,
+                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, false,
+                ProtectedProjectKeys.KEY_BULK_FINALIZE, false
+        );
 
         assertThat(protectedSettings.contains("mark_as_finalized"), equalTo(false));
         assertThat(protectedSettings.contains("default_completed"), equalTo(false));
@@ -273,7 +277,11 @@ public void when_markAsFinalized_wasDisabled_and_defaultCompleted_wasEnabled_the
 
         runMigrations();
 
-        assertSettings(protectedSettings, ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, false, ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, true);
+        assertSettings(protectedSettings,
+                ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, false,
+                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, true,
+                ProtectedProjectKeys.KEY_BULK_FINALIZE, true
+        );
 
         assertThat(protectedSettings.contains("mark_as_finalized"), equalTo(false));
         assertThat(protectedSettings.contains("default_completed"), equalTo(false));
@@ -285,7 +293,11 @@ public void when_markAsFinalized_wasDisabled_and_defaultCompleted_wasNotSet_then
 
         runMigrations();
 
-        assertSettings(protectedSettings, ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, false, ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, true);
+        assertSettings(protectedSettings,
+                ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, false,
+                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, true,
+                ProtectedProjectKeys.KEY_BULK_FINALIZE, true
+        );
 
         assertThat(protectedSettings.contains("mark_as_finalized"), equalTo(false));
         assertThat(protectedSettings.contains("default_completed"), equalTo(false));
@@ -322,7 +334,7 @@ public void when_AllowOtherWaysOfEditingFormIsDisabled_thenSaveAsDraftShouldBeDi
         initSettings(protectedSettings,
                 ProtectedProjectKeys.ALLOW_OTHER_WAYS_OF_EDITING_FORM, false,
                 ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, true,
-                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, false
+                "finalize", false
         );
 
         runMigrations();
@@ -338,7 +350,7 @@ public void when_AllowOtherWaysOfEditingFormIsEnabled_thenDoNotUpdateSaveAsDraft
         initSettings(protectedSettings,
                 ProtectedProjectKeys.ALLOW_OTHER_WAYS_OF_EDITING_FORM, true,
                 ProtectedProjectKeys.KEY_SAVE_AS_DRAFT, true,
-                ProtectedProjectKeys.KEY_FINALIZE_IN_FORM_ENTRY, false
+                "finalize", false
         );
 
         runMigrations();