1 /* 2 * Copyright (C) 2022 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 android.car.apitest; 18 19 import android.annotation.Nullable; 20 import android.content.BroadcastReceiver; 21 import android.content.Context; 22 import android.content.ContextWrapper; 23 import android.content.Intent; 24 import android.content.IntentFilter; 25 import android.os.Handler; 26 import android.os.UserHandle; 27 import android.util.ArrayMap; 28 import android.util.Log; 29 30 import java.util.Collection; 31 32 /** 33 * A {@link Context} for testing which tracks registering/unregistering of broadcast receivers. 34 */ 35 final class ReceiverTrackingContext extends ContextWrapper { 36 37 private static final String TAG = ReceiverTrackingContext.class.getSimpleName(); 38 39 private final ArrayMap<BroadcastReceiver, String> mReceivers = new ArrayMap<>(); 40 ReceiverTrackingContext(Context baseContext)41 ReceiverTrackingContext(Context baseContext) { 42 super(baseContext); 43 } 44 45 @Override registerReceiver(@ullable BroadcastReceiver receiver, IntentFilter filter)46 public Intent registerReceiver(@Nullable BroadcastReceiver receiver, IntentFilter filter) { 47 addReceiver(receiver, "registerReceiver(%s, %s)", receiver, filter); 48 49 return super.registerReceiver(receiver, filter); 50 } 51 52 @Override registerReceiver(@ullable BroadcastReceiver receiver, IntentFilter filter, int flags)53 public Intent registerReceiver(@Nullable BroadcastReceiver receiver, IntentFilter filter, 54 int flags) { 55 addReceiver(receiver, "registerReceiver(%s, %s, %d)", receiver, filter, flags); 56 57 return super.registerReceiver(receiver, filter, flags); 58 } 59 60 @Override registerReceiver(@ullable BroadcastReceiver receiver, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler)61 public Intent registerReceiver(@Nullable BroadcastReceiver receiver, IntentFilter filter, 62 @Nullable String broadcastPermission, @Nullable Handler scheduler) { 63 addReceiver(receiver, "registerReceiver(%s, %s, %s, %s)", 64 receiver, filter, broadcastPermission, scheduler); 65 66 return super.registerReceiver(receiver, filter, broadcastPermission, 67 scheduler); 68 } 69 70 @Override registerReceiver(@ullable BroadcastReceiver receiver, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler, int flags)71 public Intent registerReceiver(@Nullable BroadcastReceiver receiver, IntentFilter filter, 72 @Nullable String broadcastPermission, @Nullable Handler scheduler, int flags) { 73 addReceiver(receiver, "registerReceiver(%s, %s, %s, %s, %d)", 74 receiver, filter, broadcastPermission, scheduler, flags); 75 76 return super.registerReceiver(receiver, filter, broadcastPermission, 77 scheduler, flags); 78 } 79 80 @Override 81 @Nullable registerReceiverForAllUsers(@ullable BroadcastReceiver receiver, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler)82 public Intent registerReceiverForAllUsers(@Nullable BroadcastReceiver receiver, 83 IntentFilter filter, @Nullable String broadcastPermission, 84 @Nullable Handler scheduler) { 85 addReceiver(receiver, "registerReceiverForAllUsers(%s, %s, %s, %s)", 86 receiver, filter, broadcastPermission, scheduler); 87 88 return super.registerReceiverForAllUsers(receiver, filter, broadcastPermission, 89 scheduler); 90 } 91 92 @Override 93 @Nullable registerReceiverForAllUsers(@ullable BroadcastReceiver receiver, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler, int flags)94 public Intent registerReceiverForAllUsers(@Nullable BroadcastReceiver receiver, 95 IntentFilter filter, @Nullable String broadcastPermission, 96 @Nullable Handler scheduler, int flags) { 97 addReceiver(receiver, "registerReceiverForAllUsers(%s, %s, %s, %s, %d)", 98 receiver, filter, broadcastPermission, scheduler, flags); 99 100 return super.registerReceiverForAllUsers(receiver, filter, broadcastPermission, 101 scheduler, flags); 102 } 103 104 @Override registerReceiverAsUser(@ullable BroadcastReceiver receiver, UserHandle user, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler)105 public Intent registerReceiverAsUser(@Nullable BroadcastReceiver receiver, UserHandle user, 106 IntentFilter filter, @Nullable String broadcastPermission, 107 @Nullable Handler scheduler) { 108 addReceiver(receiver, "registerReceiverAsUser(%s, %s, %s, %s, %s)", 109 receiver, user, filter, broadcastPermission, scheduler); 110 111 return super.registerReceiverAsUser(receiver, user, filter, broadcastPermission, 112 scheduler); 113 } 114 115 @Override registerReceiverAsUser(@ullable BroadcastReceiver receiver, UserHandle user, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler, int flags)116 public Intent registerReceiverAsUser(@Nullable BroadcastReceiver receiver, UserHandle user, 117 IntentFilter filter, @Nullable String broadcastPermission, 118 @Nullable Handler scheduler, int flags) { 119 addReceiver(receiver, "registerReceiverAsUser(%s, %s, %s, %s, %s, %d)", 120 receiver, user, filter, broadcastPermission, scheduler, flags); 121 122 return super.registerReceiverAsUser(receiver, user, filter, broadcastPermission, 123 scheduler, flags); 124 } 125 126 @Override unregisterReceiver(BroadcastReceiver receiver)127 public void unregisterReceiver(BroadcastReceiver receiver) { 128 Log.d(TAG, "unregisterReceiver(" + receiver + ") called."); 129 mReceivers.remove(receiver); 130 131 super.unregisterReceiver(receiver); 132 } 133 134 /** 135 * Returns the registration information of currently registered broadcast receivers. 136 * 137 * <p>At the end of each test, make sure this collection is empty to verify all registered 138 * receivers have been unregistered.</p> 139 */ getReceiversInfo()140 public Collection<String> getReceiversInfo() { 141 return mReceivers.values(); 142 } 143 addReceiver(BroadcastReceiver receiver, String methodPattern, Object... args)144 private void addReceiver(BroadcastReceiver receiver, String methodPattern, Object... args) { 145 String info = String.format(methodPattern, args) 146 + String.format(" called by %s", new Throwable().getStackTrace()[2]); 147 Log.d(TAG, info); 148 mReceivers.put(receiver, info); 149 } 150 } 151