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 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 @Target(AnnotationTarget.FUNCTION, AnnotationTarget.CLASS)
24 @Retention(AnnotationRetention.RUNTIME)
25 @UsesAnnotationExecutor(UsesAnnotationExecutor.ROOT)
26 @RequireAdbRoot(reason = "adb root is a prerequisite of root instrumentation")
27 annotation class RequireRootInstrumentation(
28 val reason: String,
29
30 val failureMode: FailureMode = FailureMode.SKIP,
31
32 /**
33 * Priority sets the order that annotations will be resolved.
34 *
35 *
36 * Annotations with a lower priority will be resolved before annotations with a higher
37 * priority.
38 *
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 *
44 * Priority can be set to a [AnnotationPriorityRunPrecedence] constant, or to any [int].
45 */
46 // This executes immediately after RequireAdbRoot
47 val priority: Int = AnnotationPriorityRunPrecedence.FIRST + 1
48 )
49
50 @AutoAnnotation
requireRootInstrumentationnull51 fun requireRootInstrumentation(
52 reason: String,
53 failureMode: FailureMode
54 ): RequireRootInstrumentation =
55 AutoAnnotation_RequireRootInstrumentationKt_requireRootInstrumentation(reason, failureMode)
56