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.UserType;
22 import com.android.bedstead.harrier.annotations.enterprise.AdditionalQueryParameters;
23 import com.android.queryable.annotations.Query;
24 
25 import java.lang.annotation.ElementType;
26 import java.lang.annotation.Repeatable;
27 import java.lang.annotation.Retention;
28 import java.lang.annotation.RetentionPolicy;
29 import java.lang.annotation.Target;
30 
31 /**
32  * Mark that a test requires the given test app to be installed on the given user.
33  *
34  * <p>You should 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 @Repeatable(EnsureTestAppInstalledGroup.class)
40 @UsesAnnotationExecutor(UsesAnnotationExecutor.TEST_APPS)
41 public @interface EnsureTestAppInstalled {
42 
43     int ENSURE_TEST_APP_INSTALLED_PRIORITY = MIDDLE;
44 
45     String DEFAULT_KEY = "testApp";
46 
47     /**
48      * A key which uniquely identifies the test app for the test.
49      *
50      * <p>This can be used with e.g. {@code DeviceState#testApp} and
51      * {@link AdditionalQueryParameters}.
52      */
key()53     String key() default DEFAULT_KEY;
54 
55     /** Query specifying the testapp. Defaults to any test app. */
query()56     Query query() default @Query();
57 
58     /** The user the testApp should be installed on. */
onUser()59     UserType onUser() default UserType.INSTRUMENTED_USER;
60 
61      /**
62      * Priority sets the order that annotations will be resolved.
63      *
64      * <p>Annotations with a lower priority will be resolved before annotations with a higher
65      * priority.
66      *
67      * <p>If there is an order requirement between annotations, ensure that the priority of the
68      * annotation which must be resolved first is lower than the one which must be resolved later.
69      *
70      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
71      */
priority()72     int priority() default ENSURE_TEST_APP_INSTALLED_PRIORITY;
73 }
74