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 import com.android.bedstead.harrier.annotations.RequireNotInstantApp;
25 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
26 
27 import java.lang.annotation.ElementType;
28 import java.lang.annotation.Repeatable;
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 requires that there is no profile owner on the given user.
35  *
36  * <p>You can use {@code Devicestate} to ensure that the device enters the correct state for the
37  * method.
38  */
39 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
40 @Retention(RetentionPolicy.RUNTIME)
41 // TODO(b/206441366): Add instant app support
42 @RequireNotInstantApp(reason = "Instant Apps cannot run Enterprise Tests")
43 @Repeatable(EnsureHasNoProfileOwnerGroup.class)
44 @UsesAnnotationExecutor(UsesAnnotationExecutor.ENTERPRISE)
45 public @interface EnsureHasNoProfileOwner {
46     /** Which user type the profile owner should not be attached to. */
onUser()47     UserType onUser() default INSTRUMENTED_USER;
48 
49      /**
50      * Priority sets the order that annotations will be resolved.
51      *
52      * <p>Annotations with a lower priority will be resolved before annotations with a higher
53      * priority.
54      *
55      * <p>If there is an order requirement between annotations, ensure that the priority of the
56      * annotation which must be resolved first is lower than the one which must be resolved later.
57      *
58      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
59      */
priority()60     int priority() default DO_PO_PRIORITY;
61 }
62