1 /* 2 * Copyright (C) 2022 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; 18 19 import static com.android.bedstead.harrier.annotations.AnnotationRunPrecedence.EARLY; 20 21 import java.lang.annotation.ElementType; 22 import java.lang.annotation.Repeatable; 23 import java.lang.annotation.Retention; 24 import java.lang.annotation.RetentionPolicy; 25 import java.lang.annotation.Target; 26 27 /** 28 * Mark that a test method should enable the given feature flag before running. 29 * 30 * <p>This should be used with {@code DeviceState}. 31 * 32 * <p>If you'd rather the test was skipped or failed when the feature flag is not enabled, see 33 * {@link RequireFeatureFlagEnabled}. 34 */ 35 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 36 @Retention(RetentionPolicy.RUNTIME) 37 @Repeatable(EnsureFeatureFlagEnabledGroup.class) 38 public @interface EnsureFeatureFlagEnabled { namespace()39 String namespace(); key()40 String key(); 41 42 /** 43 * Weight sets the order that annotations will be resolved. 44 * 45 * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. 46 * 47 * <p>If there is an order requirement between annotations, ensure that the weight of the 48 * annotation which must be resolved first is lower than the one which must be resolved later. 49 * 50 * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. 51 */ weight()52 int weight() default EARLY; 53 } 54