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; 18 19 import static com.android.bedstead.harrier.UserType.INSTRUMENTED_USER; 20 import static com.android.bedstead.harrier.annotations.AnnotationRunPrecedence.REQUIRE_RUN_ON_PRECEDENCE; 21 import static com.android.bedstead.nene.types.OptionalBoolean.ANY; 22 import static com.android.bedstead.nene.types.OptionalBoolean.TRUE; 23 24 import com.android.bedstead.harrier.UserType; 25 import com.android.bedstead.harrier.annotations.meta.EnsureHasProfileAnnotation; 26 import com.android.bedstead.nene.types.OptionalBoolean; 27 28 import java.lang.annotation.ElementType; 29 import java.lang.annotation.Retention; 30 import java.lang.annotation.RetentionPolicy; 31 import java.lang.annotation.Target; 32 33 /** 34 * Mark that a test method should run on a user which has a Tv profile. 35 * 36 * <p>Your test configuration may be configured so that this test is only run on a user which has 37 * a Tv profile. Otherwise, you can use {@code Devicestate} to ensure that the device enters 38 * the correct state for the method. 39 */ 40 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 41 @Retention(RetentionPolicy.RUNTIME) 42 @EnsureHasProfileAnnotation("com.android.tv.profile") 43 public @interface EnsureHasTvProfile { 44 /** Which user type the tv profile should be attached to. */ forUser()45 UserType forUser() default INSTRUMENTED_USER; 46 47 /** Whether the instrumented test app should be installed in the tv profile. */ installInstrumentedApp()48 OptionalBoolean installInstrumentedApp() default TRUE; 49 50 /** 51 * Should we ensure that we are switched to the parent of the profile. 52 */ switchedToParentUser()53 OptionalBoolean switchedToParentUser() default ANY; 54 55 /** 56 * Weight sets the order that annotations will be resolved. 57 * 58 * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. 59 * 60 * <p>If there is an order requirement between annotations, ensure that the weight of the 61 * annotation which must be resolved first is lower than the one which must be resolved later. 62 * 63 * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. 64 */ 65 // Must be before RequireRunOn to ensure users exist weight()66 int weight() default REQUIRE_RUN_ON_PRECEDENCE - 1; 67 } 68