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.AnnotationRunPrecedence.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.RequireRunOnUserAnnotation; 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 on the system user. 33 * 34 * <p>Your test configuration should be such that this test is only run on the system user 35 * 36 * <p>Optionally, you can guarantee that these methods do not run outside of the system 37 * user by using {@code Devicestate}. 38 * 39 * <p>Note that this requires that the test runs on the system user, including headless system 40 * users. To mark that a test should run on the primary user, excluding headless 41 * system users, see {@link RequireRunOnPrimaryUser}. 42 */ 43 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 44 @Retention(RetentionPolicy.RUNTIME) 45 @RequireRunOnUserAnnotation( 46 {"android.os.usertype.full.SYSTEM", "android.os.usertype.system.HEADLESS"}) 47 public @interface RequireRunOnSystemUser { 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 and the user 52 * can be switched to. 53 */ switchedToUser()54 OptionalBoolean switchedToUser() default ANY; 55 56 /** 57 * Weight sets the order that annotations will be resolved. 58 * 59 * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. 60 * 61 * <p>If there is an order requirement between annotations, ensure that the weight of the 62 * annotation which must be resolved first is lower than the one which must be resolved later. 63 * 64 * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. 65 */ weight()66 int weight() default REQUIRE_RUN_ON_PRECEDENCE; 67 } 68