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.REQUIRE_RUN_ON_PRECEDENCE;
20 
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25 
26 /**
27  * Mark that a test method should run on a non-secondary user.
28  *
29  * <p>Your test configuration should be such that this test is only run where a non-secondary user
30  * is created and the test is being run on that user.
31  *
32  * <p>Optionally, you can guarantee that these methods do not run on a secondary user by using
33  * {@code Devicestate}.
34  *
35  * <p>This annotation by default opts a test into multi-user presubmit. New tests should also be
36  * annotated {@link Postsubmit} until they are shown to meet the multi-user presubmit requirements.
37  */
38 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
39 @Retention(RetentionPolicy.RUNTIME)
40 // To ensure that the test doesn't run on the secondary user we require that the test run on
41 // the system user to ensure consistent behaviour.
42 @RequireRunOnSystemUser
43 public @interface RequireRunNotOnSecondaryUser {
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 REQUIRE_RUN_ON_PRECEDENCE;
56 }
57