Use PlatformTestStorage instead of hardcoding TestStorage in Bitmap.writeToTestStorage.

This will unlock usage in environments where TestStorage is not available.

PiperOrigin-RevId: 605044658

Author: brettchabot

core/CHANGELOG.md

@@ -13,6 +13,7 @@
 **API Changes**
 
 * Added ApplicationInfoBuilder.setFlags(int)
+* Make Bitmap.writeToTestStorage use the registered PlatformTestStorage instead of hardcoding TestStorage
 
 **Breaking API Changes**
 

core/java/androidx/test/core/BUILD

@@ -49,7 +49,6 @@ kt_android_library(
         "//annotation",
         "//opensource/androidx:annotation",
         "//runner/monitor",
-        "//services/storage",
         "@maven//:androidx_concurrent_concurrent_futures",
         "@maven//:androidx_lifecycle_lifecycle_common",
         "@maven//:androidx_tracing_tracing",

core/java/androidx/test/core/api/current_internal.txt

@@ -1 +1,9 @@
 // Signature format: 3.0
+package androidx.test.core.graphics {
+
+  public final class BitmapStorage {
+    method @Deprecated @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP) public static void writeToTestStorage(android.graphics.Bitmap, androidx.test.platform.io.PlatformTestStorage testStorage, String name) throws java.io.IOException;
+  }
+
+}
+

core/java/androidx/test/core/api/current_public.txt

@@ -50,6 +50,13 @@ package androidx.test.core.content.pm {
 
 }
 
+package androidx.test.core.graphics {
+
+  public final class BitmapStorage {
+  }
+
+}
+
 package androidx.test.core.os {
 
   public final class Parcelables {

core/java/androidx/test/core/graphics/BitmapStorageExt.kt

@@ -19,39 +19,42 @@
 package androidx.test.core.graphics
 
 import android.graphics.Bitmap
+import androidx.annotation.RestrictTo
 import androidx.test.annotation.ExperimentalTestApi
 import androidx.test.platform.io.PlatformTestStorage
-import androidx.test.services.storage.TestStorage
+import androidx.test.platform.io.PlatformTestStorageRegistry
 import java.io.IOException
 
 /**
- * Writes the contents of the [Bitmap] to a compressed png file on [TestStorage]
+ * Writes the contents of the [Bitmap] to a compressed png file on [PlatformTestStorage]
  *
  * @param name a descriptive base name for the resulting file. '.png' will be appended to this name.
  * @throws IOException if bitmap could not be compressed or written to ds
  */
 @ExperimentalTestApi
 @Throws(IOException::class)
 fun Bitmap.writeToTestStorage(name: String) {
-  writeToTestStorage(TestStorage(), name)
+  writeToTestStorage(PlatformTestStorageRegistry.getInstance(), name)
 }
 
 /**
- * Writes the contents of the [Bitmap] to a compressed png file to the given [PlatformTestStorage]
- *
- * @param testStorage the [PlatformTestStorage] to use
- * @param name a descriptive base name for the resulting file
- * @throws IOException if bitmap could not be compressed or written to storage
+ * @deprecated
+ * @hide
  */
-@ExperimentalTestApi
+@Deprecated(
+  "use  PlatformTestStorageRegistry.setInstance in the rare cases where you want to override the PlatformTestStorage to use",
+  replaceWith = ReplaceWith("writeToTestStorage()"),
+)
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) // legacy - used by espresso 3.5.0 DefaultFailureHandler
 @Throws(IOException::class)
 fun Bitmap.writeToTestStorage(testStorage: PlatformTestStorage, name: String) {
   testStorage.openOutputFile("$name.png").use {
-    if (!this.compress(
+    if (
+      !this.compress(
         Bitmap.CompressFormat.PNG,
         /** PNG is lossless, so quality is ignored. */
         0,
-        it
+        it,
       )
     ) {
       throw IOException("Failed to compress bitmap")

core/javatests/androidx/test/core/graphics/BitmapStorageTest.kt

@@ -16,14 +16,7 @@
 package androidx.test.core.graphics
 
 import android.graphics.Bitmap
-import android.net.Uri
 import androidx.test.ext.junit.runners.AndroidJUnit4
-import androidx.test.platform.io.PlatformTestStorage
-import java.io.IOException
-import java.io.InputStream
-import java.io.OutputStream
-import java.io.Serializable
-import org.junit.Assert.assertThrows
 import org.junit.Test
 import org.junit.runner.RunWith
 
@@ -35,62 +28,4 @@ class BitmapStorageTest {
     val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)
     bitmap.writeToTestStorage("test")
   }
-
-  @Test
-  fun writeToTestStorage_throws() {
-    val bitmap = Bitmap.createBitmap(100, 100, Bitmap.Config.ARGB_8888)
-    assertThrows(IOException::class.java) {
-      bitmap.writeToTestStorage(ThrowingPlatformTestStorage(), "test")
-    }
-  }
-
-  class ThrowingPlatformTestStorage : PlatformTestStorage {
-    override fun openInputFile(pathname: String?): InputStream {
-      TODO("Not yet implemented")
-    }
-
-    override fun getInputArg(argName: String?): String {
-      TODO("Not yet implemented")
-    }
-
-    override fun getInputArgs(): MutableMap<String, String> {
-      TODO("Not yet implemented")
-    }
-
-    override fun openOutputFile(pathname: String?): OutputStream {
-      throw IOException("error")
-    }
-
-    override fun openOutputFile(pathname: String?, append: Boolean): OutputStream {
-      TODO("Not yet implemented")
-    }
-
-    override fun addOutputProperties(properties: MutableMap<String, Serializable>?) {
-      TODO("Not yet implemented")
-    }
-
-    override fun getOutputProperties(): MutableMap<String, Serializable> {
-      TODO("Not yet implemented")
-    }
-
-    override fun openInternalInputFile(pathname: String?): InputStream {
-      TODO("Not yet implemented")
-    }
-
-    override fun openInternalOutputFile(pathname: String?): OutputStream {
-      TODO("Not yet implemented")
-    }
-
-    override fun getInputFileUri2(pathname: String): Uri {
-      TODO("Not yet implemented")
-    }
-
-    override fun getOutputFileUri2(pathname: String): Uri {
-      TODO("Not yet implemented")
-    }
-
-    override fun isTestStorageFilePath(pathname: String): Boolean {
-      TODO("Not yet implemented")
-    }
-  }
 }

espresso/CHANGELOG.md

@@ -17,6 +17,7 @@ The following artifacts were released:
 **Bug Fixes**
 
 * Fix slow inRoot operations in Robolectric
+* Use PlatformTestStorageRegistry.getInstance consistently instead of passing a reference around
 
 **New Features**
 

espresso/core/java/androidx/test/espresso/base/BaseLayerModule.java

@@ -30,7 +30,6 @@
 import androidx.test.internal.platform.ServiceLoaderWrapper;
 import androidx.test.internal.platform.os.ControlledLooper;
 import androidx.test.platform.app.InstrumentationRegistry;
-import androidx.test.platform.io.PlatformTestStorage;
 import androidx.test.platform.tracing.Tracing;
 import androidx.test.runner.lifecycle.ActivityLifecycleMonitor;
 import androidx.test.runner.lifecycle.ActivityLifecycleMonitorRegistry;
@@ -173,9 +172,8 @@ FailureHandler provideFailureHander(DefaultFailureHandler impl) {
   }
 
   @Provides
-  DefaultFailureHandler provideDefaultFailureHander(
-      @TargetContext Context context, PlatformTestStorage testStorage) {
-    return new DefaultFailureHandler(context, testStorage, true);
+  DefaultFailureHandler provideDefaultFailureHander(@TargetContext Context context) {
+    return new DefaultFailureHandler(context, true);
   }
 
   @Provides

espresso/core/java/androidx/test/espresso/base/DefaultFailureHandler.java

@@ -31,14 +31,11 @@
 import androidx.test.espresso.base.ViewHierarchyExceptionHandler.Truncater;
 import androidx.test.espresso.internal.inject.TargetContext;
 import androidx.test.internal.platform.util.TestOutputEmitter;
-import androidx.test.platform.io.PlatformTestStorage;
-import androidx.test.platform.io.PlatformTestStorageRegistry;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;
-import javax.inject.Inject;
 import junit.framework.AssertionFailedError;
 import org.hamcrest.Matcher;
 
@@ -50,23 +47,15 @@ public final class DefaultFailureHandler implements FailureHandler {
 
   private static final AtomicInteger failureCount = new AtomicInteger(0);
   private final List<FailureHandler> handlers = new ArrayList<>();
-  private final PlatformTestStorage testStorage;
   private final boolean captureScreenshotOnFailure;
 
   public DefaultFailureHandler(@TargetContext Context appContext) {
-    this(appContext, PlatformTestStorageRegistry.getInstance(), true);
+    this(appContext, true);
   }
 
   public DefaultFailureHandler(
       @TargetContext Context appContext, boolean captureScreenshotOnFailure) {
-    this(appContext, PlatformTestStorageRegistry.getInstance(), captureScreenshotOnFailure);
-  }
 
-  @Inject
-  DefaultFailureHandler(
-      @TargetContext Context appContext,
-      PlatformTestStorage testStorage,
-      boolean captureScreenshotOnFailure) {
     // Adds a chain of exception handlers.
     // Order matters and a matching failure handler in the chain will throw after the exception is
     // handled. Always adds the handler of the child class ahead of its superclasses to make sure
@@ -77,17 +66,14 @@ public DefaultFailureHandler(
     // PerformException ---------> EspressoException
     //                  ---------> Throwable
     // AssertionError ----------->
-    this.testStorage = testStorage;
     this.captureScreenshotOnFailure = captureScreenshotOnFailure;
     handlers.add(
         new ViewHierarchyExceptionHandler<>(
-            testStorage,
             failureCount,
             NoMatchingViewException.class,
             getNoMatchingViewExceptionTruncater()));
     handlers.add(
         new ViewHierarchyExceptionHandler<>(
-            testStorage,
             failureCount,
             AmbiguousViewMatcherException.class,
             getAmbiguousViewMatcherExceptionTruncater()));
@@ -141,8 +127,7 @@ private void takeScreenshot(String outputName) {
     }
     try {
       if (DeviceCapture.canTakeScreenshot()) {
-        BitmapStorage.writeToTestStorage(
-            DeviceCapture.takeScreenshotNoSync(), testStorage, outputName);
+        BitmapStorage.writeToTestStorage(DeviceCapture.takeScreenshotNoSync(), outputName);
       } else {
         TestOutputEmitter.takeScreenshot(outputName + ".png");
       }

espresso/core/java/androidx/test/espresso/base/ViewHierarchyExceptionHandler.java

@@ -16,7 +16,6 @@
 package androidx.test.espresso.base;
 
 import static androidx.test.espresso.util.Throwables.throwIfUnchecked;
-import static androidx.test.internal.util.Checks.checkNotNull;
 
 import android.util.Log;
 import android.view.View;
@@ -25,6 +24,7 @@
 import androidx.test.espresso.base.DefaultFailureHandler.TypedFailureHandler;
 import androidx.test.espresso.util.HumanReadables;
 import androidx.test.platform.io.PlatformTestStorage;
+import androidx.test.platform.io.PlatformTestStorageRegistry;
 import androidx.test.services.storage.TestStorageException;
 import java.io.IOException;
 import java.io.OutputStream;
@@ -44,7 +44,6 @@ class ViewHierarchyExceptionHandler<T extends Throwable & RootViewException>
   private static final int MAX_MSG_SIZE = (64 - 2) * 1024;
   private static final String VIEW_HIERARCHY_CHAR_LIMIT = "view_hierarchy_char_limit";
 
-  private final PlatformTestStorage testStorage;
   private final AtomicInteger failureCount;
   private final Truncater<T> truncater;
 
@@ -53,12 +52,10 @@ interface Truncater<T> {
   }
 
   public ViewHierarchyExceptionHandler(
-      PlatformTestStorage testStorage,
       AtomicInteger failureCount,
       Class<T> expectedType,
       Truncater<T> truncater) {
     super(expectedType);
-    this.testStorage = checkNotNull(testStorage);
     this.failureCount = failureCount;
     this.truncater = truncater;
   }
@@ -79,6 +76,7 @@ public void handleSafely(T exception, Matcher<View> viewMatcher) {
   }
 
   private int getMsgLen() {
+    PlatformTestStorage testStorage = PlatformTestStorageRegistry.getInstance();
     try {
       if (testStorage.getInputArgs().containsKey(VIEW_HIERARCHY_CHAR_LIMIT)) {
         String limit = testStorage.getInputArg(VIEW_HIERARCHY_CHAR_LIMIT);
@@ -116,7 +114,7 @@ private String dumpFullViewHierarchyToFile(T error) {
   }
 
   private void addOutputFile(String filename, String content) throws IOException {
-    try (OutputStream out = testStorage.openOutputFile(filename)) {
+    try (OutputStream out = PlatformTestStorageRegistry.getInstance().openOutputFile(filename)) {
       out.write(content.getBytes());
     }
   }