1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.android.tradefed.testtype;
17 
18 import com.android.tradefed.result.ITestInvocationListener;
19 
20 /**
21  * In case of an incomplete execution, {@link IRemoteTest} that implements this interface may report
22  * their non-executed tests for improved reporting.
23  */
24 public interface IReportNotExecuted {
25 
26     public static final String NOT_EXECUTED_FAILURE = "Test did not run. This is a placeholder.";
27 
28     /**
29      * Report the non-executed tests to the main listener provided. They should be reported as
30      * failed with the {@link #NOT_EXECUTED_FAILURE} message.
31      *
32      * @param listener the main listener where to report the non-executed results.
33      */
reportNotExecuted(ITestInvocationListener listener)34     public default void reportNotExecuted(ITestInvocationListener listener) {}
35 
36     /**
37      * Report the non-executed tests to the main listener provided. They should be reported as
38      * failed with the {@link #NOT_EXECUTED_FAILURE} message.
39      *
40      * @param listener the main listener where to report the non-executed results.
41      * @param message the message to be associated with the non-executed failure.
42      */
reportNotExecuted(ITestInvocationListener listener, String message)43     public default void reportNotExecuted(ITestInvocationListener listener, String message) {
44         reportNotExecuted(listener);
45     }
46 }
47