Introduced the platform test storage API and plugged it into Espresso.

PiperOrigin-RevId: 374800866

Author: copybara-androidxtest

espresso/core/java/androidx/test/espresso/BaseLayerComponent.java

@@ -22,6 +22,7 @@
 import androidx.test.espresso.base.MainThread;
 import androidx.test.espresso.base.UiControllerModule;
 import androidx.test.internal.platform.os.ControlledLooper;
+import androidx.test.platform.io.PlatformTestStorage;
 import dagger.Component;
 import java.util.concurrent.Executor;
 import javax.inject.Singleton;
@@ -46,4 +47,6 @@ public interface BaseLayerComponent {
   Executor mainThreadExecutor();
 
   ControlledLooper controlledLooper();
+
+  PlatformTestStorage testStorage();
 }

espresso/core/java/androidx/test/espresso/GraphHolder.java

@@ -18,17 +18,19 @@
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
+import android.util.Log;
 import androidx.test.espresso.base.ActiveRootLister;
-import androidx.test.internal.platform.util.TestOutputEmitter;
 import androidx.test.internal.runner.tracker.UsageTrackerRegistry;
 import androidx.test.internal.runner.tracker.UsageTrackerRegistry.AxtVersions;
+import androidx.test.platform.io.PlatformTestStorage;
 import java.io.Serializable;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicReference;
 
 /** Holds Espresso's object graph. */
 public final class GraphHolder {
+  private static final String TAG = GraphHolder.class.getSimpleName();
 
   private static final AtomicReference<GraphHolder> instance =
       new AtomicReference<GraphHolder>(null);
@@ -48,7 +50,7 @@ static BaseLayerComponent baseLayer() {
         // Also adds the usage data as test output properties. By default it's no-op.
         Map<String, Serializable> usageProperties = new HashMap<>();
         usageProperties.put("Espresso", AxtVersions.ESPRESSO_VERSION);
-        TestOutputEmitter.addOutputProperties(usageProperties);
+        addUsageToOutputProperties(usageProperties, instanceRef.component.testStorage());
         return instanceRef.component;
       } else {
         return instance.get().component;
@@ -57,4 +59,20 @@ static BaseLayerComponent baseLayer() {
       return instanceRef.component;
     }
   }
+
+  private static void addUsageToOutputProperties(
+      Map<String, Serializable> usageProperties, PlatformTestStorage testStorage) {
+    try {
+      testStorage.addOutputProperties(usageProperties);
+    } catch (Exception e) {
+      // The properties.dat file can be created only once on an automotive emulator with API 30,
+      // which causes the `addOutputProperties` call to fail when running multiple test cases. Catch
+      // the exception and log until the issue is fixed in the emulator.
+      Log.d(
+          TAG,
+          "Failed to add the output properties. This could happen when running on an"
+              + " automotive emulator with API 30. Ignore for now.",
+          e);
+    }
+  }
 }

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

@@ -27,6 +27,8 @@
 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.io.PlatformTestStorageRegistry;
 import androidx.test.runner.lifecycle.ActivityLifecycleMonitor;
 import androidx.test.runner.lifecycle.ActivityLifecycleMonitorRegistry;
 import com.google.common.base.Optional;
@@ -198,4 +200,10 @@ public ControlledLooper provideControlledLooper() {
     return ServiceLoaderWrapper.loadSingleService(
         ControlledLooper.class, () -> ControlledLooper.NO_OP_CONTROLLED_LOOPER);
   }
+
+  @Provides
+  @Singleton
+  PlatformTestStorage provideTestStorage() {
+    return PlatformTestStorageRegistry.getInstance();
+  }
 }

runner/android_junit_runner/java/androidx/test/runner/AndroidJUnitRunner.java

@@ -48,10 +48,12 @@
 import androidx.test.internal.runner.tracker.AnalyticsBasedUsageTracker;
 import androidx.test.internal.runner.tracker.UsageTrackerRegistry.AxtVersions;
 import androidx.test.orchestrator.callback.OrchestratorV1Connection;
+import androidx.test.platform.io.PlatformTestStorageRegistry;
 import androidx.test.runner.lifecycle.ApplicationLifecycleCallback;
 import androidx.test.runner.lifecycle.ApplicationLifecycleMonitorRegistry;
 import androidx.test.runner.screenshot.ScreenCaptureProcessor;
 import androidx.test.runner.screenshot.Screenshot;
+import androidx.test.services.storage.TestStorage;
 import java.util.HashSet;
 import java.util.ServiceLoader;
 import java.util.concurrent.TimeUnit;
@@ -433,9 +435,11 @@ public void onStart() {
       return;
     }
 
+    // TODO(b/187349527): Clean up the runner I/O.
     if (runnerArgs.useTestStorageService) {
       runnerIO = new RunnerTestStorageIO();
     }
+    registerTestStorage(runnerArgs);
 
     Bundle results = new Bundle();
     try {
@@ -625,4 +629,12 @@ private void registerUserTracker() {
   TestRequestBuilder createTestRequestBuilder(Instrumentation instr, Bundle arguments) {
     return new TestRequestBuilder(instr, arguments);
   }
+
+  private void registerTestStorage(RunnerArgs runnerArgs) {
+    // TODO: Uses the app folder for test storage otherwise. By default, the no_op one will be used.
+    if (runnerArgs.useTestStorageService) {
+      Log.d(LOG_TAG, "Use the test storage service for managing file I/O.");
+      PlatformTestStorageRegistry.registerInstance(new TestStorage());
+    }
+  }
 }

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

@@ -0,0 +1,93 @@
+/*
+ * Copyright (C) 2021 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package androidx.test.platform.io;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.Serializable;
+import java.util.Map;
+
+/**
+ * An interface represents on-device I/O operations in an Android test.
+ *
+ * <p>This is a low level API, typically used by higher level test frameworks. It is generally not
+ * recommended for direct use by most tests.
+ *
+ * <p>Use a concrete implementation class of this interface if you need to read/write files in your
+ * tests. For example, in an Android Instrumentation test, use {@code
+ * androidx.test.services.storage.TestStorage} when the test services is installed on the device.
+ */
+public interface PlatformTestStorage {
+  /**
+   * Provides an InputStream to a test file dependency.
+   *
+   * @param pathname path to the test file dependency. Should not be null. This is a relative path
+   *     to where the storage service stores the input files. For example, if the storage service
+   *     stores the input files under "/sdcard/test_input_files", with a pathname
+   *     "/path/to/my_input.txt", the file will end up at
+   *     "/sdcard/test_input_files/path/to/my_input.txt" on device.
+   * @return an InputStream to the given test file.
+   */
+  InputStream openInputFile(String pathname) throws IOException;
+
+  /**
+   * Returns the value of a given argument name.
+   *
+   * <p>There should be one and only one argument defined with the given argument name. Otherwise,
+   * it will throw a TestStorageException if zero or more than one arguments are found.
+   *
+   * <p>We suggest using some naming convention when defining the argument name to avoid possible
+   * conflict, e.g. defining "namespaces" for your arguments which helps clarify how the argument is
+   * used and also its scope. For example, for arguments used for authentication purposes, you could
+   * name the account email argument as something like "google_account.email" and its password as
+   * "google_account.password".
+   *
+   * @param argName the argument name. Should not be null.
+   */
+  String getInputArg(String argName);
+
+  /**
+   * Returns the name/value map of all test arguments or an empty map if no arguments are defined.
+   */
+  Map<String, String> getInputArgs();
+
+  /**
+   * Provides an OutputStream to a test output file.
+   *
+   * @param pathname path to the test output file. Should not be null. This is a relative path to
+   *     where the storage service stores the output files. For example, if the storage service
+   *     stores the output files under "/sdcard/test_output_files", with a pathname
+   *     "/path/to/my_output.txt", the file will end up at
+   *     "/sdcard/test_output_files/path/to/my_output.txt" on device.
+   * @return an OutputStream to the given output file.
+   */
+  OutputStream openOutputFile(String pathname) throws IOException;
+
+  /**
+   * Adds the given properties.
+   *
+   * <p>Adding a property with the same name would append new values and overwrite the old values if
+   * keys already exist.
+   */
+  void addOutputProperties(Map<String, Serializable> properties);
+
+  /**
+   * Returns a map of all the output test properties. If no properties exist, an empty map will be
+   * returned.
+   */
+  Map<String, Serializable> getOutputProperties();
+}

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

@@ -0,0 +1,111 @@
+/*
+ * Copyright (C) 2021 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package androidx.test.platform.io;
+
+import static androidx.test.internal.util.Checks.checkNotNull;
+
+import androidx.test.internal.platform.ServiceLoaderWrapper;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.Serializable;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * An exposed registry instance that holds a reference to an {@code PlatformTestStorage} instance.
+ *
+ * <p>{@code PlatformTestStorage} and {@code PlatformTestStorageRegistry} are low level APIs,
+ * typically used by higher level test frameworks. It is generally not recommended for direct use by
+ * most tests.
+ */
+public final class PlatformTestStorageRegistry {
+  private static PlatformTestStorage testStorageInstance;
+
+  static {
+    // By default, uses the instance loaded by the service loader if available; otherwise, uses a
+    // default no_op implementation.
+    testStorageInstance =
+        ServiceLoaderWrapper.loadSingleService(
+            PlatformTestStorage.class, NoOpPlatformTestStorage::new);
+  }
+
+  private PlatformTestStorageRegistry() {}
+
+  /**
+   * Registers a new {@code PlatformTestStorage} instance. This will override any previously set
+   * instance.
+   *
+   * @param instance the instance to be registered. Cannot be null.
+   */
+  public static synchronized void registerInstance(PlatformTestStorage instance) {
+    testStorageInstance = checkNotNull(instance);
+  }
+
+  /**
+   * Returns the registered {@code PlatformTestStorage} instance.
+   *
+   * <p>This method returns the instance last registered by the {@link
+   * #registerInstance(PlatformTestStorage)} method, or the default instance if none is ever
+   * registered.
+   */
+  public static synchronized PlatformTestStorage getInstance() {
+    return testStorageInstance;
+  }
+
+  /** A test storage that does nothing. All the I/O operations in this class are ignored. */
+  static class NoOpPlatformTestStorage implements PlatformTestStorage {
+
+    @Override
+    public InputStream openInputFile(String pathname) {
+      return new NullInputStream();
+    }
+
+    @Override
+    public String getInputArg(String argName) {
+      return null;
+    }
+
+    @Override
+    public Map<String, String> getInputArgs() {
+      return new HashMap<>();
+    }
+
+    @Override
+    public OutputStream openOutputFile(String pathname) {
+      return new NullOutputStream();
+    }
+
+    @Override
+    public void addOutputProperties(Map<String, Serializable> properties) {}
+
+    @Override
+    public Map<String, Serializable> getOutputProperties() {
+      return new HashMap<>();
+    }
+
+    static class NullInputStream extends InputStream {
+      @Override
+      public int read() {
+        return 0;
+      }
+    }
+
+    static class NullOutputStream extends OutputStream {
+      @Override
+      public void write(int b) {}
+    }
+  }
+}

runner/monitor/javatests/androidx/test/BUILD.bazel

@@ -47,6 +47,7 @@ android_library_instrumentation_tests(
         "//runner/monitor",
         "//runner/monitor/javatests/androidx/test/internal/platform:fixtures",
         "//runner/rules",
+        "//services/storage",
         "@maven//:com_google_truth_truth",
         "@maven//:com_linkedin_dexmaker_dexmaker",
         "@maven//:com_linkedin_dexmaker_dexmaker_mockito",

runner/monitor/javatests/androidx/test/platform/io/PlatformTestStorageRegistryTest.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2021 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package androidx.test.platform.io;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import androidx.test.services.storage.TestStorage;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+/** Unit test cases for {@link PlatformTestStorage}. */
+@RunWith(AndroidJUnit4.class)
+public class PlatformTestStorageRegistryTest {
+
+  @Test
+  public void registerInstance() {
+    TestStorage testStorage = new TestStorage();
+    PlatformTestStorageRegistry.registerInstance(testStorage);
+    assertThat(PlatformTestStorageRegistry.getInstance()).isSameInstanceAs(testStorage);
+  }
+}