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