Merge pull request #6108 from seadowg/entity-lists

Store shared entities for follow up forms

androidshared/src/main/java/org/odk/collect/androidshared/ui/DialogFragmentUtils.kt

@@ -4,6 +4,7 @@ import android.os.Bundle
 import androidx.fragment.app.DialogFragment
 import androidx.fragment.app.FragmentManager
 import timber.log.Timber
+import kotlin.reflect.KClass
 
 object DialogFragmentUtils {
 
@@ -86,4 +87,8 @@ object DialogFragmentUtils {
             }
         }
     }
+
+    fun <T : DialogFragment> FragmentManager.showIfNotShowing(dialogClass: KClass<T>) {
+        showIfNotShowing(dialogClass.java, this)
+    }
 }

collect_app/src/androidTest/java/org/odk/collect/android/feature/entitymanagement/ViewEntitiesTest.kt

@@ -0,0 +1,48 @@
+package org.odk.collect.android.feature.entitymanagement
+
+import org.junit.Rule
+import org.junit.Test
+import org.junit.rules.RuleChain
+import org.odk.collect.android.support.StubOpenRosaServer
+import org.odk.collect.android.support.TestDependencies
+import org.odk.collect.android.support.pages.FormEntryPage
+import org.odk.collect.android.support.rules.CollectTestRule
+import org.odk.collect.android.support.rules.TestRuleChain
+
+class ViewEntitiesTest {
+
+    private val rule = CollectTestRule(useDemoProject = false)
+    private val testDependencies = TestDependencies()
+
+    @get:Rule
+    val ruleChain: RuleChain = TestRuleChain.chain(testDependencies)
+        .around(rule)
+
+    @Test
+    fun canViewLocallyCreatedEntitiesInBrowser() {
+        testDependencies.server.addForm("one-question-entity-registration.xml")
+
+        rule.withMatchExactlyProject(testDependencies.server.url)
+            .addEntityListInBrowser("people")
+            .startBlankForm("One Question Entity Registration")
+            .fillOutAndFinalize(FormEntryPage.QuestionAndAnswer("Name", "Logan Roy"))
+            .openEntityBrowser()
+            .clickOnDataset("people")
+            .assertEntity("Logan Roy", "full_name: Logan Roy")
+    }
+
+    @Test
+    fun canViewListEntitiesInBrowser() {
+        testDependencies.server.addForm(
+            "one-question-entity-follow-up.xml",
+            listOf(StubOpenRosaServer.EntityListItem("people.csv"))
+        )
+
+        rule.withMatchExactlyProject(testDependencies.server.url)
+            .addEntityListInBrowser("people")
+            .refreshForms()
+            .openEntityBrowser()
+            .clickOnDataset("people")
+            .assertEntity("Roman Roy", "full_name: Roman Roy")
+    }
+}

collect_app/src/androidTest/java/org/odk/collect/android/feature/formentry/EntityFormTest.kt

@@ -5,8 +5,10 @@ import org.junit.Rule
 import org.junit.Test
 import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
+import org.odk.collect.android.support.StubOpenRosaServer.EntityListItem
 import org.odk.collect.android.support.TestDependencies
 import org.odk.collect.android.support.pages.FormEntryPage
+import org.odk.collect.android.support.pages.MainMenuPage
 import org.odk.collect.android.support.rules.CollectTestRule
 import org.odk.collect.android.support.rules.TestRuleChain
 
@@ -21,24 +23,35 @@ class EntityFormTest {
         .around(rule)
 
     @Test
-    fun fillingEntityRegistrationForm_createsEntityInTheBrowser() {
+    fun fillingEntityRegistrationForm_beforeCreatingEntityList_doesNotCreateEntityForFollowUpForms() {
         testDependencies.server.addForm("one-question-entity-registration.xml")
+        testDependencies.server.addForm(
+            "one-question-entity-update.xml",
+            listOf(EntityListItem("people.csv"))
+        )
 
         rule.withMatchExactlyProject(testDependencies.server.url)
+            .enableLocalEntitiesInForms()
+
             .startBlankForm("One Question Entity Registration")
             .fillOutAndFinalize(FormEntryPage.QuestionAndAnswer("Name", "Logan Roy"))
-            .openEntityBrowser()
-            .clickOnDataset("people")
-            .assertEntity("Logan Roy", "full_name: Logan Roy")
+
+            .startBlankForm("One Question Entity Update")
+            .assertQuestion("Select person")
+            .assertText("Roman Roy")
+            .assertTextDoesNotExist("Logan Roy")
     }
 
     @Test
     fun fillingEntityRegistrationForm_createsEntityForFollowUpForms() {
         testDependencies.server.addForm("one-question-entity-registration.xml")
-        testDependencies.server.addForm("one-question-entity-update.xml", listOf("people.csv"))
+        testDependencies.server.addForm(
+            "one-question-entity-update.xml",
+            listOf(EntityListItem("people.csv"))
+        )
 
         rule.withMatchExactlyProject(testDependencies.server.url)
-            .enableLocalEntitiesInForms()
+            .setupEntities("people")
 
             .startBlankForm("One Question Entity Registration")
             .fillOutAndFinalize(FormEntryPage.QuestionAndAnswer("Name", "Logan Roy"))
@@ -52,10 +65,13 @@ class EntityFormTest {
     @Test
     fun fillingEntityRegistrationForm_createsEntityForFollowUpFormsWithCachedFormDefs() {
         testDependencies.server.addForm("one-question-entity-registration.xml")
-        testDependencies.server.addForm("one-question-entity-update.xml", listOf("people.csv"))
+        testDependencies.server.addForm(
+            "one-question-entity-update.xml",
+            listOf(EntityListItem("people.csv"))
+        )
 
         rule.withMatchExactlyProject(testDependencies.server.url)
-            .enableLocalEntitiesInForms()
+            .setupEntities("people")
 
             .startBlankForm("One Question Entity Update") // Open to create cached form def
             .pressBackAndDiscardForm()
@@ -71,10 +87,13 @@ class EntityFormTest {
 
     @Test
     fun fillingEntityUpdateForm_updatesEntityForFollowUpForms() {
-        testDependencies.server.addForm("one-question-entity-update.xml", listOf("people.csv"))
+        testDependencies.server.addForm(
+            "one-question-entity-update.xml",
+            listOf(EntityListItem("people.csv"))
+        )
 
         rule.withMatchExactlyProject(testDependencies.server.url)
-            .enableLocalEntitiesInForms()
+            .setupEntities("people")
 
             .startBlankForm("One Question Entity Update")
             .assertQuestion("Select person")
@@ -90,54 +109,37 @@ class EntityFormTest {
     }
 
     @Test
-    fun fillingEntityFollowUpForm_whenOnlineDuplicateHasHigherVersion_showsOnlineVersion() {
-        testDependencies.server.addForm("one-question-entity-update.xml", listOf("people.csv"))
-
-        val mainMenuPage = rule.withMatchExactlyProject(testDependencies.server.url)
+    fun entityListSecondaryInstancesAreConsistentBetweenFollowUpForms() {
+        testDependencies.server.apply {
+            addForm(
+                "one-question-entity-update.xml",
+                listOf(EntityListItem("people.csv"))
+            )
+
+            addForm(
+                "one-question-entity-follow-up.xml",
+                listOf(EntityListItem("people.csv", "updated-people.csv"))
+            )
+        }
+
+        rule.withProject(testDependencies.server)
             .enableLocalEntitiesInForms()
+            .addEntityListInBrowser("people")
 
+            .clickGetBlankForm()
+            .clickClearAll()
+            .clickForm("One Question Entity Update")
+            .clickGetSelected()
+            .clickOK(MainMenuPage())
             .startBlankForm("One Question Entity Update")
-            .assertQuestion("Select person")
-            .clickOnText("Roman Roy")
-            .swipeToNextQuestion("Name")
-            .answerQuestion("Name", "Romulus Roy")
-            .swipeToEndScreen()
-            .clickFinalize()
-
-        testDependencies.server.updateMediaFile(
-            "one-question-entity-update.xml",
-            "people.csv",
-            "updated-people.csv"
-        )
+            .assertText("Roman Roy")
+            .pressBackAndDiscardForm()
 
-        mainMenuPage.clickFillBlankForm()
-            .clickRefresh()
-            .clickOnForm("One Question Entity Update")
+            .clickGetBlankForm()
+            .clickGetSelected() // Collect automatically only selects the un-downloaded forms
+            .clickOK(MainMenuPage())
+            .startBlankForm("One Question Entity Update")
             .assertText("Ro-Ro Roy")
-            .assertTextDoesNotExist("Romulus Roy")
             .assertTextDoesNotExist("Roman Roy")
     }
-
-    @Test
-    fun fillingEntityFollowUpForm_whenOfflineDuplicateHasHigherVersion_showsOfflineVersion() {
-        testDependencies.server.addForm(
-            "one-question-entity-update.xml",
-            mapOf("people.csv" to "updated-people.csv")
-        )
-
-        rule.withMatchExactlyProject(testDependencies.server.url)
-            .enableLocalEntitiesInForms()
-
-            .startBlankForm("One Question Entity Update")
-            .assertQuestion("Select person")
-            .clickOnText("Ro-Ro Roy")
-            .swipeToNextQuestion("Name")
-            .answerQuestion("Name", "Romulus Roy")
-            .swipeToEndScreen()
-            .clickFinalize()
-
-            .startBlankForm("One Question Entity Update")
-            .assertText("Romulus Roy")
-            .assertTextDoesNotExist("Ro-Ro Roy")
-    }
 }

collect_app/src/androidTest/java/org/odk/collect/android/feature/projects/SwitchProjectTest.kt

@@ -76,6 +76,7 @@ class SwitchProjectTest {
             .clickOKOnDialog(MainMenuPage())
 
             // Fill form
+            .addEntityListInBrowser("people")
             .startBlankForm("One Question Entity Registration")
             .fillOutAndFinalize(FormEntryPage.QuestionAndAnswer("Name", "Alice"))
             .clickSendFinalizedForm(1)