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