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