1 /*
2  * Copyright (C) 2024 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 com.android.interactive.annotations
18 
19 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence
20 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor
21 
22 /**
23  * Mark that a test requires user interaction.
24  *
25  * This will exclude the test from non-interactive test suites and allow the use of the
26  * Interactive library in the test.
27  */
28 @Target(AnnotationTarget.FUNCTION)
29 @Retention(AnnotationRetention.RUNTIME)
30 @UsesAnnotationExecutor(UsesAnnotationExecutor.INTERACTIVE)
31 annotation class Interactive(
32     /**
33      * Priority sets the order that annotations will be resolved.
34      *
35      * Annotations with a lower priority will be resolved before annotations with a higher
36      * priority.
37      *
38      * If there is an order requirement between annotations, ensure that the priority of the
39      * annotation which must be resolved first is lower than the one which must be resolved later.
40      *
41      * Priority can be set to a [AnnotationPriorityRunPrecedence] constant, or to any [Int].
42      */
43     val priority: Int = AnnotationPriorityRunPrecedence.EARLY
44 )
45