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.Defaults.DEFAULT_PASSWORD; 20 import static com.android.bedstead.harrier.UserType.INSTRUMENTED_USER; 21 import static com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.MIDDLE; 22 23 import com.android.bedstead.harrier.UserType; 24 25 import java.lang.annotation.ElementType; 26 import java.lang.annotation.Retention; 27 import java.lang.annotation.RetentionPolicy; 28 import java.lang.annotation.Target; 29 30 /** 31 * Mark that a test method requires a password be set on the given user. 32 * 33 * <p>You can use {@code Devicestate} to ensure that the device enters 34 * the correct state for the method. 35 */ 36 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 37 @Retention(RetentionPolicy.RUNTIME) 38 public @interface EnsurePasswordSet { 39 40 /** The user who must have a password. */ forUser()41 UserType forUser() default INSTRUMENTED_USER; 42 43 /** The password to set. Defaults to {@code Devicestate#DEFAULT_PASSWORD}. */ password()44 String password() default DEFAULT_PASSWORD; 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 MIDDLE; 58 } 59