Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit fb409567 authored by Daniel Perez's avatar Daniel Perez
Browse files

Add Backup & Restore Metrics for Sim settings. 

Bug: 379861078
Change-Id: I09c62595b618f28e3302815b15ebdfdd1a5a7172
Flag: com.android.server.backup.enable_metrics_settings_backup_agents
Tested: atest SettingsBackupAgentTest
parent 11611d23

packages/SettingsProvider/src/com/android/providers/settings/SettingsBackupAgent.java

+25 −3
Original line number Diff line number Diff line
@@ -214,6 +214,8 @@ public class SettingsBackupAgent extends BackupAgentHelper { 
        "failed_to_restore_softap_config";

    private static final String ERROR_FAILED_TO_RESTORE_WIFI_CONFIG =

        "failed_to_restore_wifi_config";

    private static final String ERROR_FAILED_TO_RESTORE_SIM_SPECIFIC_SETTINGS =

        "failed_to_restore_sim_specific_settings";





    // Name of the temporary file we use during full backup/restore.  This is
@@ -1592,7 +1594,8 @@ public class SettingsBackupAgent extends BackupAgentHelper { 
        return true;

    }



    private byte[] getSimSpecificSettingsData() {

    @VisibleForTesting

    byte[] getSimSpecificSettingsData() {

        byte[] simSpecificData = new byte[0];

        PackageManager packageManager = getBaseContext().getPackageManager();

        if (packageManager.hasSystemFeature(PackageManager.FEATURE_TELEPHONY)) {
@@ -1600,17 +1603,36 @@ public class SettingsBackupAgent extends BackupAgentHelper { 
            simSpecificData = subManager.getAllSimSpecificSettingsForBackup();

            Log.i(TAG, "sim specific data of length + " + simSpecificData.length

                + " successfully retrieved");

            if (areAgentMetricsEnabled) {

                // We're unable to determine how many settings this includes, so we'll just log 1.

                numberOfSettingsPerKey.put(KEY_SIM_SPECIFIC_SETTINGS_2, 1);

            }

        }



        return simSpecificData;

    }



    private void restoreSimSpecificSettings(byte[] data) {

    @VisibleForTesting

    void restoreSimSpecificSettings(byte[] data) {

        PackageManager packageManager = getBaseContext().getPackageManager();

        boolean hasTelephony = packageManager.hasSystemFeature(PackageManager.FEATURE_TELEPHONY);

        if (hasTelephony) {

            SubscriptionManager subManager = SubscriptionManager.from(getBaseContext());

            if (areAgentMetricsEnabled) {

                try {

                    subManager.restoreAllSimSpecificSettingsFromBackup(data);

                    mBackupRestoreEventLogger

                        .logItemsRestored(KEY_SIM_SPECIFIC_SETTINGS_2, /* count= */ 1);

                } catch (Exception e) {

                    mBackupRestoreEventLogger

                        .logItemsRestoreFailed(

                            KEY_SIM_SPECIFIC_SETTINGS_2,

                            /* count= */ 1,

                            ERROR_FAILED_TO_RESTORE_SIM_SPECIFIC_SETTINGS);

                }

            } else {

                subManager.restoreAllSimSpecificSettingsFromBackup(data);

            }

        }

    }

packages/SettingsProvider/test/src/com/android/providers/settings/SettingsBackupAgentTest.java

+70 −3
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ package com.android.providers.settings; 


import static com.android.providers.settings.SettingsBackupRestoreKeys.KEY_WIFI_NEW_CONFIG;

import static com.android.providers.settings.SettingsBackupRestoreKeys.KEY_SOFTAP_CONFIG;

import static com.android.providers.settings.SettingsBackupRestoreKeys.KEY_SIM_SPECIFIC_SETTINGS_2;



import static junit.framework.Assert.assertEquals;

import static junit.framework.Assert.assertNotNull;
@@ -59,6 +60,7 @@ import android.platform.test.flag.junit.SetFlagsRule; 
import android.provider.Settings;

import android.provider.settings.validators.SettingsValidators;

import android.provider.settings.validators.Validator;

import android.telephony.SubscriptionManager;

import android.test.mock.MockContentProvider;

import android.test.mock.MockContentResolver;
@@ -136,6 +138,7 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest { 
    @Mock private BackupDataInput mBackupDataInput;

    @Mock private BackupDataOutput mBackupDataOutput;

    @Mock private static WifiManager mWifiManager;

    @Mock private static SubscriptionManager mSubscriptionManager;



    private TestFriendlySettingsBackupAgent mAgentUnderTest;

    private Context mContext;
@@ -906,6 +909,66 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest { 
        assertNull(getLoggingResultForDatatype(KEY_WIFI_NEW_CONFIG, mAgentUnderTest));

    }



    @Test

    @EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)

    public void

        getSimSpecificSettingsData_agentMetricsAreEnabled_numberOfSettingsInKeyAreRecorded() {

        mAgentUnderTest.onCreate(

            UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.BACKUP);

        when(mSubscriptionManager.getAllSimSpecificSettingsForBackup()).thenReturn(new byte[0]);



        mAgentUnderTest.getSimSpecificSettingsData();



        assertEquals(mAgentUnderTest.getNumberOfSettingsPerKey(KEY_SIM_SPECIFIC_SETTINGS_2), 1);

    }



    @Test

    @EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)

    public void

        restoreSimSpecificSettings_agentMetricsAreEnabled_restoreIsSuccessful_successMetricsAreLogged() {

        mAgentUnderTest.onCreate(

            UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);

        doNothing().when(mSubscriptionManager).restoreAllSimSpecificSettingsFromBackup(any());



        mAgentUnderTest.restoreSimSpecificSettings(new byte[0]);



        DataTypeResult loggingResult =

            getLoggingResultForDatatype(KEY_SIM_SPECIFIC_SETTINGS_2, mAgentUnderTest);

        assertNotNull(loggingResult);

        assertEquals(loggingResult.getSuccessCount(), 1);

    }



    @Test

    @EnableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)

    public void

        restoreSimSpecificSettings_agentMetricsAreEnabled_restoreIsNotSuccessful_failureMetricsAreLogged() {

        mAgentUnderTest.onCreate(

            UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);

        doThrow(new RuntimeException())

            .when(mSubscriptionManager)

            .restoreAllSimSpecificSettingsFromBackup(any());



        mAgentUnderTest.restoreSimSpecificSettings(new byte[0]);



        DataTypeResult loggingResult =

            getLoggingResultForDatatype(KEY_SIM_SPECIFIC_SETTINGS_2, mAgentUnderTest);

        assertNotNull(loggingResult);

        assertEquals(loggingResult.getFailCount(), 1);

    }



    @Test

    @DisableFlags(com.android.server.backup.Flags.FLAG_ENABLE_METRICS_SETTINGS_BACKUP_AGENTS)

    public void

        restoreSimSpecificSettings_agentMetricsAreNotEnabled_metricsAreNotLogged() {

        mAgentUnderTest.onCreate(

            UserHandle.SYSTEM, BackupDestination.CLOUD, OperationType.RESTORE);

        doNothing().when(mSubscriptionManager).restoreAllSimSpecificSettingsFromBackup(any());



        mAgentUnderTest.restoreSimSpecificSettings(new byte[0]);



        assertNull(getLoggingResultForDatatype(KEY_SIM_SPECIFIC_SETTINGS_2, mAgentUnderTest));

    }



    private byte[] generateBackupData(Map<String, String> keyValueData) {

        int totalBytes = 0;

        for (String key : keyValueData.keySet()) {
@@ -1106,12 +1169,16 @@ public class SettingsBackupAgentTest extends BaseSettingsProviderTest { 


        @Override

        public Object getSystemService(String name) {

            if (name.equals(Context.WIFI_SERVICE)) {

            switch (name) {

                case Context.WIFI_SERVICE:

                    return mWifiManager;

            }

                case Context.TELEPHONY_SUBSCRIPTION_SERVICE:

                    return mSubscriptionManager;

                default:

                    return super.getSystemService(name);

            }

        }

    }



    /** ContentProvider which returns a set of known test values. */

    private static class DeviceSpecificInfoMockContentProvider extends MockContentProvider {