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 23 import com.android.bedstead.harrier.DeviceState; 24 import com.android.bedstead.harrier.OptionalBoolean; 25 import com.android.bedstead.harrier.annotations.enterprise.EnsureHasProfileOwner; 26 import com.android.bedstead.harrier.annotations.meta.RequireRunOnProfileAnnotation; 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 within a work profile. 35 * 36 * <p>Your test configuration should be such that this test is only run where a work profile is 37 * created and the test is being run within that user. 38 * 39 * <p>Optionally, you can guarantee that these methods do not run outside of a work 40 * profile by using {@link DeviceState}. 41 * 42 * <p>This annotation by default opts a test into multi-user presubmit. New tests should also be 43 * annotated {@link Postsubmit} until they are shown to meet the multi-user presubmit requirements. 44 */ 45 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 46 @Retention(RetentionPolicy.RUNTIME) 47 @RequireRunOnProfileAnnotation(value = "android.os.usertype.profile.MANAGED", hasProfileOwner = true) 48 @EnsureHasProfileOwner 49 @RequireFeature(FEATURE_DEVICE_ADMIN) 50 public @interface RequireRunOnWorkProfile { installInstrumentedAppInParent()51 OptionalBoolean installInstrumentedAppInParent() default ANY; 52 53 /** 54 * Whether the profile owner's DPC should be returned by calls to {@link DeviceState#dpc()}. 55 * 56 * <p>Only one device policy controller per test should be marked as primary. 57 */ dpcIsPrimary()58 boolean dpcIsPrimary() default false; 59 60 /** 61 * Affiliation ids to be set for the profile owner. 62 */ affiliationIds()63 String[] affiliationIds() default {}; 64 }