/* * Copyright (C) 2025 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.content.ContextWrapper import android.content.res.Resources import android.media.AudioManager import android.os.Vibrator import android.provider.Settings.System.VIBRATE_ON import androidx.core.content.getSystemService import androidx.test.core.app.ApplicationProvider import androidx.test.ext.junit.runners.AndroidJUnit4 import com.android.settings.R import com.android.settings.testutils.shadow.ShadowAudioManager import com.android.settingslib.datastore.SettingsSystemStore import com.android.settingslib.preference.PreferenceBindingFactory import com.android.settingslib.preference.createAndBindWidget import com.android.settingslib.widget.MainSwitchPreference import com.android.settingslib.widget.SliderPreference import com.google.common.truth.Truth.assertThat import org.junit.Assume.assumeFalse import org.junit.Assume.assumeTrue import org.junit.Before import org.junit.Test import org.junit.runner.RunWith import org.mockito.kotlin.doReturn import org.mockito.kotlin.spy import org.mockito.kotlin.stub import org.robolectric.annotation.Config /** Test case for vibration slider preferences. */ // LINT.IfChange @Config(shadows = [ShadowAudioManager::class]) @RunWith(AndroidJUnit4::class) abstract class VibrationIntensitySliderPreferenceTestCase { protected abstract val hasRingerModeDependency: Boolean protected abstract val preference: VibrationIntensitySliderPreference protected val mainSwitchPreference = VibrationMainSwitchPreference("some_key") protected val resourcesSpy: Resources = spy(ApplicationProvider.getApplicationContext().resources) protected val vibratorSpy: Vibrator = spy(ApplicationProvider.getApplicationContext().getSystemService()!!) protected val context: Context = object : ContextWrapper(ApplicationProvider.getApplicationContext()) { override fun getResources(): Resources = resourcesSpy override fun getSystemService(name: String): Any? = when { name == getSystemServiceName(Vibrator::class.java) -> vibratorSpy else -> super.getSystemService(name) } } @Before fun setUp() { setRingerMode(AudioManager.RINGER_MODE_NORMAL) } @Test fun minMaxIncrement_usesConfigIntensityLevels() { setSupportedLevels(2) val widget = createWidget() assertThat(widget.min).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) assertThat(widget.max).isEqualTo(2) assertThat(widget.sliderIncrement).isEqualTo(1) } @Test fun maxValue_badConfigTooHigh_returnsVibratorMaxIntensity() { setSupportedLevels(5) val widget = createWidget() assertThat(widget.max).isEqualTo(Vibrator.VIBRATION_INTENSITY_HIGH) } @Test fun state_valueUnsetAndDefaultSupported_enabledAndDefaultIntensity() { setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(null) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) } @Test fun state_valueUnsetDefaultTooHigh_enabledAndMaxIntensity() { setSupportedLevels(1) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_HIGH) setValue(null) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(1) } @Test fun state_valueSetToSupported_enabledAndStoredValue() { setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_MEDIUM) setValue(Vibrator.VIBRATION_INTENSITY_LOW) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) } @Test fun state_valueOff_enabledAndValueOff() { setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_MEDIUM) setValue(Vibrator.VIBRATION_INTENSITY_OFF) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) } @Test fun state_valueTooHigh_enabledAndMaxIntensity() { setSupportedLevels(2) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(Vibrator.VIBRATION_INTENSITY_HIGH) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(2) } @Test fun state_ringerModeNormal_enabledAndChecked() { setRingerMode(AudioManager.RINGER_MODE_NORMAL) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(Vibrator.VIBRATION_INTENSITY_HIGH) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_HIGH) } @Test fun state_ringerModeVibrate_enabledAndChecked() { setRingerMode(AudioManager.RINGER_MODE_VIBRATE) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(Vibrator.VIBRATION_INTENSITY_LOW) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) } @Test fun state_ringerModeSilentWithoutDependency_enabledAndChecked() { assumeFalse(hasRingerModeDependency) setRingerMode(AudioManager.RINGER_MODE_SILENT) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(Vibrator.VIBRATION_INTENSITY_MEDIUM) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_MEDIUM) } @Test fun state_ringerModeSilentWithDependency_disabledAndUncheckedAndPreservesStoredValue() { assumeTrue(hasRingerModeDependency) setRingerMode(AudioManager.RINGER_MODE_SILENT) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(Vibrator.VIBRATION_INTENSITY_MEDIUM) val widget = createWidget() assertThat(widget.isEnabled).isFalse() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_MEDIUM) } @Test fun summary_preferenceEnabled_isNull() { setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(Vibrator.VIBRATION_INTENSITY_MEDIUM) val widget = createWidget() assertThat(widget.isEnabled).isTrue() assertThat(widget.summary).isNull() } @Test fun summary_preferenceDisabledByMainSwitch_isNull() { setMainSwitchValue(false) setRingerMode(AudioManager.RINGER_MODE_SILENT) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(Vibrator.VIBRATION_INTENSITY_MEDIUM) val widget = createWidget() val mainSwitchWidget = createMainSwitchWidget() assertThat(mainSwitchWidget.isChecked).isFalse() assertThat(widget.isEnabled).isFalse() assertThat(widget.summary).isNull() } @Test fun summary_preferenceDisabledByRingerModeSilent_isSilentModeMessage() { assumeTrue(hasRingerModeDependency) setRingerMode(AudioManager.RINGER_MODE_SILENT) val expectedSummary = context.getString( R.string.accessibility_vibration_setting_disabled_for_silent_mode_summary ) setMainSwitchValue(true) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(Vibrator.VIBRATION_INTENSITY_MEDIUM) val widget = createWidget() val mainSwitchWidget = createMainSwitchWidget() assertThat(mainSwitchWidget.isChecked).isTrue() assertThat(widget.isEnabled).isFalse() assertThat(widget.summary).isEqualTo(expectedSummary) } @Test fun state_valueOnAndMainSwitchFalse_disabledAndValueOff() { setMainSwitchValue(false) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_MEDIUM) setValue(Vibrator.VIBRATION_INTENSITY_LOW) val widget = createWidget() val mainSwitchWidget = createMainSwitchWidget() assertThat(mainSwitchWidget.isChecked).isFalse() assertThat(widget.isEnabled).isFalse() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) } @Test fun setValue_supportedValues_storesIntensityValues() { setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_MEDIUM) setValue(null) val widget = createWidget() assertThat(getRawStoredValue()).isNull() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_MEDIUM) widget.value = Vibrator.VIBRATION_INTENSITY_OFF assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) widget.value = Vibrator.VIBRATION_INTENSITY_HIGH assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_HIGH) } @Test fun setValue_oneLevelSupported_storesDefaultIntensity() { setSupportedLevels(1) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_MEDIUM) setValue(null) val widget = createWidget() assertThat(getRawStoredValue()).isNull() assertThat(widget.value).isEqualTo(1) widget.value = Vibrator.VIBRATION_INTENSITY_OFF assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) widget.value = 1 assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_MEDIUM) } @Test fun setValue_twoLevelsSupported_storesMinAndMaxIntensities() { setSupportedLevels(2) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_LOW) setValue(null) val widget = createWidget() assertThat(getRawStoredValue()).isNull() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) widget.value = Vibrator.VIBRATION_INTENSITY_OFF assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) widget.value = 1 assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) widget.value = 2 assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_HIGH) } @Test fun mainSwitchClick_withValueOn_updateSliderStateAndRestoreOriginalIntensity() { setMainSwitchValue(true) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_MEDIUM) setValue(Vibrator.VIBRATION_INTENSITY_HIGH) val widget = createWidget() val mainSwitchWidget = createMainSwitchWidget() assertThat(mainSwitchWidget.isChecked).isTrue() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_HIGH) mainSwitchWidget.performClick() updatePreferenceBinding(widget) assertThat(mainSwitchWidget.isChecked).isFalse() assertThat(widget.isEnabled).isFalse() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) mainSwitchWidget.performClick() updatePreferenceBinding(widget) assertThat(mainSwitchWidget.isChecked).isTrue() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_HIGH) } @Test fun mainSwitchClick_withValueFalse_doesNotChangeCheckedState() { setMainSwitchValue(true) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_MEDIUM) setValue(Vibrator.VIBRATION_INTENSITY_OFF) val widget = createWidget() val mainSwitchWidget = createMainSwitchWidget() assertThat(mainSwitchWidget.isChecked).isTrue() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) mainSwitchWidget.performClick() updatePreferenceBinding(widget) assertThat(mainSwitchWidget.isChecked).isFalse() assertThat(widget.isEnabled).isFalse() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) mainSwitchWidget.performClick() updatePreferenceBinding(widget) assertThat(mainSwitchWidget.isChecked).isTrue() assertThat(widget.isEnabled).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) } @Test fun mainSwitchClick_withIntensitySet_doesNotUpdateStoredValue() { setMainSwitchValue(true) setSupportedLevels(3) setDefaultIntensity(Vibrator.VIBRATION_INTENSITY_MEDIUM) setValue(Vibrator.VIBRATION_INTENSITY_LOW) val widget = createWidget() val mainSwitchWidget = createMainSwitchWidget() assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) assertThat(mainSwitchWidget.isChecked).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) mainSwitchWidget.performClick() updatePreferenceBinding(widget) assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) assertThat(mainSwitchWidget.isChecked).isFalse() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_OFF) mainSwitchWidget.performClick() updatePreferenceBinding(widget) assertThat(getRawStoredValue()).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) assertThat(mainSwitchWidget.isChecked).isTrue() assertThat(widget.value).isEqualTo(Vibrator.VIBRATION_INTENSITY_LOW) } private fun setRingerMode(ringerMode: Int) { val audioManager = context.getSystemService() audioManager?.ringerModeInternal = ringerMode assertThat(audioManager?.ringerModeInternal).isEqualTo(ringerMode) } protected fun setSupportedLevels(levels: Int) { resourcesSpy.stub { on { getInteger(R.integer.config_vibration_supported_intensity_levels) } doReturn levels } } protected fun setDefaultIntensity(intensity: Int) { vibratorSpy.stub { on { getDefaultVibrationIntensity(preference.vibrationUsage) } doReturn intensity } } private fun getRawStoredValue() = SettingsSystemStore.get(context).getInt(preference.key) private fun setMainSwitchValue(value: Boolean?) = SettingsSystemStore.get(context).setBoolean(VIBRATE_ON, value) protected fun setValue(value: Int?) = preference.storage(context).setInt(preference.key, value) protected fun createWidget(): SliderPreference = preference.createAndBindWidget(context) private fun createMainSwitchWidget(): MainSwitchPreference = mainSwitchPreference.createAndBindWidget(context) private fun updatePreferenceBinding(widget: SliderPreference) = PreferenceBindingFactory.defaultFactory .getPreferenceBinding(preference)!! .bind(widget, preference) } // LINT.ThenChange(VibrationTogglePreferenceControllerTest.java)