Add a footer to Location Settings page
At the bottom of Settings -> Security & Location -> Location, inject footers with text provided by system apps. GmsCore uses this footer to present legal consent info for Google Location Services. Bug: 70350519 Test: Robo Test: Manual Change-Id: I201afdb30baa7b81b591d161fce5be55569b6320
This commit is contained in:
Maggie
@@ -0,0 +1,220 @@
|
||||
/*
|
||||
* Copyright (C) 2018 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.location;
|
||||
|
||||
import static com.google.common.truth.Truth.assertThat;
|
||||
import static org.mockito.Matchers.any;
|
||||
import static org.mockito.Matchers.anyInt;
|
||||
import static org.mockito.Mockito.doNothing;
|
||||
import static org.mockito.Mockito.never;
|
||||
import static org.mockito.Mockito.spy;
|
||||
import static org.mockito.Mockito.times;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
import android.arch.lifecycle.LifecycleOwner;
|
||||
import android.content.ComponentName;
|
||||
import android.content.Context;
|
||||
import android.content.Intent;
|
||||
import android.content.pm.ActivityInfo;
|
||||
import android.content.pm.ApplicationInfo;
|
||||
import android.content.pm.PackageManager;
|
||||
import android.content.pm.PackageManager.NameNotFoundException;
|
||||
import android.content.pm.ResolveInfo;
|
||||
import android.content.res.Resources;
|
||||
import android.location.LocationManager;
|
||||
import android.os.Bundle;
|
||||
import android.support.v7.preference.Preference;
|
||||
import android.support.v7.preference.PreferenceCategory;
|
||||
import com.android.settings.TestConfig;
|
||||
import com.android.settings.testutils.SettingsRobolectricTestRunner;
|
||||
import com.android.settingslib.core.lifecycle.Lifecycle;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.ArgumentCaptor;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.MockitoAnnotations;
|
||||
import org.robolectric.RuntimeEnvironment;
|
||||
import org.robolectric.annotation.Config;
|
||||
|
||||
/** Unit tests for {@link LocationFooterPreferenceController} */
|
||||
@RunWith(SettingsRobolectricTestRunner.class)
|
||||
@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
|
||||
public class LocationFooterPreferenceControllerTest {
|
||||
|
||||
@Mock
|
||||
private PreferenceCategory mPreferenceCategory;
|
||||
@Mock
|
||||
private PackageManager mPackageManager;
|
||||
@Mock
|
||||
private Resources mResources;
|
||||
private Context mContext;
|
||||
private LocationFooterPreferenceController mController;
|
||||
private LifecycleOwner mLifecycleOwner;
|
||||
private Lifecycle mLifecycle;
|
||||
private static final int TEST_RES_ID = 1234;
|
||||
private static final String TEST_TEXT = "text";
|
||||
|
||||
@Before
|
||||
public void setUp() throws NameNotFoundException {
|
||||
MockitoAnnotations.initMocks(this);
|
||||
mContext = spy(RuntimeEnvironment.application);
|
||||
when(mContext.getPackageManager()).thenReturn(mPackageManager);
|
||||
mLifecycleOwner = () -> mLifecycle;
|
||||
mLifecycle = new Lifecycle(mLifecycleOwner);
|
||||
when(mPreferenceCategory.getContext()).thenReturn(mContext);
|
||||
mController = spy(new LocationFooterPreferenceController(mContext, mLifecycle));
|
||||
when(mPackageManager.getResourcesForApplication(any(ApplicationInfo.class)))
|
||||
.thenReturn(mResources);
|
||||
when(mResources.getString(TEST_RES_ID)).thenReturn(TEST_TEXT);
|
||||
doNothing().when(mPreferenceCategory).removeAll();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isAvailable_hasValidFooter_returnsTrue() throws NameNotFoundException {
|
||||
final List<ResolveInfo> testResolveInfos = new ArrayList<>();
|
||||
testResolveInfos.add(
|
||||
getTestResolveInfo(/*isSystemApp*/ true, /*hasRequiredMetadata*/ true));
|
||||
when(mPackageManager.queryBroadcastReceivers(any(Intent.class), anyInt()))
|
||||
.thenReturn(testResolveInfos);
|
||||
|
||||
assertThat(mController.isAvailable()).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isAvailable_noSystemApp_returnsFalse() throws NameNotFoundException {
|
||||
final List<ResolveInfo> testResolveInfos = new ArrayList<>();
|
||||
testResolveInfos.add(
|
||||
getTestResolveInfo(/*isSystemApp*/ false, /*hasRequiredMetadata*/ true));
|
||||
when(mPackageManager.queryBroadcastReceivers(any(Intent.class), anyInt()))
|
||||
.thenReturn(testResolveInfos);
|
||||
assertThat(mController.isAvailable()).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isAvailable_noRequiredMetadata_returnsFalse() throws NameNotFoundException {
|
||||
final List<ResolveInfo> testResolveInfos = new ArrayList<>();
|
||||
testResolveInfos.add(
|
||||
getTestResolveInfo(/*isSystemApp*/ true, /*hasRequiredMetadata*/ false));
|
||||
when(mPackageManager.queryBroadcastReceivers(any(Intent.class), anyInt()))
|
||||
.thenReturn(testResolveInfos);
|
||||
assertThat(mController.isAvailable()).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void sendBroadcastFooterInject() {
|
||||
ArgumentCaptor<Intent> intent = ArgumentCaptor.forClass(Intent.class);
|
||||
final ActivityInfo activityInfo =
|
||||
getTestResolveInfo(/*isSystemApp*/ true, /*hasRequiredMetadata*/ true).activityInfo;
|
||||
mController.sendBroadcastFooterDisplayed(
|
||||
new ComponentName(activityInfo.packageName, activityInfo.name));
|
||||
verify(mContext).sendBroadcast(intent.capture());
|
||||
assertThat(intent.getValue().getAction())
|
||||
.isEqualTo(LocationManager.SETTINGS_FOOTER_DISPLAYED_ACTION);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void updateState_sendBroadcast() throws NameNotFoundException {
|
||||
final List<ResolveInfo> testResolveInfos = new ArrayList<>();
|
||||
testResolveInfos.add(
|
||||
getTestResolveInfo(/*isSystemApp*/ true, /*hasRequiredMetadata*/ true));
|
||||
when(mPackageManager.queryBroadcastReceivers(any(), anyInt()))
|
||||
.thenReturn(testResolveInfos);
|
||||
mController.updateState(mPreferenceCategory);
|
||||
ArgumentCaptor<Intent> intent = ArgumentCaptor.forClass(Intent.class);
|
||||
verify(mContext).sendBroadcast(intent.capture());
|
||||
assertThat(intent.getValue().getAction())
|
||||
.isEqualTo(LocationManager.SETTINGS_FOOTER_DISPLAYED_ACTION);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void updateState_addPreferences() throws NameNotFoundException {
|
||||
final List<ResolveInfo> testResolveInfos = new ArrayList<>();
|
||||
testResolveInfos.add(
|
||||
getTestResolveInfo(/*isSystemApp*/ true, /*hasRequiredMetadata*/ true));
|
||||
when(mPackageManager.queryBroadcastReceivers(any(Intent.class), anyInt()))
|
||||
.thenReturn(testResolveInfos);
|
||||
mController.updateState(mPreferenceCategory);
|
||||
ArgumentCaptor<Preference> pref = ArgumentCaptor.forClass(Preference.class);
|
||||
verify(mPreferenceCategory).addPreference(pref.capture());
|
||||
assertThat(pref.getValue().getTitle()).isEqualTo(TEST_TEXT);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void updateState_notSystemApp_ignore() throws NameNotFoundException {
|
||||
final List<ResolveInfo> testResolveInfos = new ArrayList<>();
|
||||
testResolveInfos.add(
|
||||
getTestResolveInfo(/*isSystemApp*/ false, /*hasRequiredMetadata*/ true));
|
||||
when(mPackageManager.queryBroadcastReceivers(any(Intent.class), anyInt()))
|
||||
.thenReturn(testResolveInfos);
|
||||
mController.updateState(mPreferenceCategory);
|
||||
verify(mPreferenceCategory, never()).addPreference(any(Preference.class));
|
||||
verify(mContext, never()).sendBroadcast(any(Intent.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void updateState_thenOnPause_sendBroadcasts() throws NameNotFoundException {
|
||||
final List<ResolveInfo> testResolveInfos = new ArrayList<>();
|
||||
testResolveInfos.add(
|
||||
getTestResolveInfo(/*isSystemApp*/ true, /*hasRequiredMetadata*/ true));
|
||||
when(mPackageManager.queryBroadcastReceivers(any(Intent.class), anyInt()))
|
||||
.thenReturn(testResolveInfos);
|
||||
mController.updateState(mPreferenceCategory);
|
||||
ArgumentCaptor<Intent> intent = ArgumentCaptor.forClass(Intent.class);
|
||||
verify(mContext).sendBroadcast(intent.capture());
|
||||
assertThat(intent.getValue().getAction())
|
||||
.isEqualTo(LocationManager.SETTINGS_FOOTER_DISPLAYED_ACTION);
|
||||
|
||||
mController.onPause();
|
||||
verify(mContext, times(2)).sendBroadcast(intent.capture());
|
||||
assertThat(intent.getValue().getAction())
|
||||
.isEqualTo(LocationManager.SETTINGS_FOOTER_REMOVED_ACTION);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void onPause_doNotSendBroadcast() {
|
||||
mController.onPause();
|
||||
verify(mContext, never()).sendBroadcast(any(Intent.class));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a ResolveInfo object for testing
|
||||
* @param isSystemApp If true, the application is a system app.
|
||||
* @param hasRequiredMetaData If true, the broadcast receiver has a valid value for
|
||||
* {@link LocationManager#METADATA_SETTINGS_FOOTER_STRING}
|
||||
*/
|
||||
private ResolveInfo getTestResolveInfo(boolean isSystemApp, boolean hasRequiredMetaData) {
|
||||
ResolveInfo testResolveInfo = new ResolveInfo();
|
||||
ApplicationInfo testAppInfo = new ApplicationInfo();
|
||||
if (isSystemApp) {
|
||||
testAppInfo.flags |= ApplicationInfo.FLAG_SYSTEM;
|
||||
}
|
||||
ActivityInfo testActivityInfo = new ActivityInfo();
|
||||
testActivityInfo.name = "TestActivityName";
|
||||
testActivityInfo.packageName = "TestPackageName";
|
||||
testActivityInfo.applicationInfo = testAppInfo;
|
||||
if (hasRequiredMetaData) {
|
||||
testActivityInfo.metaData = new Bundle();
|
||||
testActivityInfo.metaData.putInt(
|
||||
LocationManager.METADATA_SETTINGS_FOOTER_STRING, TEST_RES_ID);
|
||||
}
|
||||
testResolveInfo.activityInfo = testActivityInfo;
|
||||
return testResolveInfo;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user