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 * Mark a test as testing the states where a policy is allowed to be applied. 30 * 31 * <p>This will generate parameterized runs for all matching states. Tests will only be run on 32 * the same user as the DPC. If you wish to test that a policy applies across all relevant states, 33 * use {@link PolicyAppliesTest}. 34 */ 35 @Target(ElementType.METHOD) 36 @Retention(RetentionPolicy.RUNTIME) 37 @RequiresBedsteadJUnit4 38 public @interface CanSetPolicyTest { 39 /** 40 * The policy being tested. 41 * 42 * <p>If multiple policies are specified, then they will be merged so that all valid states for 43 * all specified policies are considered as valid. 44 * 45 * <p>This is used to calculate which states are required to be tested. 46 */ policy()47 Class<?>[] policy(); 48 49 /** 50 * If true, this test will only be run in a single state. 51 * 52 * <p>This is useful for tests of invalid inputs, where running in multiple states is unlikely 53 * to add meaningful coverage. 54 * 55 * By default, all states where the policy can be set will be included. 56 */ singleTestOnly()57 boolean singleTestOnly() default false; 58 59 /** 60 * Priority sets the order that annotations will be resolved. 61 * 62 * <p>Annotations with a lower priority will be resolved before annotations with a higher 63 * priority. 64 * 65 * <p>If there is an order requirement between annotations, ensure that the priority of the 66 * annotation which must be resolved first is lower than the one which must be resolved later. 67 * 68 * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}. 69 */ priority()70 int priority() default PRECEDENCE_NOT_IMPORTANT; 71 } 72