From 47103ac3de5228d9285c15a41dcc84b0b82e4a05 Mon Sep 17 00:00:00 2001 From: Fan Zhang Date: Wed, 25 Apr 2018 17:50:23 -0700 Subject: [PATCH] Implement LifecycleObserver in pulse notif controller. Change-Id: Icb8d55c5a72bc6a8d6566c43e193b7f12377b4c9 Fixes: 74923755 Test: manually run through lifecycle Test: atest CodeInspectionTest --- ...PulseNotificationPreferenceController.java | 10 +- .../codeinspection/CodeInspectionTest.java | 5 + .../LifecycleObserverCodeInspector.java | 93 +++++++++++++++++++ 3 files changed, 104 insertions(+), 4 deletions(-) create mode 100644 tests/robotests/src/com/android/settings/core/codeinspection/LifecycleObserverCodeInspector.java diff --git a/src/com/android/settings/notification/PulseNotificationPreferenceController.java b/src/com/android/settings/notification/PulseNotificationPreferenceController.java index 1696268037b..206043c682c 100644 --- a/src/com/android/settings/notification/PulseNotificationPreferenceController.java +++ b/src/com/android/settings/notification/PulseNotificationPreferenceController.java @@ -16,23 +16,25 @@ package com.android.settings.notification; +import static android.provider.Settings.System.NOTIFICATION_LIGHT_PULSE; + import android.content.ContentResolver; import android.content.Context; import android.database.ContentObserver; import android.net.Uri; import android.os.Handler; import android.provider.Settings; -import androidx.preference.Preference; -import androidx.preference.PreferenceScreen; import com.android.settings.core.TogglePreferenceController; +import com.android.settingslib.core.lifecycle.LifecycleObserver; import com.android.settingslib.core.lifecycle.events.OnPause; import com.android.settingslib.core.lifecycle.events.OnResume; -import static android.provider.Settings.System.NOTIFICATION_LIGHT_PULSE; +import androidx.preference.Preference; +import androidx.preference.PreferenceScreen; public class PulseNotificationPreferenceController extends TogglePreferenceController - implements OnResume, OnPause { + implements LifecycleObserver, OnResume, OnPause { private static final int ON = 1; private static final int OFF = 0; diff --git a/tests/robotests/src/com/android/settings/core/codeinspection/CodeInspectionTest.java b/tests/robotests/src/com/android/settings/core/codeinspection/CodeInspectionTest.java index 6c17e6a6363..4ddf53fe595 100644 --- a/tests/robotests/src/com/android/settings/core/codeinspection/CodeInspectionTest.java +++ b/tests/robotests/src/com/android/settings/core/codeinspection/CodeInspectionTest.java @@ -64,4 +64,9 @@ public class CodeInspectionTest { public void runSearchIndexProviderCodeInspection() { new SearchIndexProviderCodeInspector(mClasses).run(); } + + @Test + public void runLifecycleObserverInspection() { + new LifecycleObserverCodeInspector(mClasses).run(); + } } diff --git a/tests/robotests/src/com/android/settings/core/codeinspection/LifecycleObserverCodeInspector.java b/tests/robotests/src/com/android/settings/core/codeinspection/LifecycleObserverCodeInspector.java new file mode 100644 index 00000000000..d08a460b280 --- /dev/null +++ b/tests/robotests/src/com/android/settings/core/codeinspection/LifecycleObserverCodeInspector.java @@ -0,0 +1,93 @@ +/* + * 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.core.codeinspection; + +import static junit.framework.Assert.fail; + +import android.util.ArraySet; + +import com.android.settingslib.core.lifecycle.LifecycleObserver; +import com.android.settingslib.core.lifecycle.events.OnAttach; +import com.android.settingslib.core.lifecycle.events.OnCreate; +import com.android.settingslib.core.lifecycle.events.OnCreateOptionsMenu; +import com.android.settingslib.core.lifecycle.events.OnDestroy; +import com.android.settingslib.core.lifecycle.events.OnOptionsItemSelected; +import com.android.settingslib.core.lifecycle.events.OnPause; +import com.android.settingslib.core.lifecycle.events.OnPrepareOptionsMenu; +import com.android.settingslib.core.lifecycle.events.OnResume; +import com.android.settingslib.core.lifecycle.events.OnSaveInstanceState; +import com.android.settingslib.core.lifecycle.events.OnStart; +import com.android.settingslib.core.lifecycle.events.OnStop; +import com.android.settingslib.core.lifecycle.events.SetPreferenceScreen; + +import java.util.Arrays; +import java.util.List; +import java.util.Set; + +public class LifecycleObserverCodeInspector extends CodeInspector { + + private static final List LIFECYCLE_EVENTS = Arrays.asList( + OnAttach.class, + OnCreate.class, + OnCreateOptionsMenu.class, + OnDestroy.class, + OnOptionsItemSelected.class, + OnPause.class, + OnPrepareOptionsMenu.class, + OnResume.class, + OnSaveInstanceState.class, + OnStart.class, + OnStop.class, + SetPreferenceScreen.class + ); + + public LifecycleObserverCodeInspector(List> classes) { + super(classes); + } + + @Override + public void run() { + final Set notImplementingLifecycleObserver = new ArraySet<>(); + for (Class clazz : mClasses) { + if (!isConcreteSettingsClass(clazz)) { + continue; + } + boolean classObservesLifecycleEvent = false; + for (Class event : LIFECYCLE_EVENTS) { + if (event.isAssignableFrom(clazz)) { + classObservesLifecycleEvent = true; + break; + } + } + if (classObservesLifecycleEvent && !LifecycleObserver.class.isAssignableFrom(clazz)) { + // Observes LifecycleEvent but not implementing LifecycleObserver. Something is + // wrong. + notImplementingLifecycleObserver.add(clazz.getName()); + } + } + if (!notImplementingLifecycleObserver.isEmpty()) { + final String errorTemplate = + "The following class(es) implements lifecycle.events.*, but don't " + + "implement LifecycleObserver. Something is wrong:\n"; + final StringBuilder error = new StringBuilder(errorTemplate); + for (String name : notImplementingLifecycleObserver) { + error.append(name).append('\n'); + } + fail(error.toString()); + } + } +}