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.enterprise; 18 19 import static android.content.pm.PackageManager.FEATURE_DEVICE_ADMIN; 20 21 import static com.android.bedstead.harrier.DeviceState.UserType.SYSTEM_USER; 22 23 import com.android.bedstead.harrier.DeviceState; 24 import com.android.bedstead.harrier.annotations.FailureMode; 25 import com.android.bedstead.harrier.annotations.RequireFeature; 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 that a device owner is available on the device. 34 * 35 * <p>Your test configuration may be configured so that this test is only run on a device which has 36 * a device owner. Otherwise, you can use {@link DeviceState} to ensure that the device enters 37 * the correct state for the method. If using {@link DeviceState}, you can use 38 * {@link DeviceState#deviceOwner()} to interact with the device owner. 39 * 40 * <p>If {@link DeviceState} is required to set the device owner (because there isn't one already) 41 * then all users and accounts may be removed from the device. 42 */ 43 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 44 @Retention(RetentionPolicy.RUNTIME) 45 @RequireFeature(FEATURE_DEVICE_ADMIN) 46 public @interface EnsureHasDeviceOwner { 47 /** Which user type the device owner should be installed on. */ onUser()48 DeviceState.UserType onUser() default SYSTEM_USER; 49 50 /** Behaviour if the device owner cannot be set. */ failureMode()51 FailureMode failureMode() default FailureMode.FAIL; 52 53 /** 54 * Whether this 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 */ isPrimary()58 boolean isPrimary() default false; 59 60 /** 61 * Affiliation ids to be set for the device owner. 62 */ affiliationIds()63 String[] affiliationIds() default {}; 64 } 65