From dbcdd2bf46bbf3b88ab234f62c54b6583d42d193 Mon Sep 17 00:00:00 2001 From: Lais Andrade Date: Mon, 17 Jan 2022 20:44:18 +0000 Subject: [PATCH] Add VibrationPreferenceControler to check availability Add check to Vibrator.hasVibrator() to the "Vibration & haptics" settings page. Bug: 178530831 Test: VibrationPreferenceControllerTest Change-Id: Ia574d59ad086dd273a9a4ca9d3b472bf23e3684a --- .../VibrationPreferenceController.java | 38 +++++++++ .../accessibility/VibrationSettings.java | 39 +++++++-- .../VibrationPreferenceControllerTest.java | 79 +++++++++++++++++++ 3 files changed, 150 insertions(+), 6 deletions(-) create mode 100644 src/com/android/settings/accessibility/VibrationPreferenceController.java create mode 100644 tests/robotests/src/com/android/settings/accessibility/VibrationPreferenceControllerTest.java diff --git a/src/com/android/settings/accessibility/VibrationPreferenceController.java b/src/com/android/settings/accessibility/VibrationPreferenceController.java new file mode 100644 index 00000000000..238527cf764 --- /dev/null +++ b/src/com/android/settings/accessibility/VibrationPreferenceController.java @@ -0,0 +1,38 @@ +/* + * Copyright (C) 2022 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.accessibility; + +import android.content.Context; +import android.os.Vibrator; + +import com.android.settings.core.BasePreferenceController; + +/** Controller for "Vibration & haptics" settings page. */ +public class VibrationPreferenceController extends BasePreferenceController { + + private final boolean mHasVibrator; + + public VibrationPreferenceController(Context context, String key) { + super(context, key); + mHasVibrator = context.getSystemService(Vibrator.class).hasVibrator(); + } + + @Override + public int getAvailabilityStatus() { + return mHasVibrator ? AVAILABLE : UNSUPPORTED_ON_DEVICE; + } +} diff --git a/src/com/android/settings/accessibility/VibrationSettings.java b/src/com/android/settings/accessibility/VibrationSettings.java index 1bf75f724f7..8c00c34a10e 100644 --- a/src/com/android/settings/accessibility/VibrationSettings.java +++ b/src/com/android/settings/accessibility/VibrationSettings.java @@ -17,18 +17,33 @@ package com.android.settings.accessibility; import android.app.settings.SettingsEnums; +import android.content.Context; +import android.os.Vibrator; +import android.provider.SearchIndexableResource; import com.android.settings.R; import com.android.settings.dashboard.DashboardFragment; import com.android.settings.search.BaseSearchIndexProvider; import com.android.settingslib.search.SearchIndexable; +import java.util.ArrayList; +import java.util.List; + /** Accessibility settings for the vibration. */ @SearchIndexable(forTarget = SearchIndexable.ALL & ~SearchIndexable.ARC) public class VibrationSettings extends DashboardFragment { private static final String TAG = "VibrationSettings"; + private static int getVibrationXmlResourceId(Context context) { + final int supportedIntensities = context.getResources().getInteger( + R.integer.config_vibration_supported_intensity_levels); + return supportedIntensities > 1 + ? R.xml.accessibility_vibration_intensity_settings + : R.xml.accessibility_vibration_settings; + + } + @Override public int getMetricsCategory() { return SettingsEnums.ACCESSIBILITY_VIBRATION; @@ -41,11 +56,7 @@ public class VibrationSettings extends DashboardFragment { @Override protected int getPreferenceScreenResId() { - final int supportedIntensities = getContext().getResources().getInteger( - R.integer.config_vibration_supported_intensity_levels); - return supportedIntensities > 1 - ? R.xml.accessibility_vibration_intensity_settings - : R.xml.accessibility_vibration_settings; + return getVibrationXmlResourceId(getContext()); } @Override @@ -54,5 +65,21 @@ public class VibrationSettings extends DashboardFragment { } public static final BaseSearchIndexProvider SEARCH_INDEX_DATA_PROVIDER = - new BaseSearchIndexProvider(R.xml.accessibility_vibration_settings); + new BaseSearchIndexProvider() { + + @Override + protected boolean isPageSearchEnabled(Context context) { + return context.getSystemService(Vibrator.class).hasVibrator(); + } + + @Override + public List getXmlResourcesToIndex(Context context, + boolean enabled) { + final List resourceData = new ArrayList<>(); + final SearchIndexableResource sir = new SearchIndexableResource(context); + sir.xmlResId = getVibrationXmlResourceId(context); + resourceData.add(sir); + return resourceData; + } + }; } diff --git a/tests/robotests/src/com/android/settings/accessibility/VibrationPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/accessibility/VibrationPreferenceControllerTest.java new file mode 100644 index 00000000000..2b628f5ecf5 --- /dev/null +++ b/tests/robotests/src/com/android/settings/accessibility/VibrationPreferenceControllerTest.java @@ -0,0 +1,79 @@ +/* + * Copyright (C) 2022 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.accessibility; + +import static com.android.settings.core.BasePreferenceController.AVAILABLE; +import static com.android.settings.core.BasePreferenceController.UNSUPPORTED_ON_DEVICE; + +import static com.google.common.truth.Truth.assertThat; + +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.when; + +import android.content.Context; +import android.os.Vibrator; + +import androidx.test.core.app.ApplicationProvider; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.robolectric.RobolectricTestRunner; + +@RunWith(RobolectricTestRunner.class) +public class VibrationPreferenceControllerTest { + + private static final String PREFERENCE_KEY = "preference_key"; + + @Mock private Vibrator mVibrator; + + private Context mContext; + + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + mContext = spy(ApplicationProvider.getApplicationContext()); + when(mContext.getSystemService(Context.VIBRATOR_SERVICE)).thenReturn(mVibrator); + } + + @Test + public void verifyConstants() { + VibrationPreferenceController controller = + new VibrationPreferenceController(mContext, PREFERENCE_KEY); + assertThat(controller.getPreferenceKey()).isEqualTo(PREFERENCE_KEY); + } + + @Test + public void getAvailabilityStatus_noVibrator_returnUnsupportedOnDevice() { + when(mVibrator.hasVibrator()).thenReturn(false); + VibrationPreferenceController controller = + new VibrationPreferenceController(mContext, PREFERENCE_KEY); + + assertThat(controller.getAvailabilityStatus()).isEqualTo(UNSUPPORTED_ON_DEVICE); + } + + @Test + public void getAvailabilityStatus_withVibrator_returnAvailable() { + when(mVibrator.hasVibrator()).thenReturn(true); + VibrationPreferenceController controller = + new VibrationPreferenceController(mContext, PREFERENCE_KEY); + + assertThat(controller.getAvailabilityStatus()).isEqualTo(AVAILABLE); + } +}