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.AnnotationRunPrecedence.REQUIRE_RUN_ON_PRECEDENCE; 20 import static com.android.bedstead.nene.types.OptionalBoolean.ANY; 21 22 import com.android.bedstead.harrier.annotations.meta.EnsureHasUserAnnotation; 23 import com.android.bedstead.nene.types.OptionalBoolean; 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 method should run on a device which has a secondary user. 32 * 33 * <p>Your test configuration may be configured so that this test is only run on a device which 34 * has a secondary user that is not the current user. Otherwise, you can use {@code Devicestate} 35 * to ensure that the device enters the correct state for the method. If there is not already a 36 * secondary user on the device, and the device does not support creating additional users, then 37 * the test will be skipped. 38 */ 39 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 40 @Retention(RetentionPolicy.RUNTIME) 41 @EnsureHasUserAnnotation("android.os.usertype.full.SECONDARY") 42 public @interface EnsureHasSecondaryUser { 43 /** Whether the instrumented test app should be installed in the secondary user. */ installInstrumentedApp()44 OptionalBoolean installInstrumentedApp() default ANY; 45 46 /** 47 * Should we ensure that we are switched to the given user 48 */ switchedToUser()49 OptionalBoolean switchedToUser() default ANY; 50 51 /** 52 * Weight sets the order that annotations will be resolved. 53 * 54 * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. 55 * 56 * <p>If there is an order requirement between annotations, ensure that the weight of the 57 * annotation which must be resolved first is lower than the one which must be resolved later. 58 * 59 * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. 60 */ 61 // Must be before RequireRunOn to ensure users exist weight()62 int weight() default REQUIRE_RUN_ON_PRECEDENCE - 1; 63 } 64