Align with Bluetooth metadata API changes

* Align with the changes of Bluetooth metadata APIs.
* Move metadata utils from Settings to SettingsLib.

Bug: 124448651
Test: make RunSettingsRoboTests
Change-Id: Ic9ad91536ef3ff6807a08bbffa3dd796ef1ad523
This commit is contained in:
Ugo Yu
2019-03-05 16:43:08 +08:00
parent dc4f7ce282
commit 9f11ccf319
8 changed files with 64 additions and 131 deletions

View File

@@ -39,6 +39,7 @@ import androidx.preference.PreferenceScreen;
import com.android.settings.R; import com.android.settings.R;
import com.android.settings.core.BasePreferenceController; import com.android.settings.core.BasePreferenceController;
import com.android.settings.fuelgauge.BatteryMeterView; import com.android.settings.fuelgauge.BatteryMeterView;
import com.android.settingslib.bluetooth.BluetoothUtils;
import com.android.settingslib.bluetooth.CachedBluetoothDevice; import com.android.settingslib.bluetooth.CachedBluetoothDevice;
import com.android.settingslib.core.lifecycle.LifecycleObserver; import com.android.settingslib.core.lifecycle.LifecycleObserver;
import com.android.settingslib.core.lifecycle.events.OnDestroy; import com.android.settingslib.core.lifecycle.events.OnDestroy;
@@ -69,13 +70,12 @@ public class AdvancedBluetoothDetailsHeaderController extends BasePreferenceCont
@VisibleForTesting @VisibleForTesting
Handler mHandler = new Handler(Looper.getMainLooper()); Handler mHandler = new Handler(Looper.getMainLooper());
@VisibleForTesting @VisibleForTesting
final BluetoothAdapter.MetadataListener mMetadataListener = final BluetoothAdapter.OnMetadataChangedListener mMetadataListener =
new BluetoothAdapter.MetadataListener() { new BluetoothAdapter.OnMetadataChangedListener() {
@Override @Override
public void onMetadataChanged(BluetoothDevice device, int key, String value) { public void onMetadataChanged(BluetoothDevice device, int key, byte[] value) {
super.onMetadataChanged(device, key, value);
Log.i(TAG, String.format("Metadata updated in Device %s: %d = %s.", device, key, Log.i(TAG, String.format("Metadata updated in Device %s: %d = %s.", device, key,
value)); value == null ? null : new String(value)));
refresh(); refresh();
} }
}; };
@@ -88,9 +88,9 @@ public class AdvancedBluetoothDetailsHeaderController extends BasePreferenceCont
@Override @Override
public int getAvailabilityStatus() { public int getAvailabilityStatus() {
final boolean unthetheredHeadset = Utils.getBooleanMetaData(mCachedDevice.getDevice(), final boolean untetheredHeadset = BluetoothUtils.getBooleanMetaData(
BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET); mCachedDevice.getDevice(), BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET);
return unthetheredHeadset ? AVAILABLE : CONDITIONALLY_UNAVAILABLE; return untetheredHeadset ? AVAILABLE : CONDITIONALLY_UNAVAILABLE;
} }
@Override @Override
@@ -108,8 +108,8 @@ public class AdvancedBluetoothDetailsHeaderController extends BasePreferenceCont
return; return;
} }
mCachedDevice.registerCallback(this::onDeviceAttributesChanged); mCachedDevice.registerCallback(this::onDeviceAttributesChanged);
mBluetoothAdapter.registerMetadataListener(mCachedDevice.getDevice(), mMetadataListener, mBluetoothAdapter.addOnMetadataChangedListener(mCachedDevice.getDevice(),
mHandler); mContext.getMainExecutor(), mMetadataListener);
} }
@Override @Override
@@ -118,7 +118,8 @@ public class AdvancedBluetoothDetailsHeaderController extends BasePreferenceCont
return; return;
} }
mCachedDevice.unregisterCallback(this::onDeviceAttributesChanged); mCachedDevice.unregisterCallback(this::onDeviceAttributesChanged);
mBluetoothAdapter.unregisterMetadataListener(mCachedDevice.getDevice()); mBluetoothAdapter.removeOnMetadataChangedListener(mCachedDevice.getDevice(),
mMetadataListener);
} }
@Override @Override
@@ -154,21 +155,21 @@ public class AdvancedBluetoothDetailsHeaderController extends BasePreferenceCont
} }
updateSubLayout(mLayoutPreference.findViewById(R.id.layout_left), updateSubLayout(mLayoutPreference.findViewById(R.id.layout_left),
BluetoothDevice.METADATA_UNTHETHERED_LEFT_ICON, BluetoothDevice.METADATA_UNTETHERED_LEFT_ICON,
BluetoothDevice.METADATA_UNTHETHERED_LEFT_BATTERY, BluetoothDevice.METADATA_UNTETHERED_LEFT_BATTERY,
BluetoothDevice.METADATA_UNTHETHERED_LEFT_CHARGING, BluetoothDevice.METADATA_UNTETHERED_LEFT_CHARGING,
R.string.bluetooth_left_name); R.string.bluetooth_left_name);
updateSubLayout(mLayoutPreference.findViewById(R.id.layout_middle), updateSubLayout(mLayoutPreference.findViewById(R.id.layout_middle),
BluetoothDevice.METADATA_UNTHETHERED_CASE_ICON, BluetoothDevice.METADATA_UNTETHERED_CASE_ICON,
BluetoothDevice.METADATA_UNTHETHERED_CASE_BATTERY, BluetoothDevice.METADATA_UNTETHERED_CASE_BATTERY,
BluetoothDevice.METADATA_UNTHETHERED_CASE_CHARGING, BluetoothDevice.METADATA_UNTETHERED_CASE_CHARGING,
R.string.bluetooth_middle_name); R.string.bluetooth_middle_name);
updateSubLayout(mLayoutPreference.findViewById(R.id.layout_right), updateSubLayout(mLayoutPreference.findViewById(R.id.layout_right),
BluetoothDevice.METADATA_UNTHETHERED_RIGHT_ICON, BluetoothDevice.METADATA_UNTETHERED_RIGHT_ICON,
BluetoothDevice.METADATA_UNTHETHERED_RIGHT_BATTERY, BluetoothDevice.METADATA_UNTETHERED_RIGHT_BATTERY,
BluetoothDevice.METADATA_UNTHETHERED_RIGHT_CHARGING, BluetoothDevice.METADATA_UNTETHERED_RIGHT_CHARGING,
R.string.bluetooth_right_name); R.string.bluetooth_right_name);
} }
} }
@@ -194,15 +195,15 @@ public class AdvancedBluetoothDetailsHeaderController extends BasePreferenceCont
return; return;
} }
final BluetoothDevice bluetoothDevice = mCachedDevice.getDevice(); final BluetoothDevice bluetoothDevice = mCachedDevice.getDevice();
final String iconUri = Utils.getStringMetaData(bluetoothDevice, iconMetaKey); final String iconUri = BluetoothUtils.getStringMetaData(bluetoothDevice, iconMetaKey);
if (iconUri != null) { if (iconUri != null) {
final ImageView imageView = linearLayout.findViewById(R.id.header_icon); final ImageView imageView = linearLayout.findViewById(R.id.header_icon);
updateIcon(imageView, iconUri); updateIcon(imageView, iconUri);
} }
final int batteryLevel = Utils.getIntMetaData(bluetoothDevice, batteryMetaKey); final int batteryLevel = BluetoothUtils.getIntMetaData(bluetoothDevice, batteryMetaKey);
final boolean charging = Utils.getBooleanMetaData(bluetoothDevice, chargeMetaKey); final boolean charging = BluetoothUtils.getBooleanMetaData(bluetoothDevice, chargeMetaKey);
if (batteryLevel != Utils.META_INT_ERROR) { if (batteryLevel != BluetoothUtils.META_INT_ERROR) {
linearLayout.setVisibility(View.VISIBLE); linearLayout.setVisibility(View.VISIBLE);
final ImageView imageView = linearLayout.findViewById(R.id.bt_battery_icon); final ImageView imageView = linearLayout.findViewById(R.id.bt_battery_icon);
imageView.setImageDrawable(createBtBatteryIcon(mContext, batteryLevel, charging)); imageView.setImageDrawable(createBtBatteryIcon(mContext, batteryLevel, charging));
@@ -233,7 +234,7 @@ public class AdvancedBluetoothDetailsHeaderController extends BasePreferenceCont
// Only show bluetooth icon // Only show bluetooth icon
final BluetoothDevice bluetoothDevice = mCachedDevice.getDevice(); final BluetoothDevice bluetoothDevice = mCachedDevice.getDevice();
final String iconUri = Utils.getStringMetaData(bluetoothDevice, final String iconUri = BluetoothUtils.getStringMetaData(bluetoothDevice,
BluetoothDevice.METADATA_MAIN_ICON); BluetoothDevice.METADATA_MAIN_ICON);
if (iconUri != null) { if (iconUri != null) {
final ImageView imageView = linearLayout.findViewById(R.id.header_icon); final ImageView imageView = linearLayout.findViewById(R.id.header_icon);

View File

@@ -53,8 +53,8 @@ public class BluetoothDetailsHeaderController extends BluetoothDetailsController
@Override @Override
public boolean isAvailable() { public boolean isAvailable() {
return !Utils.getBooleanMetaData(mCachedDevice.getDevice(), return !BluetoothUtils.getBooleanMetaData(mCachedDevice.getDevice(),
BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET); BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET);
} }
@Override @Override

View File

@@ -33,8 +33,8 @@ public class BluetoothFeatureProviderImpl implements BluetoothFeatureProvider {
@Override @Override
public Uri getBluetoothDeviceSettingsUri(BluetoothDevice bluetoothDevice) { public Uri getBluetoothDeviceSettingsUri(BluetoothDevice bluetoothDevice) {
final String uriString = bluetoothDevice.getMetadata( final byte[] uriByte = bluetoothDevice.getMetadata(
BluetoothDevice.METADATA_ENHANCED_SETTINGS_UI_URI); BluetoothDevice.METADATA_ENHANCED_SETTINGS_UI_URI);
return uriString != null ? Uri.parse(uriString) : null; return uriByte == null ? null : Uri.parse(new String(uriByte));
} }
} }

View File

@@ -47,8 +47,6 @@ public final class Utils {
static final boolean V = BluetoothUtils.V; // verbose logging static final boolean V = BluetoothUtils.V; // verbose logging
static final boolean D = BluetoothUtils.D; // regular logging static final boolean D = BluetoothUtils.D; // regular logging
public static final int META_INT_ERROR = -1;
private Utils() { private Utils() {
} }
@@ -154,30 +152,4 @@ public final class Utils {
return Settings.Global.getInt(context.getContentResolver(), return Settings.Global.getInt(context.getContentResolver(),
Settings.Global.BLE_SCAN_ALWAYS_AVAILABLE, 0) == 1; Settings.Global.BLE_SCAN_ALWAYS_AVAILABLE, 0) == 1;
} }
public static boolean getBooleanMetaData(BluetoothDevice bluetoothDevice, int key) {
if (bluetoothDevice == null) {
return false;
}
return Boolean.parseBoolean(bluetoothDevice.getMetadata(key));
}
public static String getStringMetaData(BluetoothDevice bluetoothDevice, int key) {
if (bluetoothDevice == null) {
return null;
}
return bluetoothDevice.getMetadata(key);
}
public static int getIntMetaData(BluetoothDevice bluetoothDevice, int key) {
if (bluetoothDevice == null) {
return META_INT_ERROR;
}
try {
return Integer.parseInt(bluetoothDevice.getMetadata(key));
} catch (NumberFormatException e) {
return META_INT_ERROR;
}
}
} }

View File

@@ -104,14 +104,14 @@ public class AdvancedBluetoothDetailsHeaderControllerTest{
@Test @Test
public void refresh_connected_updateCorrectInfo() { public void refresh_connected_updateCorrectInfo() {
when(mBluetoothDevice.getMetadata( when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_UNTHETHERED_LEFT_BATTERY)).thenReturn( BluetoothDevice.METADATA_UNTETHERED_LEFT_BATTERY)).thenReturn(
String.valueOf(BATTERY_LEVEL_LEFT)); String.valueOf(BATTERY_LEVEL_LEFT).getBytes());
when(mBluetoothDevice.getMetadata( when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_UNTHETHERED_RIGHT_BATTERY)).thenReturn( BluetoothDevice.METADATA_UNTETHERED_RIGHT_BATTERY)).thenReturn(
String.valueOf(BATTERY_LEVEL_RIGHT)); String.valueOf(BATTERY_LEVEL_RIGHT).getBytes());
when(mBluetoothDevice.getMetadata( when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_UNTHETHERED_CASE_BATTERY)).thenReturn( BluetoothDevice.METADATA_UNTETHERED_CASE_BATTERY)).thenReturn(
String.valueOf(BATTERY_LEVEL_MAIN)); String.valueOf(BATTERY_LEVEL_MAIN).getBytes());
when(mCachedDevice.isConnected()).thenReturn(true); when(mCachedDevice.isConnected()).thenReturn(true);
mController.refresh(); mController.refresh();
@@ -141,18 +141,18 @@ public class AdvancedBluetoothDetailsHeaderControllerTest{
} }
@Test @Test
public void getAvailabilityStatus_unthetheredHeadset_returnAvailable() { public void getAvailabilityStatus_untetheredHeadset_returnAvailable() {
when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)) when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET))
.thenReturn("true"); .thenReturn("true".getBytes());
assertThat(mController.getAvailabilityStatus()).isEqualTo( assertThat(mController.getAvailabilityStatus()).isEqualTo(
BasePreferenceController.AVAILABLE); BasePreferenceController.AVAILABLE);
} }
@Test @Test
public void getAvailabilityStatus_notUnthetheredHeadset_returnUnavailable() { public void getAvailabilityStatus_notUntetheredHeadset_returnUnavailable() {
when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)) when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET))
.thenReturn("false"); .thenReturn("false".getBytes());
assertThat(mController.getAvailabilityStatus()).isEqualTo( assertThat(mController.getAvailabilityStatus()).isEqualTo(
BasePreferenceController.CONDITIONALLY_UNAVAILABLE); BasePreferenceController.CONDITIONALLY_UNAVAILABLE);
@@ -169,50 +169,52 @@ public class AdvancedBluetoothDetailsHeaderControllerTest{
@Test @Test
public void onStart_isAvailable_registerCallback() { public void onStart_isAvailable_registerCallback() {
when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)) when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET))
.thenReturn("true"); .thenReturn("true".getBytes());
mController.onStart(); mController.onStart();
verify(mBluetoothAdapter).registerMetadataListener(mBluetoothDevice, verify(mBluetoothAdapter).addOnMetadataChangedListener(mBluetoothDevice,
mController.mMetadataListener, mController.mHandler); mContext.getMainExecutor() ,mController.mMetadataListener);
} }
@Test @Test
public void onStop_isAvailable_unregisterCallback() { public void onStop_isAvailable_unregisterCallback() {
when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)) when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET))
.thenReturn("true"); .thenReturn("true".getBytes());
mController.onStop(); mController.onStop();
verify(mBluetoothAdapter).unregisterMetadataListener(mBluetoothDevice); verify(mBluetoothAdapter).removeOnMetadataChangedListener(mBluetoothDevice,
mController.mMetadataListener);
} }
@Test @Test
public void onStart_notAvailable_registerCallback() { public void onStart_notAvailable_registerCallback() {
when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)) when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET))
.thenReturn("false"); .thenReturn("false".getBytes());
mController.onStart(); mController.onStart();
verify(mBluetoothAdapter, never()).registerMetadataListener(mBluetoothDevice, verify(mBluetoothAdapter, never()).addOnMetadataChangedListener(mBluetoothDevice,
mController.mMetadataListener, mController.mHandler); mContext.getMainExecutor() ,mController.mMetadataListener);
} }
@Test @Test
public void onStop_notAvailable_unregisterCallback() { public void onStop_notAvailable_unregisterCallback() {
when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)) when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET))
.thenReturn("false"); .thenReturn("false".getBytes());
mController.onStop(); mController.onStop();
verify(mBluetoothAdapter, never()).unregisterMetadataListener(mBluetoothDevice); verify(mBluetoothAdapter, never()).removeOnMetadataChangedListener(mBluetoothDevice,
mController.mMetadataListener);
} }
@Test @Test
public void onDestroy_isAvailable_recycleBitmap() { public void onDestroy_isAvailable_recycleBitmap() {
when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)) when(mBluetoothDevice.getMetadata(BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET))
.thenReturn("true"); .thenReturn("true".getBytes());
mController.mIconCache.put(ICON_URI, mBitmap); mController.mIconCache.put(ICON_URI, mBitmap);
mController.onDestroy(); mController.onDestroy();

View File

@@ -123,9 +123,9 @@ public class BluetoothDetailsHeaderControllerTest extends BluetoothDetailsContro
} }
@Test @Test
public void isAvailable_unthetheredHeadset_returnFalse() { public void isAvailable_untetheredHeadset_returnFalse() {
when(mBluetoothDevice.getMetadata( when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)).thenReturn("true"); BluetoothDevice.METADATA_IS_UNTETHERED_HEADSET)).thenReturn("true".getBytes());
assertThat(mController.isAvailable()).isFalse(); assertThat(mController.isAvailable()).isFalse();
} }

View File

@@ -49,7 +49,8 @@ public class BluetoothFeatureProviderImplTest {
@Test @Test
public void getBluetoothDeviceSettingsUri_containCorrectMacAddress() { public void getBluetoothDeviceSettingsUri_containCorrectMacAddress() {
when(mBluetoothDevice.getMetadata( when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_ENHANCED_SETTINGS_UI_URI)).thenReturn(SETTINGS_URI); BluetoothDevice.METADATA_ENHANCED_SETTINGS_UI_URI)).thenReturn(
SETTINGS_URI.getBytes());
final Uri uri = mBluetoothFeatureProvider.getBluetoothDeviceSettingsUri(mBluetoothDevice); final Uri uri = mBluetoothFeatureProvider.getBluetoothDeviceSettingsUri(mBluetoothDevice);
assertThat(uri.toString()).isEqualTo(SETTINGS_URI); assertThat(uri.toString()).isEqualTo(SETTINGS_URI);
} }

View File

@@ -43,14 +43,8 @@ import org.robolectric.RobolectricTestRunner;
@RunWith(RobolectricTestRunner.class) @RunWith(RobolectricTestRunner.class)
public class UtilsTest { public class UtilsTest {
private static final String STRING_METADATA = "string_metadata";
private static final String BOOL_METADATA = "true";
private static final String INT_METADATA = "25";
@Mock(answer = Answers.RETURNS_DEEP_STUBS) @Mock(answer = Answers.RETURNS_DEEP_STUBS)
private Context mContext; private Context mContext;
@Mock
private BluetoothDevice mBluetoothDevice;
private MetricsFeatureProvider mMetricsFeatureProvider; private MetricsFeatureProvider mMetricsFeatureProvider;
@@ -69,41 +63,4 @@ public class UtilsTest {
verify(mMetricsFeatureProvider).visible(eq(mContext), anyInt(), verify(mMetricsFeatureProvider).visible(eq(mContext), anyInt(),
eq(MetricsEvent.ACTION_SETTINGS_BLUETOOTH_CONNECT_ERROR)); eq(MetricsEvent.ACTION_SETTINGS_BLUETOOTH_CONNECT_ERROR));
} }
@Test
public void getStringMetaData_hasMetaData_getCorrectMetaData() {
when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_UNTHETHERED_LEFT_ICON)).thenReturn(STRING_METADATA);
assertThat(Utils.getStringMetaData(mBluetoothDevice,
BluetoothDevice.METADATA_UNTHETHERED_LEFT_ICON)).isEqualTo(STRING_METADATA);
}
@Test
public void getIntMetaData_hasMetaData_getCorrectMetaData() {
when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_UNTHETHERED_LEFT_BATTERY)).thenReturn(INT_METADATA);
assertThat(Utils.getIntMetaData(mBluetoothDevice,
BluetoothDevice.METADATA_UNTHETHERED_LEFT_BATTERY))
.isEqualTo(Integer.parseInt(INT_METADATA));
}
@Test
public void getIntMetaData_invalidMetaData_getErrorCode() {
when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_UNTHETHERED_LEFT_BATTERY)).thenReturn(STRING_METADATA);
assertThat(Utils.getIntMetaData(mBluetoothDevice,
BluetoothDevice.METADATA_UNTHETHERED_LEFT_ICON)).isEqualTo(Utils.META_INT_ERROR);
}
@Test
public void getBooleanMetaData_hasMetaData_getCorrectMetaData() {
when(mBluetoothDevice.getMetadata(
BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)).thenReturn(BOOL_METADATA);
assertThat(Utils.getBooleanMetaData(mBluetoothDevice,
BluetoothDevice.METADATA_IS_UNTHETHERED_HEADSET)).isEqualTo(true);
}
} }