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.TRUE;
21 
22 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
23 import com.android.bedstead.harrier.annotations.RequireRunOnInitialUser;
24 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
25 import com.android.bedstead.multiuser.annotations.meta.RequireRunOnUserAnnotation;
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 on the primary user.
35  *
36  * <p>Your test configuration should be such that this test is only run on the primary user
37  *
38  * <p>Optionally, you can guarantee that these methods do not run outside of the primary
39  * user by using {@code Devicestate}.
40  *
41  * <p>Note that in practice this requires that the test runs on the system user, but excludes
42  * headless system users. To mark that a test should run on the system user, including headless
43  * system users, see {@link RequireRunOnSystemUser} - or to run on the first user used by a
44  * human (which will be the primary user on non-headless-system-user devices, or a secondary user
45  * otherwise), use {@link RequireRunOnInitialUser}.
46  */
47 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
48 @Retention(RetentionPolicy.RUNTIME)
49 @RequireRunOnUserAnnotation("android.os.usertype.full.SYSTEM")
50 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER)
51 public @interface RequireRunOnPrimaryUser {
52     /**
53      * Should we ensure that we are switched to the given user.
54      *
55      * <p>ANY will be treated as TRUE if no other annotation has forced a switch.
56      */
switchedToUser()57     OptionalBoolean switchedToUser() default TRUE;
58 
59      /**
60      * Priority sets the order that annotations will be resolved.
61      *
62      * <p>Annotations with a lower priority will be resolved before annotations with a higher
63      * priority.
64      *
65      * <p>If there is an order requirement between annotations, ensure that the priority of the
66      * annotation which must be resolved first is lower than the one which must be resolved later.
67      *
68      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
69      */
priority()70     int priority() default REQUIRE_RUN_ON_PRECEDENCE;
71 }
72