Merge changes from topic "SurveyFeatureProvider_isSurveyAvailable" into main

* changes:
  Add HaTS entrypoint for Magnification page
  Add controller for magnification feedback preference
  Add a new API: checkSurveyAvailable
This commit is contained in:
Menghan Li
2025-01-09 01:14:45 -08:00
committed by Android (Google) Code Review
6 changed files with 328 additions and 21 deletions

View File

@@ -0,0 +1,121 @@
/*
* 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 static com.android.settings.accessibility.MagnificationFeedbackPreferenceController.FEEDBACK_KEY;
import static com.android.settings.accessibility.MagnificationFeedbackPreferenceController.PREF_KEY;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import android.content.Context;
import androidx.core.util.Consumer;
import androidx.preference.Preference;
import androidx.preference.PreferenceManager;
import androidx.preference.PreferenceScreen;
import androidx.test.core.app.ApplicationProvider;
import com.android.settings.R;
import com.android.settings.dashboard.DashboardFragment;
import com.android.settings.overlay.SurveyFeatureProvider;
import com.android.settings.testutils.FakeFeatureFactory;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.robolectric.RobolectricTestRunner;
/** Tests for {@link MagnificationFeedbackPreferenceController}. */
@RunWith(RobolectricTestRunner.class)
public class MagnificationFeedbackPreferenceControllerTest {
@Rule
public MockitoRule mMockitoRule = MockitoJUnit.rule();
private final Context mContext = ApplicationProvider.getApplicationContext();
@Mock private PreferenceScreen mScreen;
@Mock private PreferenceManager mPreferenceManager;
@Mock private DashboardFragment mFragment;
private SurveyFeatureProvider mSurveyFeatureProvider;
private MagnificationFeedbackPreferenceController mController;
private Preference mPreference;
@Before
public void setUp() {
FakeFeatureFactory.setupForTest();
mSurveyFeatureProvider =
FakeFeatureFactory.getFeatureFactory().getSurveyFeatureProvider(mContext);
mController = new MagnificationFeedbackPreferenceController(mContext, mFragment, PREF_KEY);
mPreference = new Preference(mContext);
when(mFragment.getPreferenceManager()).thenReturn(mPreferenceManager);
when(mPreferenceManager.findPreference(PREF_KEY)).thenReturn(mPreference);
when(mFragment.getPreferenceScreen()).thenReturn(mScreen);
}
@Test
public void getAvailabilityStatus_shouldAlwaysBeAvailable() {
assertThat(mController.getAvailabilityStatus()).isEqualTo(
MagnificationFeedbackPreferenceController.AVAILABLE);
}
@Test
public void updateState_surveyAvailable_preferenceEnabledWithSummary() {
doAnswer(invocation -> {
Consumer<Boolean> consumer = invocation.getArgument(2);
consumer.accept(true);
return null;
}).when(mSurveyFeatureProvider).checkSurveyAvailable(any(), eq(FEEDBACK_KEY), any());
mController.updateState(mPreference);
assertThat(mPreference.isEnabled()).isTrue();
assertThat(mPreference.getSummary()).isEqualTo(
mContext.getString(R.string.accessibility_feedback_summary));
}
@Test
public void updateState_surveyUnavailable_preferenceDisabledWithSummary() {
doAnswer(invocation -> {
Consumer<Boolean> consumer = invocation.getArgument(2);
consumer.accept(false);
return null;
}).when(mSurveyFeatureProvider).checkSurveyAvailable(any(), eq(FEEDBACK_KEY), any());
mController.updateState(mPreference);
assertThat(mPreference.isEnabled()).isFalse();
assertThat(mPreference.getSummary()).isEqualTo(
mContext.getString(R.string.accessibility_feedback_disabled_summary));
}
@Test
public void handlePreferenceTreeClick_shouldStartSurvey() {
mController.handlePreferenceTreeClick(mPreference);
verify(mSurveyFeatureProvider).sendActivityIfAvailable(FEEDBACK_KEY);
}
}

View File

@@ -336,6 +336,26 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
assertThat(switchPreference.isChecked()).isFalse();
}
@Test
@EnableFlags(Flags.FLAG_ENABLE_LOW_VISION_HATS)
public void onResume_enableLowVisionHaTS_feedbackPreferenceShouldReturnNotNull() {
mFragController.create(R.id.main_content, /* bundle= */ null).start().resume();
final Preference feedbackPreference = mFragController.get().findPreference(
MagnificationFeedbackPreferenceController.PREF_KEY);
assertThat(feedbackPreference).isNotNull();
}
@Test
@DisableFlags(Flags.FLAG_ENABLE_LOW_VISION_HATS)
public void onResume_disableLowVisionHaTS_feedbackPreferenceShouldReturnNull() {
mFragController.create(R.id.main_content, /* bundle= */ null).start().resume();
final Preference feedbackPreference = mFragController.get().findPreference(
MagnificationFeedbackPreferenceController.PREF_KEY);
assertThat(feedbackPreference).isNull();
}
@Test
public void onResume_haveRegisterToSpecificUris() {
ShadowContentResolver shadowContentResolver = Shadows.shadowOf(
@@ -893,13 +913,14 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
@Test
@EnableFlags(com.android.settings.accessibility.Flags.FLAG_FIX_A11Y_SETTINGS_SEARCH)
public void getRawDataToIndex_returnsAllPreferenceKeys() {
List<String> expectedSearchKeys = List.of(
final List<String> expectedSearchKeys = List.of(
KEY_MAGNIFICATION_SHORTCUT_PREFERENCE,
MagnificationModePreferenceController.PREF_KEY,
MagnificationFollowTypingPreferenceController.PREF_KEY,
MagnificationOneFingerPanningPreferenceController.PREF_KEY,
MagnificationAlwaysOnPreferenceController.PREF_KEY,
MagnificationJoystickPreferenceController.PREF_KEY);
MagnificationJoystickPreferenceController.PREF_KEY,
MagnificationFeedbackPreferenceController.PREF_KEY);
final List<SearchIndexableRaw> rawData = ToggleScreenMagnificationPreferenceFragment
.SEARCH_INDEX_DATA_PROVIDER.getRawDataToIndex(mContext, true);
@@ -910,8 +931,7 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
@Test
@EnableFlags(com.android.settings.accessibility.Flags.FLAG_FIX_A11Y_SETTINGS_SEARCH)
public void
getNonIndexableKeys_windowMagnificationNotSupported_onlyShortcutPreferenceSearchable() {
public void getNonIndexableKeys_windowMagnificationNotSupported_onlyShortcutSearchable() {
setWindowMagnificationSupported(false, false);
final List<String> niks = ToggleScreenMagnificationPreferenceFragment
@@ -920,7 +940,8 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
.SEARCH_INDEX_DATA_PROVIDER.getRawDataToIndex(mContext, true);
// Expect all search data, except the shortcut preference, to be in NIKs.
final List<String> expectedNiks = rawData.stream().map(raw -> raw.key)
.filter(key -> !key.equals(KEY_MAGNIFICATION_SHORTCUT_PREFERENCE)).toList();
.filter(key -> !key.equals(KEY_MAGNIFICATION_SHORTCUT_PREFERENCE))
.toList();
// In NonIndexableKeys == not searchable
assertThat(niks).containsExactlyElementsIn(expectedNiks);
@@ -929,7 +950,32 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
@Test
@EnableFlags({
com.android.settings.accessibility.Flags.FLAG_FIX_A11Y_SETTINGS_SEARCH,
Flags.FLAG_ENABLE_MAGNIFICATION_ONE_FINGER_PANNING_GESTURE})
Flags.FLAG_ENABLE_LOW_VISION_HATS})
public void
getNonIndexableKeys_windowMagnificationNotSupportedHatsOn_shortcutFeedbackSearchable() {
setWindowMagnificationSupported(false, false);
final List<String> niks = ToggleScreenMagnificationPreferenceFragment
.SEARCH_INDEX_DATA_PROVIDER.getNonIndexableKeys(mContext);
final List<SearchIndexableRaw> rawData = ToggleScreenMagnificationPreferenceFragment
.SEARCH_INDEX_DATA_PROVIDER.getRawDataToIndex(mContext, true);
// Expect all search data, except the shortcut preference and feedback preference, to be in
// NIKs.
final List<String> expectedNiks = rawData.stream().map(raw -> raw.key)
.filter(key ->
!key.equals(KEY_MAGNIFICATION_SHORTCUT_PREFERENCE)
&& !key.equals(MagnificationFeedbackPreferenceController.PREF_KEY))
.toList();
// In NonIndexableKeys == not searchable
assertThat(niks).containsExactlyElementsIn(expectedNiks);
}
@Test
@EnableFlags({
com.android.settings.accessibility.Flags.FLAG_FIX_A11Y_SETTINGS_SEARCH,
Flags.FLAG_ENABLE_MAGNIFICATION_ONE_FINGER_PANNING_GESTURE,
Flags.FLAG_ENABLE_LOW_VISION_HATS})
public void getNonIndexableKeys_hasShortcutAndAllFeaturesEnabled_allItemsSearchable() {
setMagnificationTripleTapEnabled(true);
setAlwaysOnSupported(true);
@@ -991,6 +1037,16 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
assertThat(niks).contains(MagnificationJoystickPreferenceController.PREF_KEY);
}
@Test
@DisableFlags(Flags.FLAG_ENABLE_LOW_VISION_HATS)
public void getNonIndexableKeys_hatsNotSupported_notSearchable() {
final List<String> niks = ToggleScreenMagnificationPreferenceFragment
.SEARCH_INDEX_DATA_PROVIDER.getNonIndexableKeys(mContext);
// In NonIndexableKeys == not searchable
assertThat(niks).contains(MagnificationFeedbackPreferenceController.PREF_KEY);
}
private void putStringIntoSettings(String key, String componentName) {
Settings.Secure.putString(mContext.getContentResolver(), key, componentName);
}