1 /*
2 * Copyright (C) 2022 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.xts.root.annotations
17
18 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence
19 import com.android.bedstead.harrier.annotations.FailureMode
20 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor
21 import com.google.auto.value.AutoAnnotation
22
23 /**
24 * Mark that a test method requires adb to be able to access root capabilities.
25 *
26 * The implementation would consider that the shell has root available if any of the following
27 * conditions are true:
28 * 1. The [su] command is available and shell can run commands as root with the substitute user.
29 * 2. The [su] command is not available but shell has access to root.
30 *
31 * You can use `DeviceState` to ensure that the device enters the correct state for the method.
32 */
33 @Target(AnnotationTarget.FUNCTION, AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS)
34 @Retention(AnnotationRetention.RUNTIME)
35 @UsesAnnotationExecutor(UsesAnnotationExecutor.ROOT)
36 annotation class RequireAdbRoot(
37 val reason: String = "",
38
39 val failureMode: FailureMode = FailureMode.SKIP,
40
41 /**
42 * Priority sets the order that annotations will be resolved.
43 *
44 *
45 * Annotations with a lower priority will be resolved before annotations with a higher
46 * priority.
47 *
48 *
49 * If there is an order requirement between annotations, ensure that the priority of the
50 * annotation which must be resolved first is lower than the one which must be resolved later.
51 *
52 *
53 * Priority can be set to a [AnnotationPriorityRunPrecedence] constant, or to any [int].
54 */
55 val priority: Int = AnnotationPriorityRunPrecedence.FIRST
56 )
57
58 @AutoAnnotation
requireAdbRootnull59 fun requireAdbRoot(
60 reason: String,
61 failureMode: FailureMode
62 ): RequireAdbRoot =
63 AutoAnnotation_RequireAdbRootKt_requireAdbRoot(reason, failureMode)
64