1 /*
2  * Copyright (C) 2023 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 
17  package android.platform.test.annotations;
18 
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23 
24 /**
25  * Test methods marked with this annotation are quietly ignored when running under a Ravenwood test
26  * environment. The test continues to execute normally under all other non-Ravenwood test
27  * environments.
28  *
29  * This annotation only takes effect when the containing class has a {@code
30  * RavenwoodRule} configured. Ignoring is accomplished by throwing an {@code org.junit
31  * .AssumptionViolatedException} which test infrastructure treats as being ignored.
32  *
33  * Developers are encouraged to use either the {@code blockedBy} and/or {@code reason} arguments
34  * to document why a test is being ignored, to aid in future audits of tests that are candidates
35  * to be enabled.
36  *
37  * @hide
38  *
39  * @deprecated Use {@link DisabledOnRavenwood} instead.
40  */
41 @Target({ElementType.METHOD, ElementType.TYPE})
42 @Retention(RetentionPolicy.RUNTIME)
43 @Deprecated
44 public @interface IgnoreUnderRavenwood {
45     /**
46      * One or more classes that aren't yet supported by Ravenwood, which this test depends on.
47      */
blockedBy()48     Class<?>[] blockedBy() default {};
49 
50     /**
51      * General free-form description of why this test is being ignored.
52      */
reason()53     String reason() default "";
54 }
55