/* * 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.server.appsearch.contactsindexer; import static android.app.appsearch.testutil.AppSearchTestUtils.checkIsBatchResultSuccess; import static android.app.appsearch.testutil.AppSearchTestUtils.convertSearchResultsToDocuments; import static com.android.bedstead.harrier.UserType.WORK_PROFILE; import static com.android.bedstead.permissions.CommonPermissions.INTERACT_ACROSS_USERS_FULL; import static com.android.bedstead.permissions.CommonPermissions.WRITE_CONTACTS; import static com.android.server.appsearch.contactsindexer.appsearchtypes.ContactPoint.CONTACT_POINT_PROPERTY_ADDRESS; import static com.android.server.appsearch.contactsindexer.appsearchtypes.ContactPoint.CONTACT_POINT_PROPERTY_EMAIL; import static com.android.server.appsearch.contactsindexer.appsearchtypes.ContactPoint.CONTACT_POINT_PROPERTY_LABEL; import static com.android.server.appsearch.contactsindexer.appsearchtypes.ContactPoint.CONTACT_POINT_PROPERTY_TELEPHONE; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_ADDITIONAL_NAMES; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_ADDITIONAL_NAME_TYPES; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_AFFILIATIONS; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_CONTACT_POINTS; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_EXTERNAL_URI; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_FAMILY_NAME; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_GIVEN_NAME; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_IMAGE_URI; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_MIDDLE_NAME; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_NAME; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.PERSON_PROPERTY_NOTES; import static com.android.server.appsearch.contactsindexer.appsearchtypes.Person.TYPE_NICKNAME; import static com.google.common.truth.Truth.assertThat; import static org.junit.Assume.assumeTrue; import android.app.admin.PackagePolicy; import android.app.appsearch.AppSearchBatchResult; import android.app.appsearch.AppSearchManager; import android.app.appsearch.AppSearchSchema; import android.app.appsearch.AppSearchSession; import android.app.appsearch.AppSearchSessionShim; import android.app.appsearch.EnterpriseGlobalSearchSessionShim; import android.app.appsearch.GenericDocument; import android.app.appsearch.GetByDocumentIdRequest; import android.app.appsearch.GetSchemaResponse; import android.app.appsearch.GlobalSearchSessionShim; import android.app.appsearch.PutDocumentsRequest; import android.app.appsearch.SearchResultsShim; import android.app.appsearch.SearchSpec; import android.app.appsearch.SetSchemaRequest; import android.app.appsearch.observer.DocumentChangeInfo; import android.app.appsearch.observer.ObserverCallback; import android.app.appsearch.observer.ObserverSpec; import android.app.appsearch.observer.SchemaChangeInfo; import android.app.appsearch.testutil.AppSearchSessionShimImpl; import android.app.appsearch.testutil.EnterpriseGlobalSearchSessionShimImpl; import android.app.appsearch.testutil.GlobalSearchSessionShimImpl; import android.app.appsearch.testutil.TestContactsIndexerConfig; import android.content.ContentProviderOperation; import android.content.ContentProviderResult; import android.content.ContentResolver; import android.content.Context; import android.database.Cursor; import android.graphics.Bitmap; import android.net.Uri; import android.os.Build; import android.provider.ContactsContract; import androidx.annotation.NonNull; import androidx.test.core.app.ApplicationProvider; import com.android.bedstead.harrier.BedsteadJUnit4; import com.android.bedstead.harrier.DeviceState; import com.android.bedstead.permissions.annotations.EnsureHasPermission; import com.android.bedstead.enterprise.annotations.EnsureHasWorkProfile; import com.android.bedstead.nene.TestApis; import com.android.bedstead.remotedpc.RemoteDpc; import com.android.server.appsearch.contactsindexer.appsearchtypes.ContactPoint; import com.android.server.appsearch.contactsindexer.appsearchtypes.Person; import org.junit.After; import org.junit.Before; import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.runner.RunWith; import java.io.ByteArrayOutputStream; import java.util.ArrayList; import java.util.Arrays; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.CountDownLatch; import java.util.concurrent.Executor; import java.util.concurrent.Executors; import java.util.concurrent.TimeUnit; /** * These tests use Bedstead which is used to automatically set up a managed profile for testing. * By default, the profile allows "managed profile caller id" and "managed profile contacts" access, * but Bedstead also allows us to set these access policies through {@link RemoteDpc}. * *

These tests only require INTERACT_ACROSS_USERS_FULL to add contacts across profiles. * {@link android.app.appsearch.EnterpriseGlobalSearchSession} behaves the same regardless of this * permission. */ @EnsureHasPermission({INTERACT_ACROSS_USERS_FULL, WRITE_CONTACTS}) @EnsureHasWorkProfile @RunWith(BedsteadJUnit4.class) public class EnterpriseContactsTest { @ClassRule @Rule public static final DeviceState sDeviceState = new DeviceState(); private static final String TEST_ACCOUNT_TYPE = "AppSearchTestAccountType"; private static final String TEST_ACCOUNT_NAME = "AppSearchTestAccountName"; private static final long ENTERPRISE_CONTACT_ID_BASE = 1000000000; private final Executor mSingleThreadedExecutor = Executors.newSingleThreadExecutor(); // Enterprise profile private Context mContext; private AppSearchHelper mAppSearchHelper; private AppSearchSessionShim mDb; private ContactsIndexerConfig mConfigForTest = new TestContactsIndexerConfig(); // Main profile private EnterpriseGlobalSearchSessionShim mEnterpriseSession; @Before public void setUp() throws Exception { // Enterprise contacts are only supported on U+ due to needing U+ DevicePolicyManager APIs // to check managed profile contacts access assumeTrue(Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE); // Install the test package for the work profile, otherwise the test will fail while // performing any operations with the enterprise profile context. TestApis.packages().find(ApplicationProvider.getApplicationContext().getPackageName()) .installExisting(sDeviceState.workProfile()); // This is a context for the testing package under the work profile; it's not actually // possible to get a context for the "android" package in this way mContext = TestApis.context().androidContextAsUser(sDeviceState.workProfile()); // Set up AppSearch contacts in the managed profile mAppSearchHelper = AppSearchHelper.createAppSearchHelper(mContext, mSingleThreadedExecutor, mConfigForTest); // Call getSession() to ensure mAppSearchHelper has finished initializing AppSearchSession unused = mAppSearchHelper.getSession(); AppSearchManager.SearchContext searchContext = new AppSearchManager.SearchContext.Builder( AppSearchHelper.DATABASE_NAME).build(); mDb = AppSearchSessionShimImpl.createSearchSessionAsync(mContext, searchContext, Executors.newCachedThreadPool()).get(); // Main profile mEnterpriseSession = EnterpriseGlobalSearchSessionShimImpl .createEnterpriseGlobalSearchSessionAsync().get(); setUpEnterpriseContacts(); } @After public void tearDown() throws Exception { if (mDb != null) { // Wipe the data in AppSearchHelper.DATABASE_NAME. SetSchemaRequest setSchemaRequest = new SetSchemaRequest.Builder() .setForceOverride(true).build(); mDb.setSchemaAsync(setSchemaRequest).get(); } } private Person.Builder createPersonBuilder(String namespace, String id, String name) { return new Person.Builder(namespace, id, name) .setGivenName("givenName") .setMiddleName("middleName") .setFamilyName("familyName") .setExternalUri(Uri.parse("externalUri")) .setImageUri(Uri.parse("imageUri")) .setIsImportant(true) .setIsBot(true) .addAdditionalName(TYPE_NICKNAME, "nickname") .addAffiliation("affiliation") .addRelation("relation") .addNote("note"); } private void setUpEnterpriseContacts() throws Exception { // Index document Person person1 = createPersonBuilder("namespace", "123", "Sam1 Curran") .addContactPoint(new ContactPoint .Builder("namespace", "cp1", "contact1") .addEmail("person1@email.com") .addPhone("123456") .addAppId("appId1") .addAddress("address1") .build()) .build(); Person person2 = createPersonBuilder("namespace", "1234", "Sam2 Curran") .addContactPoint(new ContactPoint .Builder("namespace", "cp2", "contact2") .addEmail("person2@email.com") .addPhone("1234567") .addAppId("appId2") .addAddress("address2") .build()) .build(); Person person3 = createPersonBuilder("namespace", "12345", "Sam3 Curran") .addContactPoint(new ContactPoint .Builder("namespace", "cp3", "contact3") .addEmail("person3@email.com") .addPhone("12345678") .addAppId("appId3") .addAddress("address3") .build()) .build(); checkIsBatchResultSuccess(mDb.putAsync( new PutDocumentsRequest.Builder().addGenericDocuments(person1, person2, person3).build())); } @Test public void testGetEnterpriseContact() throws Exception { GetByDocumentIdRequest getDocumentRequest = new GetByDocumentIdRequest.Builder( "namespace").addIds("123").build(); AppSearchBatchResult getResult = mEnterpriseSession.getByDocumentIdAsync( ApplicationProvider.getApplicationContext().getPackageName(), AppSearchHelper.DATABASE_NAME, getDocumentRequest).get(); assertThat(getResult.isSuccess()).isTrue(); GenericDocument document = getResult.getSuccesses().get("123"); assertThat(document.getPropertyNames()).containsExactly(PERSON_PROPERTY_NAME, PERSON_PROPERTY_GIVEN_NAME, PERSON_PROPERTY_MIDDLE_NAME, PERSON_PROPERTY_FAMILY_NAME, PERSON_PROPERTY_EXTERNAL_URI, PERSON_PROPERTY_ADDITIONAL_NAME_TYPES, PERSON_PROPERTY_ADDITIONAL_NAMES, PERSON_PROPERTY_IMAGE_URI, PERSON_PROPERTY_CONTACT_POINTS); // Note, the imageUri and externalUri properties will not be rewritten by // EnterpriseSearchResultPageTransformer since this document does not come from the actual // AppSearch contacts corpus. assertThat(document.getPropertyString(PERSON_PROPERTY_NAME)).isEqualTo("Sam1 Curran"); assertThat(document.getPropertyString(PERSON_PROPERTY_GIVEN_NAME)).isEqualTo("givenName"); assertThat(document.getPropertyString(PERSON_PROPERTY_MIDDLE_NAME)).isEqualTo("middleName"); assertThat(document.getPropertyString(PERSON_PROPERTY_FAMILY_NAME)).isEqualTo("familyName"); assertThat(document.getPropertyString(PERSON_PROPERTY_EXTERNAL_URI)).isEqualTo( "externalUri"); assertThat(document.getPropertyLongArray( PERSON_PROPERTY_ADDITIONAL_NAME_TYPES)).asList().containsExactly( (long) TYPE_NICKNAME); assertThat(document.getPropertyStringArray( PERSON_PROPERTY_ADDITIONAL_NAMES)).asList().containsExactly("nickname"); assertThat(document.getPropertyString(Person.PERSON_PROPERTY_IMAGE_URI)).isEqualTo( "imageUri"); GenericDocument contactPoint = document.getPropertyDocumentArray( Person.PERSON_PROPERTY_CONTACT_POINTS)[0]; assertThat(contactPoint.getPropertyNames()).containsExactly(CONTACT_POINT_PROPERTY_LABEL, CONTACT_POINT_PROPERTY_EMAIL, CONTACT_POINT_PROPERTY_TELEPHONE); assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_LABEL)).isEqualTo( "contact1"); assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_EMAIL)).isEqualTo( "person1@email.com"); assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_TELEPHONE)).isEqualTo( "123456"); // Check projections were not overwritten across Binder assertThat(getDocumentRequest.getProjections()).isEmpty(); } @Test public void testGetEnterpriseContact_withProjection() throws Exception { GetByDocumentIdRequest getDocumentRequest = new GetByDocumentIdRequest.Builder( "namespace").addIds("123").addProjection(Person.SCHEMA_TYPE, Arrays.asList(PERSON_PROPERTY_NAME, PERSON_PROPERTY_ADDITIONAL_NAMES, PERSON_PROPERTY_CONTACT_POINTS + "." + CONTACT_POINT_PROPERTY_ADDRESS, PERSON_PROPERTY_CONTACT_POINTS + "." + CONTACT_POINT_PROPERTY_EMAIL)).build(); Map> projectionsCopy = getDocumentRequest.getProjections(); AppSearchBatchResult getResult = mEnterpriseSession.getByDocumentIdAsync( ApplicationProvider.getApplicationContext().getPackageName(), AppSearchHelper.DATABASE_NAME, getDocumentRequest).get(); assertThat(getResult.isSuccess()).isTrue(); GenericDocument document = getResult.getSuccesses().get("123"); assertThat(document.getPropertyNames()).containsExactly(PERSON_PROPERTY_NAME, PERSON_PROPERTY_CONTACT_POINTS, PERSON_PROPERTY_ADDITIONAL_NAMES); assertThat(document.getPropertyString(PERSON_PROPERTY_NAME)).isEqualTo("Sam1 Curran"); assertThat(document.getPropertyStringArray( PERSON_PROPERTY_ADDITIONAL_NAMES)).asList().containsExactly("nickname"); GenericDocument contactPoint = document.getPropertyDocumentArray( PERSON_PROPERTY_CONTACT_POINTS)[0]; assertThat(contactPoint.getPropertyNames()).containsExactly(CONTACT_POINT_PROPERTY_EMAIL); assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_EMAIL)).isEqualTo( "person1@email.com"); // CONTACT_POINT_PROPERTY_ADDRESS is not an accessible property assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_ADDRESS)).isNull(); // Check projections were not overwritten across Binder assertThat(getDocumentRequest.getProjections()).isEqualTo(projectionsCopy); } @Test public void testSearchEnterpriseContacts() throws Exception { SearchSpec spec = new SearchSpec.Builder() .setTermMatch(SearchSpec.TERM_MATCH_PREFIX) .addFilterNamespaces("namespace") .build(); SearchResultsShim searchResults = mEnterpriseSession.search("", spec); List documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).hasSize(3); for (GenericDocument document : documents) { assertThat(document.getPropertyNames()).containsExactly(PERSON_PROPERTY_NAME, PERSON_PROPERTY_GIVEN_NAME, PERSON_PROPERTY_MIDDLE_NAME, PERSON_PROPERTY_FAMILY_NAME, PERSON_PROPERTY_EXTERNAL_URI, PERSON_PROPERTY_ADDITIONAL_NAME_TYPES, PERSON_PROPERTY_ADDITIONAL_NAMES, PERSON_PROPERTY_IMAGE_URI, PERSON_PROPERTY_CONTACT_POINTS); GenericDocument contactPoint = document.getPropertyDocumentArray( Person.PERSON_PROPERTY_CONTACT_POINTS)[0]; assertThat(contactPoint.getPropertyNames()).containsExactly( CONTACT_POINT_PROPERTY_LABEL, CONTACT_POINT_PROPERTY_EMAIL, CONTACT_POINT_PROPERTY_TELEPHONE); } // Searching by indexed but inaccessible properties returns nothing searchResults = mEnterpriseSession.search("affiliation OR note OR address", spec); documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).isEmpty(); } @Test public void testSearchEnterpriseContacts_withProjection() throws Exception { SearchSpec spec = new SearchSpec.Builder() .setTermMatch(SearchSpec.TERM_MATCH_PREFIX) .addFilterNamespaces("namespace") .addProjection(Person.SCHEMA_TYPE, Arrays.asList(PERSON_PROPERTY_NAME, PERSON_PROPERTY_ADDITIONAL_NAMES, PERSON_PROPERTY_CONTACT_POINTS + "." + CONTACT_POINT_PROPERTY_ADDRESS, PERSON_PROPERTY_CONTACT_POINTS + "." + CONTACT_POINT_PROPERTY_EMAIL)) .build(); SearchResultsShim searchResults = mEnterpriseSession.search("", spec); List documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).hasSize(3); for (GenericDocument document : documents) { assertThat(document.getPropertyNames()).containsExactly(PERSON_PROPERTY_NAME, PERSON_PROPERTY_CONTACT_POINTS, PERSON_PROPERTY_ADDITIONAL_NAMES); GenericDocument contactPoint = document.getPropertyDocumentArray( Person.PERSON_PROPERTY_CONTACT_POINTS)[0]; assertThat(contactPoint.getPropertyNames()).containsExactly( CONTACT_POINT_PROPERTY_EMAIL); // CONTACT_POINT_PROPERTY_ADDRESS is not an accessible property assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_ADDRESS)).isNull(); } // Searching by indexed but inaccessible properties returns nothing searchResults = mEnterpriseSession.search("affiliation OR note OR address", spec); documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).isEmpty(); } @Test public void testSearchEnterpriseContacts_withFilter() throws Exception { SearchSpec spec = new SearchSpec.Builder() .setTermMatch(SearchSpec.TERM_MATCH_PREFIX) .addFilterNamespaces("namespace") .addFilterProperties(Person.SCHEMA_TYPE, Arrays.asList(PERSON_PROPERTY_NAME, PERSON_PROPERTY_ADDITIONAL_NAMES, PERSON_PROPERTY_AFFILIATIONS, PERSON_PROPERTY_NOTES)) .build(); // Searching by name returns results SearchResultsShim searchResults = mEnterpriseSession.search("Sam AND nickname", spec); List documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).hasSize(3); for (GenericDocument document : documents) { assertThat(document.getPropertyNames()).containsExactly(PERSON_PROPERTY_NAME, PERSON_PROPERTY_GIVEN_NAME, PERSON_PROPERTY_MIDDLE_NAME, PERSON_PROPERTY_FAMILY_NAME, PERSON_PROPERTY_EXTERNAL_URI, PERSON_PROPERTY_ADDITIONAL_NAME_TYPES, PERSON_PROPERTY_ADDITIONAL_NAMES, PERSON_PROPERTY_IMAGE_URI, PERSON_PROPERTY_CONTACT_POINTS); GenericDocument contactPoint = document.getPropertyDocumentArray( Person.PERSON_PROPERTY_CONTACT_POINTS)[0]; assertThat(contactPoint.getPropertyNames()).containsExactly( CONTACT_POINT_PROPERTY_LABEL, CONTACT_POINT_PROPERTY_EMAIL, CONTACT_POINT_PROPERTY_TELEPHONE); } // Searching by the filtered properties that are still inaccessible even when explicitly // set returns nothing searchResults = mEnterpriseSession.search("affiliation OR note OR address", spec); documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).isEmpty(); } @Test public void testEnterpriseContacts_canAccessWithOnlyContactsAccess() throws Exception { // Allowlist blocks all packages by default; blocklist allows all packages by default PackagePolicy allowlist = new PackagePolicy(PackagePolicy.PACKAGE_POLICY_ALLOWLIST); PackagePolicy blocklist = new PackagePolicy(PackagePolicy.PACKAGE_POLICY_BLOCKLIST); try (RemoteDpc remoteDpc = sDeviceState.profileOwner(WORK_PROFILE)) { remoteDpc.devicePolicyManager().setManagedProfileCallerIdAccessPolicy(allowlist); remoteDpc.devicePolicyManager().setManagedProfileContactsAccessPolicy(blocklist); // Verify we can get the Person schema GetSchemaResponse getSchemaResponse = mEnterpriseSession.getSchemaAsync("android", AppSearchHelper.DATABASE_NAME).get(); Set schemas = getSchemaResponse.getSchemas(); assertThat(schemas).hasSize(1); assertThat(schemas.iterator().next().getSchemaType()).isEqualTo(Person.SCHEMA_TYPE); SearchSpec spec = new SearchSpec.Builder() .setTermMatch(SearchSpec.TERM_MATCH_PREFIX) .addFilterNamespaces("namespace") .build(); SearchResultsShim searchResults = mEnterpriseSession.search("", spec); List documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).hasSize(3); } } @Test public void testEnterpriseContacts_canNotAccessWithoutContactsAccess() throws Exception { // Allowlist blocks all packages by default PackagePolicy allowlist = new PackagePolicy(PackagePolicy.PACKAGE_POLICY_ALLOWLIST); try (RemoteDpc remoteDpc = sDeviceState.profileOwner(WORK_PROFILE)) { remoteDpc.devicePolicyManager().setManagedProfileContactsAccessPolicy(allowlist); // Verify we can't get the Person schema GetSchemaResponse getSchemaResponse = mEnterpriseSession.getSchemaAsync("android", AppSearchHelper.DATABASE_NAME).get(); Set schemas = getSchemaResponse.getSchemas(); assertThat(schemas).isEmpty(); SearchSpec spec = new SearchSpec.Builder() .setTermMatch(SearchSpec.TERM_MATCH_PREFIX) .addFilterNamespaces("namespace") .build(); SearchResultsShim searchResults = mEnterpriseSession.search("", spec); List documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).isEmpty(); } } // TODO(b/323951275): We originally planned to support caller id access to enterprise contacts; // this test makes sure that it is currently not allowed access @Test public void testEnterpriseContacts_canNotAccessWithOnlyCallerIdAccess() throws Exception { // Allowlist blocks all packages by default; blocklist allows all packages by default PackagePolicy allowlist = new PackagePolicy(PackagePolicy.PACKAGE_POLICY_ALLOWLIST); PackagePolicy blocklist = new PackagePolicy(PackagePolicy.PACKAGE_POLICY_BLOCKLIST); try (RemoteDpc remoteDpc = sDeviceState.profileOwner(WORK_PROFILE)) { remoteDpc.devicePolicyManager().setManagedProfileCallerIdAccessPolicy(blocklist); remoteDpc.devicePolicyManager().setManagedProfileContactsAccessPolicy(allowlist); // Verify we can't get the Person schema GetSchemaResponse getSchemaResponse = mEnterpriseSession.getSchemaAsync("android", AppSearchHelper.DATABASE_NAME).get(); Set schemas = getSchemaResponse.getSchemas(); assertThat(schemas).isEmpty(); SearchSpec spec = new SearchSpec.Builder() .setTermMatch(SearchSpec.TERM_MATCH_PREFIX) .addFilterNamespaces("namespace") .build(); SearchResultsShim searchResults = mEnterpriseSession.search("", spec); List documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).isEmpty(); } } @Test public void testEnterpriseContactsInSystemPackage_transformPerson() throws Exception { // The other tests in this class test behavior against contacts indexed in the local // package. This test however creates a test contact in CP2 which will be indexed in the // android package. // Before inserting a test contact, clean up any test contacts that may not have been // previously deleted from CP2 ContentResolver resolver = mContext.getContentResolver(); cleanupTestContacts(resolver); Uri rawContactUri = insertTestContact(resolver); try { long contactId = getContactId(resolver, rawContactUri); String id = String.valueOf(contactId); // Register an ObserverCallback that will wait for the inserted contact to be indexed by // AppSearch GlobalSearchSessionShim globalSearchSession = GlobalSearchSessionShimImpl .createGlobalSearchSessionAsync(mContext).get(); CountDownLatch latch = new CountDownLatch(1); ObserverCallback callback = new ObserverCallback() { @Override public void onSchemaChanged(@NonNull SchemaChangeInfo changeInfo) { } @Override public void onDocumentChanged(@NonNull DocumentChangeInfo changeInfo) { // Callback will be registered for android package and Person schema, so we only // need to check database name and id here if (changeInfo.getDatabaseName().equals(AppSearchHelper.DATABASE_NAME) && changeInfo.getChangedDocumentIds().contains(id)) { latch.countDown(); } } }; globalSearchSession.registerObserverCallback("android", new ObserverSpec.Builder().addFilterSchemas(Person.SCHEMA_TYPE).build(), mSingleThreadedExecutor, callback); try { // Check if the contact was indexed since there's a potential race condition where // the contact was indexed before we registered the ObserverCallback GetByDocumentIdRequest getDocumentRequest = new GetByDocumentIdRequest.Builder( AppSearchHelper.NAMESPACE_NAME).addIds(id).build(); AppSearchBatchResult getResult = globalSearchSession.getByDocumentIdAsync("android", AppSearchHelper.DATABASE_NAME, getDocumentRequest).get(); if (getResult.getSuccesses().containsKey(id)) { latch.countDown(); } assertThat(latch.await(30, TimeUnit.SECONDS)).isTrue(); } finally { globalSearchSession.unregisterObserverCallback("android", callback); } // The retrieved document should have its imageUri and externalUri transformed GetByDocumentIdRequest getDocumentRequest = new GetByDocumentIdRequest.Builder( AppSearchHelper.NAMESPACE_NAME).addIds(id).build(); AppSearchBatchResult getResult = mEnterpriseSession.getByDocumentIdAsync("android", AppSearchHelper.DATABASE_NAME, getDocumentRequest).get(); assertThat(getResult.isSuccess()).isTrue(); GenericDocument document = getResult.getSuccesses().get(id); assertThat(document.getPropertyString(PERSON_PROPERTY_NAME)).isEqualTo("Test Contact"); assertThat(document.getPropertyString(PERSON_PROPERTY_EXTERNAL_URI)).isEqualTo( getCorpLookupUri(contactId)); assertThat(document.getPropertyString(Person.PERSON_PROPERTY_IMAGE_URI)).isEqualTo( getCorpImageUri(contactId)); GenericDocument contactPoint = document.getPropertyDocumentArray( Person.PERSON_PROPERTY_CONTACT_POINTS)[0]; assertThat(contactPoint.getPropertyNames()).containsExactly( CONTACT_POINT_PROPERTY_LABEL, CONTACT_POINT_PROPERTY_EMAIL, CONTACT_POINT_PROPERTY_TELEPHONE); assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_LABEL)).isEqualTo( "Work"); assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_EMAIL)).isEqualTo( "testcontact@email.com"); assertThat(contactPoint.getPropertyString(CONTACT_POINT_PROPERTY_TELEPHONE)).isEqualTo( "123456"); // Search for the contact this time and verify it's the same SearchSpec spec = new SearchSpec.Builder() .setTermMatch(SearchSpec.TERM_MATCH_PREFIX) .addFilterPackageNames("android") .addFilterNamespaces(AppSearchHelper.NAMESPACE_NAME) .addFilterSchemas(Person.SCHEMA_TYPE) .build(); SearchResultsShim searchResults = mEnterpriseSession.search("Test Contact", spec); List documents = convertSearchResultsToDocuments(searchResults); assertThat(documents).contains(document); } finally { // Delete the raw contact; this will delete the associated contact as well since it only // has this one raw contact assertThat(resolver.delete(rawContactUri, null, null)).isEqualTo(1); } } /** Deletes all raw contacts belonging to this test. */ private void cleanupTestContacts(ContentResolver resolver) { String where = ContactsContract.RawContacts.ACCOUNT_TYPE + " = '" + TEST_ACCOUNT_TYPE + "' AND " + ContactsContract.RawContacts.ACCOUNT_NAME + " = '" + TEST_ACCOUNT_NAME + "'"; resolver.delete(ContactsContract.RawContacts.CONTENT_URI, where, /* selectionArgs= */ null); } /** Inserts a test contact and returns a Uri that points to its raw contact. */ private Uri insertTestContact(ContentResolver resolver) throws Exception { ArrayList ops = new ArrayList<>(); // Insert a raw contact; this will create a contact linked to this raw contact ops.add(ContentProviderOperation.newInsert(ContactsContract.RawContacts.CONTENT_URI) .withValue(ContactsContract.RawContacts.ACCOUNT_TYPE, TEST_ACCOUNT_TYPE) .withValue(ContactsContract.RawContacts.ACCOUNT_NAME, TEST_ACCOUNT_NAME) .build()); // Insert a display name connected with the raw contact created above ops.add(ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI) .withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0) .withValue(ContactsContract.Contacts.Data.MIMETYPE, ContactsContract.CommonDataKinds.StructuredName.CONTENT_ITEM_TYPE) .withValue(ContactsContract.CommonDataKinds.StructuredName.DISPLAY_NAME, "Test Contact") .build()); // Insert a phone number connected with the raw contact created above ops.add(ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI) .withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0) .withValue(ContactsContract.Contacts.Data.MIMETYPE, ContactsContract.CommonDataKinds.Phone.CONTENT_ITEM_TYPE) .withValue(ContactsContract.CommonDataKinds.Phone.NUMBER, "123456") .withValue(ContactsContract.CommonDataKinds.Phone.TYPE, ContactsContract.CommonDataKinds.Phone.TYPE_WORK) .build()); // Insert an email connected with the raw contact created above ops.add(ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI) .withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0) .withValue(ContactsContract.Contacts.Data.MIMETYPE, ContactsContract.CommonDataKinds.Email.CONTENT_ITEM_TYPE) .withValue(ContactsContract.CommonDataKinds.Email.ADDRESS, "testcontact@email.com") .withValue(ContactsContract.CommonDataKinds.Email.TYPE, ContactsContract.CommonDataKinds.Email.TYPE_WORK) .build()); // Insert a 1x1 empty bitmap as the photo connected with the raw contact created above Bitmap bmp = Bitmap.createBitmap(1, 1, Bitmap.Config.ARGB_8888); ByteArrayOutputStream stream = new ByteArrayOutputStream(); bmp.compress(Bitmap.CompressFormat.JPEG, 0, stream); byte[] byteArray = stream.toByteArray(); ops.add(ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI) .withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0) .withValue(ContactsContract.Contacts.Data.MIMETYPE, ContactsContract.CommonDataKinds.Photo.CONTENT_ITEM_TYPE) .withValue(ContactsContract.CommonDataKinds.Photo.PHOTO, byteArray) .build()); ContentProviderResult[] results = resolver.applyBatch(ContactsContract.AUTHORITY, ops); // The uri pointing to the created raw contact return results[0].uri; } /** Returns the id of the contact linked to the given raw contact. **/ private long getContactId(ContentResolver resolver, Uri rawContactUri) { String[] projection = new String[] { ContactsContract.RawContacts.CONTACT_ID }; try (Cursor cursor = resolver.query(rawContactUri, projection, /*selection=*/ null, /*selectionArgs=*/ null, /*sortOrder=*/ null)) { assertThat(cursor).isNotNull(); assertThat(cursor.moveToNext()).isTrue(); return cursor.getLong(0); } } /** Returns the corp lookup uri of the given contact through enterprise contacts CP2. */ private String getCorpLookupUri(long contactId) { ContentResolver resolver = ApplicationProvider.getApplicationContext().getContentResolver(); long enterpriseId = ENTERPRISE_CONTACT_ID_BASE + contactId; String[] projection = new String[] { ContactsContract.Data.LOOKUP_KEY }; String selection = ContactsContract.Contacts._ID + " = " + contactId; try (Cursor cursor = resolver.query(ContactsContract.Contacts.ENTERPRISE_CONTENT_URI, projection, selection, /*selectionArgs=*/ null, /*sortOrder=*/ null)) { assertThat(cursor).isNotNull(); assertThat(cursor.moveToNext()).isTrue(); return ContactsContract.Contacts.getLookupUri(enterpriseId, cursor.getString(0)).toString(); } } /** Returns the corp image uri of the given contact through enterprise contacts CP2. */ private String getCorpImageUri(long contactId) { ContentResolver resolver = ApplicationProvider.getApplicationContext().getContentResolver(); String[] projection = new String[] { ContactsContract.Data.PHOTO_THUMBNAIL_URI }; String selection = ContactsContract.Contacts._ID + " = " + contactId; try (Cursor cursor = resolver.query(ContactsContract.Contacts.ENTERPRISE_CONTENT_URI, projection, selection, /*selectionArgs=*/ null, /*sortOrder=*/ null)) { assertThat(cursor).isNotNull(); assertThat(cursor.moveToNext()).isTrue(); return cursor.getString(0); } } }