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.enterprise.annotations;
18 
19 import static com.android.bedstead.enterprise.annotations.EnsureHasDeviceOwner.DO_PO_PRIORITY;
20 import static com.android.bedstead.harrier.UserType.INSTRUMENTED_USER;
21 
22 import com.android.bedstead.harrier.UserType;
23 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
24 
25 import java.lang.annotation.ElementType;
26 import java.lang.annotation.Retention;
27 import java.lang.annotation.RetentionPolicy;
28 import java.lang.annotation.Target;
29 
30 /**
31  * Mark that a test requires that there is no dpc on the device.
32  *
33  * <p>This checks that there is no device owner, the current user has no work profiles, and the
34  * current user has no profile owner.
35  *
36  * <p>Your test configuration may be configured so that this test is only run on a device which has
37  * no dpc. Otherwise, you can use {@code Devicestate} to ensure that the device enters
38  * the correct state for the method.
39  */
40 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
41 @Retention(RetentionPolicy.RUNTIME)
42 @EnsureHasNoDeviceOwner
43 @EnsureHasNoWorkProfile
44 @EnsureHasNoProfileOwner
45 public @interface EnsureHasNoDpc {
46 
47     /** This is currently non-functional. */
48     // TODO(264845059): Add support for EnsureHasNoDpc across users
onUser()49     UserType onUser() default INSTRUMENTED_USER;
50 
51      /**
52      * Priority sets the order that annotations will be resolved.
53      *
54      * <p>Annotations with a lower priority will be resolved before annotations with a higher
55      * priority.
56      *
57      * <p>If there is an order requirement between annotations, ensure that the priority of the
58      * annotation which must be resolved first is lower than the one which must be resolved later.
59      *
60      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
61      */
priority()62     int priority() default DO_PO_PRIORITY;
63 }
64