1 /*
2  * Copyright (C) 2023 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.UserType.INITIAL_USER;
20 import static com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.REQUIRE_RUN_ON_PRECEDENCE;
21 import static com.android.bedstead.nene.types.OptionalBoolean.ANY;
22 
23 import com.android.bedstead.harrier.UserType;
24 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
25 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
26 import com.android.bedstead.multiuser.annotations.meta.EnsureHasProfileAnnotation;
27 import com.android.bedstead.nene.types.OptionalBoolean;
28 
29 import java.lang.annotation.ElementType;
30 import java.lang.annotation.Retention;
31 import java.lang.annotation.RetentionPolicy;
32 import java.lang.annotation.Target;
33 
34 /**
35  * Mark that a test method should run on a user which has a private profile.
36  *
37  * <p>Your test configuration may be configured so that this test is only run on a user which has
38  * a private profile. Otherwise, you can use {@code Devicestate} to ensure that the device enters
39  * the correct state for the method.
40  */
41 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
42 @Retention(RetentionPolicy.RUNTIME)
43 @EnsureHasProfileAnnotation("android.os.usertype.profile.PRIVATE")
44 @RequirePrivateSpaceSupported
45 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER)
46 public @interface EnsureHasPrivateProfile {
47     int ENSURE_HAS_PRIVATE_PROFILE_PRECEDENCE = REQUIRE_RUN_ON_PRECEDENCE - 1;
48 
49     /** Which user type the private profile should be attached to. */
forUser()50     UserType forUser() default INITIAL_USER;
51 
52     /** Whether the instrumented test app should be installed in the private profile. */
installInstrumentedApp()53     OptionalBoolean installInstrumentedApp() default ANY;
54 
55     /**
56      * Should we ensure that we are switched to the parent of the profile.
57      */
switchedToParentUser()58     OptionalBoolean switchedToParentUser() default ANY;
59 
60     /**
61      * Priority sets the order that annotations will be resolved.
62      *
63      * <p>Annotations with a lower priority will be resolved before annotations with a higher
64      * priority.
65      *
66      * <p>If there is an order requirement between annotations, ensure that the priority of the
67      * annotation which must be resolved first is lower than the one which must be resolved later.
68      *
69      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
70      */
71     // Must be before RequireRunOn to ensure users exist
priority()72     int priority() default ENSURE_HAS_PRIVATE_PROFILE_PRECEDENCE;
73 }
74