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.multiuser.annotations; 18 19 import static com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence.REQUIRE_RUN_ON_PRECEDENCE; 20 21 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence; 22 import com.android.bedstead.harrier.annotations.Postsubmit; 23 24 import java.lang.annotation.ElementType; 25 import java.lang.annotation.Retention; 26 import java.lang.annotation.RetentionPolicy; 27 import java.lang.annotation.Target; 28 29 /** 30 * Mark that a test method should run on a non-secondary user. 31 * 32 * <p>Your test configuration should be such that this test is only run where a non-secondary user 33 * is created and the test is being run on that user. 34 * 35 * <p>Optionally, you can guarantee that these methods do not run on a secondary user by using 36 * {@code Devicestate}. 37 * 38 * <p>This annotation by default opts a test into multi-user presubmit. New tests should also be 39 * annotated {@link Postsubmit} until they are shown to meet the multi-user presubmit requirements. 40 */ 41 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 42 @Retention(RetentionPolicy.RUNTIME) 43 // To ensure that the test doesn't run on the secondary user we require that the test run on 44 // the system user to ensure consistent behaviour. 45 @RequireRunOnSystemUser 46 public @interface RequireRunNotOnSecondaryUser { 47 /** 48 * Priority sets the order that annotations will be resolved. 49 * 50 * <p>Annotations with a lower priority will be resolved before annotations with a higher 51 * priority. 52 * 53 * <p>If there is an order requirement between annotations, ensure that the priority of the 54 * annotation which must be resolved first is lower than the one which must be resolved later. 55 * 56 * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}. 57 */ priority()58 int priority() default REQUIRE_RUN_ON_PRECEDENCE; 59 } 60