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 package com.android.bedstead.multiuser.annotations
17 
18 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence
19 import com.android.bedstead.harrier.annotations.FailureMode
20 import com.android.bedstead.harrier.annotations.RequireMultiUserSupport
21 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor
22 
23 /**
24  * Mark that a test method requires the ability to add a new user.
25  *
26  * You can use `Devicestate` to ensure that the device enters the correct state for the method.
27  */
28 @Target(
29     AnnotationTarget.FUNCTION,
30     AnnotationTarget.PROPERTY_GETTER,
31     AnnotationTarget.PROPERTY_SETTER,
32     AnnotationTarget.ANNOTATION_CLASS,
33     AnnotationTarget.CLASS
34 )
35 @Retention(AnnotationRetention.RUNTIME)
36 @JvmRepeatable(EnsureCanAddUserGroup::class)
37 @RequireMultiUserSupport
38 @UsesAnnotationExecutor(UsesAnnotationExecutor.MULTI_USER)
39 annotation class EnsureCanAddUser(
40     /** The number of users we need space for. Defaults to 1.  */
41     val number: Int = 1,
42     val failureMode: FailureMode = FailureMode.SKIP,
43     /**
44      * Priority sets the order that annotations will be resolved.
45      *
46      * Annotations with a lower priority will be resolved before annotations with a higher
47      * priority.
48      *
49      * If there is an order requirement between annotations, ensure that the priority of the
50      * annotation which must be resolved first is lower than the one which must be resolved later.
51      *
52      * Priority can be set to a [AnnotationPriorityRunPrecedence] constant, or to any [int].
53      */
54     val priority: Int = AnnotationPriorityRunPrecedence.MIDDLE
55 )
56