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.harrier.annotations.AnnotationPriorityRunPrecedence.PRECEDENCE_NOT_IMPORTANT;
20 
21 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
22 import com.android.bedstead.harrier.annotations.meta.RequiresBedsteadJUnit4;
23 
24 import java.lang.annotation.ElementType;
25 import java.lang.annotation.Retention;
26 import java.lang.annotation.RetentionPolicy;
27 import java.lang.annotation.Target;
28 
29 /**
30  * Mark a test as testing the states where a policy is not allowed to be applied.
31  *
32  * <p>An example is running with a device owner for a policy only applicable to profile owners.
33  *
34  * <p>This will generate parameterized runs for all matching states.
35  */
36 @Target(ElementType.METHOD)
37 @Retention(RetentionPolicy.RUNTIME)
38 @RequiresBedsteadJUnit4
39 public @interface CannotSetPolicyTest {
40     /**
41      * The policy being tested.
42      *
43      * <p>If multiple policies are specified, then they will be merged so that all valid states for
44      * all specified policies are considered as valid.
45      *
46      * <p>This is used to calculate which states are required to be tested.
47      */
policy()48     Class<?>[] policy();
49 
50     /**
51      * If true, then this will run in states where the app is a device admin but is not one which is
52      * allowed to make the call.
53      */
includeDeviceAdminStates()54     boolean includeDeviceAdminStates() default true;
55 
56     /**
57      * If true, then this will run in states where the app is not a device admin.
58      */
includeNonDeviceAdminStates()59     boolean includeNonDeviceAdminStates() default true;
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 PRECEDENCE_NOT_IMPORTANT;
73 }
74