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.interactive; 18 19 import static com.android.bedstead.harrier.annotations.AnnotationRunPrecedence.LAST; 20 21 import com.android.bedstead.harrier.annotations.AnnotationRunPrecedence; 22 import com.android.bedstead.harrier.annotations.FailureMode; 23 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor; 24 25 import java.lang.annotation.ElementType; 26 import java.lang.annotation.Repeatable; 27 import java.lang.annotation.Retention; 28 import java.lang.annotation.RetentionPolicy; 29 import java.lang.annotation.Target; 30 31 /** 32 * Mark that a test method should only run when a boolean Step returns the expected value. 33 * 34 * <p>You can use {@code DeviceState} to ensure that the test is only run in the correct state. 35 */ 36 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 37 @Retention(RetentionPolicy.RUNTIME) 38 @UsesAnnotationExecutor(InteractiveAnnotationExecutor.class) 39 @Repeatable(RequireBooleanStepResultGroup.class) 40 public @interface RequireBooleanStepResult { 41 /** The step to execute. */ step()42 Class<? extends Step<Boolean>> step(); 43 44 /** The expected result of the step. */ expectedResult()45 boolean expectedResult(); 46 47 /** The reason for this requirement. */ reason()48 String reason(); 49 failureMode()50 FailureMode failureMode() default FailureMode.SKIP; 51 52 /** 53 * Weight sets the order that annotations will be resolved. 54 * 55 * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. 56 * 57 * <p>If there is an order requirement between annotations, ensure that the weight of the 58 * annotation which must be resolved first is lower than the one which must be resolved later. 59 * 60 * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. 61 */ weight()62 int weight() default LAST; 63 } 64