• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 com.android.bedstead.harrier.annotations.AnnotationRunPrecedence.PRECEDENCE_NOT_IMPORTANT;
20 
21 import com.android.bedstead.harrier.annotations.AnnotationRunPrecedence;
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 applied (by a Device Owner or Profile Owner)
31  * and it should not apply to the user the test is running on.
32  *
33  * <p>This will generate parameterized runs for all matching states.
34  */
35 @Target(ElementType.METHOD)
36 @Retention(RetentionPolicy.RUNTIME)
37 @RequiresBedsteadJUnit4
38 public @interface PolicyDoesNotApplyTest {
39     /**
40      * The policy being tested.
41      *
42      * <p>This is used to calculate which states are required to be tested.
43      */
policy()44     Class<?> policy();
45 
46     /**
47      * Weight sets the order that annotations will be resolved.
48      *
49      * <p>Annotations with a lower weight will be resolved before annotations with a higher weight.
50      *
51      * <p>If there is an order requirement between annotations, ensure that the weight of the
52      * annotation which must be resolved first is lower than the one which must be resolved later.
53      *
54      * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}.
55      */
weight()56     int weight() default PRECEDENCE_NOT_IMPORTANT;
57 }
58