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