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.TRUE; 21 22 import com.android.bedstead.harrier.annotations.meta.RequireRunOnUserAnnotation; 23 import com.android.bedstead.nene.types.OptionalBoolean; 24 25 import java.lang.annotation.ElementType; 26 import java.lang.annotation.Retention; 27 import java.lang.annotation.RetentionPolicy; 28 import java.lang.annotation.Target; 29 30 /** 31 * Mark that a test method should run on a secondary user. 32 * 33 * <p>Your test configuration should be such that this test is only run where a secondary user is 34 * created and the test is being run on that user. 35 * 36 * <p>Optionally, you can guarantee that these methods do not run outside of a secondary user by 37 * using {@code Devicestate}. 38 * 39 * <p>This annotation by default opts a test into multi-user presubmit. New tests should also be 40 * annotated {@link Postsubmit} until they are shown to meet the multi-user presubmit 41 * requirements. 42 */ 43 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 44 @Retention(RetentionPolicy.RUNTIME) 45 @RequireRunOnUserAnnotation("android.os.usertype.full.SECONDARY") 46 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER) 47 public @interface RequireRunOnSecondaryUser { 48 /** 49 * Should we ensure that we are switched to the given user. 50 * 51 * <p>ANY will be treated as TRUE if no other annotation has forced a switch. 52 */ switchedToUser()53 OptionalBoolean switchedToUser() default TRUE; 54 55 /** 56 * Priority sets the order that annotations will be resolved. 57 * 58 * <p>Annotations with a lower priority will be resolved before annotations with a higher 59 * priority. 60 * 61 * <p>If there is an order requirement between annotations, ensure that the priority of the 62 * annotation which must be resolved first is lower than the one which must be resolved later. 63 * 64 * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}. 65 */ priority()66 int priority() default REQUIRE_RUN_ON_PRECEDENCE; 67 } 68