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.enterprise.annotations.EnsureHasWorkProfileKt.ENSURE_HAS_WORK_PROFILE_PRIORITY;
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.nene.types.OptionalBoolean;
25 
26 import java.lang.annotation.ElementType;
27 import java.lang.annotation.Retention;
28 import java.lang.annotation.RetentionPolicy;
29 import java.lang.annotation.Target;
30 
31 /**
32  * Mark that a test method should run on a device which has an additional user.
33  *
34  * <p>An additional user is a full user which is not the initial user. In general this will be
35  * a secondary user. On headless-system-user devices it will mean there are at least two secondary
36  * users on the device.
37  *
38  * <p>Your test configuration may be configured so that this test is only run on a device which
39  * has an additional user that is not the current user. Otherwise, you can use {@code Devicestate}
40  * to ensure that the device enters the correct state for the method. If there is not already an
41  * additional user on the device, and the device does not support creating additional users, then
42  * the test will be skipped.
43  */
44 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
45 @Retention(RetentionPolicy.RUNTIME)
46 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER)
47 public @interface EnsureHasAdditionalUser {
48     /** Whether the instrumented test app should be installed in the additional user. */
installInstrumentedApp()49     OptionalBoolean installInstrumentedApp() default ANY;
50 
51     /**
52      * Should we ensure that we are switched to the given user
53      */
switchedToUser()54     OptionalBoolean switchedToUser() default ANY;
55 
56      /**
57      * Priority sets the order that annotations will be resolved.
58      *
59      * <p>Annotations with a lower priority will be resolved before annotations with a higher
60      * priority.
61      *
62      * <p>If there is an order requirement between annotations, ensure that the priority of the
63      * annotation which must be resolved first is lower than the one which must be resolved later.
64      *
65      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
66      */
67     // Lower weights than EnsureWorkProfile annotation to make sure parent exists during profile
68     // creation
priority()69     int priority() default ENSURE_HAS_WORK_PROFILE_PRIORITY - 1;
70 }
71