Merge "Refactor AccessibilityControlTimeoutPreferenceFragment to improve maintainability"

This commit is contained in:
Menghan Li
2022-07-18 13:52:29 +00:00
committed by Android (Google) Code Review
9 changed files with 334 additions and 232 deletions

View File

@@ -0,0 +1,82 @@
/*
* 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.google.common.truth.Truth.assertThat;
import android.app.settings.SettingsEnums;
import android.content.Context;
import androidx.test.core.app.ApplicationProvider;
import com.android.settings.R;
import com.android.settings.testutils.XmlTestUtils;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import java.util.List;
/** Tests for {@link AccessibilityControlTimeoutPreferenceFragment}. */
@RunWith(RobolectricTestRunner.class)
public class AccessibilityControlTimeoutPreferenceFragmentTest {
private final Context mContext = ApplicationProvider.getApplicationContext();
private AccessibilityControlTimeoutPreferenceFragment mFragment;
@Before
public void setUp() {
mFragment = new AccessibilityControlTimeoutPreferenceFragment();
}
@Test
public void getMetricsCategory_returnsCorrectCategory() {
assertThat(mFragment.getMetricsCategory()).isEqualTo(
SettingsEnums.ACCESSIBILITY_TIMEOUT);
}
@Test
public void getPreferenceScreenResId_returnsCorrectXml() {
assertThat(mFragment.getPreferenceScreenResId()).isEqualTo(
R.xml.accessibility_control_timeout_settings);
}
@Test
public void getHelpResource_returnsCorrectHelpResource() {
assertThat(mFragment.getHelpResource()).isEqualTo(R.string.help_url_timeout);
}
@Test
public void getLogTag_returnsCorrectTag() {
assertThat(mFragment.getLogTag()).isEqualTo(
"AccessibilityControlTimeoutPreferenceFragment");
}
@Test
public void getNonIndexableKeys_existInXmlLayout() {
final List<String> niks =
AccessibilityControlTimeoutPreferenceFragment.SEARCH_INDEX_DATA_PROVIDER
.getNonIndexableKeys(mContext);
final List<String> keys =
XmlTestUtils.getKeysFromPreferenceXml(mContext,
R.xml.accessibility_control_timeout_settings);
assertThat(keys).containsAtLeastElementsIn(niks);
}
}

View File

@@ -18,8 +18,6 @@ package com.android.settings.accessibility;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
@@ -27,59 +25,57 @@ import android.content.ContentResolver;
import android.content.Context;
import android.provider.Settings;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;
import androidx.test.core.app.ApplicationProvider;
import com.android.settings.R;
import com.android.settingslib.core.lifecycle.Lifecycle;
import com.android.settings.core.BasePreferenceController;
import com.android.settingslib.widget.SelectorWithWidgetPreference;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
/** Tests for {@link AccessibilityTimeoutController}. */
@RunWith(RobolectricTestRunner.class)
public class AccessibilityTimeoutControllerTest
implements AccessibilityTimeoutController.OnChangeListener {
public class AccessibilityTimeoutControllerTest {
private static final String PREF_KEY = "accessibility_control_timeout_30secs";
private AccessibilityTimeoutController mController;
@Rule
public final MockitoRule mMockitoRule = MockitoJUnit.rule();
@Mock
private SelectorWithWidgetPreference mMockPref;
private Context mContext;
private ContentResolver mContentResolver;
@Mock
private PreferenceScreen mScreen;
@Mock
private AccessibilitySettingsContentObserver mAccessibilitySettingsContentObserver;
private Context mContext = ApplicationProvider.getApplicationContext();
private ContentResolver mContentResolver;
private AccessibilityTimeoutController mController;
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
mContext = RuntimeEnvironment.application;
mController = new AccessibilityTimeoutController(mContext, mock(Lifecycle.class), PREF_KEY);
mController.setOnChangeListener(this);
mContentResolver = mContext.getContentResolver();
String prefTitle = mContext.getResources().getString(R.string.accessibility_timeout_30secs);
mController = new AccessibilityTimeoutController(mContext, PREF_KEY,
mAccessibilitySettingsContentObserver);
when(mScreen.findPreference(mController.getPreferenceKey())).thenReturn(mMockPref);
when(mMockPref.getKey()).thenReturn(PREF_KEY);
final String prefTitle =
mContext.getResources().getString(R.string.accessibility_timeout_30secs);
when(mMockPref.getTitle()).thenReturn(prefTitle);
mController.displayPreference(mScreen);
}
@Override
public void onCheckedChanged(Preference preference) {
mController.updateState(preference);
}
@Test
public void isAvailable() {
assertTrue(mController.isAvailable());
public void getAvailabilityStatus_shouldReturnAvailable() {
assertThat(mController.getAvailabilityStatus()).isEqualTo(
BasePreferenceController.AVAILABLE);
}
@Test
@@ -115,4 +111,18 @@ public class AccessibilityTimeoutControllerTest
assertThat(accessibilityUiTimeoutValue).isEqualTo("30000");
}
@Test
public void onStart_registerSpecificContentObserverForSpecificKeys() {
mController.onStart();
verify(mAccessibilitySettingsContentObserver).register(mContentResolver);
}
@Test
public void onStop_unregisterContentObserver() {
mController.onStop();
verify(mAccessibilitySettingsContentObserver).unregister(mContentResolver);
}
}

View File

@@ -21,6 +21,8 @@ import static com.google.common.truth.Truth.assertThat;
import android.content.Context;
import android.provider.Settings;
import androidx.test.core.app.ApplicationProvider;
import com.android.settings.R;
import com.android.settings.core.BasePreferenceController;
@@ -28,17 +30,16 @@ import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
/** Tests for {@link AccessibilityTimeoutPreferenceController}. */
@RunWith(RobolectricTestRunner.class)
public class AccessibilityTimeoutPreferenceControllerTest {
private Context mContext;
private Context mContext = ApplicationProvider.getApplicationContext();
private AccessibilityTimeoutPreferenceController mController;
@Before
public void setUp() {
mContext = RuntimeEnvironment.application;
mController = new AccessibilityTimeoutPreferenceController(mContext, "control_timeout");
}
@@ -50,31 +51,31 @@ public class AccessibilityTimeoutPreferenceControllerTest {
@Test
public void getSummary_byDefault_shouldReturnDefaultSummary() {
final String[] timeoutSummarys = mContext.getResources().getStringArray(
final String[] timeoutSummaries = mContext.getResources().getStringArray(
R.array.accessibility_timeout_summaries);
Settings.Secure.putString(mContext.getContentResolver(),
Settings.Secure.ACCESSIBILITY_INTERACTIVE_UI_TIMEOUT_MS, "0");
assertThat(mController.getSummary()).isEqualTo(timeoutSummarys[0]);
assertThat(mController.getSummary().toString()).isEqualTo(timeoutSummaries[0]);
}
@Test
public void getSummary_invalidTimeout_shouldReturnDefaultSummary() {
final String[] timeoutSummarys = mContext.getResources().getStringArray(
final String[] timeoutSummaries = mContext.getResources().getStringArray(
R.array.accessibility_timeout_summaries);
Settings.Secure.putString(mContext.getContentResolver(),
Settings.Secure.ACCESSIBILITY_INTERACTIVE_UI_TIMEOUT_MS, "invalid_timeout");
assertThat(mController.getSummary()).isEqualTo(timeoutSummarys[0]);
assertThat(mController.getSummary().toString()).isEqualTo(timeoutSummaries[0]);
}
@Test
public void getSummary_validTimeout_shouldReturnValidSummary() {
final String[] timeoutSummarys = mContext.getResources().getStringArray(
final String[] timeoutSummaries = mContext.getResources().getStringArray(
R.array.accessibility_timeout_summaries);
Settings.Secure.putString(mContext.getContentResolver(),
Settings.Secure.ACCESSIBILITY_INTERACTIVE_UI_TIMEOUT_MS, "60000");
assertThat(mController.getSummary()).isEqualTo(timeoutSummarys[3]);
assertThat(mController.getSummary().toString()).isEqualTo(timeoutSummaries[3]);
}
}

View File

@@ -0,0 +1,65 @@
/*
* 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.google.common.truth.Truth.assertThat;
import android.content.Context;
import android.provider.Settings;
import androidx.test.core.app.ApplicationProvider;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
/** Tests for {@link AccessibilityTimeoutUtils}. */
@RunWith(RobolectricTestRunner.class)
public final class AccessibilityTimeoutUtilsTest {
private final Context mContext = ApplicationProvider.getApplicationContext();
@Test
public void getSecureAccessibilityTimeoutValue_byDefault_shouldReturnDefaultValue() {
Settings.Secure.putString(mContext.getContentResolver(),
Settings.Secure.ACCESSIBILITY_INTERACTIVE_UI_TIMEOUT_MS, "0");
final int timeOutValue = AccessibilityTimeoutUtils.getSecureAccessibilityTimeoutValue(
mContext.getContentResolver());
assertThat(timeOutValue).isEqualTo(0);
}
@Test
public void getSecureAccessibilityTimeoutValue_invalidTimeout_shouldReturnDefaultValue() {
Settings.Secure.putString(mContext.getContentResolver(),
Settings.Secure.ACCESSIBILITY_INTERACTIVE_UI_TIMEOUT_MS, "invalid_timeout");
final int timeOutValue = AccessibilityTimeoutUtils.getSecureAccessibilityTimeoutValue(
mContext.getContentResolver());
assertThat(timeOutValue).isEqualTo(0);
}
@Test
public void getSecureAccessibilityTimeoutValue_validTimeout_shouldReturnValidValue() {
Settings.Secure.putString(mContext.getContentResolver(),
Settings.Secure.ACCESSIBILITY_INTERACTIVE_UI_TIMEOUT_MS, "60000");
final int timeOutValue = AccessibilityTimeoutUtils.getSecureAccessibilityTimeoutValue(
mContext.getContentResolver());
assertThat(timeOutValue).isEqualTo(60000);
}
}