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.EnsureHasDelegate.ENSURE_HAS_DELEGATE_PRIORITY;
20 
21 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
22 import com.android.bedstead.harrier.annotations.RequireNotInstantApp;
23 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
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 the given admin does not delegate the given scope to a test app.
32  *
33  * <p>You should use {@code Devicestate} to ensure that the device enters
34  * the correct state for the method.
35  */
36 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
37 @Retention(RetentionPolicy.RUNTIME)
38 // TODO(b/206441366): Add instant app support
39 @RequireNotInstantApp(reason = "Instant Apps cannot run Enterprise Tests")
40 @UsesAnnotationExecutor(UsesAnnotationExecutor.ENTERPRISE)
41 public @interface EnsureHasNoDelegate {
42 
43     enum AdminType {
44         DEVICE_OWNER,
45         PROFILE_OWNER,
46         PRIMARY,
47         ANY
48     }
49 
50 
51     /**
52      * The admin that should not delegate this scope.
53      *
54      * <p>Defaults to any admin
55      *
56      * <p>If this is set to {@link AdminType#PRIMARY} and {@link #isPrimary()} is true, then the
57      * delegate will replace the primary dpc as primary without error.
58      */
admin()59     AdminType admin() default AdminType.ANY;
60 
61      /**
62      * Priority sets the order that annotations will be resolved.
63      *
64      * <p>Annotations with a lower priority will be resolved before annotations with a higher
65      * priority.
66      *
67      * <p>If there is an order requirement between annotations, ensure that the priority of the
68      * annotation which must be resolved first is lower than the one which must be resolved later.
69      *
70      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
71      */
priority()72     int priority() default ENSURE_HAS_DELEGATE_PRIORITY + 1; // Should run after setting delegate
73 }
74