invocation_interfaces/com/android/tradefed/testtype/IRemoteTest.java

/*
 * Copyright (C) 2010 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 com.android.tradefed.testtype;

import com.android.tradefed.device.DeviceNotAvailableException;
import com.android.tradefed.invoker.TestInformation;
import com.android.tradefed.result.ITestInvocationListener;

/**
 * A test that reports results directly to a {@link ITestInvocationListener}.
 *
 * <p>This has the following benefits over a JUnit.
 *
 * <ul>
 *   <li> easier to report the results of a test that has been run remotely on an Android device, as
 *       the results of a remote test don't need to be unnecessarily marshalled and unmarshalled
 *       from JUnit Test objects.
 *   <li> supports reporting test metrics
 * </ul>
 */
public interface IRemoteTest {

    /**
     * Runs the tests, and reports result to the listener.
     *
     * @param listener the {@link ITestInvocationListener} of test results
     * @throws DeviceNotAvailableException
     * @deprecated Use {@link #run(TestInformation, ITestInvocationListener)} instead.
     */
    @Deprecated
    public default void run(ITestInvocationListener listener) throws DeviceNotAvailableException {
        // Throw if not implemented: If the new interface is implemented this won't be called. If
        // something is calling the old interface instead of new one, then it will throw and report
        // the error.
        throw new UnsupportedOperationException(
                "run(ITestInvocationListener) is deprecated. You need to update to the new "
                        + "run(TestInformation, ITestInvocationListener) interface.");
    }

    /**
     * Runs the tests, and reports result to the listener.
     *
     * @param testInfo The {@link TestInformation} object containing useful information to run
     *     tests.
     * @param listener the {@link ITestInvocationListener} of test results
     * @throws DeviceNotAvailableException
     */
    public default void run(TestInformation testInfo, ITestInvocationListener listener)
            throws DeviceNotAvailableException {
        run(listener);
    }
}