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.annotations.AnnotationPriorityRunPrecedence.REQUIRE_RUN_ON_PRECEDENCE; 20 import static com.android.bedstead.nene.types.OptionalBoolean.ANY; 21 import static com.android.bedstead.nene.types.OptionalBoolean.TRUE; 22 23 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence; 24 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor; 25 import com.android.bedstead.multiuser.annotations.meta.RequireRunOnProfileAnnotation; 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 within a Clone profile. 35 * 36 * <p>Your test configuration should be such that this test is only run where a Clone profile is 37 * created and the test is being run within that user. 38 * 39 * <p>Optionally, you can guarantee that these methods do not run outside of a Clone 40 * profile by using {@code Devicestate}. 41 */ 42 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 43 @Retention(RetentionPolicy.RUNTIME) 44 @RequireNotHeadlessSystemUserMode(reason = "Requires full system user") 45 @RequireRunOnProfileAnnotation("android.os.usertype.profile.CLONE") 46 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER) 47 public @interface RequireRunOnCloneProfile { installInstrumentedAppInParent()48 OptionalBoolean installInstrumentedAppInParent() default ANY; 49 50 /** 51 * Should we ensure that we are switched to the parent of the profile. 52 * 53 * <p>ANY will be treated as TRUE if no other annotation has forced a switch. 54 */ switchedToParentUser()55 OptionalBoolean switchedToParentUser() default TRUE; 56 57 /** 58 * Priority sets the order that annotations will be resolved. 59 * 60 * <p>Annotations with a lower priority will be resolved before annotations with a higher 61 * priority. 62 * 63 * <p>If there is an order requirement between annotations, ensure that the priority of the 64 * annotation which must be resolved first is lower than the one which must be resolved later. 65 * 66 * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}. 67 */ priority()68 int priority() default REQUIRE_RUN_ON_PRECEDENCE; 69 } 70