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.Postsubmit;
24 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
25 import com.android.bedstead.harrier.annotations.meta.RequiresBedsteadJUnit4;
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 an additional user.
35  *
36  * <p>Your test configuration should be such that this test is only run where a secondary user is
37  * created, the test is being run on that user, and that user is not the initial user.
38  *
39  * <p>Optionally, you can guarantee that these methods do not run outside of an additional user by
40  * using {@code Devicestate}.
41  *
42  * <p>This requires the use of {@link com.android.bedstead.harrier.BedsteadJUnit4}. This will
43  * replace this annotation with the {@code RequireRunOn} annotation for the additional user.
44  *
45  * <p>Note that in general this requires the test runs on a secondary user. On headless system user
46  * devices, this will require running on a second secondary user.
47  *
48  * <p>This annotation by default opts a test into multi-user presubmit. New tests should also be
49  * annotated {@link Postsubmit} until they are shown to meet the multi-user presubmit
50  * requirements.
51  */
52 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
53 @Retention(RetentionPolicy.RUNTIME)
54 @RequiresBedsteadJUnit4
55 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER)
56 // Note that additional annotations added here will not be applied by default due to special
57 // logic (for HSUM) inside BedsteadJUnit4#ANNOTATION_REPLACEMENTS
58 public @interface RequireRunOnAdditionalUser {
59     /**
60      * Should we ensure that we are switched to the given user.
61      *
62      * <p>ANY will be treated as TRUE if no other annotation has forced a switch.
63      */
switchedToUser()64     OptionalBoolean switchedToUser() default TRUE;
65 
66      /**
67      * Priority sets the order that annotations will be resolved.
68      *
69      * <p>Annotations with a lower priority will be resolved before annotations with a higher
70      * priority.
71      *
72      * <p>If there is an order requirement between annotations, ensure that the priority of the
73      * annotation which must be resolved first is lower than the one which must be resolved later.
74      *
75      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
76      */
priority()77     int priority() default REQUIRE_RUN_ON_PRECEDENCE;
78 }
79