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.EnsureHasWorkProfile.ENSURE_HAS_WORK_PROFILE_WEIGHT; 20 import static com.android.bedstead.nene.types.OptionalBoolean.ANY; 21 22 import com.android.bedstead.nene.types.OptionalBoolean; 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 device which has an additional user. 31 * 32 * <p>An additional user is a full user which is not the initial user. In general this will be 33 * a secondary user. On headless-system-user devices it will mean there are at least two secondary 34 * users on the device. 35 * 36 * <p>Your test configuration may be configured so that this test is only run on a device which 37 * has an additional user that is not the current user. Otherwise, you can use {@code Devicestate} 38 * to ensure that the device enters the correct state for the method. If there is not already an 39 * additional user on the device, and the device does not support creating additional users, then 40 * the test will be skipped. 41 */ 42 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) 43 @Retention(RetentionPolicy.RUNTIME) 44 public @interface EnsureHasAdditionalUser { 45 /** Whether the instrumented test app should be installed in the additional user. */ installInstrumentedApp()46 OptionalBoolean installInstrumentedApp() default ANY; 47 48 /** 49 * Should we ensure that we are switched to the given user 50 */ switchedToUser()51 OptionalBoolean switchedToUser() default ANY; 52 53 /** 54 * Weight sets the order that annotations will be resolved. 55 * 56 * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. 57 * 58 * <p>If there is an order requirement between annotations, ensure that the weight of the 59 * annotation which must be resolved first is lower than the one which must be resolved later. 60 * 61 * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. 62 */ 63 // Lower weights than EnsureWorkProfile annotation to make sure parent exists during profile 64 // creation weight()65 int weight() default ENSURE_HAS_WORK_PROFILE_WEIGHT - 1; 66 } 67