PawletOS/app_Settings
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Index Data to build Slices in Settings

Browse Source 
The indexing is done by taking the indexable fragments from
search, grabbing their XML via SearchIndexableResources, and
then looking for controllers defined in preferences.

For each controller found, we take the combination of the
fragment providing the XML and the Preference info to create
an indexable row.

Buiding a Slice will be handled in a subsquent CL, but a
prototype can be found here: ag/3324435

Test: robotests
Bug: 67996923
Change-Id: I48668618079bcc3da55ab77b7323ee8e467073af
This commit is contained in:
Matthew Fritze
2017-12-12 16:03:22 -08:00
parent ce2b7fe988
commit 13c43f1900
18 changed files with 882 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
tests/robotests/src/com/android/settings/search/FakeIndexProvider.java
View File

@@ -20,8 +20,10 @@ package com.android.settings.search;
import android.content.Context;
import android.provider.SearchIndexableResource;
import com.android.settings.R;
import com.android.settingslib.core.AbstractPreferenceController;
import java.util.ArrayList;
import java.util.List;
public class FakeIndexProvider implements Indexable {
@@ -33,7 +35,11 @@ public class FakeIndexProvider implements Indexable {
@Override
public List<SearchIndexableResource> getXmlResourcesToIndex(Context context,
boolean enabled) {
return null;
List<SearchIndexableResource> resources = new ArrayList<>();
SearchIndexableResource res = new SearchIndexableResource(context);
res.xmlResId = R.xml.location_settings;
resources.add(res);
return resources;
}
@Override
@@ -44,7 +50,8 @@ public class FakeIndexProvider implements Indexable {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> getPreferenceControllers(
Context context) {
return null;
}
};

33
tests/robotests/src/com/android/settings/slices/FakePreferenceController.java Normal file
View File

@@ -0,0 +1,33 @@
/*
* Copyright (C) 2017 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.slices;
import android.content.Context;
import com.android.settings.core.BasePreferenceController;
public class FakePreferenceController extends BasePreferenceController {
public FakePreferenceController(Context context, String preferenceKey) {
super(context, preferenceKey);
}
@Override
public int getAvailabilityStatus() {
return AVAILABLE;
}
}

89
tests/robotests/src/com/android/settings/slices/SliceDataConverterTest.java Normal file
View File

@@ -0,0 +1,89 @@
/*
* Copyright (C) 2017 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.slices;
import static com.google.common.truth.Truth.assertThat;
import android.content.Context;
import com.android.settings.TestConfig;
import com.android.settings.search.FakeIndexProvider;
import com.android.settings.search.SearchIndexableResources;
import com.android.settings.testutils.SettingsRobolectricTestRunner;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
@RunWith(SettingsRobolectricTestRunner.class)
@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
public class SliceDataConverterTest {
private final String fakeKey = "key";
private final String fakeTitle = "title";
private final String fakeSummary = "summary";
private final String fakeScreenTitle = "screen_title";
private final String fakeFragmentClassName = FakeIndexProvider.class.getName();
private final String fakeControllerName = FakePreferenceController.class.getName();
Context mContext;
private Set<Class> mProviderClassesCopy;
SliceDataConverter mSliceDataConverter;
@Before
public void setUp() {
mContext = RuntimeEnvironment.application;
mProviderClassesCopy = new HashSet<>(SearchIndexableResources.providerValues());
mSliceDataConverter = new SliceDataConverter(mContext);
}
@After
public void cleanUp() {
SearchIndexableResources.providerValues().clear();
SearchIndexableResources.providerValues().addAll(mProviderClassesCopy);
}
@Test
@Config(qualifiers = "mcc999")
public void testFakeProvider_convertsFakeData() {
SearchIndexableResources.providerValues().clear();
SearchIndexableResources.providerValues().add(FakeIndexProvider.class);
List<SliceData> sliceDataList = mSliceDataConverter.getSliceData();
assertThat(sliceDataList).hasSize(1);
SliceData fakeSlice = sliceDataList.get(0);
assertThat(fakeSlice.getKey()).isEqualTo(fakeKey);
assertThat(fakeSlice.getTitle()).isEqualTo(fakeTitle);
assertThat(fakeSlice.getSummary()).isEqualTo(fakeSummary);
assertThat(fakeSlice.getScreenTitle()).isEqualTo(fakeScreenTitle);
assertThat(fakeSlice.getIconResource()).isNotNull();
assertThat(fakeSlice.getUri()).isNull();
assertThat(fakeSlice.getFragmentClassName()).isEqualTo(fakeFragmentClassName);
assertThat(fakeSlice.getPreferenceController()).isEqualTo(fakeControllerName);
}
}

37
tests/robotests/src/com/android/settings/slices/SliceDataTest.java
View File

@@ -104,19 +104,6 @@ public class SliceDataTest {
.build();
}
@Test(expected = IllegalStateException.class)
public void testBuilder_noUri_throwsIllegalStateException() {
new SliceData.Builder()
.setKey(KEY)
.setTitle(TITLE)
.setSummary(SUMMARY)
.setScreenTitle(SCREEN_TITLE)
.setIcon(ICON)
.setFragmentName(FRAGMENT_NAME)
.setPreferenceControllerClassName(PREF_CONTROLLER)
.build();
}
@Test(expected = IllegalStateException.class)
public void testBuilder_noPrefController_throwsIllegalStateException() {
new SliceData.Builder()
@@ -199,6 +186,30 @@ public class SliceDataTest {
assertThat(data.getPreferenceController()).isEqualTo(PREF_CONTROLLER);
}
@Test
public void testBuilder_noUri_buildsMatchingObject() {
SliceData.Builder builder = new SliceData.Builder()
.setKey(KEY)
.setTitle(TITLE)
.setSummary(SUMMARY)
.setScreenTitle(SCREEN_TITLE)
.setIcon(ICON)
.setFragmentName(FRAGMENT_NAME)
.setUri(null)
.setPreferenceControllerClassName(PREF_CONTROLLER);
SliceData data = builder.build();
assertThat(data.getKey()).isEqualTo(KEY);
assertThat(data.getTitle()).isEqualTo(TITLE);
assertThat(data.getSummary()).isEqualTo(SUMMARY);
assertThat(data.getScreenTitle()).isEqualTo(SCREEN_TITLE);
assertThat(data.getIconResource()).isEqualTo(ICON);
assertThat(data.getFragmentClassName()).isEqualTo(FRAGMENT_NAME);
assertThat(data.getUri()).isNull();
assertThat(data.getPreferenceController()).isEqualTo(PREF_CONTROLLER);
}
@Test
public void testEquality_identicalObjects() {
SliceData.Builder builder = new SliceData.Builder()

60
tests/robotests/src/com/android/settings/slices/SlicesDatabaseHelperTest.java
View File

@@ -1,7 +1,26 @@
/*
* Copyright (C) 2017 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.slices;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
import android.content.ContentValues;
import android.content.Context;
import android.database.Cursor;
@@ -19,6 +38,8 @@ import org.junit.runner.RunWith;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
import java.util.Locale;
@RunWith(SettingsRobolectricTestRunner.class)
@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
public class SlicesDatabaseHelperTest {
@@ -30,7 +51,7 @@ public class SlicesDatabaseHelperTest {
@Before
public void setUp() {
mContext = RuntimeEnvironment.application;
mSlicesDatabaseHelper = new SlicesDatabaseHelper(mContext);
mSlicesDatabaseHelper = spy(SlicesDatabaseHelper.getInstance(mContext));
mDatabase = mSlicesDatabaseHelper.getWritableDatabase();
}
@@ -47,7 +68,7 @@ public class SlicesDatabaseHelperTest {
String[] expectedNames = new String[]{
IndexColumns.KEY,
IndexColumns.TITLE,
IndexColumns.SUBTITLE,
IndexColumns.SUMMARY,
IndexColumns.SCREENTITLE,
IndexColumns.ICON_RESOURCE,
IndexColumns.FRAGMENT,
@@ -71,17 +92,48 @@ public class SlicesDatabaseHelperTest {
assertThat(newCursor.getCount()).isEqualTo(0);
}
@Test
public void testIndexState_buildAndLocaleSet() {
mSlicesDatabaseHelper.reconstruct(mDatabase);
boolean baseState = mSlicesDatabaseHelper.isSliceDataIndexed();
assertThat(baseState).isFalse();
mSlicesDatabaseHelper.setIndexedState();
boolean indexedState = mSlicesDatabaseHelper.isSliceDataIndexed();
assertThat(indexedState).isTrue();
}
@Test
public void testLocaleChanges_newIndexingState() {
mSlicesDatabaseHelper.reconstruct(mDatabase);
mSlicesDatabaseHelper.setIndexedState();
Locale.setDefault(new Locale("ca"));
assertThat(mSlicesDatabaseHelper.isSliceDataIndexed()).isFalse();
}
@Test
public void testBuildFingerprintChanges_newIndexingState() {
mSlicesDatabaseHelper.reconstruct(mDatabase);
mSlicesDatabaseHelper.setIndexedState();
doReturn("newBuild").when(mSlicesDatabaseHelper).getBuildTag();
assertThat(mSlicesDatabaseHelper.isSliceDataIndexed()).isFalse();
}
private ContentValues getDummyRow() {
ContentValues values;
values = new ContentValues();
values.put(IndexColumns.KEY, "key");
values.put(IndexColumns.TITLE, "title");
values.put(IndexColumns.SUBTITLE, "subtitle");
values.put(IndexColumns.SUMMARY, "summary");
values.put(IndexColumns.ICON_RESOURCE, 99);
values.put(IndexColumns.FRAGMENT, "fragmentClassName");
values.put(IndexColumns.CONTROLLER, "preferenceController");
return values;
}
}
}

152
tests/robotests/src/com/android/settings/slices/SlicesIndexerTest.java Normal file
View File

@@ -0,0 +1,152 @@
/*
* Copyright (C) 2017 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.slices;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
import android.content.ContentValues;
import android.content.Context;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.net.Uri;
import com.android.settings.TestConfig;
import com.android.settings.slices.SlicesDatabaseHelper.IndexColumns;
import com.android.settings.testutils.DatabaseTestUtils;
import com.android.settings.testutils.SettingsRobolectricTestRunner;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
@RunWith(SettingsRobolectricTestRunner.class)
@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
public class SlicesIndexerTest {
private final String[] KEYS = new String[]{"key1", "key2", "key3"};
private final String[] TITLES = new String[]{"title1", "title2", "title3"};
private final String SUMMARY = "subtitle";
private final String SCREEN_TITLE = "screen title";
private final String FRAGMENT_NAME = "fragment name";
private final int ICON = 1234; // I declare a thumb war
private final Uri URI = Uri.parse("content://com.android.settings.slices/test");
private final String PREF_CONTROLLER = "com.android.settings.slices.tester";
private Context mContext;
private SlicesIndexer mManager;
private SQLiteDatabase mDb;
@Before
public void setUp() {
mContext = RuntimeEnvironment.application;
mManager = spy(new SlicesIndexer(mContext));
mDb = SlicesDatabaseHelper.getInstance(mContext).getWritableDatabase();
}
@After
public void cleanUp() {
DatabaseTestUtils.clearDb(mContext);
}
@Test
public void testAlreadyIndexed_doesNotIndexAgain() {
String newKey = "newKey";
String newTitle = "newTitle";
SlicesDatabaseHelper.getInstance(mContext).setIndexedState();
Locale.setDefault(new Locale("ca"));
insertSpecialCase(newKey, newTitle);
// Attempt indexing - should not do anything.
mManager.run();
Cursor cursor = mDb.rawQuery("SELECT * FROM slices_index", null);
cursor.moveToFirst();
assertThat(cursor.getCount()).isEqualTo(1);
assertThat(cursor.getString(cursor.getColumnIndex(IndexColumns.KEY))).isEqualTo(newKey);
assertThat(cursor.getString(cursor.getColumnIndex(IndexColumns.TITLE))).isEqualTo(newTitle);
}
@Test
public void testInsertSliceData_indexedStateSet() {
SlicesDatabaseHelper helper = SlicesDatabaseHelper.getInstance(mContext);
helper.setIndexedState();
doReturn(new ArrayList<SliceData>()).when(mManager).getSliceData();
mManager.run();
assertThat(helper.isSliceDataIndexed()).isTrue();
}
@Test
public void testInsertSliceData_mockDataInserted() {
List<SliceData> sliceData = getDummyIndexableData();
doReturn(sliceData).when(mManager).getSliceData();
mManager.run();
Cursor cursor = mDb.rawQuery("SELECT * FROM slices_index", null);
assertThat(cursor.getCount()).isEqualTo(sliceData.size());
cursor.moveToFirst();
for (int i = 0; i < sliceData.size(); i++) {
assertThat(cursor.getString(cursor.getColumnIndex(IndexColumns.KEY))).isEqualTo(
KEYS[i]);
assertThat(cursor.getString(cursor.getColumnIndex(IndexColumns.TITLE))).isEqualTo(
TITLES[i]);
cursor.moveToNext();
}
}
private void insertSpecialCase(String key, String title) {
ContentValues values = new ContentValues();
values.put(IndexColumns.KEY, key);
values.put(IndexColumns.TITLE, title);
mDb.replaceOrThrow(SlicesDatabaseHelper.Tables.TABLE_SLICES_INDEX, null, values);
}
private List<SliceData> getDummyIndexableData() {
List<SliceData> sliceData = new ArrayList<>();
SliceData.Builder builder = new SliceData.Builder();
builder.setSummary(SUMMARY)
.setScreenTitle(SCREEN_TITLE)
.setFragmentName(FRAGMENT_NAME)
.setIcon(ICON)
.setUri(URI)
.setPreferenceControllerClassName(PREF_CONTROLLER);
for (int i = 0; i < KEYS.length; i++) {
builder.setKey(KEYS[i])
.setTitle(TITLES[i]);
sliceData.add(builder.build());
}
return sliceData;
}
}

21
tests/robotests/src/com/android/settings/testutils/DatabaseTestUtils.java
View File

@@ -19,12 +19,33 @@ package com.android.settings.testutils;
import android.content.Context;
import com.android.settings.search.IndexDatabaseHelper;
import com.android.settings.slices.SlicesDatabaseHelper;
import java.lang.reflect.Field;
public class DatabaseTestUtils {
public static void clearDb(Context context) {
clearSearchDb(context);
clearSlicesDb(context);
}
private static void clearSlicesDb(Context context) {
SlicesDatabaseHelper helper = SlicesDatabaseHelper.getInstance(context);
helper.close();
Field instance;
Class clazz = SlicesDatabaseHelper.class;
try {
instance = clazz.getDeclaredField("sSingleton");
instance.setAccessible(true);
instance.set(null, null);
} catch (Exception e) {
throw new RuntimeException();
}
}
private static void clearSearchDb(Context context) {
IndexDatabaseHelper helper = IndexDatabaseHelper.getInstance(context);
helper.close();

8
tests/robotests/src/com/android/settings/testutils/FakeFeatureFactory.java
View File

@@ -37,6 +37,7 @@ import com.android.settings.overlay.SupportFeatureProvider;
import com.android.settings.overlay.SurveyFeatureProvider;
import com.android.settings.search.SearchFeatureProvider;
import com.android.settings.security.SecurityFeatureProvider;
import com.android.settings.slices.SlicesFeatureProvider;
import com.android.settings.users.UserFeatureProvider;
import org.mockito.Answers;
@@ -63,6 +64,7 @@ public class FakeFeatureFactory extends FeatureFactory {
public final BluetoothFeatureProvider bluetoothFeatureProvider;
public final DataPlanFeatureProvider dataPlanFeatureProvider;
public final SmsMirroringFeatureProvider smsMirroringFeatureProvider;
public final SlicesFeatureProvider slicesFeatureProvider;
/**
* Call this in {@code @Before} method of the test class to use fake factory.
@@ -101,6 +103,7 @@ public class FakeFeatureFactory extends FeatureFactory {
bluetoothFeatureProvider = mock(BluetoothFeatureProvider.class);
dataPlanFeatureProvider = mock(DataPlanFeatureProvider.class);
smsMirroringFeatureProvider = mock(SmsMirroringFeatureProvider.class);
slicesFeatureProvider = mock(SlicesFeatureProvider.class);
}
@Override
@@ -182,4 +185,9 @@ public class FakeFeatureFactory extends FeatureFactory {
public SmsMirroringFeatureProvider getSmsMirroringFeatureProvider() {
return smsMirroringFeatureProvider;
}
@Override
public SlicesFeatureProvider getSlicesFeatureProvider() {
return slicesFeatureProvider;
}
}