Honor DISALLOW_CELLULAR_2G User Restriction in Enable2gPreferenceController

When 2g is disallowed by a device admin the 2g toggle in the preference
screen will implement the following behaviors as a result of being
changed to a RestrictedSwitchPreference:
1. become disabled (greyed out)
2. show a summary message explaining that the preference was disabled by
   an admin
3 show a pop up when a user tries to click on the preference informing
  them that the setting is unusable because it was disabled by an admin.

Additionally, the toggle will show as unchecked (off) when admins
disable 2g.

When 2g is re-enabled by a device admin, the preference screen will go back
to its previous state.

Test: atest Enable2gPreferenceControllerTest
Bug: b/248250240
Change-Id: I7af901f2d9f62ebfe884e01724d8eff845c2968e
This commit is contained in:
Gil Cukierman
2022-09-23 15:55:18 +00:00
parent 90dcc7c5c1
commit a2ddff3865
3 changed files with 139 additions and 48 deletions

View File

@@ -27,15 +27,19 @@ import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import android.content.Context;
import android.os.Looper;
import android.os.PersistableBundle;
import android.telephony.CarrierConfigManager;
import android.telephony.SubscriptionManager;
import android.telephony.TelephonyManager;
import androidx.preference.PreferenceManager;
import androidx.preference.PreferenceScreen;
import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.android.settings.network.CarrierConfigCache;
import com.android.settingslib.RestrictedSwitchPreference;
import org.junit.Before;
import org.junit.Test;
@@ -46,6 +50,7 @@ import org.mockito.MockitoAnnotations;
@RunWith(AndroidJUnit4.class)
public final class Enable2gPreferenceControllerTest {
private static final int SUB_ID = 2;
private static final String PREFERENCE_KEY = "TEST_2G_PREFERENCE";
@Mock
private CarrierConfigCache mCarrierConfigCache;
@@ -54,12 +59,18 @@ public final class Enable2gPreferenceControllerTest {
@Mock
private TelephonyManager mInvalidTelephonyManager;
private RestrictedSwitchPreference mPreference;
private PreferenceScreen mPreferenceScreen;
private PersistableBundle mPersistableBundle;
private Enable2gPreferenceController mController;
private Context mContext;
@Before
public void setUp() {
if (Looper.myLooper() == null) {
Looper.prepare();
}
MockitoAnnotations.initMocks(this);
mContext = spy(ApplicationProvider.getApplicationContext());
@@ -75,7 +86,12 @@ public final class Enable2gPreferenceControllerTest {
doReturn(mPersistableBundle).when(mCarrierConfigCache).getConfigForSubId(SUB_ID);
doReturn(mPersistableBundle).when(mCarrierConfigCache).getConfigForSubId(
SubscriptionManager.INVALID_SUBSCRIPTION_ID);
mController = new Enable2gPreferenceController(mContext, "mobile_data");
mController = new Enable2gPreferenceController(mContext, PREFERENCE_KEY);
mPreference = spy(new RestrictedSwitchPreference(mContext));
mPreference.setKey(PREFERENCE_KEY);
mPreferenceScreen = new PreferenceManager(mContext).createPreferenceScreen(mContext);
mPreferenceScreen.addPreference(mPreference);
mController.init(SUB_ID);
}
@@ -137,13 +153,15 @@ public final class Enable2gPreferenceControllerTest {
assertThat(mController.setChecked(false)).isFalse();
}
@Test
public void setChecked_disabledByAdmin_returnFalse() {
when2gIsDisabledByAdmin(true);
assertThat(mController.setChecked(false)).isFalse();
}
@Test
public void onPreferenceChange_update() {
// Set "Enable 2G" flag to "on"
when(mTelephonyManager.getAllowedNetworkTypesForReason(
TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_ENABLE_2G)).thenReturn(
(long) (TelephonyManager.NETWORK_TYPE_BITMASK_GSM
| TelephonyManager.NETWORK_TYPE_BITMASK_LTE));
when2gIsEnabledForReasonEnable2g();
// Setup state to allow disabling
doReturn(true).when(mTelephonyManager).isRadioInterfaceCapabilitySupported(
@@ -159,4 +177,42 @@ public final class Enable2gPreferenceControllerTest {
TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_ENABLE_2G,
TelephonyManager.NETWORK_TYPE_BITMASK_LTE);
}
@Test
public void disabledByAdmin_toggleUnchecked() {
when2gIsEnabledForReasonEnable2g();
when2gIsDisabledByAdmin(true);
assertThat(mController.isChecked()).isFalse();
}
@Test
public void userRestrictionInactivated_userToggleMaintainsState() {
// Initially, 2g is enabled
when2gIsEnabledForReasonEnable2g();
when2gIsDisabledByAdmin(false);
assertThat(mController.isChecked()).isTrue();
// When we disable the preference by an admin, the preference should be unchecked
when2gIsDisabledByAdmin(true);
assertThat(mController.isChecked()).isFalse();
// If the preference is re-enabled by an admin, former state should hold
when2gIsDisabledByAdmin(false);
assertThat(mController.isChecked()).isTrue();
}
private void when2gIsEnabledForReasonEnable2g() {
when(mTelephonyManager.getAllowedNetworkTypesForReason(
TelephonyManager.ALLOWED_NETWORK_TYPES_REASON_ENABLE_2G)).thenReturn(
(long) (TelephonyManager.NETWORK_TYPE_BITMASK_GSM
| TelephonyManager.NETWORK_TYPE_BITMASK_LTE));
}
private void when2gIsDisabledByAdmin(boolean is2gDisabledByAdmin) {
// Our controller depends on state being initialized when the associated preference is
// displayed because the admin disablement functionality flows from the association of a
// Preference with the PreferenceScreen
when(mPreference.isDisabledByAdmin()).thenReturn(is2gDisabledByAdmin);
mController.displayPreference(mPreferenceScreen);
}
}