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.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.RequireNotInstantApp; 25 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor; 26 27 import java.lang.annotation.ElementType; 28 import java.lang.annotation.Retention; 29 import java.lang.annotation.RetentionPolicy; 30 import java.lang.annotation.Target; 31 32 /** 33 * Mark that a test requires a test Device Policy Manager role holder. 34 * 35 * <p>You should use {@code DeviceState} to ensure that the device enters 36 * the correct state for the method. You can use {@code DeviceState#dpmRoleHolder()} to interact 37 * with the role holder. 38 */ 39 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 40 @Retention(RetentionPolicy.RUNTIME) 41 // TODO(b/206441366): Add instant app support 42 @RequireNotInstantApp(reason = "Instant Apps cannot run Enterprise Tests") 43 // TODO(276740719): Support custom queries 44 @UsesAnnotationExecutor(UsesAnnotationExecutor.ENTERPRISE) 45 public @interface EnsureHasDevicePolicyManagerRoleHolder { 46 47 // We want the isPrimary here to take precedence over any other 48 int ENSURE_HAS_DEVICE_POLICY_MANAGER_ROLE_HOLDER_PRIORITY = LATE; 49 50 /** Which user type the device policy manager role holder should be installed on. */ onUser()51 UserType onUser() default INSTRUMENTED_USER; 52 53 /** 54 * Whether this delegate should be returned by calls to {@code DeviceState#dpc()}. 55 * 56 * <p>Only one policy manager per test should be marked as primary. 57 */ isPrimary()58 boolean isPrimary() default false; 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_DEVICE_POLICY_MANAGER_ROLE_HOLDER_PRIORITY; 72 } 73