Merge "Start populating the ITestInvocation interface" into oc-dev

2 files changed, 137 insertions, 57 deletions

diff --git a/src/com/android/tradefed/invoker/ITestInvocation.java b/src/com/android/tradefed/invoker/ITestInvocation.java
index 0214071cc..58ec3dedc 100644
--- a/src/com/android/tradefed/invoker/ITestInvocation.java
+++ b/src/com/android/tradefed/invoker/ITestInvocation.java
@@ -18,7 +18,10 @@ package com.android.tradefed.invoker;
 
 import com.android.tradefed.config.IConfiguration;
 import com.android.tradefed.device.DeviceNotAvailableException;
+import com.android.tradefed.invoker.shard.IShardHelper;
 import com.android.tradefed.result.ITestInvocationListener;
+import com.android.tradefed.targetprep.BuildError;
+import com.android.tradefed.targetprep.TargetSetupError;
 
 /**
  * Handles one TradeFederation test invocation.
@@ -41,6 +44,93 @@ public interface ITestInvocation {
             IRescheduler rescheduler, ITestInvocationListener... extraListeners)
             throws DeviceNotAvailableException, Throwable;
 
+    /**
+     * Execute the build_provider step of the invocation.
+     *
+     * @param context the {@link IInvocationContext} of the invocation.
+     * @param config the {@link IConfiguration} of this test run.
+     * @param rescheduler the {@link IRescheduler}, for rescheduling portions of the invocation for
+     *     execution on another resource(s)
+     * @param listener the {@link ITestInvocation} to report build download failures.
+     * @return True if we successfully downloaded the build, false otherwise.
+     * @throws DeviceNotAvailableException
+     */
+    public default boolean fetchBuild(
+            IInvocationContext context,
+            IConfiguration config,
+            IRescheduler rescheduler,
+            ITestInvocationListener listener)
+            throws DeviceNotAvailableException {
+        return false;
+    }
+
+    /**
+     * Execute the build_provider clean up step. Associated with the build fetching.
+     *
+     * @param context the {@link IInvocationContext} of the invocation.
+     * @param config the {@link IConfiguration} of this test run.
+     */
+    public default void cleanUpBuilds(IInvocationContext context, IConfiguration config) {}
+
+    /**
+     * Execute the target_preparer and multi_target_preparer setUp step. Does all the devices setup
+     * required for the test to run.
+     *
+     * @param context the {@link IInvocationContext} of the invocation.
+     * @param config the {@link IConfiguration} of this test run.
+     * @param listener the {@link ITestInvocation} to report setup failures.
+     * @throws TargetSetupError
+     * @throws BuildError
+     * @throws DeviceNotAvailableException
+     */
+    public default void doSetup(
+            IInvocationContext context,
+            IConfiguration config,
+            final ITestInvocationListener listener)
+            throws TargetSetupError, BuildError, DeviceNotAvailableException {}
+
+    /**
+     * Execute the target_preparer and multi_target_preparer teardown step. Does the devices tear
+     * down associated with the setup.
+     *
+     * @param context the {@link IInvocationContext} of the invocation.
+     * @param config the {@link IConfiguration} of this test run.
+     * @param exception the original exception thrown by the test running.
+     * @throws Throwable
+     */
+    public default void doTeardown(
+            IInvocationContext context, IConfiguration config, Throwable exception)
+            throws Throwable {}
+
+    /**
+     * Execute the target_preparer and multi_target_preparer cleanUp step. Does the devices clean
+     * up.
+     *
+     * @param context the {@link IInvocationContext} of the invocation.
+     * @param config the {@link IConfiguration} of this test run.
+     * @param exception the original exception thrown by the test running.
+     */
+    public default void doCleanUp(
+            IInvocationContext context, IConfiguration config, Throwable exception) {}
+
+    /**
+     * Attempt to shard the configuration into sub-configurations, to be re-scheduled to run on
+     * multiple resources in parallel.
+     *
+     * <p>If a shard count is greater than 1, it will simply create configs for each shard by
+     * setting shard indices and reschedule them. If a shard count is not set,it would fallback to
+     * {@link IShardHelper#shardConfig}.
+     *
+     * @param config the current {@link IConfiguration}.
+     * @param context the {@link IInvocationContext} holding the info of the tests.
+     * @param rescheduler the {@link IRescheduler}
+     * @return true if test was sharded. Otherwise return <code>false</code>
+     */
+    public default boolean shardConfig(
+            IConfiguration config, IInvocationContext context, IRescheduler rescheduler) {
+        return false;
+    }
+
     /** Notify the {@link TestInvocation} that TradeFed has been requested to stop. */
     public default void notifyInvocationStopped() {}
 }
diff --git a/src/com/android/tradefed/invoker/TestInvocation.java b/src/com/android/tradefed/invoker/TestInvocation.java
index 01851022a..dd9a4fb3c 100644
--- a/src/com/android/tradefed/invoker/TestInvocation.java
+++ b/src/com/android/tradefed/invoker/TestInvocation.java
@@ -158,20 +158,8 @@ public class TestInvocation implements ITestInvocation {
         }
     }
 
-    /**
-     * Attempt to shard the configuration into sub-configurations, to be re-scheduled to run on
-     * multiple resources in parallel.
-     *
-     * <p>If a shard count is greater than 1, it will simply create configs for each shard by
-     * setting shard indices and reschedule them. If a shard count is not set,it would fallback to
-     * {@link IShardHelper#shardConfig}.
-     *
-     * @param config the current {@link IConfiguration}.
-     * @param context the {@link IInvocationContext} holding the info of the tests.
-     * @param rescheduler the {@link IRescheduler}
-     * @return true if test was sharded. Otherwise return <code>false</code>
-     */
-    private boolean shardConfig(
+    @Override
+    public boolean shardConfig(
             IConfiguration config, IInvocationContext context, IRescheduler rescheduler) {
         mStatus = "sharding";
         return createShardHelper().shardConfig(config, context, rescheduler);
@@ -417,7 +405,7 @@ public class TestInvocation implements ITestInvocation {
             }
             mStatus = "tearing down";
             try {
-                doTeardown(config, context, exception);
+                doTeardown(context, config, exception);
             } catch (Throwable e) {
                 tearDownException = e;
                 CLog.e("Exception when tearing down invocation: %s", tearDownException.toString());
@@ -430,7 +418,7 @@ public class TestInvocation implements ITestInvocation {
             mStatus = "done running tests";
             try {
                 // Clean up host.
-                doCleanUp(config, context, exception);
+                doCleanUp(context, config, exception);
                 if (config.getProfiler() != null) {
                     config.getProfiler().reportAllMetrics(listener);
                 }
@@ -454,10 +442,7 @@ public class TestInvocation implements ITestInvocation {
                     listener.invocationEnded(elapsedTime);
                 }
             } finally {
-                for (String deviceName : context.getDeviceConfigNames()) {
-                    config.getDeviceConfigByName(deviceName).getBuildProvider()
-                            .cleanUp(context.getBuildInfo(deviceName));
-                }
+                cleanUpBuilds(context, config);
             }
         }
         if (tearDownException != null) {
@@ -480,16 +465,16 @@ public class TestInvocation implements ITestInvocation {
         }
         getRunUtil().allowInterrupt(true);
         logDeviceBatteryLevel(context, "initial -> setup");
-        doSetup(config, context, listener);
+        doSetup(context, config, listener);
         logDeviceBatteryLevel(context, "setup -> test");
         runTests(context, config, listener);
         logDeviceBatteryLevel(context, "after test");
     }
 
-    @VisibleForTesting
-    void doSetup(
-            IConfiguration config,
+    @Override
+    public void doSetup(
             IInvocationContext context,
+            IConfiguration config,
             final ITestInvocationListener listener)
             throws TargetSetupError, BuildError, DeviceNotAvailableException {
         // TODO: evaluate doing device setup in parallel
@@ -536,8 +521,9 @@ public class TestInvocation implements ITestInvocation {
         }
     }
 
-    private void doTeardown(IConfiguration config, IInvocationContext context,
-            Throwable exception) throws Throwable {
+    @Override
+    public void doTeardown(IInvocationContext context, IConfiguration config, Throwable exception)
+            throws Throwable {
         Throwable throwable = null;
 
         List<IMultiTargetPreparer> multiPreparers = config.getMultiTargetPreparers();
@@ -588,8 +574,8 @@ public class TestInvocation implements ITestInvocation {
         }
     }
 
-    private void doCleanUp(IConfiguration config, IInvocationContext context,
-            Throwable exception) {
+    @Override
+    public void doCleanUp(IInvocationContext context, IConfiguration config, Throwable exception) {
         for (String deviceName : context.getDeviceConfigNames()) {
             List<ITargetPreparer> preparers =
                     config.getDeviceConfigByName(deviceName).getTargetPreparers();
@@ -843,11 +829,8 @@ public class TestInvocation implements ITestInvocation {
         }
     }
 
-    /**
-     * Helper method that proceed with doing the complete build_provider step for each devices and
-     * return a success of failure status.
-     */
-    private boolean fetchBuild(
+    @Override
+    public boolean fetchBuild(
             IInvocationContext context,
             IConfiguration config,
             IRescheduler rescheduler,
@@ -917,6 +900,24 @@ public class TestInvocation implements ITestInvocation {
         return true;
     }
 
+    @Override
+    public void cleanUpBuilds(IInvocationContext context, IConfiguration config) {
+        // Ensure build infos are always cleaned up at the end of invocation.
+        for (String cleanUpDevice : context.getDeviceConfigNames()) {
+            if (context.getBuildInfo(cleanUpDevice) != null) {
+                try {
+                    config.getDeviceConfigByName(cleanUpDevice)
+                            .getBuildProvider()
+                            .cleanUp(context.getBuildInfo(cleanUpDevice));
+                } catch (RuntimeException e) {
+                    // We catch an simply log exception in cleanUp to avoid missing any final
+                    // step of the invocation.
+                    CLog.e(e);
+                }
+            }
+        }
+    }
+
     /** {@inheritDoc} */
     @Override
     public void invoke(
@@ -961,36 +962,25 @@ public class TestInvocation implements ITestInvocation {
                 return;
             }
 
-            if (shardConfig(config, context, rescheduler)) {
-                CLog.i(
-                        "Invocation for %s has been sharded, rescheduling",
-                        context.getSerials().toString());
-            } else {
-                if (config.getTests() == null || config.getTests().isEmpty()) {
-                    CLog.e("No tests to run");
-                } else {
-                    performInvocation(config, context, rescheduler, listener);
-                    setExitCode(ExitCode.NO_ERROR, null);
-                }
+            boolean sharding = shardConfig(config, context, rescheduler);
+            if (sharding) {
+                CLog.i("Invocation for %s has been sharded, rescheduling", context.getSerials());
+                return;
             }
+
+            if (config.getTests() == null || config.getTests().isEmpty()) {
+                CLog.e("No tests to run");
+                return;
+            }
+
+            performInvocation(config, context, rescheduler, listener);
+            setExitCode(ExitCode.NO_ERROR, null);
         } catch (IOException e) {
             CLog.e(e);
         } finally {
 
             // Ensure build infos are always cleaned up at the end of invocation.
-            for (String cleanUpDevice : context.getDeviceConfigNames()) {
-                if (context.getBuildInfo(cleanUpDevice) != null) {
-                    try {
-                        config.getDeviceConfigByName(cleanUpDevice)
-                                .getBuildProvider()
-                                .cleanUp(context.getBuildInfo(cleanUpDevice));
-                    } catch (RuntimeException e) {
-                        // We catch an simply log exception in cleanUp to avoid missing any final
-                        // step of the invocation.
-                        CLog.e(e);
-                    }
-                }
-            }
+            cleanUpBuilds(context, config);
 
             // ensure we always deregister the logger
             for (String deviceName : context.getDeviceConfigNames()) {