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.INSTRUMENTED_USER;
20 import static com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.MIDDLE;
21 
22 import com.android.bedstead.harrier.UserType;
23 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
24 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
25 import com.android.bedstead.multiuser.annotations.meta.EnsureHasNoProfileAnnotation;
26 
27 import java.lang.annotation.ElementType;
28 import java.lang.annotation.Retention;
29 import java.lang.annotation.RetentionPolicy;
30 import java.lang.annotation.Target;
31 
32 /**
33  * Mark that a test method should run on a user which has no private profile.
34  *
35  * <p>Your test configuration may be configured so that this test is only run on a user which has
36  * no private profile. Otherwise, you can use {@code Devicestate} to ensure that the device enters
37  * the correct state for the method.
38  */
39 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
40 @Retention(RetentionPolicy.RUNTIME)
41 @EnsureHasNoProfileAnnotation("android.os.usertype.profile.PRIVATE")
42 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER)
43 public @interface EnsureHasNoPrivateProfile {
44     /** Which user type the private profile should not be attached to. */
forUser()45     UserType forUser() default INSTRUMENTED_USER;
46 
47     /**
48      * Priority sets the order that annotations will be resolved.
49      *
50      * <p>Annotations with a lower priority will be resolved before annotations with a higher priority.
51      *
52      * <p>If there is an order requirement between annotations, ensure that the priority of the
53      * annotation which must be resolved first is lower than the one which must be resolved later.
54      *
55      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
56      */
priority()57     int priority() default MIDDLE;
58 }
59