Implement dynamic waits, setup methods, isolate gps tests

src/androidTest/java/de/dennisguse/opentracks/util/ActivityTestUtils.java

@@ -0,0 +1,106 @@
+package de.dennisguse.opentracks.util;
+
+import static org.junit.Assert.fail;
+
+import android.app.Activity;
+import android.app.Application;
+import android.os.Bundle;
+
+import androidx.test.core.app.ApplicationProvider;
+import androidx.test.platform.app.InstrumentationRegistry;
+import androidx.test.runner.lifecycle.ActivityLifecycleMonitorRegistry;
+import androidx.test.runner.lifecycle.Stage;
+
+import java.time.Duration;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
+
+public final class ActivityTestUtils {
+
+    private ActivityTestUtils() {
+    }
+
+    public static <T extends Activity> T waitForResumedActivity(Class<T> activityClass, Duration timeout) {
+        T resumedActivity = getResumedActivity(activityClass);
+        if (resumedActivity != null) {
+            return resumedActivity;
+        }
+
+        Application application = ApplicationProvider.getApplicationContext();
+        CountDownLatch latch = new CountDownLatch(1);
+        AtomicReference<T> resumedActivityRef = new AtomicReference<>();
+
+        Application.ActivityLifecycleCallbacks callbacks = new Application.ActivityLifecycleCallbacks() {
+            @Override
+            public void onActivityResumed(Activity activity) {
+                if (activityClass.isInstance(activity)) {
+                    resumedActivityRef.set(activityClass.cast(activity));
+                    latch.countDown();
+                }
+            }
+
+            @Override
+            public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
+            }
+
+            @Override
+            public void onActivityStarted(Activity activity) {
+            }
+
+            @Override
+            public void onActivityPaused(Activity activity) {
+            }
+
+            @Override
+            public void onActivityStopped(Activity activity) {
+            }
+
+            @Override
+            public void onActivitySaveInstanceState(Activity activity, Bundle outState) {
+            }
+
+            @Override
+            public void onActivityDestroyed(Activity activity) {
+            }
+        };
+
+        InstrumentationRegistry.getInstrumentation().runOnMainSync(() -> {
+            application.registerActivityLifecycleCallbacks(callbacks);
+
+            T currentResumedActivity = findResumedActivity(activityClass);
+            if (currentResumedActivity != null) {
+                resumedActivityRef.set(currentResumedActivity);
+                latch.countDown();
+            }
+        });
+
+        try {
+            if (!latch.await(timeout.toMillis(), TimeUnit.MILLISECONDS)) {
+                fail("Timed out waiting for resumed activity " + activityClass.getSimpleName());
+            }
+        } catch (InterruptedException e) {
+            Thread.currentThread().interrupt();
+            fail("Interrupted while waiting for resumed activity " + activityClass.getSimpleName());
+        } finally {
+            InstrumentationRegistry.getInstrumentation().runOnMainSync(() -> application.unregisterActivityLifecycleCallbacks(callbacks));
+        }
+
+        return resumedActivityRef.get();
+    }
+
+    private static <T extends Activity> T getResumedActivity(Class<T> activityClass) {
+        AtomicReference<T> resumedActivity = new AtomicReference<>();
+        InstrumentationRegistry.getInstrumentation().runOnMainSync(() -> resumedActivity.set(findResumedActivity(activityClass)));
+        return resumedActivity.get();
+    }
+
+    private static <T extends Activity> T findResumedActivity(Class<T> activityClass) {
+        for (Activity activity : ActivityLifecycleMonitorRegistry.getInstance().getActivitiesInStage(Stage.RESUMED)) {
+            if (activityClass.isInstance(activity)) {
+                return activityClass.cast(activity);
+            }
+        }
+        return null;
+    }
+}

src/androidTest/java/de/dennisguse/opentracks/util/EspressoUtils.java

@@ -1,14 +1,25 @@
 package de.dennisguse.opentracks.util;
 
 import static androidx.test.espresso.matcher.ViewMatchers.isDisplayed;
+import static androidx.test.espresso.matcher.ViewMatchers.isRoot;
 
+import android.app.Activity;
+import android.os.SystemClock;
 import android.view.View;
 import android.view.ViewGroup;
 import android.view.ViewParent;
 import android.widget.ListView;
 
+import androidx.recyclerview.widget.RecyclerView;
+import androidx.test.espresso.PerformException;
 import androidx.test.espresso.UiController;
 import androidx.test.espresso.ViewAction;
+import androidx.test.platform.app.InstrumentationRegistry;
+import androidx.test.runner.lifecycle.ActivityLifecycleMonitorRegistry;
+import androidx.test.runner.lifecycle.Stage;
+import androidx.test.espresso.util.HumanReadables;
+import androidx.test.espresso.util.TreeIterables;
+import androidx.viewpager2.widget.ViewPager2;
 
 import com.google.android.material.tabs.TabLayout;
 
@@ -16,8 +27,15 @@ import org.hamcrest.Description;
 import org.hamcrest.Matcher;
 import org.hamcrest.TypeSafeMatcher;
 
+import java.time.Duration;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.concurrent.TimeoutException;
+import java.util.function.Predicate;
+
 public class EspressoUtils {
 
+    private static final long VIEW_POLLING_INTERVAL_MS = 50;
+
     public static Matcher<View> childAtPosition(
             final Matcher<View> parentMatcher, final int position) {
 
@@ -51,26 +69,138 @@ public class EspressoUtils {
         };
     }
 
-    public static ViewAction waitFor(final long duration_ms) {
-        return new ViewAction() {
+    public static Matcher<View> withRecyclerViewItemCount(final int count) {
+        return new TypeSafeMatcher<>() {
+            @Override
+            protected boolean matchesSafely(View view) {
+                if (!(view instanceof RecyclerView recyclerView)) {
+                    return false;
+                }
+
+                RecyclerView.Adapter<?> adapter = recyclerView.getAdapter();
+                return adapter != null && adapter.getItemCount() == count;
+            }
 
+            @Override
+            public void describeTo(Description description) {
+                description.appendText("RecyclerView should have " + count + " items");
+            }
+        };
+    }
+
+    public static Matcher<View> withSelectedTab(final int index) {
+        return new TypeSafeMatcher<>() {
+            @Override
+            protected boolean matchesSafely(View view) {
+                return view instanceof TabLayout tabLayout
+                        && tabLayout.getSelectedTabPosition() == index;
+            }
+
+            @Override
+            public void describeTo(Description description) {
+                description.appendText("TabLayout should have selected tab " + index);
+            }
+        };
+    }
+
+    public static Matcher<View> withViewPagerCurrentItem(final int index) {
+        return new TypeSafeMatcher<>() {
+            @Override
+            protected boolean matchesSafely(View view) {
+                return view instanceof ViewPager2 viewPager2
+                        && viewPager2.getCurrentItem() == index
+                        && viewPager2.getScrollState() == ViewPager2.SCROLL_STATE_IDLE;
+            }
+
+            @Override
+            public void describeTo(Description description) {
+                description.appendText("ViewPager2 should be idle on item " + index);
+            }
+        };
+    }
+
+    public static ViewAction waitForView(final Matcher<View> viewMatcher, final Duration timeout) {
+        return waitForViewCondition(viewMatcher, ignored -> true, "view to match " + viewMatcher, timeout);
+    }
+
+    public static ViewAction waitForViewCondition(final Matcher<View> viewMatcher,
+                                                  final Predicate<View> condition,
+                                                  final String conditionDescription,
+                                                  final Duration timeout) {
+        return new ViewAction() {
             @Override
             public String getDescription() {
-                return "Wait for milliseconds.";
+                return "wait up to " + timeout + " ms for " + conditionDescription;
             }
 
             @Override
             public Matcher<View> getConstraints() {
-                return isDisplayed();
+                return isRoot();
             }
 
             @Override
-            public void perform(UiController uiController, final View view) {
-                uiController.loopMainThreadForAtLeast(duration_ms);
+            public void perform(UiController uiController, View view) {
+                long deadline = SystemClock.uptimeMillis() + timeout.toMillis();
+
+                do {
+                    uiController.loopMainThreadUntilIdle();
+
+                    for (View child : TreeIterables.breadthFirstViewTraversal(view)) {
+                        if (viewMatcher.matches(child) && condition.test(child)) {
+                            return;
+                        }
+                    }
+
+                    uiController.loopMainThreadForAtLeast(VIEW_POLLING_INTERVAL_MS);
+                } while (SystemClock.uptimeMillis() < deadline);
+
+                throw new PerformException.Builder()
+                        .withActionDescription(getDescription())
+                        .withViewDescription(HumanReadables.describe(view))
+                        .withCause(new TimeoutException("Timed out waiting for " + conditionDescription))
+                        .build();
             }
         };
     }
 
+    public static void waitForResumedView(final Matcher<View> viewMatcher, final Duration timeout) {
+        waitForResumedViewCondition(viewMatcher, ignored -> true, "view to match " + viewMatcher, timeout);
+    }
+
+    public static void waitForResumedViewCondition(final Matcher<View> viewMatcher,
+                                                   final Predicate<View> condition,
+                                                   final String conditionDescription,
+                                                   final Duration timeout) {
+        long deadline = SystemClock.uptimeMillis() + timeout.toMillis();
+
+        do {
+            InstrumentationRegistry.getInstrumentation().waitForIdleSync();
+
+            AtomicBoolean matched = new AtomicBoolean(false);
+            InstrumentationRegistry.getInstrumentation().runOnMainSync(() -> {
+                for (Activity activity : ActivityLifecycleMonitorRegistry.getInstance().getActivitiesInStage(Stage.RESUMED)) {
+                    View decorView = activity.getWindow() != null ? activity.getWindow().getDecorView() : null;
+                    if (decorView == null) {
+                        continue;
+                    }
+
+                    for (View child : TreeIterables.breadthFirstViewTraversal(decorView)) {
+                        if (viewMatcher.matches(child) && condition.test(child)) {
+                            matched.set(true);
+                            return;
+                        }
+                    }
+                }
+            });
+
+            if (matched.get()) {
+                return;
+            }
+        } while (SystemClock.uptimeMillis() < deadline);
+
+        throw new AssertionError("Timed out waiting for " + conditionDescription);
+    }
+
     public static ViewAction selectTabAtIndex(final int index) {
         return new ViewAction() {
             @Override

src/androidTest/java/de/dennisguse/opentracks/util/LiveDataTestUtils.java

@@ -0,0 +1,57 @@
+package de.dennisguse.opentracks.util;
+
+import static org.junit.Assert.fail;
+
+import androidx.lifecycle.LiveData;
+import androidx.lifecycle.Observer;
+import androidx.test.platform.app.InstrumentationRegistry;
+
+import java.time.Duration;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
+import java.util.function.Predicate;
+
+public final class LiveDataTestUtils {
+
+    private LiveDataTestUtils() {
+    }
+
+    public static <T> T waitForValue(LiveData<T> liveData,
+                                     Predicate<T> predicate,
+                                     Duration timeout,
+                                     String description) {
+        AtomicReference<T> lastValue = new AtomicReference<>(liveData.getValue());
+        CountDownLatch latch = new CountDownLatch(1);
+
+        Observer<T> observer = value -> {
+            lastValue.set(value);
+            if (predicate.test(value)) {
+                latch.countDown();
+            }
+        };
+
+        InstrumentationRegistry.getInstrumentation().runOnMainSync(() -> {
+            liveData.observeForever(observer);
+
+            T currentValue = liveData.getValue();
+            lastValue.set(currentValue);
+            if (predicate.test(currentValue)) {
+                latch.countDown();
+            }
+        });
+
+        try {
+            if (!latch.await(timeout.toMillis(), TimeUnit.MILLISECONDS)) {
+                fail("Timed out waiting for " + description + ". Last value: " + lastValue.get());
+            }
+        } catch (InterruptedException e) {
+            Thread.currentThread().interrupt();
+            fail("Interrupted while waiting for " + description);
+        } finally {
+            InstrumentationRegistry.getInstrumentation().runOnMainSync(() -> liveData.removeObserver(observer));
+        }
+
+        return lastValue.get();
+    }
+}

src/androidTest/java/de/dennisguse/opentracks/util/TrackRecordingServiceTestUtils.java

@@ -0,0 +1,50 @@
+package de.dennisguse.opentracks.util;
+
+import static org.junit.Assert.fail;
+
+import android.content.Context;
+
+import androidx.test.core.app.ApplicationProvider;
+import androidx.test.platform.app.InstrumentationRegistry;
+
+import java.time.Duration;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
+
+import de.dennisguse.opentracks.services.TrackRecordingService;
+import de.dennisguse.opentracks.services.TrackRecordingServiceConnection;
+
+public final class TrackRecordingServiceTestUtils {
+
+    private TrackRecordingServiceTestUtils() {
+    }
+
+    public static void waitForRecordingState(boolean isRecording, Duration timeout) {
+        Context context = ApplicationProvider.getApplicationContext();
+        CountDownLatch connectedLatch = new CountDownLatch(1);
+        AtomicReference<TrackRecordingService> serviceRef = new AtomicReference<>();
+        TrackRecordingServiceConnection connection = new TrackRecordingServiceConnection((service, self) -> {
+            serviceRef.set(service);
+            connectedLatch.countDown();
+        });
+
+        InstrumentationRegistry.getInstrumentation().runOnMainSync(() -> connection.bind(context));
+
+        try {
+            if (!connectedLatch.await(timeout.toMillis(), TimeUnit.MILLISECONDS)) {
+                fail("Timed out waiting to bind TrackRecordingService");
+            }
+
+            LiveDataTestUtils.waitForValue(serviceRef.get().getRecordingStatusObservable(),
+                    status -> status != null && status.isRecording() == isRecording,
+                    timeout,
+                    "recording state to become " + isRecording);
+        } catch (InterruptedException e) {
+            Thread.currentThread().interrupt();
+            fail("Interrupted while waiting for recording state " + isRecording);
+        } finally {
+            InstrumentationRegistry.getInstrumentation().runOnMainSync(() -> connection.unbind(context));
+        }
+    }
+}