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 
22 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
23 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
24 import com.android.bedstead.multiuser.annotations.meta.RequireRunOnUserAnnotation;
25 import com.android.bedstead.nene.types.OptionalBoolean;
26 
27 import java.lang.annotation.ElementType;
28 import java.lang.annotation.Retention;
29 import java.lang.annotation.RetentionPolicy;
30 import java.lang.annotation.Target;
31 
32 /**
33  * Mark that a test method should run on the system user.
34  *
35  * <p>Your test configuration should be such that this test is only run on the system user
36  *
37  * <p>Optionally, you can guarantee that these methods do not run outside of the system
38  * user by using {@code Devicestate}.
39  *
40  * <p>Note that this requires that the test runs on the system user, including headless system
41  * users. To mark that a test should run on the primary user, excluding headless
42  * system users, see {@link RequireRunOnPrimaryUser}.
43  */
44 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
45 @Retention(RetentionPolicy.RUNTIME)
46 @RequireRunOnUserAnnotation(
47         {"android.os.usertype.full.SYSTEM", "android.os.usertype.system.HEADLESS"})
48 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER)
49 public @interface RequireRunOnSystemUser {
50     /**
51      * Should we ensure that we are switched to the given user.
52      *
53      * <p>ANY will be treated as TRUE if no other annotation has forced a switch and the user
54      * can be switched to.
55      */
switchedToUser()56     OptionalBoolean switchedToUser() 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      */
priority()69     int priority() default REQUIRE_RUN_ON_PRECEDENCE;
70 }
71