• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.enterprise;
18 
19 import static com.android.bedstead.harrier.UserType.INSTRUMENTED_USER;
20 import static com.android.bedstead.harrier.annotations.enterprise.EnsureHasDeviceOwner.DO_PO_WEIGHT;
21 
22 import com.android.bedstead.harrier.UserType;
23 import com.android.bedstead.harrier.annotations.AnnotationRunPrecedence;
24 import com.android.bedstead.harrier.annotations.RequireNotInstantApp;
25 
26 import java.lang.annotation.ElementType;
27 import java.lang.annotation.Repeatable;
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 requires that there is no profile owner on the given user.
34  *
35  * <p>You can use {@code Devicestate} to ensure that the device enters the correct state for the
36  * method.
37  */
38 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
39 @Retention(RetentionPolicy.RUNTIME)
40 // TODO(b/206441366): Add instant app support
41 @RequireNotInstantApp(reason = "Instant Apps cannot run Enterprise Tests")
42 @Repeatable(EnsureHasNoProfileOwnerGroup.class)
43 public @interface EnsureHasNoProfileOwner {
44     /** Which user type the profile owner should not be attached to. */
onUser()45     UserType onUser() default INSTRUMENTED_USER;
46 
47     /**
48      * Weight sets the order that annotations will be resolved.
49      *
50      * <p>Annotations with a lower weight will be resolved before annotations with a higher weight.
51      *
52      * <p>If there is an order requirement between annotations, ensure that the weight of the
53      * annotation which must be resolved first is lower than the one which must be resolved later.
54      *
55      * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}.
56      */
weight()57     int weight() default DO_PO_WEIGHT;
58 }
59