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 android.content.pm.PackageManager.FEATURE_DEVICE_ADMIN; 20 21 import static com.android.bedstead.harrier.OptionalBoolean.ANY; 22 import static com.android.bedstead.harrier.OptionalBoolean.TRUE; 23 import static com.android.bedstead.harrier.annotations.AnnotationRunPrecedence.EARLY; 24 25 import com.android.bedstead.harrier.DeviceState; 26 import com.android.bedstead.harrier.OptionalBoolean; 27 import com.android.bedstead.harrier.annotations.enterprise.EnsureHasProfileOwner; 28 import com.android.bedstead.harrier.annotations.meta.RequireRunOnProfileAnnotation; 29 30 import java.lang.annotation.ElementType; 31 import java.lang.annotation.Retention; 32 import java.lang.annotation.RetentionPolicy; 33 import java.lang.annotation.Target; 34 35 /** 36 * Mark that a test method should run within a work profile. 37 * 38 * <p>Your test configuration should be such that this test is only run where a work profile is 39 * created and the test is being run within that user. 40 * 41 * <p>Optionally, you can guarantee that these methods do not run outside of a work 42 * profile by using {@link DeviceState}. 43 * 44 * <p>This annotation by default opts a test into multi-user presubmit. New tests should also be 45 * annotated {@link Postsubmit} until they are shown to meet the multi-user presubmit requirements. 46 */ 47 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 48 @Retention(RetentionPolicy.RUNTIME) 49 @RequireRunOnProfileAnnotation(value = "android.os.usertype.profile.MANAGED", hasProfileOwner = true) 50 @EnsureHasProfileOwner 51 @RequireFeature(FEATURE_DEVICE_ADMIN) 52 public @interface RequireRunOnWorkProfile { installInstrumentedAppInParent()53 OptionalBoolean installInstrumentedAppInParent() default ANY; 54 55 /** 56 * Whether the profile owner's DPC should be returned by calls to {@link 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 * Affiliation ids to be set for the profile owner. 64 */ affiliationIds()65 String[] affiliationIds() default {}; 66 67 /** 68 * Should we ensure that we are switched to the parent of the profile. 69 */ switchedToParentUser()70 OptionalBoolean switchedToParentUser() default TRUE; 71 72 /** 73 * Weight sets the order that annotations will be resolved. 74 * 75 * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. 76 * 77 * <p>If there is an order requirement between annotations, ensure that the weight of the 78 * annotation which must be resolved first is lower than the one which must be resolved later. 79 * 80 * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. 81 */ weight()82 int weight() default EARLY; 83 }