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.CURRENT_USER;
22 
23 import com.android.bedstead.harrier.DeviceState;
24 import com.android.bedstead.harrier.annotations.RequireFeature;
25 
26 import java.lang.annotation.ElementType;
27 import java.lang.annotation.Retention;
28 import java.lang.annotation.RetentionPolicy;
29 import java.lang.annotation.Target;
30 
31 /**
32  * Mark that a test requires that a profile owner is set.
33  *
34  * <p>You can use {@link DeviceState} to ensure that the device enters
35  * the correct state for the method. If using {@link DeviceState}, you can use
36  * {@link DeviceState#profileOwner()} to interact with the profile owner.
37  */
38 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
39 @Retention(RetentionPolicy.RUNTIME)
40 @RequireFeature(FEATURE_DEVICE_ADMIN)
41 public @interface EnsureHasProfileOwner {
42     /** Which user type the work profile should be attached to. */
onUser()43     DeviceState.UserType onUser() default CURRENT_USER;
44 
45     /**
46      * Whether this DPC should be returned by calls to {@link DeviceState#dpc()}.
47      *
48      * <p>Only one device policy controller per test should be marked as primary.
49      */
isPrimary()50     boolean isPrimary() default false;
51 
52     /**
53      * Affiliation ids to be set for the profile owner.
54      */
affiliationIds()55     String[] affiliationIds() default {};
56 }