1 /*
2  * Copyright (C) 2022 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  * Marks that a test method should run on the initial user.
32  *
33  * <p>This requires the use of {@link com.android.bedstead.harrier.BedsteadJUnit4}. This will
34  * replace this annotation with the {@code RequireRunOn} annotation for the initial user.
35  *
36  * <p>Note that in general this requires the test runs on the system user. On headless system user
37  * devices, this will require running on the first non-system user.
38  */
39 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
40 @Retention(RetentionPolicy.RUNTIME)
41 @RequiresBedsteadJUnit4
42 public @interface RequireRunOnInitialUser {
43 
44     // Note that when generating the list of tests, BedsteadJUnit4 will replace this annotation with
45     // the relevant annotation to ensure a test is run on the correct user for the given device
46 
47     /**
48      * Should we ensure that we are switched to the given user.
49      *
50      * <p>ANY will be treated as TRUE if no other annotation has forced a switch.
51      */
switchedToUser()52     OptionalBoolean switchedToUser() default TRUE;
53 
54      /**
55      * Priority sets the order that annotations will be resolved.
56      *
57      * <p>Annotations with a lower priority will be resolved before annotations with a higher
58      * priority.
59      *
60      * <p>If there is an order requirement between annotations, ensure that the priority of the
61      * annotation which must be resolved first is lower than the one which must be resolved later.
62      *
63      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
64      */
priority()65     int priority() default REQUIRE_RUN_ON_PRECEDENCE;
66 }
67