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.DeviceState.UserType.CURRENT_USER; 20 import static com.android.bedstead.harrier.OptionalBoolean.TRUE; 21 22 import com.android.bedstead.harrier.DeviceState; 23 import com.android.bedstead.harrier.OptionalBoolean; 24 import com.android.bedstead.harrier.annotations.enterprise.EnsureHasNoDeviceOwner; 25 import com.android.bedstead.harrier.annotations.meta.EnsureHasProfileAnnotation; 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 method should run on a user which has a work profile. 34 * 35 * <p>Use of this annotation implies 36 * {@code RequireFeature("android.software.managed_users", SKIP)}. 37 * 38 * <p>Your test configuration may be configured so that this test is only run on a user which has 39 * a work profile. Otherwise, you can use {@link DeviceState} to ensure that the device enters 40 * the correct state for the method. 41 */ 42 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 43 @Retention(RetentionPolicy.RUNTIME) 44 @EnsureHasProfileAnnotation(value = "android.os.usertype.profile.MANAGED", hasProfileOwner = true) 45 @RequireFeature("android.software.managed_users") 46 @EnsureHasNoDeviceOwner // TODO: This should only apply on Android R+ 47 public @interface EnsureHasWorkProfile { 48 /** Which user type the work profile should be attached to. */ forUser()49 DeviceState.UserType forUser() default CURRENT_USER; 50 51 /** Whether the instrumented test app should be installed in the work profile. */ installInstrumentedApp()52 OptionalBoolean installInstrumentedApp() default TRUE; 53 54 /** 55 * Whether the profile owner's DPC should be returned by calls to {@link DeviceState#dpc()}. 56 * 57 * <p>Only one device policy controller per test should be marked as primary. 58 */ dpcIsPrimary()59 boolean dpcIsPrimary() default false; 60 }