1 /*
2  * Copyright (C) 2021 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.bedstead.accounts.annotations;
18 
19 import static com.android.bedstead.harrier.UserType.INSTRUMENTED_USER;
20 import static com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.LATE;
21 
22 import com.android.bedstead.harrier.UserType;
23 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
24 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
25 
26 import java.lang.annotation.ElementType;
27 import java.lang.annotation.Repeatable;
28 import java.lang.annotation.Retention;
29 import java.lang.annotation.RetentionPolicy;
30 import java.lang.annotation.Target;
31 
32 /**
33  * Annotation to indicate that a test needs an account authenticator.
34  */
35 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
36 @Retention(RetentionPolicy.RUNTIME)
37 @Repeatable(EnsureHasAccountAuthenticatorGroup.class)
38 @UsesAnnotationExecutor(UsesAnnotationExecutor.ACCOUNTS)
39 public @interface EnsureHasAccountAuthenticator {
40 
41     int ENSURE_HAS_ACCOUNT_AUTHENTICATOR_PRIORITY = LATE;
42 
43     /** Which user type the account authenticator must be installed on. */
onUser()44     UserType onUser() default INSTRUMENTED_USER;
45 
46      /**
47      * Priority sets the order that annotations will be resolved.
48      *
49      * <p>Annotations with a lower priority will be resolved before annotations with a higher
50      * priority.
51      *
52      * <p>If there is an order requirement between annotations, ensure that the priority of the
53      * annotation which must be resolved first is lower than the one which must be resolved later.
54      *
55      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
56      */
priority()57     int priority() default ENSURE_HAS_ACCOUNT_AUTHENTICATOR_PRIORITY;
58 }
59