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.OptionalBoolean.ANY; 20 import static com.android.bedstead.harrier.UserType.PRIMARY_USER; 21 import static com.android.bedstead.harrier.annotations.AnnotationRunPrecedence.MIDDLE; 22 23 import com.android.bedstead.harrier.OptionalBoolean; 24 import com.android.bedstead.harrier.UserType; 25 import com.android.bedstead.harrier.annotations.enterprise.EnsureHasNoDeviceOwner; 26 import com.android.bedstead.harrier.annotations.meta.EnsureHasProfileAnnotation; 27 28 import java.lang.annotation.ElementType; 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 method should run on a user which has a work profile. 35 * 36 * <p>Use of this annotation implies 37 * {@code RequireFeature("android.software.managed_users", SKIP)}. 38 * 39 * <p>Your test configuration may be configured so that this test is only run on a user which has 40 * a work profile. Otherwise, you can use {@code Devicestate} to ensure that the device enters 41 * the correct state for the method. 42 */ 43 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 44 @Retention(RetentionPolicy.RUNTIME) 45 @EnsureHasProfileAnnotation(value = "android.os.usertype.profile.MANAGED", hasProfileOwner = true) 46 @RequireFeature("android.software.managed_users") 47 @EnsureHasNoDeviceOwner // TODO: This should only apply on Android R+ 48 public @interface EnsureHasWorkProfile { 49 /** Which user type the work profile should be attached to. */ forUser()50 UserType forUser() default PRIMARY_USER; // Currently only the primary user is supported 51 52 /** Whether the instrumented test app should be installed in the work profile. */ installInstrumentedApp()53 OptionalBoolean installInstrumentedApp() default ANY; 54 55 /** 56 * Whether the profile owner's DPC should be returned by calls to {@code Devicestate#dpc()}. 57 * 58 * <p>Only one device policy controller per test should be marked as primary. 59 */ dpcIsPrimary()60 boolean dpcIsPrimary() default false; 61 62 /** 63 * If true, uses the {@code DevicePolicyManager#getParentProfileInstance(ComponentName)} 64 * instance of the dpc when calling to .dpc() 65 * 66 * <p>Only used if {@link #dpcIsPrimary()} is true. 67 */ useParentInstanceOfDpc()68 boolean useParentInstanceOfDpc() default false; 69 70 /** 71 * Should we ensure that we are switched to the parent of the profile. 72 */ switchedToParentUser()73 OptionalBoolean switchedToParentUser() default ANY; 74 75 /** 76 * Weight sets the order that annotations will be resolved. 77 * 78 * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. 79 * 80 * <p>If there is an order requirement between annotations, ensure that the weight of the 81 * annotation which must be resolved first is lower than the one which must be resolved later. 82 * 83 * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. 84 */ weight()85 int weight() default MIDDLE; 86 } 87