Merge pull request #5734 from seadowg/bulk-finalization

Add bulk finalization

.circleci/config.yml

@@ -91,7 +91,7 @@ jobs:
 
       - run:
           name: Run code quality checks
-          command: ./gradlew checkCode
+          command: ./gradlew pmd ktlintCheck checkstyle lintDebug -PlintStrings
 
   test_modules:
     <<: *android_config

androidshared/src/main/java/org/odk/collect/androidshared/data/AppState.kt

@@ -5,6 +5,8 @@ import android.app.Application
 import android.app.Service
 import android.content.Context
 import androidx.fragment.app.Fragment
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
 
 /**
@@ -41,13 +43,21 @@ class AppState {
 
     @Suppress("UNCHECKED_CAST")
     fun <T> get(key: String): T? {
-        return map.get(key) as T?
+        return map[key] as T?
+    }
+
+    fun <T> getLive(key: String, default: T): LiveData<T> {
+        return get(key, MutableLiveData(default))
     }
 
     fun set(key: String, value: Any?) {
         map[key] = value
     }
 
+    fun <T> setLive(key: String, value: T?) {
+        get(key, MutableLiveData<T>()).postValue(value)
+    }
+
     fun clear() {
         map.clear()
     }

collect_app/build.gradle

@@ -216,6 +216,10 @@ android {
         htmlReport true
         lintConfig file("$rootDir/config/lint.xml")
         xmlReport true
+
+        if (!project.hasProperty("lintStrings")) {
+            disable += ["HardcodedText"]
+        }
     }
     namespace 'org.odk.collect.android'
 }
@@ -373,6 +377,7 @@ dependencies {
         exclude group: 'org.robolectric' // Some tests in `collect_app` don't work with newer Robolectric
     }
     testImplementation(project(":shadows"))
+    testImplementation(project(":test-forms"))
 
     testImplementation Dependencies.robolectric
 

collect_app/src/androidTest/java/org/odk/collect/android/feature/formmanagement/BulkFinalizationTest.kt

@@ -0,0 +1,106 @@
+package org.odk.collect.android.feature.formmanagement
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import org.junit.Rule
+import org.junit.Test
+import org.junit.rules.RuleChain
+import org.junit.runner.RunWith
+import org.odk.collect.android.support.pages.FormEntryPage.QuestionAndAnswer
+import org.odk.collect.android.support.pages.MainMenuPage
+import org.odk.collect.android.support.pages.SaveOrDiscardFormDialog
+import org.odk.collect.android.support.rules.CollectTestRule
+import org.odk.collect.android.support.rules.TestRuleChain
+import org.odk.collect.strings.R.plurals
+import org.odk.collect.strings.R.string
+
+@RunWith(AndroidJUnit4::class)
+class BulkFinalizationTest {
+
+    val rule = CollectTestRule()
+
+    @get:Rule
+    val chain: RuleChain = TestRuleChain.chain().around(rule)
+
+    @Test
+    fun canBulkFinalizeDrafts() {
+        rule.startAtMainMenu()
+            .copyForm("one-question.xml")
+            .startBlankForm("One Question")
+            .fillOutAndSave(QuestionAndAnswer("what is your age", "97"))
+            .startBlankForm("One Question")
+            .fillOutAndSave(QuestionAndAnswer("what is your age", "98"))
+
+            .clickEditSavedForm(2)
+            .clickOptionsIcon(string.finalize_all_forms)
+            .clickOnString(string.finalize_all_forms)
+            .checkIsSnackbarWithQuantityDisplayed(plurals.bulk_finalize_success, 2)
+            .assertTextDoesNotExist("One Question")
+            .pressBack(MainMenuPage())
+
+            .assertNumberOfFinalizedForms(2)
+    }
+
+    @Test
+    fun whenThereAreDraftsWithConstraintViolations_marksFormsAsHavingErrors() {
+        rule.startAtMainMenu()
+            .copyForm("two-question-required.xml")
+            .startBlankForm("Two Question Required")
+            .fillOut(QuestionAndAnswer("What is your name?", "Dan"))
+            .pressBack(SaveOrDiscardFormDialog(MainMenuPage()))
+            .clickSaveChanges()
+
+            .startBlankForm("Two Question Required")
+            .fillOutAndSave(
+                QuestionAndAnswer("What is your name?", "Tim"),
+                QuestionAndAnswer("What is your age?", "45", true)
+            )
+
+            .clickEditSavedForm(2)
+            .clickOptionsIcon(string.finalize_all_forms)
+            .clickOnString(string.finalize_all_forms)
+            .checkIsSnackbarWithMessageDisplayed(string.bulk_finalize_partial_success, 1, 1)
+            .assertText("Two Question Required")
+            .pressBack(MainMenuPage())
+
+            .assertNumberOfEditableForms(1)
+            .assertNumberOfFinalizedForms(1)
+    }
+
+    @Test
+    fun whenADraftPreviouslyHadConstraintViolations_marksFormsAsHavingErrors() {
+        rule.startAtMainMenu()
+            .copyForm("two-question-required.xml")
+            .startBlankForm("Two Question Required")
+            .fillOut(QuestionAndAnswer("What is your name?", "Dan"))
+            .pressBack(SaveOrDiscardFormDialog(MainMenuPage()))
+            .clickSaveChanges()
+
+            .clickEditSavedForm(1)
+            .clickOptionsIcon(string.finalize_all_forms)
+            .clickOnString(string.finalize_all_forms)
+            .checkIsSnackbarWithQuantityDisplayed(plurals.bulk_finalize_failure, 1)
+
+            .clickOptionsIcon(string.finalize_all_forms)
+            .clickOnString(string.finalize_all_forms)
+            .checkIsSnackbarWithQuantityDisplayed(plurals.bulk_finalize_failure, 1)
+    }
+
+    @Test
+    fun doesNotFinalizeOtherTypesOfInstance() {
+        rule.startAtMainMenu()
+            .copyForm("one-question.xml")
+            .startBlankForm("One Question")
+            .fillOutAndSave(QuestionAndAnswer("what is your age", "97"))
+            .startBlankForm("One Question")
+            .fillOutAndFinalize(QuestionAndAnswer("what is your age", "98"))
+
+            .clickEditSavedForm(1)
+            .clickOptionsIcon(string.finalize_all_forms)
+            .clickOnString(string.finalize_all_forms)
+            .checkIsSnackbarWithQuantityDisplayed(plurals.bulk_finalize_success, 1)
+            .assertTextDoesNotExist("One Question")
+            .pressBack(MainMenuPage())
+
+            .assertNumberOfFinalizedForms(2)
+    }
+}

collect_app/src/androidTest/java/org/odk/collect/android/feature/instancemanagement/PartialSubmissionTet.kt

@@ -0,0 +1,56 @@
+package org.odk.collect.android.feature.instancemanagement
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import org.hamcrest.MatcherAssert.assertThat
+import org.hamcrest.Matchers.equalTo
+import org.junit.Rule
+import org.junit.Test
+import org.junit.rules.RuleChain
+import org.junit.runner.RunWith
+import org.kxml2.io.KXmlParser
+import org.kxml2.kdom.Document
+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
+import java.io.File
+import java.io.StringReader
+
+@RunWith(AndroidJUnit4::class)
+class PartialSubmissionTet {
+
+    private val testDependencies = TestDependencies()
+    private val rule = CollectTestRule(useDemoProject = false)
+
+    @get:Rule
+    val chain: RuleChain = TestRuleChain.chain(testDependencies)
+        .around(rule)
+
+    @Test
+    fun canFillAndSubmitAFormWithPartialSubmission() {
+        rule.withProject(testDependencies.server.url)
+            .copyForm("one-question-partial.xml", testDependencies.server.hostName)
+            .startBlankForm("One Question")
+            .fillOutAndFinalize(FormEntryPage.QuestionAndAnswer("what is your age", "123"))
+
+            .clickSendFinalizedForm(1)
+            .clickSelectAll()
+            .clickSendSelected()
+
+        val submissions = testDependencies.server.submissions
+        assertThat(submissions.size, equalTo(1))
+
+        val root = parseXml(submissions[0]).rootElement
+        assertThat(root.name, equalTo("age"))
+        assertThat(root.childCount, equalTo(1))
+        assertThat(root.getChild(0), equalTo("123"))
+    }
+
+    private fun parseXml(file: File): Document {
+        return StringReader(String(file.readBytes())).use { reader ->
+            val parser = KXmlParser()
+            parser.setInput(reader)
+            Document().also { it.parse(parser) }
+        }
+    }
+}

collect_app/src/androidTest/java/org/odk/collect/android/support/StubOpenRosaServer.java

@@ -16,6 +16,8 @@
 import org.odk.collect.android.openrosa.HttpPostResult;
 import org.odk.collect.android.openrosa.OpenRosaConstants;
 import org.odk.collect.android.openrosa.OpenRosaHttpInterface;
+import org.odk.collect.android.utilities.FileUtils;
+import org.odk.collect.shared.TempFiles;
 import org.odk.collect.shared.strings.Md5;
 import org.odk.collect.shared.strings.RandomString;
 
@@ -44,6 +46,8 @@ public class StubOpenRosaServer implements OpenRosaHttpInterface {
     private boolean noHashPrefixInMediaFiles;
     private boolean randomHash;
 
+    private final File submittedFormsDir = TempFiles.createTempDir();
+
     @NonNull
     @Override
     public HttpGetResult executeGetRequest(@NonNull URI uri, @Nullable String contentType, @Nullable HttpCredentialsInterface credentials) throws Exception {
@@ -111,6 +115,8 @@ public HttpPostResult uploadSubmissionAndFiles(@NonNull File submissionFile, @No
         } else if (credentialsIncorrect(credentials)) {
             return new HttpPostResult("", 401, "");
         } else if (uri.getPath().equals(OpenRosaConstants.SUBMISSION)) {
+            File destFile = new File(submittedFormsDir, String.valueOf(submittedFormsDir.listFiles().length));
+            FileUtils.copyFile(submissionFile, destFile);
             return new HttpPostResult("", 201, "");
         } else {
             return new HttpPostResult("", 404, "");
@@ -162,6 +168,10 @@ public String getHostName() {
         return HOST;
     }
 
+    public List<File> getSubmissions() {
+        return asList(submittedFormsDir.listFiles());
+    }
+
     private boolean credentialsIncorrect(HttpCredentialsInterface credentials) {
         if (username == null && password == null) {
             return false;

collect_app/src/androidTest/java/org/odk/collect/android/support/pages/FormEntryPage.java

@@ -75,6 +75,12 @@ public <D extends Page<D>> D fillOutAndSave(D destination, QuestionAndAnswer...
                 .clickSaveChanges();
     }
 
+    public MainMenuPage fillOutAndSave(QuestionAndAnswer... questionsAndAnswers) {
+        return fillOut(questionsAndAnswers)
+                .pressBack(new SaveOrDiscardFormDialog<>(new MainMenuPage()))
+                .clickSaveChanges();
+    }
+
     public MainMenuPage fillOutAndFinalize(QuestionAndAnswer... questionsAndAnswers) {
         return fillOut(questionsAndAnswers)
                 .swipeToEndScreen()

collect_app/src/androidTest/java/org/odk/collect/android/support/pages/Page.kt

@@ -1,5 +1,6 @@
 package org.odk.collect.android.support.pages
 
+import android.app.Application
 import android.content.pm.ActivityInfo
 import androidx.annotation.StringRes
 import androidx.recyclerview.widget.RecyclerView
@@ -43,6 +44,7 @@ import org.odk.collect.android.support.WaitFor.waitFor
 import org.odk.collect.android.support.actions.RotateAction
 import org.odk.collect.android.support.matchers.CustomMatchers.withIndex
 import org.odk.collect.androidshared.ui.ToastUtils.popRecordedToasts
+import org.odk.collect.strings.localization.getLocalizedQuantityString
 import org.odk.collect.strings.localization.getLocalizedString
 import org.odk.collect.testshared.RecyclerViewMatcher
 import timber.log.Timber
@@ -169,7 +171,18 @@ abstract class Page<T : Page<T>> {
         return this as T
     }
 
-    fun checkIsSnackbarWithMessageDisplayed(message: Int): T {
+    fun checkIsSnackbarWithQuantityDisplayed(message: Int, quantity: Int): T {
+        return checkIsSnackbarWithMessageDisplayed(
+            ApplicationProvider.getApplicationContext<Application>()
+                .getLocalizedQuantityString(message, quantity, quantity)
+        )
+    }
+
+    fun checkIsSnackbarWithMessageDisplayed(message: Int, vararg formatArgs: Any): T {
+        return checkIsSnackbarWithMessageDisplayed(getTranslatedString(message, *formatArgs))
+    }
+
+    fun checkIsSnackbarWithMessageDisplayed(message: String): T {
         onView(withText(message)).check(matches(withEffectiveVisibility(ViewMatchers.Visibility.VISIBLE)))
         return this as T
     }
@@ -425,6 +438,10 @@ abstract class Page<T : Page<T>> {
     }
 
     fun clickOptionsIcon(@StringRes expectedOptionString: Int): T {
+        return clickOptionsIcon(getTranslatedString(expectedOptionString))
+    }
+
+    fun clickOptionsIcon(expectedOptionString: String): T {
         tryAgainOnFail({
             Espresso.openActionBarOverflowOrOptionsMenu(ActivityHelpers.getActivity())
             assertText(expectedOptionString)