Fix external apps returning data when Collect is being restored

async/src/main/java/org/odk/collect/async/SchedulerAsyncTaskMimic.kt

@@ -0,0 +1,76 @@
+package org.odk.collect.async
+
+import android.os.AsyncTask
+
+/**
+ * Basic reimplementation of the [AsyncTask] API that allows an [AsyncTask] implementation to
+ * use [Scheduler] with minimal internal and external changes.
+ */
+abstract class SchedulerAsyncTaskMimic<Params, Progress, Result>(private val scheduler: Scheduler) {
+
+    @Volatile
+    private var status: AsyncTask.Status = AsyncTask.Status.PENDING
+
+    @Volatile
+    private var cancelled = false
+
+    protected abstract fun onPreExecute()
+    protected abstract fun doInBackground(vararg params: Params): Result
+    protected abstract fun onProgressUpdate(vararg values: Progress)
+    protected abstract fun onPostExecute(result: Result)
+    protected abstract fun onCancelled()
+
+    /**
+     * Execute [doInBackground] on calling thread and return the [Result] value. Should probably
+     * not be used as a replacement for [AsyncTask.get] (unless it's for testing purposes).
+     */
+    fun executeSynchronously(vararg params: Params): Result {
+        return doInBackground(*params)
+    }
+
+    fun execute(vararg params: Params): SchedulerAsyncTaskMimic<Params, Progress, Result> {
+        status = AsyncTask.Status.RUNNING
+        onPreExecute()
+
+        scheduler.immediate(
+            background = {
+                doInBackground(*params)
+            },
+            foreground = { result ->
+                if (cancelled) {
+                    onCancelled()
+                } else {
+                    onPostExecute(result)
+                }
+
+                status = AsyncTask.Status.FINISHED
+            }
+        )
+
+        return this
+    }
+
+    fun getStatus(): AsyncTask.Status {
+        return status
+    }
+
+    /**
+     * Unlike [AsyncTask.cancel], this does not offer the option to attempt to interrupt the
+     * background thread running [doInBackground]. Calling [cancel] will allow [doInBackground]
+     * to finish, but will prevent [onPostExecute] from running ([onCancelled] will be run
+     * instead).
+     */
+    fun cancel() {
+        cancelled = true
+    }
+
+    fun isCancelled(): Boolean {
+        return cancelled
+    }
+
+    protected fun publishProgress(vararg values: Progress) {
+        scheduler.immediate(
+            foreground = { onProgressUpdate(*values) }
+        )
+    }
+}

collect_app/build.gradle

@@ -200,15 +200,6 @@ android {
         }
     }
 
-
-    sourceSets {
-        androidTest {
-            java.srcDirs += "src/commonTest/java"
-        }
-        test {
-            java.srcDirs += "src/commonTest/java"
-        }
-    }
     lint {
         abortOnError true
         checkDependencies true
@@ -373,6 +364,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
 
@@ -389,6 +381,7 @@ dependencies {
     testImplementation Dependencies.androidx_test_core_ktx
 
     androidTestImplementation project(':androidtest')
+    androidTestImplementation project(':test-forms')
 
     androidTestImplementation Dependencies.mockito_android
     androidTestImplementation Dependencies.androidx_test_ext_junit

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

@@ -1,6 +1,6 @@
 package org.odk.collect.android.feature.formentry;
 
-import static org.odk.collect.android.support.FileUtils.copyFileFromAssets;
+import static org.odk.collect.android.utilities.FileUtils.copyFileFromResources;
 
 import android.app.Application;
 
@@ -10,12 +10,12 @@
 import org.junit.Test;
 import org.junit.rules.RuleChain;
 import org.junit.runner.RunWith;
-import org.odk.collect.android.support.rules.CollectTestRule;
 import org.odk.collect.android.support.TestDependencies;
-import org.odk.collect.android.support.rules.TestRuleChain;
 import org.odk.collect.android.support.pages.FormEntryPage;
 import org.odk.collect.android.support.pages.MainMenuPage;
 import org.odk.collect.android.support.pages.OkDialog;
+import org.odk.collect.android.support.rules.CollectTestRule;
+import org.odk.collect.android.support.rules.TestRuleChain;
 import org.odk.collect.audiorecorder.recording.AudioRecorder;
 import org.odk.collect.audiorecorder.testsupport.StubAudioRecorder;
 
@@ -35,7 +35,7 @@ public AudioRecorder providesAudioRecorder(Application application) {
                     File stubRecording = File.createTempFile("test", ".m4a");
                     stubRecording.deleteOnExit();
 
-                    copyFileFromAssets("media/test.m4a", stubRecording.getAbsolutePath());
+                    copyFileFromResources("media/test.m4a", stubRecording.getAbsolutePath());
                     stubAudioRecorderViewModel = new StubAudioRecorder(stubRecording.getAbsolutePath());
                 } catch (IOException e) {
                     throw new RuntimeException(e);

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

@@ -4,7 +4,7 @@
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.CoreMatchers.nullValue;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.odk.collect.android.support.FileUtils.copyFileFromAssets;
+import static org.odk.collect.android.utilities.FileUtils.copyFileFromResources;
 
 import android.Manifest;
 import android.app.Activity;
@@ -56,7 +56,7 @@ public AudioRecorder providesAudioRecorder(Application application) {
                     File stubRecording = File.createTempFile("test", ".m4a");
                     stubRecording.deleteOnExit();
 
-                    copyFileFromAssets("media/test.m4a", stubRecording.getAbsolutePath());
+                    copyFileFromResources("media/test.m4a", stubRecording.getAbsolutePath());
                     stubAudioRecorderViewModel = new StubAudioRecorder(stubRecording.getAbsolutePath());
                 } catch (IOException e) {
                     throw new RuntimeException(e);

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

@@ -2,7 +2,7 @@
 
 import static androidx.test.espresso.intent.Intents.intending;
 import static androidx.test.espresso.intent.matcher.IntentMatchers.hasAction;
-import static org.odk.collect.android.support.FileUtils.copyFileFromAssets;
+import static org.odk.collect.android.utilities.FileUtils.copyFileFromResources;
 
 import android.app.Activity;
 import android.app.Instrumentation;
@@ -39,7 +39,7 @@ public class ExternalAudioRecordingTest {
                 try {
                     File stubRecording = File.createTempFile("test", ".m4a");
                     stubRecording.deleteOnExit();
-                    copyFileFromAssets("media/test.m4a", stubRecording.getAbsolutePath());
+                    copyFileFromResources("media/test.m4a", stubRecording.getAbsolutePath());
 
                     Intent intent = new Intent();
                     intent.setData(Uri.fromFile(stubRecording));

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

@@ -43,6 +43,7 @@
 import static org.odk.collect.android.support.matchers.CustomMatchers.withIndex;
 
 import android.app.Activity;
+import android.app.Application;
 import android.app.Instrumentation;
 import android.graphics.Bitmap;
 import android.graphics.BitmapFactory;
@@ -60,7 +61,7 @@
 import org.junit.Test;
 import org.junit.rules.RuleChain;
 import org.odk.collect.android.R;
-import org.odk.collect.android.TestSettingsProvider;
+import org.odk.collect.android.injection.DaggerUtils;
 import org.odk.collect.android.preferences.GuidanceHint;
 import org.odk.collect.android.storage.StoragePathProvider;
 import org.odk.collect.android.support.pages.FormEntryPage;
@@ -323,7 +324,11 @@ public void questionsAppearingBeforeCurrentBinaryQuestion_ShouldNotChangeFocus()
 
     @Test
     public void changeInValueUsedInGuidanceHint_ShouldChangeGuidanceHintText() {
-        TestSettingsProvider.getUnprotectedSettings().save(ProjectKeys.KEY_GUIDANCE_HINT, GuidanceHint.YES.toString());
+        DaggerUtils.getComponent(ApplicationProvider.<Application>getApplicationContext())
+                .settingsProvider()
+                .getUnprotectedSettings()
+                .save(ProjectKeys.KEY_GUIDANCE_HINT, GuidanceHint.YES.toString());
+
         jumpToGroupWithText("Guidance hint");
         onView(withText(startsWith("Source11"))).perform(click());
 

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

@@ -8,13 +8,16 @@
 import static androidx.test.espresso.matcher.ViewMatchers.withText;
 import static org.hamcrest.CoreMatchers.not;
 
+import android.app.Application;
+
+import androidx.test.core.app.ApplicationProvider;
 import androidx.test.espresso.matcher.ViewMatchers;
 
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.RuleChain;
 import org.odk.collect.android.R;
-import org.odk.collect.android.TestSettingsProvider;
+import org.odk.collect.android.injection.DaggerUtils;
 import org.odk.collect.android.preferences.GuidanceHint;
 import org.odk.collect.android.support.rules.BlankFormTestRule;
 import org.odk.collect.android.support.rules.TestRuleChain;
@@ -36,7 +39,11 @@ public void guidanceHint_ShouldBeHiddenByDefault() {
 
     @Test
     public void guidanceHint_ShouldBeDisplayedWhenSettingSetToYes() {
-        TestSettingsProvider.getUnprotectedSettings().save(ProjectKeys.KEY_GUIDANCE_HINT, GuidanceHint.YES.toString());
+        DaggerUtils.getComponent(ApplicationProvider.<Application>getApplicationContext())
+                .settingsProvider()
+                .getUnprotectedSettings()
+                .save(ProjectKeys.KEY_GUIDANCE_HINT, GuidanceHint.YES.toString());
+
         // jump to force recreation of the view after the settings change
         onView(withId(R.id.menu_goto)).perform(click());
         onView(withId(R.id.jumpBeginningButton)).perform(click());
@@ -46,7 +53,11 @@ public void guidanceHint_ShouldBeDisplayedWhenSettingSetToYes() {
 
     @Test
     public void guidanceHint_ShouldBeDisplayedAfterClickWhenSettingSetToYesCollapsed() {
-        TestSettingsProvider.getUnprotectedSettings().save(ProjectKeys.KEY_GUIDANCE_HINT, GuidanceHint.YES_COLLAPSED.toString());
+        DaggerUtils.getComponent(ApplicationProvider.<Application>getApplicationContext())
+                .settingsProvider()
+                .getUnprotectedSettings()
+                .save(ProjectKeys.KEY_GUIDANCE_HINT, GuidanceHint.YES_COLLAPSED.toString());
+
         // jump to force recreation of the view after the settings change
         onView(withId(R.id.menu_goto)).perform(click());
         onView(withId(R.id.jumpBeginningButton)).perform(click());

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

@@ -37,7 +37,7 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 import static org.odk.collect.android.support.matchers.CustomMatchers.withIndex;
-import static org.odk.collect.android.support.FileUtils.copyFileFromAssets;
+import static org.odk.collect.android.utilities.FileUtils.copyFileFromResources;
 
 import android.app.Activity;
 import android.app.Instrumentation;
@@ -251,7 +251,7 @@ private Uri createTempFile(String name, String extension) throws IOException {
                 .getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS);
 
         File file = File.createTempFile(name, extension, downloadsDir);
-        copyFileFromAssets("media" + File.separator + name + "." + extension, file.getPath());
+        copyFileFromResources("media" + File.separator + name + "." + extension, file.getPath());
         return getUriForFile(file);
     }
 

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

@@ -7,7 +7,6 @@ import org.junit.Rule
 import org.junit.Test
 import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
-import org.odk.collect.android.support.CollectHelpers
 import org.odk.collect.android.support.StorageUtils
 import org.odk.collect.android.support.pages.AppClosedPage
 import org.odk.collect.android.support.pages.FormEntryPage
@@ -223,18 +222,15 @@ class SavePointTest {
      * being battery dying).
      */
     private fun simulateBatteryDeath(): FormEntryActivityTestRule {
-        CollectHelpers.simulateProcessRestart()
-        return rule
+        return rule.simulateProcessRestart()
     }
 
     /**
      * Simulate a "process death" case where an app in the background is killed
      */
     private fun simulateProcessDeath(): FormEntryActivityTestRule {
-        rule.navigateAwayFromActivity()
+        return rule.navigateAwayFromActivity()
             .destroyActivity()
-
-        CollectHelpers.simulateProcessRestart()
-        return rule
+            .simulateProcessRestart()
     }
 }

collect_app/src/androidTest/java/org/odk/collect/android/instrumented/forms/FormNavigationTest.java

@@ -18,6 +18,8 @@
 
 import static junit.framework.Assert.assertEquals;
 
+import static org.mockito.Mockito.mock;
+
 import android.app.Application;
 
 import androidx.test.core.app.ApplicationProvider;
@@ -129,7 +131,7 @@ private void testIndices(String formName, String[] expectedIndices) throws Execu
             Timber.i(e);
         }
 
-        FormLoaderTask formLoaderTask = new FormLoaderTask(formPath(formName), null, null, formEntryControllerFactory);
+        FormLoaderTask formLoaderTask = new FormLoaderTask(formPath(formName), null, null, formEntryControllerFactory, mock());
         formLoaderTask.setFormLoaderListener(new FormLoaderListener() {
             @Override
             public void loadingComplete(FormLoaderTask task, FormDef fd, String warningMsg) {
@@ -162,7 +164,7 @@ public void onProgressStep(String stepMessage) {
 
             }
         });
-        formLoaderTask.execute(formPath(formName)).get();
+        formLoaderTask.executeSynchronously(formPath(formName));
     }
 
     /**