Migrate Dial pad tones preference

Bug: 364899400
Test: atest DialPadTonePreferenceTest
Flag: com.android.settings.flags.catalyst_sound_screen
Change-Id: I5939a4d41ad61337f38bd5d48a1cb74f14f1e397

res/xml/sound_settings.xml

@@ -170,7 +170,7 @@
 
     <!-- Dial pad tones -->
     <SwitchPreferenceCompat
-        android:key="dial_pad_tones"
+        android:key="dtmf_tone"
         android:title="@string/dial_pad_tones_title"
         android:order="-50"/>
 

src/com/android/settings/notification/DialPadTonePreference.kt

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2024 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.notification
+
+import android.content.Context
+import android.provider.Settings.System.DTMF_TONE_WHEN_DIALING
+import com.android.settings.R
+import com.android.settings.Utils
+import com.android.settingslib.datastore.SettingsSystemStore
+import com.android.settingslib.metadata.PreferenceAvailabilityProvider
+import com.android.settingslib.metadata.SwitchPreference
+import com.android.settingslib.preference.SwitchPreferenceBinding
+
+// LINT.IfChange
+class DialPadTonePreference :
+    SwitchPreference(DTMF_TONE_WHEN_DIALING, R.string.dial_pad_tones_title),
+    SwitchPreferenceBinding, PreferenceAvailabilityProvider {
+    override fun storage(context: Context) = SettingsSystemStore.get(context)
+
+    override fun isAvailable(context: Context) = Utils.isVoiceCapable(context)
+}
+// LINT.ThenChange(DialPadTonePreferenceController.java)

src/com/android/settings/notification/DialPadTonePreferenceController.java

@@ -16,24 +16,24 @@
 
 package com.android.settings.notification;
 
+import static android.provider.Settings.System.DTMF_TONE_WHEN_DIALING;
+
 import static com.android.settings.notification.SettingPref.TYPE_SYSTEM;
 
 import android.content.Context;
-import android.provider.Settings.System;
 
 import com.android.settings.SettingsPreferenceFragment;
 import com.android.settings.Utils;
 import com.android.settingslib.core.lifecycle.Lifecycle;
 
+// LINT.IfChange
 public class DialPadTonePreferenceController extends SettingPrefController {
 
-    private static final String KEY_DIAL_PAD_TONES = "dial_pad_tones";
-
     public DialPadTonePreferenceController(Context context, SettingsPreferenceFragment parent,
             Lifecycle lifecycle) {
         super(context, parent, lifecycle);
-        mPreference = new SettingPref(
+        mPreference = new SettingPref(TYPE_SYSTEM, DTMF_TONE_WHEN_DIALING, DTMF_TONE_WHEN_DIALING,
-            TYPE_SYSTEM, KEY_DIAL_PAD_TONES, System.DTMF_TONE_WHEN_DIALING, DEFAULT_ON) {
+                DEFAULT_ON) {
             @Override
             public boolean isApplicable(Context context) {
                 return Utils.isVoiceCapable(context);
@@ -42,3 +42,4 @@ public class DialPadTonePreferenceController extends SettingPrefController {
     }
 
 }
+// LINT.ThenChange(DialPadTonePreference.kt)

src/com/android/settings/notification/SoundScreen.kt

@@ -40,7 +40,10 @@ class SoundScreen : PreferenceScreenCreator {
 
     override fun fragmentClass(): Class<out Fragment>? = SoundSettings::class.java
 
-    override fun getPreferenceHierarchy(context: Context) = preferenceHierarchy(this) {}
+    override fun getPreferenceHierarchy(context: Context) =
+        preferenceHierarchy(this) {
+            +DialPadTonePreference()
+        }
 
     companion object {
         const val KEY = "sound_screen"

tests/robotests/src/com/android/settings/notification/DialPadTonePreferenceControllerTest.java

@@ -39,6 +39,7 @@ import org.robolectric.RobolectricTestRunner;
 import org.robolectric.RuntimeEnvironment;
 import org.robolectric.annotation.Config;
 
+// LINT.IfChange
 @RunWith(RobolectricTestRunner.class)
 @Config(shadows = {
         com.android.settings.testutils.shadow.ShadowFragment.class,
@@ -123,3 +124,4 @@ public class DialPadTonePreferenceControllerTest {
         assertThat(System.getInt(mContentResolver, System.DTMF_TONE_WHEN_DIALING, 1)).isEqualTo(0);
     }
 }
+// LINT.ThenChange(DialPadTonePreferenceTest.kt)

tests/robotests/src/com/android/settings/notification/DialPadTonePreferenceTest.kt

@@ -0,0 +1,106 @@
+/*
+ * Copyright (C) 2024 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.notification
+
+import android.content.Context
+import android.content.ContextWrapper
+import android.provider.Settings.System.DTMF_TONE_WHEN_DIALING
+import android.telephony.TelephonyManager
+import androidx.preference.SwitchPreferenceCompat
+import androidx.test.core.app.ApplicationProvider
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.android.settingslib.datastore.SettingsSystemStore
+import com.google.common.truth.Truth.assertThat
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.mockito.kotlin.doReturn
+import org.mockito.kotlin.mock
+
+// LINT.IfChange
+@RunWith(AndroidJUnit4::class)
+class DialPadTonePreferenceTest {
+    private var telephonyManager: TelephonyManager? = null
+
+    private val context =
+        object : ContextWrapper(ApplicationProvider.getApplicationContext()) {
+            override fun getSystemService(name: String): Any? =
+                when (name) {
+                    Context.TELEPHONY_SERVICE -> telephonyManager
+                    else -> super.getSystemService(name)
+                }
+        }
+
+    private val dialPadTonePreference = DialPadTonePreference()
+
+    @Test
+    fun isAvailable_voiceCapable_shouldReturnTrue() {
+        telephonyManager = mock { on { isVoiceCapable } doReturn true }
+
+        assertThat(dialPadTonePreference.isAvailable(context)).isTrue()
+    }
+
+    @Test
+    fun isAvailable_noVoicCapable_shouldReturnFalse() {
+        telephonyManager = mock { on { isVoiceCapable } doReturn false }
+
+        assertThat(dialPadTonePreference.isAvailable(context)).isFalse()
+    }
+
+    @Test
+    fun performClick_shouldPreferenceChangeToChecked() {
+        setDialPadToneEnabled(false)
+
+        val preference = getSwitchPreference().apply { performClick() }
+
+        assertThat(preference.isChecked).isTrue()
+    }
+
+    @Test
+    fun performClick_shouldPreferenceChangeToUnchecked() {
+        setDialPadToneEnabled(true)
+
+        val preference = getSwitchPreference().apply { performClick() }
+
+        assertThat(preference.isChecked).isFalse()
+    }
+
+    @Test
+    fun dialToneEnabled_shouldCheckedPreference() {
+        setDialPadToneEnabled(true)
+
+        assertThat(getSwitchPreference().isChecked).isTrue()
+    }
+
+    @Test
+    fun dialToneDisabled_shouldUncheckedPreference() {
+        setDialPadToneEnabled(false)
+
+        assertThat(getSwitchPreference().isChecked).isFalse()
+    }
+
+    private fun getSwitchPreference(): SwitchPreferenceCompat =
+        dialPadTonePreference.run {
+            val preference = createWidget(context)
+            bind(preference, this)
+            preference as SwitchPreferenceCompat
+        }
+
+    private fun setDialPadToneEnabled(enabled: Boolean) {
+        SettingsSystemStore.get(context)
+            .setValue(DTMF_TONE_WHEN_DIALING, Boolean::class.javaObjectType, enabled)
+    }
+}
+// LINT.ThenChange(DialPadTonePreferenceControllerTest.java)