Make PlatformTestStorage throw FileNotFoundException instead of IOException.

This was done largely to have consistency with its TestStorage implementation,
and to have a more precise API.

PiperOrigin-RevId: 604714337

Author: brettchabot

runner/android_junit_runner/javatests/androidx/test/internal/runner/RunnerArgsTest.java

@@ -41,6 +41,7 @@
 import java.io.BufferedWriter;
 import java.io.ByteArrayInputStream;
 import java.io.File;
+import java.io.FileNotFoundException;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.io.InputStream;
@@ -704,11 +705,11 @@ private static class FakeTestStorage implements PlatformTestStorage {
     private final Map<String, InputStream> inputFileMap = new HashMap<>();
 
     @Override
-    public InputStream openInputFile(String pathname) throws IOException {
+    public InputStream openInputFile(String pathname) throws FileNotFoundException {
 
       InputStream is = inputFileMap.get(pathname);
       if (is == null) {
-        throw new IOException();
+        throw new FileNotFoundException();
       }
       return is;
     }
@@ -728,12 +729,12 @@ public Map<String, String> getInputArgs() {
     }
 
     @Override
-    public OutputStream openOutputFile(String pathname) throws IOException {
+    public OutputStream openOutputFile(String pathname) {
       throw new UnsupportedOperationException();
     }
 
     @Override
-    public OutputStream openOutputFile(String pathname, boolean append) throws IOException {
+    public OutputStream openOutputFile(String pathname, boolean append) {
       throw new UnsupportedOperationException();
     }
 
@@ -748,12 +749,12 @@ public Map<String, Serializable> getOutputProperties() {
     }
 
     @Override
-    public InputStream openInternalInputFile(String pathname) throws IOException {
+    public InputStream openInternalInputFile(String pathname) {
       throw new UnsupportedOperationException();
     }
 
     @Override
-    public OutputStream openInternalOutputFile(String pathname) throws IOException {
+    public OutputStream openInternalOutputFile(String pathname) {
       throw new UnsupportedOperationException();
     }
 

runner/monitor/CHANGELOG.md

@@ -14,6 +14,8 @@
 * Make DeviceController an public API from ExperimentalTestApi
 * Upstream TestStorage.isTestStoragePath to PlatformTestStorage
 * Upstream TestStorage.getInputFileUri and getOutputFileUri  to PlatformTestStorage
+* Change PlatformTestStorage methods to throw FileNotFoundException instead of 
+  IOException
 
 **Breaking API Changes**
 

runner/monitor/java/androidx/test/platform/io/FileTestStorage.java

@@ -23,6 +23,7 @@
 import androidx.test.platform.app.InstrumentationRegistry;
 import java.io.File;
 import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
@@ -55,12 +56,19 @@ public FileTestStorage() {
    *     apk's asset directory
    */
   @Override
-  public InputStream openInputFile(String pathname) throws IOException {
+  public InputStream openInputFile(String pathname) throws FileNotFoundException {
     File inputFile = new File(pathname);
     if (inputFile.isAbsolute()) {
       return new FileInputStream(inputFile);
     }
-    return InstrumentationRegistry.getInstrumentation().getContext().getAssets().open(pathname);
+    try {
+      return InstrumentationRegistry.getInstrumentation().getContext().getAssets().open(pathname);
+    } catch (IOException e) {
+      FileNotFoundException fe =
+          new FileNotFoundException(String.format("failed to open %s from apk assets", pathname));
+      fe.initCause(e);
+      throw fe;
+    }
   }
 
   /**
@@ -71,12 +79,12 @@ public InputStream openInputFile(String pathname) throws IOException {
    *     writable output dir based on API level.
    */
   @Override
-  public OutputStream openOutputFile(String pathname) throws IOException {
+  public OutputStream openOutputFile(String pathname) throws FileNotFoundException {
     return openOutputFile(pathname, false);
   }
 
   @Override
-  public OutputStream openOutputFile(String pathname, boolean append) throws IOException {
+  public OutputStream openOutputFile(String pathname, boolean append) throws FileNotFoundException {
     File outputFile = new File(pathname);
     if (!outputFile.isAbsolute()) {
       outputFile = new File(outputDirCalculator.getOutputDir(), pathname);
@@ -127,7 +135,7 @@ public Map<String, Serializable> getOutputProperties() {
    *     file path is readable.
    */
   @Override
-  public InputStream openInternalInputFile(String pathname) throws IOException {
+  public InputStream openInternalInputFile(String pathname) throws FileNotFoundException {
     return openInputFile(pathname);
   }
 
@@ -139,7 +147,7 @@ public InputStream openInternalInputFile(String pathname) throws IOException {
    *     apk's asset directory
    */
   @Override
-  public OutputStream openInternalOutputFile(String pathname) throws IOException {
+  public OutputStream openInternalOutputFile(String pathname) throws FileNotFoundException {
     return openOutputFile(pathname);
   }
 

runner/monitor/java/androidx/test/platform/io/PlatformTestStorage.java

@@ -18,7 +18,7 @@
 import android.net.Uri;
 import androidx.annotation.NonNull;
 import androidx.test.annotation.ExperimentalTestApi;
-import java.io.IOException;
+import java.io.FileNotFoundException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.io.Serializable;
@@ -44,8 +44,9 @@ public interface PlatformTestStorage {
    *
    * @param pathname path to the test file dependency. Should not be null.
    * @return an InputStream to the given test file.
+   * @throws FileNotFoundException if pathname does not exist
    */
-  InputStream openInputFile(String pathname) throws IOException;
+  InputStream openInputFile(String pathname) throws FileNotFoundException;
 
   /**
    * Returns the value of a given argument name.
@@ -64,8 +65,9 @@ public interface PlatformTestStorage {
    *
    * @param pathname path to the test output file. Should not be null.
    * @return an OutputStream to the given output file.
+   * @throws FileNotFoundException if pathname does not exist
    */
-  OutputStream openOutputFile(String pathname) throws IOException;
+  OutputStream openOutputFile(String pathname) throws FileNotFoundException;
 
   /**
    * Provides an OutputStream to a test output file.
@@ -74,8 +76,9 @@ public interface PlatformTestStorage {
    * @param append if true, then the lines will be added to the end of the file rather than
    *     overwriting.
    * @return an OutputStream to the given output file.
+   * @throws FileNotFoundException if pathname does not exist
    */
-  OutputStream openOutputFile(String pathname, boolean append) throws IOException;
+  OutputStream openOutputFile(String pathname, boolean append) throws FileNotFoundException;
 
   /**
    * Adds the given properties.
@@ -96,16 +99,18 @@ public interface PlatformTestStorage {
    *
    * @param pathname path to the internal file. Should not be null.
    * @return an InputStream to the given test file.
+   * @throws FileNotFoundException if pathname does not exist
    */
-  InputStream openInternalInputFile(String pathname) throws IOException;
+  InputStream openInternalInputFile(String pathname) throws FileNotFoundException;
 
   /**
    * Provides an OutputStream to an internal file used by the testing infrastructure.
    *
    * @param pathname path to the internal file. Should not be null.
    * @return an OutputStream to the given output file.
+   * @throws FileNotFoundException if pathname does not exist
    */
-  OutputStream openInternalOutputFile(String pathname) throws IOException;
+  OutputStream openInternalOutputFile(String pathname) throws FileNotFoundException;
 
   /**
    * Provides a Uri to a test file dependency.

runner/monitor/java/androidx/test/platform/io/PlatformTestStorageRegistry.java

@@ -21,7 +21,6 @@
 import androidx.annotation.NonNull;
 import androidx.test.annotation.ExperimentalTestApi;
 import androidx.test.internal.platform.ServiceLoaderWrapper;
-import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.io.Serializable;
@@ -109,12 +108,12 @@ public Map<String, Serializable> getOutputProperties() {
     }
 
     @Override
-    public InputStream openInternalInputFile(String pathname) throws IOException {
+    public InputStream openInternalInputFile(String pathname) {
       return new NullInputStream();
     }
 
     @Override
-    public OutputStream openInternalOutputFile(String pathname) throws IOException {
+    public OutputStream openInternalOutputFile(String pathname) {
       return new NullOutputStream();
     }
 

services/CHANGELOG.md

@@ -14,6 +14,8 @@
 
 * Upstream TestStorage.isTestStoragePath to PlatformTestStorage
 * Upstream TestStorage.getInputFileUri and getOutputFileUri  to PlatformTestStorage
+* Change openInternal* methods to throw FileNotFoundException instead of 
+  IOException for consistency
 
 **Breaking API Changes**
 

services/storage/java/androidx/test/services/storage/TestStorage.java

@@ -338,7 +338,7 @@ public Map<String, Serializable> getOutputProperties() {
    */
   @RestrictTo(Scope.LIBRARY)
   @Override
-  public InputStream openInternalInputFile(String pathname) throws IOException {
+  public InputStream openInternalInputFile(String pathname) throws FileNotFoundException {
     checkNotNull(pathname);
     Uri outputUri = HostedFile.buildUri(FileHost.INTERNAL_USE_ONLY, pathname);
     return TestStorageUtil.getInputStream(outputUri, contentResolver);
@@ -356,7 +356,7 @@ public InputStream openInternalInputFile(String pathname) throws IOException {
    */
   @RestrictTo(Scope.LIBRARY)
   @Override
-  public OutputStream openInternalOutputFile(String pathname) throws IOException {
+  public OutputStream openInternalOutputFile(String pathname) throws FileNotFoundException {
     checkNotNull(pathname);
     Uri outputUri = HostedFile.buildUri(FileHost.INTERNAL_USE_ONLY, pathname);
     return TestStorageUtil.getOutputStream(outputUri, contentResolver);