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