Move code from SuggestionChecks to FeatureProvider

This is step one to deprecate SuggestionChecks. Moving logic into
SuggestionFeatureProvider allows potential logic override and improves
testability.

Also moved isSuggestionComplete tests to corresponding activity/pref
controller test.

Bug: 65065268
Test: robotests
Change-Id: I2071d30fc58bb84acad2083ca03cfcf7d41f10cb

tests/robotests/src/com/android/settings/gestures/DoubleTapPowerPreferenceControllerTest.java

@@ -16,18 +16,29 @@
 
 package com.android.settings.gestures;
 
+import static android.provider.Settings.Secure.CAMERA_DOUBLE_TAP_POWER_GESTURE_DISABLED;
+import static com.android.settings.gestures.DoubleTapPowerPreferenceController.OFF;
+import static com.android.settings.gestures.DoubleTapPowerPreferenceController.ON;
+import static com.android.settings.gestures.DoubleTapPowerPreferenceController.isSuggestionComplete;
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.when;
+
 import android.content.ContentResolver;
 import android.content.Context;
+import android.content.SharedPreferences;
 import android.provider.Settings;
-import android.support.v7.preference.PreferenceScreen;
 
+import com.android.settings.TestConfig;
+import com.android.settings.dashboard.suggestions.SuggestionFeatureProviderImpl;
 import com.android.settings.search.InlinePayload;
 import com.android.settings.search.InlineSwitchPayload;
 import com.android.settings.search.ResultPayload;
 import com.android.settings.testutils.SettingsRobolectricTestRunner;
-import com.android.settings.TestConfig;
-
+import com.android.settings.testutils.shadow.SettingsShadowResources;
+import com.android.settings.testutils.shadow.SettingsShadowSystemProperties;
 import com.android.settings.testutils.shadow.ShadowSecureSettings;
+
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -36,20 +47,15 @@ import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
 import org.robolectric.RuntimeEnvironment;
 import org.robolectric.annotation.Config;
-import org.robolectric.shadows.ShadowApplication;
-
-import static android.provider.Settings.Secure.CAMERA_DOUBLE_TAP_POWER_GESTURE_DISABLED;
-import static com.google.common.truth.Truth.assertThat;
-import static org.mockito.Mockito.when;
 
 @RunWith(SettingsRobolectricTestRunner.class)
-@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
+@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION, shadows = {
+        SettingsShadowResources.class
+})
 public class DoubleTapPowerPreferenceControllerTest {
 
     @Mock(answer = Answers.RETURNS_DEEP_STUBS)
     private Context mContext;
-    @Mock(answer = Answers.RETURNS_DEEP_STUBS)
-    private PreferenceScreen mScreen;
     private DoubleTapPowerPreferenceController mController;
     private static final String KEY_DOUBLE_TAP_POWER = "gesture_double_tap_power";
 
@@ -59,6 +65,11 @@ public class DoubleTapPowerPreferenceControllerTest {
         mController = new DoubleTapPowerPreferenceController(mContext, null, KEY_DOUBLE_TAP_POWER);
     }
 
+    @After
+    public void tearDown() {
+        SettingsShadowResources.reset();
+    }
+
     @Test
     public void isAvailable_configIsTrue_shouldReturnTrue() {
         when(mContext.getResources().
@@ -80,9 +91,9 @@ public class DoubleTapPowerPreferenceControllerTest {
     @Test
     public void testSwitchEnabled_configIsNotSet_shouldReturnTrue() {
         // Set the setting to be enabled.
-        final Context context = ShadowApplication.getInstance().getApplicationContext();
+        final Context context = RuntimeEnvironment.application;
         Settings.System.putInt(context.getContentResolver(),
-                CAMERA_DOUBLE_TAP_POWER_GESTURE_DISABLED, 0);
+                CAMERA_DOUBLE_TAP_POWER_GESTURE_DISABLED, ON);
         mController = new DoubleTapPowerPreferenceController(context, null, KEY_DOUBLE_TAP_POWER);
 
         assertThat(mController.isSwitchPrefEnabled()).isTrue();
@@ -91,9 +102,9 @@ public class DoubleTapPowerPreferenceControllerTest {
     @Test
     public void testSwitchEnabled_configIsSet_shouldReturnFalse() {
         // Set the setting to be disabled.
-        final Context context = ShadowApplication.getInstance().getApplicationContext();
+        final Context context = RuntimeEnvironment.application;
         Settings.System.putInt(context.getContentResolver(),
-                CAMERA_DOUBLE_TAP_POWER_GESTURE_DISABLED, 1);
+                CAMERA_DOUBLE_TAP_POWER_GESTURE_DISABLED, OFF);
         mController = new DoubleTapPowerPreferenceController(context, null, KEY_DOUBLE_TAP_POWER);
 
         assertThat(mController.isSwitchPrefEnabled()).isFalse();
@@ -138,4 +149,43 @@ public class DoubleTapPowerPreferenceControllerTest {
         newValue = 1 - newValue; // DoubleTapPower is a non-standard switch
         assertThat(newValue).isEqualTo(currentValue);
     }
+
+    @Test
+    public void isSuggestionCompleted_doubleTapPower_trueWhenNotAvailable() {
+        SettingsShadowResources.overrideResource(
+                com.android.internal.R.bool.config_cameraDoubleTapPowerGestureEnabled, false);
+
+        assertThat(
+                isSuggestionComplete(RuntimeEnvironment.application, null/* prefs */))
+                .isTrue();
+    }
+
+    @Test
+    public void isSuggestionCompleted_doubleTapPower_falseWhenNotVisited() {
+        SettingsShadowResources.overrideResource(
+                com.android.internal.R.bool.config_cameraDoubleTapPowerGestureEnabled, true);
+        // No stored value in shared preferences if not visited yet.
+        final Context context = RuntimeEnvironment.application;
+        final SharedPreferences prefs = new SuggestionFeatureProviderImpl(context)
+                .getSharedPrefs(context);
+        assertThat(
+                isSuggestionComplete(RuntimeEnvironment.application, prefs))
+                .isFalse();
+    }
+
+    @Test
+    public void isSuggestionCompleted_doubleTapPower_trueWhenVisited() {
+        SettingsShadowResources.overrideResource(
+                com.android.internal.R.bool.config_cameraDoubleTapPowerGestureEnabled, true);
+        // No stored value in shared preferences if not visited yet.
+        final Context context = RuntimeEnvironment.application;
+        final SharedPreferences prefs = new SuggestionFeatureProviderImpl(context)
+                .getSharedPrefs(context);
+        prefs.edit().putBoolean(
+                DoubleTapPowerSettings.PREF_KEY_SUGGESTION_COMPLETE, true).commit();
+
+        assertThat(
+                isSuggestionComplete(RuntimeEnvironment.application, prefs))
+                .isTrue();
+    }
 }

tests/robotests/src/com/android/settings/gestures/DoubleTapScreenPreferenceControllerTest.java

@@ -16,18 +16,26 @@
 
 package com.android.settings.gestures;
 
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Matchers.anyInt;
+import static org.mockito.Mockito.when;
+
 import android.content.ContentResolver;
 import android.content.Context;
-
+import android.content.SharedPreferences;
 import android.provider.Settings;
+
 import com.android.internal.hardware.AmbientDisplayConfiguration;
+import com.android.settings.TestConfig;
+import com.android.settings.dashboard.suggestions.SuggestionFeatureProviderImpl;
 import com.android.settings.search.InlinePayload;
 import com.android.settings.search.InlineSwitchPayload;
 import com.android.settings.search.ResultPayload;
 import com.android.settings.testutils.SettingsRobolectricTestRunner;
-import com.android.settings.TestConfig;
-
+import com.android.settings.testutils.shadow.SettingsShadowResources;
 import com.android.settings.testutils.shadow.ShadowSecureSettings;
+
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -37,12 +45,10 @@ import org.mockito.MockitoAnnotations;
 import org.robolectric.RuntimeEnvironment;
 import org.robolectric.annotation.Config;
 
-import static com.google.common.truth.Truth.assertThat;
-import static org.mockito.Matchers.anyInt;
-import static org.mockito.Mockito.when;
-
 @RunWith(SettingsRobolectricTestRunner.class)
-@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
+@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION, shadows = {
+        SettingsShadowResources.class
+})
 public class DoubleTapScreenPreferenceControllerTest {
 
     @Mock(answer = Answers.RETURNS_DEEP_STUBS)
@@ -60,6 +66,11 @@ public class DoubleTapScreenPreferenceControllerTest {
                 mContext, null, mAmbientDisplayConfiguration, 0, KEY_DOUBLE_TAP_SCREEN);
     }
 
+    @After
+    public void tearDown() {
+        SettingsShadowResources.reset();
+    }
+
     @Test
     public void isAvailable_configIsTrue_shouldReturnTrue() {
         when(mAmbientDisplayConfiguration.pulseOnDoubleTapAvailable()).thenReturn(true);
@@ -125,4 +136,36 @@ public class DoubleTapScreenPreferenceControllerTest {
 
         assertThat(newValue).isEqualTo(currentValue);
     }
+
+    @Test
+    public void isSuggestionCompleted_ambientDisplay_falseWhenNotVisited() {
+        SettingsShadowResources.overrideResource(
+                com.android.internal.R.string.config_dozeComponent, "foo");
+        SettingsShadowResources.overrideResource(
+                com.android.internal.R.string.config_dozeDoubleTapSensorType, "bar");
+        // No stored value in shared preferences if not visited yet.
+        final Context context = RuntimeEnvironment.application;
+        final SharedPreferences prefs = new SuggestionFeatureProviderImpl(context)
+                .getSharedPrefs(context);
+
+        assertThat(DoubleTapScreenPreferenceController.isSuggestionComplete(context, prefs))
+                .isFalse();
+    }
+
+    @Test
+    public void isSuggestionCompleted_ambientDisplay_trueWhenVisited() {
+        SettingsShadowResources.overrideResource(
+                com.android.internal.R.string.config_dozeComponent, "foo");
+        SettingsShadowResources.overrideResource(
+                com.android.internal.R.string.config_dozeDoubleTapSensorType, "bar");
+        final Context context = RuntimeEnvironment.application;
+        final SharedPreferences prefs = new SuggestionFeatureProviderImpl(context)
+                .getSharedPrefs(context);
+
+        prefs.edit().putBoolean(
+                DoubleTapScreenSettings.PREF_KEY_SUGGESTION_COMPLETE, true).commit();
+
+        assertThat(DoubleTapScreenPreferenceController.isSuggestionComplete(context, prefs))
+                .isTrue();
+    }
 }

tests/robotests/src/com/android/settings/gestures/DoubleTwistPreferenceControllerTest.java

@@ -16,38 +16,44 @@
 
 package com.android.settings.gestures;
 
-import android.content.Context;
-import android.hardware.Sensor;
-import android.hardware.SensorManager;
-import android.os.UserManager;
-import android.provider.Settings;
-
-import com.android.settings.testutils.SettingsRobolectricTestRunner;
-import com.android.settings.TestConfig;
-import com.android.settings.testutils.shadow.ShadowSecureSettings;
-
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mockito.Answers;
-import org.mockito.Mock;
-import org.mockito.MockitoAnnotations;
-import org.robolectric.annotation.Config;
-import org.robolectric.shadows.ShadowApplication;
-
-import java.util.ArrayList;
-import java.util.List;
-
 import static com.google.common.truth.Truth.assertThat;
 import static org.mockito.Matchers.anyInt;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.when;
 
+import android.content.Context;
+import android.hardware.Sensor;
+import android.hardware.SensorManager;
+import android.os.UserManager;
+import android.provider.Settings;
+
+import com.android.settings.R;
+import com.android.settings.TestConfig;
+import com.android.settings.testutils.SettingsRobolectricTestRunner;
+import com.android.settings.testutils.shadow.SettingsShadowResources;
+import com.android.settings.testutils.shadow.SettingsShadowSystemProperties;
 import com.android.settings.testutils.shadow.ShadowDoubleTwistPreferenceController;
+import com.android.settings.testutils.shadow.ShadowSecureSettings;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Answers;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.robolectric.RuntimeEnvironment;
+import org.robolectric.annotation.Config;
+import org.robolectric.shadows.ShadowApplication;
+
+import java.util.ArrayList;
+import java.util.List;
 
 @RunWith(SettingsRobolectricTestRunner.class)
-@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
+@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION, shadows = {
+        SettingsShadowResources.class
+})
 public class DoubleTwistPreferenceControllerTest {
 
     @Mock(answer = Answers.RETURNS_DEEP_STUBS)
@@ -64,6 +70,11 @@ public class DoubleTwistPreferenceControllerTest {
         mController = new DoubleTwistPreferenceController(mContext, null, KEY_DOUBLE_TWIST);
     }
 
+    @After
+    public void tearDown() {
+        SettingsShadowResources.reset();
+    }
+
     @Test
     public void isAvailable_hasSensor_shouldReturnTrue() {
         // Mock sensors
@@ -96,6 +107,18 @@ public class DoubleTwistPreferenceControllerTest {
         assertThat(mController.isAvailable()).isFalse();
     }
 
+    @Test
+    public void isSuggestionCompleted_doubleTwist_trueWhenNotAvailable() {
+        SettingsShadowResources.overrideResource(
+                R.string.gesture_double_twist_sensor_name, "nonexistant name");
+        SettingsShadowResources.overrideResource(
+                R.string.gesture_double_twist_sensor_vendor, "nonexistant vendor");
+
+        assertThat(DoubleTwistPreferenceController.isSuggestionComplete(
+                RuntimeEnvironment.application, null /* prefs */))
+                .isTrue();
+    }
+
     @Test
     @Config(shadows = {
             ShadowDoubleTwistPreferenceController.class,
@@ -103,9 +126,9 @@ public class DoubleTwistPreferenceControllerTest {
     public void onPreferenceChange_hasWorkProfile_shouldUpdateSettingForWorkProfileUser() {
         final int managedId = 2;
         ShadowSecureSettings.putIntForUser(
-            null, Settings.Secure.CAMERA_DOUBLE_TWIST_TO_FLIP_ENABLED, 0, managedId);
+                null, Settings.Secure.CAMERA_DOUBLE_TWIST_TO_FLIP_ENABLED, 0, managedId);
         DoubleTwistPreferenceController controller =
-            spy(new DoubleTwistPreferenceController(mContext, null, KEY_DOUBLE_TWIST));
+                spy(new DoubleTwistPreferenceController(mContext, null, KEY_DOUBLE_TWIST));
         ShadowDoubleTwistPreferenceController.setManagedProfileId(managedId);
 
         // enable the gesture

tests/robotests/src/com/android/settings/gestures/PickupGesturePreferenceControllerTest.java

@@ -16,18 +16,26 @@
 
 package com.android.settings.gestures;
 
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Matchers.anyInt;
+import static org.mockito.Mockito.when;
+
 import android.content.ContentResolver;
 import android.content.Context;
-
+import android.content.SharedPreferences;
 import android.provider.Settings;
+
 import com.android.internal.hardware.AmbientDisplayConfiguration;
+import com.android.settings.TestConfig;
+import com.android.settings.dashboard.suggestions.SuggestionFeatureProviderImpl;
 import com.android.settings.search.InlinePayload;
 import com.android.settings.search.InlineSwitchPayload;
 import com.android.settings.search.ResultPayload;
 import com.android.settings.testutils.SettingsRobolectricTestRunner;
-import com.android.settings.TestConfig;
-
+import com.android.settings.testutils.shadow.SettingsShadowResources;
 import com.android.settings.testutils.shadow.ShadowSecureSettings;
+
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -37,12 +45,10 @@ import org.mockito.MockitoAnnotations;
 import org.robolectric.RuntimeEnvironment;
 import org.robolectric.annotation.Config;
 
-import static com.google.common.truth.Truth.assertThat;
-import static org.mockito.Matchers.anyInt;
-import static org.mockito.Mockito.when;
-
 @RunWith(SettingsRobolectricTestRunner.class)
-@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
+@Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION, shadows = {
+        SettingsShadowResources.class
+})
 public class PickupGesturePreferenceControllerTest {
 
     @Mock(answer = Answers.RETURNS_DEEP_STUBS)
@@ -61,6 +67,12 @@ public class PickupGesturePreferenceControllerTest {
                 mContext, null, mAmbientDisplayConfiguration, 0, KEY_PICK_UP);
     }
 
+    @After
+    public void tearDown() {
+        SettingsShadowResources.reset();
+        ShadowSecureSettings.clear();
+    }
+
     @Test
     public void isAvailable_configIsTrue_shouldReturnTrue() {
         when(mAmbientDisplayConfiguration.pulseOnPickupAvailable()).thenReturn(true);
@@ -140,4 +152,20 @@ public class PickupGesturePreferenceControllerTest {
 
         assertThat(newValue).isEqualTo(currentValue);
     }
+
+    @Test
+    public void isSuggestionCompleted_ambientDisplayPickup_trueWhenVisited() {
+        when(mContext.getResources().getBoolean(anyInt()))
+                .thenReturn(true);
+        when(mContext.getResources().getString(anyInt()))
+                .thenReturn("foo");
+        final Context context = RuntimeEnvironment.application;
+        final SharedPreferences prefs = new SuggestionFeatureProviderImpl(context)
+                .getSharedPrefs(context);
+        prefs.edit().putBoolean(
+                PickupGestureSettings.PREF_KEY_SUGGESTION_COMPLETE, true).commit();
+
+        assertThat(PickupGesturePreferenceController.isSuggestionComplete(mContext, prefs))
+                .isTrue();
+    }
 }

tests/robotests/src/com/android/settings/gestures/SwipeToNotificationPreferenceControllerTest.java

@@ -16,13 +16,19 @@
 
 package com.android.settings.gestures;
 
+import static android.provider.Settings.Secure.SYSTEM_NAVIGATION_KEYS_ENABLED;
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.when;
+
 import android.content.Context;
+import android.content.SharedPreferences;
 import android.content.pm.PackageManager;
 import android.hardware.fingerprint.FingerprintManager;
 import android.provider.Settings;
 
-import com.android.settings.testutils.SettingsRobolectricTestRunner;
 import com.android.settings.TestConfig;
+import com.android.settings.dashboard.suggestions.SuggestionFeatureProviderImpl;
+import com.android.settings.testutils.SettingsRobolectricTestRunner;
 
 import org.junit.Before;
 import org.junit.Test;
@@ -30,17 +36,10 @@ import org.junit.runner.RunWith;
 import org.mockito.Answers;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
+import org.robolectric.RuntimeEnvironment;
 import org.robolectric.annotation.Config;
 import org.robolectric.shadows.ShadowApplication;
 
-import static android.provider.Settings.Secure.SYSTEM_NAVIGATION_KEYS_ENABLED;
-import static com.google.common.truth.Truth.assertThat;
-
-import static org.mockito.Mockito.doReturn;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.spy;
-import static org.mockito.Mockito.when;
-
 @RunWith(SettingsRobolectricTestRunner.class)
 @Config(manifest = TestConfig.MANIFEST_PATH, sdk = TestConfig.SDK_VERSION)
 public class SwipeToNotificationPreferenceControllerTest {
@@ -122,6 +121,54 @@ public class SwipeToNotificationPreferenceControllerTest {
         assertThat(mController.isSwitchPrefEnabled()).isFalse();
     }
 
+    @Test
+    public void isSuggestionCompleted_configDisabled_shouldReturnTrue() {
+        stubFingerprintSupported(true);
+        when(mFingerprintManager.isHardwareDetected()).thenReturn(true);
+        when(mContext.getResources().
+                getBoolean(com.android.internal.R.bool.config_supportSystemNavigationKeys))
+                .thenReturn(false);
+
+        assertThat(SwipeToNotificationPreferenceController.isSuggestionComplete(
+                mContext, null /* prefs */))
+                .isTrue();
+    }
+
+    @Test
+    public void isSuggestionCompleted_notVisited_shouldReturnFalse() {
+        stubFingerprintSupported(true);
+        when(mFingerprintManager.isHardwareDetected()).thenReturn(true);
+        when(mContext.getResources().
+                getBoolean(com.android.internal.R.bool.config_supportSystemNavigationKeys))
+                .thenReturn(true);
+        // No stored value in shared preferences if not visited yet.
+        final Context context = RuntimeEnvironment.application;
+        final SharedPreferences prefs = new SuggestionFeatureProviderImpl(context)
+                .getSharedPrefs(context);
+
+        assertThat(SwipeToNotificationPreferenceController.isSuggestionComplete(mContext, prefs))
+                .isFalse();
+    }
+
+    @Test
+    public void isSuggestionCompleted_visited_shouldReturnTrue() {
+        stubFingerprintSupported(true);
+        when(mFingerprintManager.isHardwareDetected()).thenReturn(true);
+        when(mContext.getResources().
+                getBoolean(com.android.internal.R.bool.config_supportSystemNavigationKeys))
+                .thenReturn(true);
+        // No stored value in shared preferences if not visited yet.
+        final Context context = RuntimeEnvironment.application;
+        final SharedPreferences prefs = new SuggestionFeatureProviderImpl(context)
+                .getSharedPrefs(context);
+        prefs.edit()
+                .putBoolean(SwipeToNotificationSettings.PREF_KEY_SUGGESTION_COMPLETE, true)
+                .commit();
+
+        assertThat(SwipeToNotificationPreferenceController.isSuggestionComplete(mContext, prefs))
+                .isTrue();
+    }
+
     private void stubFingerprintSupported(boolean enabled) {
         when(mPackageManager.hasSystemFeature(PackageManager.FEATURE_FINGERPRINT))
                 .thenReturn(enabled);