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.AnnotationCostRunPrecedence
20 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence
21 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.FIRST
22 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor
23 
24 /**
25  * Mark that a test requires the device to be untethered from the host.
26  *
27  * This should only be used when absolutely required. For example, when the test requires a tester
28  * to physically move the device around the room, or requires access to the USB port.
29  */
30 @Target(AnnotationTarget.FUNCTION)
31 @Retention(AnnotationRetention.RUNTIME)
32 @UsesAnnotationExecutor(UsesAnnotationExecutor.INTERACTIVE)
33 annotation class UntetheredTest(
34     /**
35      * Priority sets the order that annotations will be resolved.
36      *
37      * Annotations with a lower priority will be resolved before annotations with a higher
38      * priority.
39      *
40      * If there is an order requirement between annotations, ensure that the priority of the
41      * annotation which must be resolved first is lower than the one which must be resolved later.
42      *
43      * Priority can be set to a [AnnotationPriorityRunPrecedence] constant, or to any [Int].
44      */
45     val priority: Int = FIRST,
46 
47     val cost: Int = AnnotationCostRunPrecedence.HIGH
48 )
49