From 6231453e914da015c719aff2c3e3acba8653bfdd Mon Sep 17 00:00:00 2001
From: Dongzhuo Zhang <dongzhuozhang@google.com>
Date: Tue, 24 Sep 2024 22:28:22 +0000
Subject: [PATCH] Add contacts storage setting entry in app settings page.

Test: atest SettingsRoboTests:com.android.settings.applications.contacts.ContactsStoragePreferenceControllerTest

Bug: 368641291
Flag: com.android.settings.flags.enable_contacts_default_account_in_settings

Change-Id: I8da16f24b17e44dc0ea417cffabd85c36d7edc5f
---
 res/values/strings.xml                        |   7 +
 res/xml/apps.xml                              |   9 +
 .../ContactsStoragePreferenceController.java  |  68 ++++++++
 ...ntactsStoragePreferenceControllerTest.java | 162 ++++++++++++++++++
 4 files changed, 246 insertions(+)
 create mode 100644 src/com/android/settings/applications/contacts/ContactsStoragePreferenceController.java
 create mode 100644 tests/robotests/src/com/android/settings/applications/contacts/ContactsStoragePreferenceControllerTest.java

diff --git a/res/values/strings.xml b/res/values/strings.xml
index fb95aa3bd39..85d3fadecdc 100644
--- a/res/values/strings.xml
+++ b/res/values/strings.xml
@@ -13668,4 +13668,11 @@
 
     <!-- Text for Search bar of Settings home screen [CHAR LIMIT=34] -->
     <string name="homepage_search">Search Settings</string>
+
+    <!-- Keywords for contacts storage item [CHAR LIMIT=NONE] -->
+    <string name="keywords_contacts_storage">contacts, storage, account</string>
+    <!-- Text for Contacts Storage Settings title [CHAR LIMIT=50]-->
+    <string name="contacts_storage_settings_title">Contacts storage</string>
+    <!-- Text for displaying when no account is set as default account [CHAR LIMIT=50] -->
+    <string name="contacts_storage_no_account_set">No default set</string>
 </resources>
diff --git a/res/xml/apps.xml b/res/xml/apps.xml
index 2ffd0b1eaba..a66cea3d698 100644
--- a/res/xml/apps.xml
+++ b/res/xml/apps.xml
@@ -79,6 +79,15 @@
         android:key="dashboard_tile_placeholder"
         android:order="10"/>
 
+    <Preference
+        android:key="contacts_storage"
+        android:title="@string/contacts_storage_settings_title"
+        android:summary="@string/summary_placeholder"
+        android:order="13"
+        settings:controller="com.android.settings.applications.contacts.ContactsStoragePreferenceController"
+        settings:keywords="@string/keywords_contacts_storage">
+    </Preference>
+
     <Preference
         android:key="hibernated_apps"
         android:title="@string/unused_apps"
diff --git a/src/com/android/settings/applications/contacts/ContactsStoragePreferenceController.java b/src/com/android/settings/applications/contacts/ContactsStoragePreferenceController.java
new file mode 100644
index 00000000000..bc6931de466
--- /dev/null
+++ b/src/com/android/settings/applications/contacts/ContactsStoragePreferenceController.java
@@ -0,0 +1,68 @@
+
+/*
+ * 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.applications.contacts;
+
+import android.accounts.Account;
+import android.content.Context;
+import android.os.UserHandle;
+import android.provider.ContactsContract;
+
+import androidx.preference.PreferenceScreen;
+
+import com.android.settings.R;
+import com.android.settings.core.BasePreferenceController;
+import com.android.settings.flags.Flags;
+import com.android.settingslib.accounts.AuthenticatorHelper;
+
+/**
+ * A preference controller handling the logic for updating summary of contacts default account.
+ */
+public class ContactsStoragePreferenceController extends BasePreferenceController {
+    private static final String TAG = "ContactsStorageController";
+
+    private final AuthenticatorHelper mAuthenticatorHelper;
+
+    public ContactsStoragePreferenceController(Context context, String preferenceKey) {
+        super(context, preferenceKey);
+        mAuthenticatorHelper = new AuthenticatorHelper(mContext,
+                new UserHandle(UserHandle.myUserId()), null);
+    }
+
+    @Override
+    public int getAvailabilityStatus() {
+        return Flags.enableContactsDefaultAccountInSettings()
+            ? AVAILABLE : CONDITIONALLY_UNAVAILABLE;
+    }
+
+    @Override
+    public CharSequence getSummary() {
+        Account currentDefaultAccount =
+                ContactsContract.Settings.getDefaultAccount(mContext.getContentResolver());
+        if (currentDefaultAccount == null) {
+            return mContext.getResources().getString(
+                    R.string.contacts_storage_no_account_set);
+        }
+        String accountTypeLabel = (String) mAuthenticatorHelper.getLabelForType(mContext,
+                currentDefaultAccount.type);
+        // If there's no account type, or the account type is the same as the
+        // current default account name, just return the account name.
+        if (accountTypeLabel == null || accountTypeLabel.equals(currentDefaultAccount.name)) {
+            return currentDefaultAccount.name;
+        }
+        return accountTypeLabel + " | " + currentDefaultAccount.name;
+    }
+}
diff --git a/tests/robotests/src/com/android/settings/applications/contacts/ContactsStoragePreferenceControllerTest.java b/tests/robotests/src/com/android/settings/applications/contacts/ContactsStoragePreferenceControllerTest.java
new file mode 100644
index 00000000000..a934cba9a3c
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/applications/contacts/ContactsStoragePreferenceControllerTest.java
@@ -0,0 +1,162 @@
+/*
+ * 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.applications.contacts;
+
+import static android.provider.ContactsContract.Settings.KEY_DEFAULT_ACCOUNT;
+import static android.provider.ContactsContract.Settings.QUERY_DEFAULT_ACCOUNT_METHOD;
+
+import static com.android.settings.core.BasePreferenceController.AVAILABLE;
+import static com.android.settings.core.BasePreferenceController.CONDITIONALLY_UNAVAILABLE;
+import static com.google.common.truth.Truth.assertThat;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyInt;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.when;
+
+
+import android.accounts.Account;
+import android.accounts.AccountManager;
+import android.content.ContentResolver;
+import android.content.Context;
+import android.content.res.Resources;
+import android.os.Bundle;
+import android.platform.test.annotations.EnableFlags;
+import android.platform.test.flag.junit.SetFlagsRule;
+import android.provider.ContactsContract;
+
+import com.android.settings.R;
+import com.android.settings.flags.Flags;
+import com.android.settings.testutils.shadow.ShadowAuthenticationHelper;
+
+import org.junit.Before;
+import android.platform.test.annotations.RequiresFlagsDisabled;
+import android.platform.test.flag.junit.CheckFlagsRule;
+import android.platform.test.flag.junit.DeviceFlagsValueProvider;
+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;
+import org.robolectric.annotation.Config;
+
+@RunWith(RobolectricTestRunner.class)
+@Config(shadows = ShadowAuthenticationHelper.class)
+public class ContactsStoragePreferenceControllerTest {
+
+    private static final String CONTACTS_DEFAULT_ACCOUNT_PREFERENCE_KEY =
+            "contacts_default_account";
+    private static final Account TEST_ACCOUNT1 = new Account("test@gmail.com", "type1");
+
+    private static final Account TEST_ACCOUNT2 = new Account("test@samsung.com", "type2");
+
+    private static final Account TEST_ACCOUNT3 = new Account("LABEL3", "type3");
+
+    @Rule
+    public final MockitoRule mockito = MockitoJUnit.rule();
+
+    @Rule
+    public final CheckFlagsRule mCheckFlagsRule = DeviceFlagsValueProvider.createCheckFlagsRule();
+
+    @Rule
+    public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
+
+    @Mock
+    private Context mContext;
+
+    @Mock
+    private ContentResolver mContentResolver;
+
+    @Mock
+    private Resources mResources;
+
+    @Mock
+    private AccountManager mAccountManager;
+
+    private ContactsStoragePreferenceController mPreferenceController;
+
+    @Before
+    public void setUp() throws Exception {
+        when(mContext.getContentResolver()).thenReturn(mContentResolver);
+        when(mContext.getSystemService(eq(Context.ACCOUNT_SERVICE))).thenReturn(mAccountManager);
+        when(mAccountManager.getAccountsAsUser(anyInt())).thenReturn(new Account[]{});
+
+        mPreferenceController = new ContactsStoragePreferenceController(mContext,
+                CONTACTS_DEFAULT_ACCOUNT_PREFERENCE_KEY);
+    }
+
+    @Test
+    @EnableFlags(Flags.FLAG_ENABLE_CONTACTS_DEFAULT_ACCOUNT_IN_SETTINGS)
+    public void getAvailabilityStatus_flagIsOn_shouldReturnAvailable() {
+
+        assertThat(mPreferenceController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
+    }
+
+    @Test
+    @RequiresFlagsDisabled(Flags.FLAG_ENABLE_CONTACTS_DEFAULT_ACCOUNT_IN_SETTINGS)
+    public void getAvailabilityStatus_flagIsOff_shouldReturnConditionallyUnavailable() {
+
+        assertThat(mPreferenceController.getAvailabilityStatus()).isEqualTo(
+                CONDITIONALLY_UNAVAILABLE);
+    }
+
+    @Test
+    public void getSummary_noAccountIsSetAsDefault_shouldReturnNoAccountSetSummary() {
+        Bundle bundle = new Bundle();
+        bundle.putParcelable(KEY_DEFAULT_ACCOUNT, null);
+        when(mContentResolver.call(eq(ContactsContract.AUTHORITY_URI),
+                eq(QUERY_DEFAULT_ACCOUNT_METHOD), any(), any())).thenReturn(bundle);
+        when(mContext.getResources()).thenReturn(mResources);
+        when(mResources.getString(eq(R.string.contacts_storage_no_account_set))).thenReturn(
+                "No default set");
+
+        assertThat(mPreferenceController.getSummary()).isEqualTo("No default set");
+    }
+
+    @Test
+    public void getSummary_googleAccountIsSetAsDefault_shouldReturnGoogleAccountTypeAndAccountName() {
+        Bundle bundle = new Bundle();
+        bundle.putParcelable(KEY_DEFAULT_ACCOUNT, TEST_ACCOUNT1);
+        when(mContentResolver.call(eq(ContactsContract.AUTHORITY_URI),
+                eq(QUERY_DEFAULT_ACCOUNT_METHOD), any(), any())).thenReturn(bundle);
+
+        assertThat(mPreferenceController.getSummary()).isEqualTo("LABEL1 | test@gmail.com");
+    }
+
+    @Test
+    public void getSummary_samsungAccountIsSetAsDefault_shouldReturnSamsungAccountTypeAndAccountName() {
+        Bundle bundle = new Bundle();
+        bundle.putParcelable(KEY_DEFAULT_ACCOUNT, TEST_ACCOUNT2);
+        when(mContentResolver.call(eq(ContactsContract.AUTHORITY_URI),
+                eq(QUERY_DEFAULT_ACCOUNT_METHOD), any(), any())).thenReturn(bundle);
+
+        assertThat(mPreferenceController.getSummary()).isEqualTo("LABEL2 | test@samsung.com");
+    }
+
+    @Test
+    public void getSummary_accountLabelSameAsAccountName_onlyReturnAccountName() {
+        Bundle bundle = new Bundle();
+        bundle.putParcelable(KEY_DEFAULT_ACCOUNT, TEST_ACCOUNT3);
+        when(mContentResolver.call(eq(ContactsContract.AUTHORITY_URI),
+                eq(QUERY_DEFAULT_ACCOUNT_METHOD), any(), any())).thenReturn(bundle);
+
+        // Since package name and account name is the same, we only return account name.
+        assertThat(mPreferenceController.getSummary()).isEqualTo("LABEL3");
+    }
+}