Merge pull request #6864 from robolectric/piper_410291892

Add ActivityController.close that transitions Activity to destroyed state
robolectric · Nov 17, 2021 · c1c3c0e · c1c3c0e
2 parents 662a2fe + feaded1
commit c1c3c0e
Show file tree

Hide file tree

Showing 2 changed files with 104 additions and 1 deletion.
diff --git a/robolectric/src/test/java/org/robolectric/android/controller/ActivityControllerTest.java b/robolectric/src/test/java/org/robolectric/android/controller/ActivityControllerTest.java
@@ -379,6 +379,77 @@ public void windowFocusChanged() {
     assertThat(controller.get().hasWindowFocus()).isTrue();
   }
 
+  @Test
+  public void close_transitionsActivityStateToDestroyed() {
+    Robolectric.buildActivity(MyActivity.class).close();
+    assertThat(transcript).isEmpty();
+    transcript.clear();
+
+    Robolectric.buildActivity(MyActivity.class).create().close();
+    assertThat(transcript)
+        .containsExactly("onCreate", "finishedOnCreate", "onDestroy", "finishedOnDestroy");
+    transcript.clear();
+
+    Robolectric.buildActivity(MyActivity.class).create().start().close();
+    assertThat(transcript)
+        .containsExactly(
+            "onCreate",
+            "finishedOnCreate",
+            "onStart",
+            "finishedOnStart",
+            "onStop",
+            "finishedOnStop",
+            "onDestroy",
+            "finishedOnDestroy");
+    transcript.clear();
+
+    Robolectric.buildActivity(MyActivity.class).setup().close();
+    assertThat(transcript)
+        .containsExactly(
+            "onCreate",
+            "finishedOnCreate",
+            "onStart",
+            "finishedOnStart",
+            "onPostCreate",
+            "finishedOnPostCreate",
+            "onResume",
+            "finishedOnResume",
+            "onPostResume",
+            "finishedOnPostResume",
+            "onPause",
+            "finishedOnPause",
+            "onStop",
+            "finishedOnStop",
+            "onDestroy",
+            "finishedOnDestroy");
+  }
+
+  @Test
+  public void close_tryWithResources_getsDestroyed() {
+    try (ActivityController<MyActivity> ignored =
+        Robolectric.buildActivity(MyActivity.class).setup()) {
+      // no-op
+    }
+    assertThat(transcript)
+        .containsExactly(
+            "onCreate",
+            "finishedOnCreate",
+            "onStart",
+            "finishedOnStart",
+            "onPostCreate",
+            "finishedOnPostCreate",
+            "onResume",
+            "finishedOnResume",
+            "onPostResume",
+            "finishedOnPostResume",
+            "onPause",
+            "finishedOnPause",
+            "onStop",
+            "finishedOnStop",
+            "onDestroy",
+            "finishedOnDestroy");
+  }
+
   public static class MyActivity extends Activity {
     @Override
     protected void onRestoreInstanceState(Bundle savedInstanceState) {

diff --git a/shadows/framework/src/main/java/org/robolectric/android/controller/ActivityController.java b/shadows/framework/src/main/java/org/robolectric/android/controller/ActivityController.java
@@ -44,7 +44,7 @@
  */
 @SuppressWarnings("NewApi")
 public class ActivityController<T extends Activity>
-    extends ComponentController<ActivityController<T>, T> {
+    extends ComponentController<ActivityController<T>, T> implements AutoCloseable {
 
   enum LifecycleState {
     INITIAL,
@@ -541,6 +541,38 @@ private Instrumentation getInstrumentation() {
     return _component_.getInstrumentation();
   }
 
+  /**
+   * Transitions the underlying Activity to the 'destroyed' state by progressing through the
+   * appropriate lifecycle events. It frees up any resources and makes the Activity eligible for GC.
+   */
+  @Override
+  public void close() {
+
+    LifecycleState originalState = currentState;
+
+    switch (originalState) {
+      case INITIAL:
+      case DESTROYED:
+        return;
+      case RESUMED:
+        pause();
+        // fall through
+      case PAUSED:
+        // fall through
+      case RESTARTED:
+        // fall through
+      case STARTED:
+        stop();
+        // fall through
+      case STOPPED:
+        // fall through
+      case CREATED:
+        break;
+    }
+
+    destroy();
+  }
+
   /** Accessor interface for android.app.Activity.NonConfigurationInstances's internals. */
   @ForType(className = "android.app.Activity$NonConfigurationInstances")
   interface _NonConfigurationInstances_ {