Merge changes from topic "DevOptionsDebugger"

* changes:
  Introduce WaitForDebuggerPreferenceController
  Introduce SelectDebugAppPreferenceController
This commit is contained in:
Jeffrey Huang
2017-09-27 17:03:09 +00:00
committed by Android (Google) Code Review
6 changed files with 620 additions and 7 deletions

View File

@@ -21,4 +21,6 @@ package com.android.settings.development;
*/
public interface DevelopmentOptionsActivityRequestCodes {
int REQUEST_CODE_ENABLE_OEM_UNLOCK = 0;
int REQUEST_CODE_DEBUG_APP = 1;
}

View File

@@ -122,15 +122,19 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
boolean handledResult = false;
for (AbstractPreferenceController controller : mPreferenceControllers) {
if (controller instanceof DeveloperOptionsPreferenceController) {
if (((DeveloperOptionsPreferenceController) controller).onActivityResult(
requestCode, resultCode, data)) {
return;
}
// We do not break early because it is possible for multiple controllers to
// handle the same result code.
handledResult |=
((DeveloperOptionsPreferenceController) controller).onActivityResult(
requestCode, resultCode, data);
}
}
super.onActivityResult(requestCode, resultCode, data);
if (!handledResult) {
super.onActivityResult(requestCode, resultCode, data);
}
}
@Override
@@ -193,8 +197,8 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
// bug report shortcut
// select mock location app
controllers.add(new DebugViewAttributesPreferenceController(context));
// select debug app
// wait for debugger
controllers.add(new SelectDebugAppPreferenceController(context, fragment));
controllers.add(new WaitForDebuggerPreferenceController(context));
// verify apps over usb
// logger buffer sizes
// store logger data persistently on device

View File

@@ -0,0 +1,132 @@
/*
* Copyright (C) 2017 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.development;
import static com.android.settings.development.DevelopmentOptionsActivityRequestCodes
.REQUEST_CODE_DEBUG_APP;
import android.app.Activity;
import android.content.Context;
import android.content.Intent;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager;
import android.provider.Settings;
import android.support.annotation.VisibleForTesting;
import android.support.v7.preference.Preference;
import android.support.v7.preference.PreferenceScreen;
import com.android.settings.R;
import com.android.settingslib.wrapper.PackageManagerWrapper;
public class SelectDebugAppPreferenceController extends DeveloperOptionsPreferenceController {
private static final String DEBUG_APP_KEY = "debug_app";
private final DevelopmentSettingsDashboardFragment mFragment;
private final PackageManagerWrapper mPackageManager;
private Preference mPreference;
public SelectDebugAppPreferenceController(Context context,
DevelopmentSettingsDashboardFragment fragment) {
super(context);
mFragment = fragment;
mPackageManager = new PackageManagerWrapper(mContext.getPackageManager());
}
@Override
public boolean isAvailable() {
return true;
}
@Override
public String getPreferenceKey() {
return DEBUG_APP_KEY;
}
@Override
public void displayPreference(PreferenceScreen screen) {
super.displayPreference(screen);
mPreference = screen.findPreference(getPreferenceKey());
}
@Override
public boolean handlePreferenceTreeClick(Preference preference) {
if (DEBUG_APP_KEY.equals(preference.getKey())) {
final Intent intent = getActivityStartIntent();
intent.putExtra(AppPicker.EXTRA_DEBUGGABLE, true /* value */);
mFragment.startActivityForResult(intent, REQUEST_CODE_DEBUG_APP);
return true;
}
return false;
}
@Override
public void updateState(Preference preference) {
updatePreferenceSummary();
}
@Override
public boolean onActivityResult(int requestCode, int resultCode, Intent data) {
if (requestCode != REQUEST_CODE_DEBUG_APP || resultCode != Activity.RESULT_OK) {
return false;
}
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
data.getAction());
updatePreferenceSummary();
return true;
}
@Override
protected void onDeveloperOptionsSwitchEnabled() {
mPreference.setEnabled(true);
}
@Override
protected void onDeveloperOptionsSwitchDisabled() {
mPreference.setEnabled(false);
mPreference.setSummary(mContext.getResources().getString(R.string.debug_app_not_set));
}
@VisibleForTesting
Intent getActivityStartIntent() {
return new Intent(mContext, AppPicker.class);
}
private void updatePreferenceSummary() {
final String debugApp = Settings.Global.getString(
mContext.getContentResolver(), Settings.Global.DEBUG_APP);
if (debugApp != null && debugApp.length() > 0) {
mPreference.setSummary(mContext.getResources().getString(R.string.debug_app_set,
getAppLabel(debugApp)));
} else {
mPreference.setSummary(mContext.getResources().getString(R.string.debug_app_not_set));
}
}
private String getAppLabel(String debugApp) {
try {
final ApplicationInfo ai = mPackageManager.getApplicationInfo(debugApp,
PackageManager.GET_DISABLED_COMPONENTS);
final CharSequence lab = mPackageManager.getApplicationLabel(ai);
return lab != null ? lab.toString() : debugApp;
} catch (PackageManager.NameNotFoundException e) {
return debugApp;
}
}
}

View File

@@ -0,0 +1,128 @@
/*
* Copyright (C) 2017 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.development;
import static com.android.settings.development.DevelopmentOptionsActivityRequestCodes
.REQUEST_CODE_DEBUG_APP;
import android.app.Activity;
import android.app.ActivityManager;
import android.app.IActivityManager;
import android.content.Context;
import android.content.Intent;
import android.os.RemoteException;
import android.provider.Settings;
import android.support.annotation.VisibleForTesting;
import android.support.v14.preference.SwitchPreference;
import android.support.v7.preference.Preference;
import android.support.v7.preference.PreferenceScreen;
import android.text.TextUtils;
public class WaitForDebuggerPreferenceController extends
DeveloperOptionsPreferenceController implements Preference.OnPreferenceChangeListener {
private static final String WAIT_FOR_DEBUGGER_KEY = "wait_for_debugger";
@VisibleForTesting
static final int SETTING_VALUE_ON = 1;
@VisibleForTesting
static final int SETTING_VALUE_OFF = 0;
private SwitchPreference mPreference;
public WaitForDebuggerPreferenceController(Context context) {
super(context);
}
@Override
public boolean isAvailable() {
return true;
}
@Override
public String getPreferenceKey() {
return WAIT_FOR_DEBUGGER_KEY;
}
@Override
public void displayPreference(PreferenceScreen screen) {
super.displayPreference(screen);
mPreference = (SwitchPreference) screen.findPreference(getPreferenceKey());
}
@Override
public boolean onPreferenceChange(Preference preference, Object newValue) {
final boolean debuggerEnabled = (Boolean) newValue;
final String debugApp = Settings.Global.getString(
mContext.getContentResolver(), Settings.Global.DEBUG_APP);
writeDebuggerAppOptions(debugApp, debuggerEnabled, true /* persistent */);
return true;
}
@Override
public void updateState(Preference preference) {
final String debugApp = Settings.Global.getString(
mContext.getContentResolver(), Settings.Global.DEBUG_APP);
final boolean debuggerEnabled = Settings.Global.getInt(mContext.getContentResolver(),
Settings.Global.WAIT_FOR_DEBUGGER, SETTING_VALUE_OFF) != SETTING_VALUE_OFF;
writeDebuggerAppOptions(debugApp, debuggerEnabled, true /* persistent */);
mPreference.setChecked(debuggerEnabled);
mPreference.setEnabled(!TextUtils.isEmpty(debugApp));
}
@Override
public boolean onActivityResult(int requestCode, int resultCode, Intent data) {
if (requestCode != REQUEST_CODE_DEBUG_APP || resultCode != Activity.RESULT_OK) {
return false;
}
final boolean debuggerEnabled = Settings.Global.getInt(mContext.getContentResolver(),
Settings.Global.WAIT_FOR_DEBUGGER, SETTING_VALUE_OFF) != SETTING_VALUE_OFF;
final String debugApp = data.getAction();
writeDebuggerAppOptions(debugApp, debuggerEnabled, true /* persistent */);
mPreference.setChecked(debuggerEnabled);
mPreference.setEnabled(!TextUtils.isEmpty(debugApp));
return true;
}
@Override
protected void onDeveloperOptionsSwitchEnabled() {
mPreference.setEnabled(true);
}
@Override
protected void onDeveloperOptionsSwitchDisabled() {
writeDebuggerAppOptions(null /* package name */,
false /* waitForDebugger */, false /* persistent */);
mPreference.setChecked(false);
mPreference.setEnabled(false);
}
@VisibleForTesting
IActivityManager getActivityManagerService() {
return ActivityManager.getService();
}
private void writeDebuggerAppOptions(String packageName, boolean waitForDebugger,
boolean persistent) {
try {
getActivityManagerService().setDebugApp(packageName, waitForDebugger, persistent);
} catch (RemoteException ex) {
/* intentional no-op */
}
}
}

View File

@@ -0,0 +1,145 @@
/*
* Copyright (C) 2017 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.development;
import static com.android.settings.development.DevelopmentOptionsActivityRequestCodes
.REQUEST_CODE_DEBUG_APP;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import android.app.Activity;
import android.content.Context;
import android.content.Intent;
import android.provider.Settings;
import android.support.v7.preference.Preference;
import android.support.v7.preference.PreferenceScreen;
import com.android.settings.R;
import com.android.settings.TestConfig;
import com.android.settings.testutils.SettingsRobolectricTestRunner;
import com.android.settingslib.wrapper.PackageManagerWrapper;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
import org.robolectric.util.ReflectionHelpers;
@RunWith(SettingsRobolectricTestRunner.class)
@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
public class SelectDebugAppPreferenceControllerTest {
@Mock
private Preference mPreference;
@Mock
private PreferenceScreen mPreferenceScreen;
@Mock
private DevelopmentSettingsDashboardFragment mFragment;
@Mock
private PackageManagerWrapper mPackageManagerWrapper;
private Context mContext;
private SelectDebugAppPreferenceController mController;
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
mContext = RuntimeEnvironment.application;
mController = spy(new SelectDebugAppPreferenceController(mContext, mFragment));
ReflectionHelpers.setField(mController, "mPackageManager" /* field name */,
mPackageManagerWrapper);
when(mPreferenceScreen.findPreference(mController.getPreferenceKey())).thenReturn(
mPreference);
mController.displayPreference(mPreferenceScreen);
}
@Test
public void handlePreferenceTreeClick_preferenceClicked_launchActivity() {
final Intent activityStartIntent = new Intent(mContext, AppPicker.class);
final String preferenceKey = mController.getPreferenceKey();
doReturn(activityStartIntent).when(mController).getActivityStartIntent();
when(mPreference.getKey()).thenReturn(preferenceKey);
mController.handlePreferenceTreeClick(mPreference);
verify(mFragment).startActivityForResult(activityStartIntent, REQUEST_CODE_DEBUG_APP);
}
@Test
public void updateState_foobarAppSelected_shouldUpdateSummaryWithDebugAppLabel() {
final String debugApp = "foobar";
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
debugApp);
mController.updateState(mPreference);
verify(mPreference).setSummary(
mContext.getResources().getString(R.string.debug_app_set, debugApp));
}
@Test
public void updateState_noAppSelected_shouldUpdateSummaryWithNoAppSelected() {
final String debugApp = null;
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
debugApp);
mController.updateState(mPreference);
verify(mPreference).setSummary(
mContext.getResources().getString(R.string.debug_app_not_set));
}
@Test
public void onActivityResult_foobarAppSelected_shouldUpdateSummaryWithDebugLabel() {
Intent activityResultIntent = new Intent(mContext, AppPicker.class);
final String appLabel = "foobar";
activityResultIntent.setAction(appLabel);
final boolean result = mController.onActivityResult(REQUEST_CODE_DEBUG_APP,
Activity.RESULT_OK, activityResultIntent);
assertThat(result).isTrue();
verify(mPreference).setSummary(
mContext.getResources().getString(R.string.debug_app_set, appLabel));
}
@Test
public void onActivityResult_badRequestCode_shouldReturnFalse() {
assertThat(mController.onActivityResult(
-1 /* requestCode */, -1 /* resultCode */, null /* intent */)).isFalse();
}
@Test
public void onDeveloperOptionsSwitchEnabled_shouldEnablePreference() {
mController.onDeveloperOptionsSwitchEnabled();
verify(mPreference).setEnabled(true);
}
@Test
public void onDeveloperOptionsSwitchDisabled_shouldDisablePreference() {
mController.onDeveloperOptionsSwitchDisabled();
verify(mPreference).setEnabled(false);
verify(mPreference).setSummary(
mContext.getResources().getString(R.string.debug_app_not_set));
}
}

View File

@@ -0,0 +1,202 @@
/*
* Copyright (C) 2017 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.development;
import static com.android.settings.development.DevelopmentOptionsActivityRequestCodes
.REQUEST_CODE_DEBUG_APP;
import static com.android.settings.development.WaitForDebuggerPreferenceController
.SETTING_VALUE_OFF;
import static com.android.settings.development.WaitForDebuggerPreferenceController.SETTING_VALUE_ON;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import android.app.Activity;
import android.app.IActivityManager;
import android.content.Context;
import android.content.Intent;
import android.os.RemoteException;
import android.provider.Settings;
import android.support.v14.preference.SwitchPreference;
import android.support.v7.preference.PreferenceScreen;
import com.android.settings.TestConfig;
import com.android.settings.testutils.SettingsRobolectricTestRunner;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
@RunWith(SettingsRobolectricTestRunner.class)
@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
public class WaitForDebuggerPreferenceControllerTest {
@Mock
private SwitchPreference mPreference;
@Mock
private PreferenceScreen mPreferenceScreen;
@Mock
private IActivityManager mIActivityManager;
private Context mContext;
private WaitForDebuggerPreferenceController mController;
@Before
public void setup() {
MockitoAnnotations.initMocks(this);
mContext = RuntimeEnvironment.application;
mController = spy(new WaitForDebuggerPreferenceController(mContext));
doReturn(mIActivityManager).when(mController).getActivityManagerService();
when(mPreferenceScreen.findPreference(mController.getPreferenceKey())).thenReturn(
mPreference);
mController.displayPreference(mPreferenceScreen);
}
@Test
public void onPreferenceChange_settingEnabledFoobarApp_waitForDebuggerShouldBeOn()
throws RemoteException {
final String debugApp = "foobar";
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
debugApp);
mController.onPreferenceChange(mPreference, true /* newValue */);
verify(mIActivityManager).setDebugApp(debugApp,
true /* waitForDebugger */, true /* persistent */);
}
@Test
public void onPreferenceChange_settingDisabledFoobarApp_waitForDebuggerShouldBeOff()
throws RemoteException {
final String debugApp = "foobar";
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
debugApp);
mController.onPreferenceChange(mPreference, false /* newValue */);
verify(mIActivityManager).setDebugApp(debugApp,
false /* waitForDebugger */, true /* persistent */);
}
@Test
public void updateState_settingEnabledNullDebugApp_preferenceShouldBeCheckedAndDisabled() {
final String debugApp = null;
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
debugApp);
Settings.Global.putInt(mContext.getContentResolver(), Settings.Global.WAIT_FOR_DEBUGGER,
SETTING_VALUE_ON);
mController.updateState(mPreference);
verify(mPreference).setChecked(true);
verify(mPreference).setEnabled(false);
}
@Test
public void updateState_settingEnabledFoobarApp_preferenceShouldBeCheckedAndDisabled() {
final String debugApp = "foobar";
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
debugApp);
Settings.Global.putInt(mContext.getContentResolver(), Settings.Global.WAIT_FOR_DEBUGGER,
SETTING_VALUE_ON);
mController.updateState(mPreference);
verify(mPreference).setChecked(true);
verify(mPreference).setEnabled(true);
}
@Test
public void updateState_settingDisabledNullDebugApp_preferenceShouldNotBeCheckedAndDisabled() {
final String debugApp = null;
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
debugApp);
Settings.Global.putInt(mContext.getContentResolver(), Settings.Global.WAIT_FOR_DEBUGGER,
SETTING_VALUE_OFF);
mController.updateState(mPreference);
verify(mPreference).setChecked(false);
verify(mPreference).setEnabled(false);
}
@Test
public void updateState_settingDisableFoobarApp_preferenceShouldNotBeCheckedAndEnabled() {
final String debugApp = "foobar";
Settings.Global.putString(mContext.getContentResolver(), Settings.Global.DEBUG_APP,
debugApp);
Settings.Global.putInt(mContext.getContentResolver(), Settings.Global.WAIT_FOR_DEBUGGER,
SETTING_VALUE_OFF);
mController.updateState(mPreference);
verify(mPreference).setChecked(false);
verify(mPreference).setEnabled(true);
}
@Test
public void onActivityResult_requestCodeAndSettingEnabled_waitForDebuggerShouldBeChecked() {
Intent onActivityResultIntent = new Intent(mContext, AppPicker.class);
Settings.Global.putInt(mContext.getContentResolver(), Settings.Global.WAIT_FOR_DEBUGGER,
SETTING_VALUE_ON);
boolean result = mController.onActivityResult(REQUEST_CODE_DEBUG_APP, Activity.RESULT_OK,
onActivityResultIntent);
assertThat(result).isTrue();
verify(mPreference).setChecked(true);
}
@Test
public void onActivityResult_requestCodeAndSettingDisabled_waitForDebuggerShouldNotBeChecked() {
Intent onActivityResultIntent = new Intent(mContext, AppPicker.class);
Settings.Global.putInt(mContext.getContentResolver(), Settings.Global.WAIT_FOR_DEBUGGER,
SETTING_VALUE_OFF);
boolean result = mController.onActivityResult(REQUEST_CODE_DEBUG_APP, Activity.RESULT_OK,
onActivityResultIntent);
assertThat(result).isTrue();
verify(mPreference).setChecked(false);
}
@Test
public void onActivityResult_badRequestCode_shouldReturnFalse() {
boolean result = mController.onActivityResult(
-1 /* request code */, -1 /* result code */, null /* intent */);
assertThat(result).isFalse();
}
@Test
public void onDeveloperOptionsSwitchDisabled_shouldDisablePreference() throws RemoteException {
mController.onDeveloperOptionsSwitchDisabled();
verify(mIActivityManager).setDebugApp(null /* package name */,
false /* waitForDebugger */, false /* persistent */);
verify(mPreference).setChecked(false);
verify(mPreference).setEnabled(false);
}
@Test
public void onDeveloperOptionsSwitchEnabled_shouldEnablePreference() {
mController.onDeveloperOptionsSwitchEnabled();
verify(mPreference).setEnabled(true);
}
}