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.enterprise.annotations;
18 
19 import static com.android.bedstead.enterprise.annotations.EnsureHasDeviceOwner.DO_PO_PRIORITY;
20 
21 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
22 import com.android.bedstead.harrier.annotations.RequireNotInstantApp;
23 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
24 
25 import java.lang.annotation.ElementType;
26 import java.lang.annotation.Retention;
27 import java.lang.annotation.RetentionPolicy;
28 import java.lang.annotation.Target;
29 
30 /**
31  * Mark that a test requires that there is no device owner on the device.
32  *
33  * <p>Your test configuration may be configured so that this test is only run on a device which has
34  * no device owner. Otherwise, you can use {@code Devicestate} to ensure that the device enters
35  * the correct state for the method.
36  */
37 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
38 @Retention(RetentionPolicy.RUNTIME)
39 // TODO(b/206441366): Add instant app support
40 @RequireNotInstantApp(reason = "Instant Apps cannot run Enterprise Tests")
41 @UsesAnnotationExecutor(UsesAnnotationExecutor.ENTERPRISE)
42 public @interface EnsureHasNoDeviceOwner {
43 
44      /**
45      * Priority sets the order that annotations will be resolved.
46      *
47      * <p>Annotations with a lower priority will be resolved before annotations with a higher
48      * priority.
49      *
50      * <p>If there is an order requirement between annotations, ensure that the priority of the
51      * annotation which must be resolved first is lower than the one which must be resolved later.
52      *
53      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
54      */
priority()55     int priority() default DO_PO_PRIORITY;
56 }
57