Add search index provider for bt page

1. Implement the search index provider for
ConnectedDeviceDashboardFragment.
2. Since in SEARCH_INDEX_DATA_PROVIDER fragment is null,
so we need to pass in context to all components
instead of getting it from fragment.
3. Update test for it as well as creating new shadow.

Change-Id: If0aa67d5b6ca207c6b728c8355581bf414577091
Fixes: 69333961
Test: RunSettingsRoboTests
This commit is contained in:
Lei Yu
2018-03-08 18:04:25 -08:00
parent 048b71a67c
commit 687964cf28
12 changed files with 181 additions and 37 deletions

View File

@@ -17,7 +17,7 @@
<PreferenceScreen <PreferenceScreen
xmlns:android="http://schemas.android.com/apk/res/android" xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:settings="http://schemas.android.com/apk/res-auto" xmlns:settings="http://schemas.android.com/apk/res-auto"
android:key="connected_devices_screen" android:key="connected_devices_advanced_screen"
android:title="@string/connected_device_connections_title"> android:title="@string/connected_device_connections_title">
<SwitchPreference <SwitchPreference

View File

@@ -93,9 +93,9 @@ public abstract class BluetoothDeviceUpdater implements BluetoothCallback {
} }
} }
public BluetoothDeviceUpdater(DashboardFragment fragment, public BluetoothDeviceUpdater(Context context, DashboardFragment fragment,
DevicePreferenceCallback devicePreferenceCallback) { DevicePreferenceCallback devicePreferenceCallback) {
this(fragment, devicePreferenceCallback, Utils.getLocalBtManager(fragment.getContext())); this(fragment, devicePreferenceCallback, Utils.getLocalBtManager(context));
} }
@VisibleForTesting @VisibleForTesting

View File

@@ -17,6 +17,7 @@ package com.android.settings.bluetooth;
import android.bluetooth.BluetoothAdapter; import android.bluetooth.BluetoothAdapter;
import android.bluetooth.BluetoothDevice; import android.bluetooth.BluetoothDevice;
import android.content.Context;
import android.support.annotation.VisibleForTesting; import android.support.annotation.VisibleForTesting;
import com.android.settings.connecteddevice.DevicePreferenceCallback; import com.android.settings.connecteddevice.DevicePreferenceCallback;
@@ -29,9 +30,9 @@ import com.android.settingslib.bluetooth.LocalBluetoothManager;
*/ */
public class ConnectedBluetoothDeviceUpdater extends BluetoothDeviceUpdater { public class ConnectedBluetoothDeviceUpdater extends BluetoothDeviceUpdater {
public ConnectedBluetoothDeviceUpdater(DashboardFragment fragment, public ConnectedBluetoothDeviceUpdater(Context context, DashboardFragment fragment,
DevicePreferenceCallback devicePreferenceCallback) { DevicePreferenceCallback devicePreferenceCallback) {
super(fragment, devicePreferenceCallback); super(context, fragment, devicePreferenceCallback);
} }
@VisibleForTesting @VisibleForTesting

View File

@@ -17,6 +17,7 @@ package com.android.settings.bluetooth;
import android.bluetooth.BluetoothAdapter; import android.bluetooth.BluetoothAdapter;
import android.bluetooth.BluetoothDevice; import android.bluetooth.BluetoothDevice;
import android.content.Context;
import android.support.annotation.VisibleForTesting; import android.support.annotation.VisibleForTesting;
import com.android.settings.connecteddevice.DevicePreferenceCallback; import com.android.settings.connecteddevice.DevicePreferenceCallback;
@@ -29,9 +30,9 @@ import com.android.settingslib.bluetooth.LocalBluetoothManager;
*/ */
public class SavedBluetoothDeviceUpdater extends BluetoothDeviceUpdater { public class SavedBluetoothDeviceUpdater extends BluetoothDeviceUpdater {
public SavedBluetoothDeviceUpdater(DashboardFragment fragment, public SavedBluetoothDeviceUpdater(Context context, DashboardFragment fragment,
DevicePreferenceCallback devicePreferenceCallback) { DevicePreferenceCallback devicePreferenceCallback) {
super(fragment, devicePreferenceCallback); super(context, fragment, devicePreferenceCallback);
} }
@VisibleForTesting @VisibleForTesting

View File

@@ -26,17 +26,22 @@ import com.android.settings.dashboard.DashboardFragment;
import com.android.settings.dashboard.SummaryLoader; import com.android.settings.dashboard.SummaryLoader;
import com.android.settings.nfc.NfcPreferenceController; import com.android.settings.nfc.NfcPreferenceController;
import com.android.settings.search.BaseSearchIndexProvider; import com.android.settings.search.BaseSearchIndexProvider;
import com.android.settings.search.Indexable;
import com.android.settingslib.core.AbstractPreferenceController; import com.android.settingslib.core.AbstractPreferenceController;
import com.android.settingslib.core.lifecycle.Lifecycle; import com.android.settingslib.core.lifecycle.Lifecycle;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays;
import java.util.List; import java.util.List;
public class ConnectedDeviceDashboardFragment extends DashboardFragment { public class ConnectedDeviceDashboardFragment extends DashboardFragment {
private static final String TAG = "ConnectedDeviceFrag"; private static final String TAG = "ConnectedDeviceFrag";
@VisibleForTesting
static final String KEY_CONNECTED_DEVICES = "connected_device_list";
@VisibleForTesting
static final String KEY_SAVED_DEVICES = "saved_device_list";
@Override @Override
public int getMetricsCategory() { public int getMetricsCategory() {
return MetricsProto.MetricsEvent.SETTINGS_CONNECTED_DEVICE_CATEGORY; return MetricsProto.MetricsEvent.SETTINGS_CONNECTED_DEVICE_CATEGORY;
@@ -59,11 +64,14 @@ public class ConnectedDeviceDashboardFragment extends DashboardFragment {
@Override @Override
protected List<AbstractPreferenceController> createPreferenceControllers(Context context) { protected List<AbstractPreferenceController> createPreferenceControllers(Context context) {
final List<AbstractPreferenceController> controllers = new ArrayList<>(); return buildPreferenceControllers(context, getLifecycle(), this);
final Lifecycle lifecycle = getLifecycle(); }
controllers.add(new ConnectedDeviceGroupController(this, lifecycle)); private static List<AbstractPreferenceController> buildPreferenceControllers(Context context,
controllers.add(new SavedDeviceGroupController(this, lifecycle)); Lifecycle lifecycle, DashboardFragment dashboardFragment) {
final List<AbstractPreferenceController> controllers = new ArrayList<>();
controllers.add(new ConnectedDeviceGroupController(context, dashboardFragment, lifecycle));
controllers.add(new SavedDeviceGroupController(context, dashboardFragment, lifecycle));
return controllers; return controllers;
} }
@@ -108,18 +116,30 @@ public class ConnectedDeviceDashboardFragment extends DashboardFragment {
/** /**
* For Search. * For Search.
*/ */
//TODO(b/69333961): update the index for this new fragment public static final SearchIndexProvider SEARCH_INDEX_DATA_PROVIDER =
public static final Indexable.SearchIndexProvider SEARCH_INDEX_DATA_PROVIDER =
new BaseSearchIndexProvider() { new BaseSearchIndexProvider() {
@Override @Override
public List<SearchIndexableResource> getXmlResourcesToIndex( public List<SearchIndexableResource> getXmlResourcesToIndex(
Context context, boolean enabled) { Context context, boolean enabled) {
return new ArrayList<>(); final SearchIndexableResource sir = new SearchIndexableResource(context);
sir.xmlResId = R.xml.connected_devices;
return Arrays.asList(sir);
}
@Override
public List<AbstractPreferenceController> createPreferenceControllers(Context
context) {
return buildPreferenceControllers(context, null /* lifecycle */,
null /* dashboardFragment */);
} }
@Override @Override
public List<String> getNonIndexableKeys(Context context) { public List<String> getNonIndexableKeys(Context context) {
return new ArrayList<>(); List<String> keys = super.getNonIndexableKeys(context);
// Disable because they show dynamic data
keys.add(KEY_CONNECTED_DEVICES);
keys.add(KEY_SAVED_DEVICES);
return keys;
} }
}; };
} }

View File

@@ -16,6 +16,7 @@
package com.android.settings.connecteddevice; package com.android.settings.connecteddevice;
import android.content.pm.PackageManager; import android.content.pm.PackageManager;
import android.content.Context;
import android.support.annotation.VisibleForTesting; import android.support.annotation.VisibleForTesting;
import android.support.v7.preference.Preference; import android.support.v7.preference.Preference;
import android.support.v7.preference.PreferenceGroup; import android.support.v7.preference.PreferenceGroup;
@@ -26,8 +27,6 @@ import com.android.settings.core.BasePreferenceController;
import com.android.settings.core.PreferenceControllerMixin; import com.android.settings.core.PreferenceControllerMixin;
import com.android.settings.bluetooth.BluetoothDeviceUpdater; import com.android.settings.bluetooth.BluetoothDeviceUpdater;
import com.android.settings.bluetooth.ConnectedBluetoothDeviceUpdater; import com.android.settings.bluetooth.ConnectedBluetoothDeviceUpdater;
import com.android.settings.search.ResultPayload;
import com.android.settingslib.core.AbstractPreferenceController;
import com.android.settingslib.core.lifecycle.Lifecycle; import com.android.settingslib.core.lifecycle.Lifecycle;
import com.android.settingslib.core.lifecycle.LifecycleObserver; import com.android.settingslib.core.lifecycle.LifecycleObserver;
import com.android.settings.dashboard.DashboardFragment; import com.android.settings.dashboard.DashboardFragment;
@@ -49,10 +48,11 @@ public class ConnectedDeviceGroupController extends BasePreferenceController
private BluetoothDeviceUpdater mBluetoothDeviceUpdater; private BluetoothDeviceUpdater mBluetoothDeviceUpdater;
private ConnectedUsbDeviceUpdater mConnectedUsbDeviceUpdater; private ConnectedUsbDeviceUpdater mConnectedUsbDeviceUpdater;
public ConnectedDeviceGroupController(DashboardFragment fragment, Lifecycle lifecycle) { public ConnectedDeviceGroupController(Context context, DashboardFragment fragment,
super(fragment.getContext(), KEY); Lifecycle lifecycle) {
init(lifecycle, new ConnectedBluetoothDeviceUpdater(fragment, this), super(context, KEY);
new ConnectedUsbDeviceUpdater(fragment, this)); init(lifecycle, new ConnectedBluetoothDeviceUpdater(context, fragment, this),
new ConnectedUsbDeviceUpdater(context, fragment, this));
} }
@VisibleForTesting @VisibleForTesting

View File

@@ -16,6 +16,7 @@
package com.android.settings.connecteddevice; package com.android.settings.connecteddevice;
import android.content.pm.PackageManager; import android.content.pm.PackageManager;
import android.content.Context;
import android.support.annotation.VisibleForTesting; import android.support.annotation.VisibleForTesting;
import android.support.v7.preference.Preference; import android.support.v7.preference.Preference;
import android.support.v7.preference.PreferenceGroup; import android.support.v7.preference.PreferenceGroup;
@@ -26,7 +27,6 @@ import com.android.settings.bluetooth.SavedBluetoothDeviceUpdater;
import com.android.settings.core.BasePreferenceController; import com.android.settings.core.BasePreferenceController;
import com.android.settings.core.PreferenceControllerMixin; import com.android.settings.core.PreferenceControllerMixin;
import com.android.settings.dashboard.DashboardFragment; import com.android.settings.dashboard.DashboardFragment;
import com.android.settingslib.core.AbstractPreferenceController;
import com.android.settingslib.core.lifecycle.Lifecycle; import com.android.settingslib.core.lifecycle.Lifecycle;
import com.android.settingslib.core.lifecycle.LifecycleObserver; import com.android.settingslib.core.lifecycle.LifecycleObserver;
import com.android.settingslib.core.lifecycle.events.OnStart; import com.android.settingslib.core.lifecycle.events.OnStart;
@@ -46,9 +46,11 @@ public class SavedDeviceGroupController extends BasePreferenceController
PreferenceGroup mPreferenceGroup; PreferenceGroup mPreferenceGroup;
private BluetoothDeviceUpdater mBluetoothDeviceUpdater; private BluetoothDeviceUpdater mBluetoothDeviceUpdater;
public SavedDeviceGroupController(DashboardFragment fragment, Lifecycle lifecycle) { public SavedDeviceGroupController(Context context, DashboardFragment fragment,
super(fragment.getContext(), KEY); Lifecycle lifecycle) {
init(lifecycle, new SavedBluetoothDeviceUpdater(fragment, SavedDeviceGroupController.this)); super(context, KEY);
init(lifecycle, new SavedBluetoothDeviceUpdater(context, fragment,
SavedDeviceGroupController.this));
} }
@VisibleForTesting @VisibleForTesting

View File

@@ -50,18 +50,18 @@ public class ConnectedUsbDeviceUpdater {
} }
}; };
public ConnectedUsbDeviceUpdater(DashboardFragment fragment, public ConnectedUsbDeviceUpdater(Context context, DashboardFragment fragment,
DevicePreferenceCallback devicePreferenceCallback) { DevicePreferenceCallback devicePreferenceCallback) {
this(fragment, devicePreferenceCallback, new UsbBackend(fragment.getContext())); this(context, fragment, devicePreferenceCallback, new UsbBackend(context));
} }
@VisibleForTesting @VisibleForTesting
ConnectedUsbDeviceUpdater(DashboardFragment fragment, ConnectedUsbDeviceUpdater(Context context, DashboardFragment fragment,
DevicePreferenceCallback devicePreferenceCallback, UsbBackend usbBackend) { DevicePreferenceCallback devicePreferenceCallback, UsbBackend usbBackend) {
mFragment = fragment; mFragment = fragment;
mDevicePreferenceCallback = devicePreferenceCallback; mDevicePreferenceCallback = devicePreferenceCallback;
mUsbBackend = usbBackend; mUsbBackend = usbBackend;
mUsbReceiver = new UsbConnectionBroadcastReceiver(fragment.getContext(), mUsbReceiver = new UsbConnectionBroadcastReceiver(context,
mUsbConnectionListener, mUsbBackend); mUsbConnectionListener, mUsbBackend);
} }

View File

@@ -20,8 +20,12 @@ import static com.google.common.truth.Truth.assertThat;
import android.content.Context; import android.content.Context;
import android.provider.SearchIndexableResource; import android.provider.SearchIndexableResource;
import com.android.settings.bluetooth.BluetoothMasterSwitchPreferenceController;
import com.android.settings.testutils.SettingsRobolectricTestRunner; import com.android.settings.testutils.SettingsRobolectricTestRunner;
import com.android.settings.testutils.XmlTestUtils; import com.android.settings.testutils.XmlTestUtils;
import com.android.settings.testutils.shadow.ShadowBluetoothPan;
import com.android.settings.testutils.shadow.ShadowConnectivityManager;
import com.android.settings.testutils.shadow.ShadowUserManager;
import com.android.settingslib.drawer.CategoryKey; import com.android.settingslib.drawer.CategoryKey;
import org.junit.Before; import org.junit.Before;
@@ -29,10 +33,13 @@ import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.runner.RunWith;
import org.mockito.MockitoAnnotations; import org.mockito.MockitoAnnotations;
import org.robolectric.RuntimeEnvironment; import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
import java.util.List; import java.util.List;
@RunWith(SettingsRobolectricTestRunner.class) @RunWith(SettingsRobolectricTestRunner.class)
@Config(shadows = {ShadowBluetoothPan.class, ShadowUserManager.class,
ShadowConnectivityManager.class})
public class AdvancedConnectedDeviceDashboardFragmentTest { public class AdvancedConnectedDeviceDashboardFragmentTest {
private AdvancedConnectedDeviceDashboardFragment mFragment; private AdvancedConnectedDeviceDashboardFragment mFragment;
@@ -67,12 +74,10 @@ public class AdvancedConnectedDeviceDashboardFragmentTest {
@Test @Test
public void testNonIndexableKeys_existInXmlLayout() { public void testNonIndexableKeys_existInXmlLayout() {
final Context context = RuntimeEnvironment.application; final Context context = RuntimeEnvironment.application;
final List<String> niks = ConnectedDeviceDashboardFragment.SEARCH_INDEX_DATA_PROVIDER final List<String> niks =
.getNonIndexableKeys(context); AdvancedConnectedDeviceDashboardFragment.SEARCH_INDEX_DATA_PROVIDER
final int xmlId = new ConnectedDeviceDashboardFragment().getPreferenceScreenResId(); .getNonIndexableKeys(context);
final List<String> keys = XmlTestUtils.getKeysFromPreferenceXml(context, xmlId); assertThat(niks).contains(BluetoothMasterSwitchPreferenceController.KEY_TOGGLE_BLUETOOTH);
assertThat(keys).containsAllIn(niks);
} }
} }

View File

@@ -0,0 +1,82 @@
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.settings.connecteddevice;
import static com.android.settings.connecteddevice.ConnectedDeviceDashboardFragment
.KEY_CONNECTED_DEVICES;
import static com.android.settings.connecteddevice.ConnectedDeviceDashboardFragment
.KEY_SAVED_DEVICES;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
import android.content.Context;
import android.content.pm.PackageManager;
import android.provider.SearchIndexableResource;
import com.android.settings.R;
import com.android.settings.testutils.SettingsRobolectricTestRunner;
import com.android.settings.testutils.shadow.ShadowBluetoothPan;
import com.android.settings.testutils.shadow.ShadowConnectivityManager;
import com.android.settings.testutils.shadow.ShadowUserManager;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
import java.util.List;
@RunWith(SettingsRobolectricTestRunner.class)
@Config(shadows = {ShadowBluetoothPan.class, ShadowUserManager.class,
ShadowConnectivityManager.class})
public class ConnectedDeviceDashboardFragmentTest {
@Mock
private PackageManager mPackageManager;
private Context mContext;
@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
mContext = spy(RuntimeEnvironment.application);
doReturn(mPackageManager).when(mContext).getPackageManager();
doReturn(true).when(mPackageManager).hasSystemFeature(PackageManager.FEATURE_BLUETOOTH);
}
@Test
public void testSearchIndexProvider_shouldIndexResource() {
final List<SearchIndexableResource> indexRes =
ConnectedDeviceDashboardFragment.SEARCH_INDEX_DATA_PROVIDER
.getXmlResourcesToIndex(mContext, true /* enabled */);
assertThat(indexRes).isNotNull();
assertThat(indexRes.get(0).xmlResId).isEqualTo(R.xml.connected_devices);
}
@Test
public void testNonIndexableKeys_existInXmlLayout() {
final List<String> niks = ConnectedDeviceDashboardFragment.SEARCH_INDEX_DATA_PROVIDER
.getNonIndexableKeys(mContext);
assertThat(niks).containsExactly(KEY_CONNECTED_DEVICES, KEY_SAVED_DEVICES);
}
}

View File

@@ -58,7 +58,8 @@ public class ConnectedUsbDeviceUpdaterTest {
mContext = RuntimeEnvironment.application; mContext = RuntimeEnvironment.application;
when(mFragment.getContext()).thenReturn(mContext); when(mFragment.getContext()).thenReturn(mContext);
mDeviceUpdater = mDeviceUpdater =
new ConnectedUsbDeviceUpdater(mFragment, mDevicePreferenceCallback, mUsbBackend); new ConnectedUsbDeviceUpdater(mContext, mFragment, mDevicePreferenceCallback,
mUsbBackend);
mDeviceUpdater.mUsbReceiver = mUsbReceiver; mDeviceUpdater.mUsbReceiver = mUsbReceiver;
} }

View File

@@ -0,0 +1,32 @@
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.settings.testutils.shadow;
import android.bluetooth.BluetoothPan;
import android.bluetooth.BluetoothProfile;
import android.content.Context;
import org.robolectric.annotation.Implementation;
import org.robolectric.annotation.Implements;
@Implements(BluetoothPan.class)
public class ShadowBluetoothPan {
@Implementation
public void __constructor__(Context context, BluetoothProfile.ServiceListener l) {
// Do nothing, implement it to avoid null pointer error inside BluetoothPan
}
}