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.harrier.annotations;
18 
19 import static com.android.bedstead.harrier.UserType.INSTRUMENTED_USER;
20 import static com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.EARLY;
21 
22 import com.android.bedstead.harrier.UserType;
23 
24 import java.lang.annotation.ElementType;
25 import java.lang.annotation.Retention;
26 import java.lang.annotation.RetentionPolicy;
27 import java.lang.annotation.Target;
28 
29 /**
30  * Mark that a test method requires no password be set on the given user.
31  *
32  * <p>You can use {@code Devicestate} to ensure that the device enters
33  * the correct state for the method.
34  */
35 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
36 @Retention(RetentionPolicy.RUNTIME)
37 public @interface EnsurePasswordNotSet {
38 
39     /** The user who must not have a password. */
forUser()40     UserType forUser() default INSTRUMENTED_USER;
41 
42      /**
43      * Priority sets the order that annotations will be resolved.
44      *
45      * <p>Annotations with a lower priority will be resolved before annotations with a higher
46      * priority.
47      *
48      * <p>If there is an order requirement between annotations, ensure that the priority of the
49      * annotation which must be resolved first is lower than the one which must be resolved later.
50      *
51      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
52      */
priority()53     int priority() default EARLY;
54 }
55