/* * 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.search; 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.provider.SearchIndexableResource; import com.android.settings.R; import com.android.settings.core.BasePreferenceController; import com.android.settings.core.PreferenceControllerMixin; import com.android.settingslib.core.AbstractPreferenceController; import com.android.settingslib.search.SearchIndexableRaw; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.mockito.MockitoAnnotations; import org.robolectric.RobolectricTestRunner; import org.robolectric.RuntimeEnvironment; import org.robolectric.annotation.Config; import java.util.ArrayList; import java.util.Collections; import java.util.List; @RunWith(RobolectricTestRunner.class) public class BaseSearchIndexProviderTest { private static final String TEST_PREF_KEY = "test_pref_key"; private Context mContext; private BaseSearchIndexProvider mIndexProvider; @Before public void setUp() { MockitoAnnotations.initMocks(this); mContext = RuntimeEnvironment.application; mIndexProvider = spy(BaseSearchIndexProvider.class); } @Test public void getNonIndexableKeys_noPreferenceController_shouldReturnEmptyList() { assertThat(mIndexProvider.getNonIndexableKeys(mContext)).isEmpty(); } public static class AvailablePreferenceController extends AbstractPreferenceController implements PreferenceControllerMixin { private AvailablePreferenceController(Context context) { super(context); } @Override public boolean isAvailable() { return true; } @Override public String getPreferenceKey() { return TEST_PREF_KEY; } @Override public void updateDynamicRawDataToIndex(List rawData) { final SearchIndexableRaw raw = new SearchIndexableRaw(this.mContext); rawData.add(raw); } } @Test public void getNonIndexableKeys_preferenceIsAvailable_shouldReturnEmptyList() { List controllers = new ArrayList<>(); controllers.add(new AvailablePreferenceController(mContext)); doReturn(controllers).when(mIndexProvider).createPreferenceControllers(mContext); assertThat(mIndexProvider.getNonIndexableKeys(mContext)).isEqualTo(Collections.EMPTY_LIST); } @Test @Config(qualifiers = "mcc999") public void getAllPreferenceControllers_shouldCreateControllerFromCodeAndXml() { final BaseSearchIndexProvider provider = new BaseSearchIndexProvider() { @Override public List getXmlResourcesToIndex(Context context, boolean enabled) { final SearchIndexableResource sir = new SearchIndexableResource(context); sir.xmlResId = R.xml.location_settings; return Collections.singletonList(sir); } @Override public List createPreferenceControllers(Context context) { final List controllersFromCode = new ArrayList<>(); controllersFromCode.add(new BasePreferenceController(mContext, "TEST_KEY") { @Override public int getAvailabilityStatus() { return AVAILABLE; } }); return controllersFromCode; } }; final List controllers = provider.getPreferenceControllers(mContext); assertThat(controllers).hasSize(2); } public static class NotAvailablePreferenceController extends AbstractPreferenceController implements PreferenceControllerMixin { private NotAvailablePreferenceController(Context context) { super(context); } @Override public boolean isAvailable() { return false; } @Override public String getPreferenceKey() { return TEST_PREF_KEY; } } @Test public void getNonIndexableKeys_preferenceIsNotAvailable_shouldReturnKey() { List controllers = new ArrayList<>(); controllers.add(new NotAvailablePreferenceController(mContext)); doReturn(controllers).when(mIndexProvider).createPreferenceControllers(mContext); assertThat(mIndexProvider.getNonIndexableKeys(mContext)).contains(TEST_PREF_KEY); } @Test public void getNonIndexableKeys_pageSearchIsDisabled_shouldSuppressEverything() { final BaseSearchIndexProvider provider = new BaseSearchIndexProvider() { @Override public List getXmlResourcesToIndex(Context context, boolean enabled) { final SearchIndexableResource sir = new SearchIndexableResource(context); sir.xmlResId = R.xml.data_usage; return Collections.singletonList(sir); } @Override public List getRawDataToIndex(Context context, boolean enabled) { List rawData = super.getRawDataToIndex(context, enabled); SearchIndexableRaw raw = new SearchIndexableRaw(context); raw.key = TEST_PREF_KEY; raw.title = "title"; rawData.add(raw); return rawData; } @Override protected boolean isPageSearchEnabled(Context context) { return false; } }; final List nonIndexableKeys = provider.getNonIndexableKeys(RuntimeEnvironment.application); assertThat(nonIndexableKeys).contains("status_header"); assertThat(nonIndexableKeys).contains(TEST_PREF_KEY); } @Test @Config(qualifiers = "mcc999") public void getNonIndexableKeys_hasSearchableAttributeInXml_shouldSuppressUnsearchable() { final BaseSearchIndexProvider provider = new BaseSearchIndexProvider() { @Override public List getXmlResourcesToIndex(Context context, boolean enabled) { final SearchIndexableResource sir = new SearchIndexableResource(context); sir.xmlResId = R.xml.display_settings; return Collections.singletonList(sir); } }; final List nonIndexableKeys = provider.getNonIndexableKeys(RuntimeEnvironment.application); assertThat(nonIndexableKeys).contains("pref_key_5"); } @Test public void getDynamicRawDataToIndex_noPreferenceController_shouldReturnEmptyList() { assertThat(mIndexProvider.getDynamicRawDataToIndex(mContext, true)).isEmpty(); } @Test public void getDynamicRawDataToIndex_disablePageSearch_shouldReturnEmptyList() { List controllers = new ArrayList<>(); controllers.add(new AvailablePreferenceController(mContext)); doReturn(controllers).when(mIndexProvider).createPreferenceControllers(mContext); doReturn(false).when(mIndexProvider).isPageSearchEnabled(mContext); assertThat(mIndexProvider.getDynamicRawDataToIndex(mContext, true)).isEmpty(); } @Test public void getDynamicRawDataToIndex_hasDynamicRaw_shouldNotEmpty() { List controllers = new ArrayList<>(); controllers.add(new AvailablePreferenceController(mContext)); doReturn(controllers).when(mIndexProvider).createPreferenceControllers(mContext); assertThat(mIndexProvider.getDynamicRawDataToIndex(mContext, true)).isNotEmpty(); } }