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.enterprise.annotations; 18 19 import static com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.LATE; 20 import static com.android.bedstead.nene.packages.CommonPackages.FEATURE_DEVICE_ADMIN; 21 22 import com.android.bedstead.harrier.UserType; 23 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence; 24 import com.android.bedstead.harrier.annotations.RequireFeature; 25 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor; 26 27 import java.lang.annotation.ElementType; 28 import java.lang.annotation.Repeatable; 29 import java.lang.annotation.Retention; 30 import java.lang.annotation.RetentionPolicy; 31 import java.lang.annotation.Target; 32 33 /** 34 * Mark that a test requires a given user restriction be set. 35 * 36 * <p>You should use {@code DeviceState} to ensure that the device enters 37 * the correct state for the method. 38 * 39 * <p>Note that when relying on {@code DeviceState} to enforce this policy, it will make use of a 40 * Profile Owner. This should not be used in states where no profile owner is wanted on the 41 * user the restriction is required on. 42 */ 43 // TODO(264844667): Enforce no use of @EnsureHasNoProfileOwner 44 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 45 @Retention(RetentionPolicy.RUNTIME) 46 @Repeatable(EnsureHasUserRestrictionGroup.class) 47 // This is only required because the user restrictions are applied by a Device Admin. 48 @RequireFeature(FEATURE_DEVICE_ADMIN) 49 @UsesAnnotationExecutor(UsesAnnotationExecutor.ENTERPRISE) 50 public @interface EnsureHasUserRestriction { 51 52 int ENSURE_HAS_USER_RESTRICTION_PRIORITY = LATE; 53 54 /** The restriction to be set. */ value()55 String value(); 56 57 /** The user the restriction should be set on. */ onUser()58 UserType onUser() default UserType.INSTRUMENTED_USER; 59 60 /** 61 * Priority sets the order that annotations will be resolved. 62 * 63 * <p>Annotations with a lower priority will be resolved before annotations with a higher 64 * priority. 65 * 66 * <p>If there is an order requirement between annotations, ensure that the priority of the 67 * annotation which must be resolved first is lower than the one which must be resolved later. 68 * 69 * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}. 70 */ priority()71 int priority() default ENSURE_HAS_USER_RESTRICTION_PRIORITY; 72 } 73