First pass for Dialer onboarding flow
* Add OnboardingActivity that controls the onboarding the UI
ensuring that the user grants the necessary permissions before
the Dialer can start.
* Add first pass (no graphics, eyeballed measurements) for the
screens that request for default dialer as well as permissions
* OnboardingActivity is not actually launched at this moment - will
be tied in to the various Dialer activities in a follow up CL.
* Add tests for logic that controls the display of the screens in
anticipation of future additions to the onboarding flow.
* Add mockito library to DialerTests's Android.mk
Bug: 24270592
Change-Id: I00d0f75edaecaa85042b136b0d830b5fbb3a0a73
diff --git a/tests/Android.mk b/tests/Android.mk
index 21beca8..07f4f00 100644
--- a/tests/Android.mk
+++ b/tests/Android.mk
@@ -16,6 +16,9 @@
# Include all test java files.
LOCAL_SRC_FILES := $(call all-java-files-under, $(src_dirs))
+LOCAL_STATIC_JAVA_LIBRARIES += \
+ mockito-target
+
LOCAL_PACKAGE_NAME := DialerTests
LOCAL_INSTRUMENTATION_FOR := Dialer
diff --git a/tests/src/com/android/dialer/onboard/DefaultDialerOnboardScreenTest.java b/tests/src/com/android/dialer/onboard/DefaultDialerOnboardScreenTest.java
new file mode 100644
index 0000000..f9724c1
--- /dev/null
+++ b/tests/src/com/android/dialer/onboard/DefaultDialerOnboardScreenTest.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright (C) 2015 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.dialer.onboard;
+
+import static org.mockito.Mockito.when;
+
+import android.test.AndroidTestCase;
+
+import com.android.dialer.onboard.OnboardingActivity.DefaultDialerOnboardingScreen;
+
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class DefaultDialerOnboardScreenTest extends AndroidTestCase {
+ private DefaultDialerOnboardingScreen mScreen;
+ @Mock private PermissionsChecker mPermissionsChecker;
+
+ @Override
+ protected void setUp() throws Exception {
+ super.setUp();
+ MockitoAnnotations.initMocks(this);
+ mScreen = new DefaultDialerOnboardingScreen(mPermissionsChecker);
+ }
+
+ public void testNeverRequestedForDefaultDialer_shouldShowScreen() {
+ when(mPermissionsChecker.previouslyRequestedDefaultDialer()).thenReturn(false);
+ assertTrue(mScreen.shouldShowScreen());
+ }
+
+ public void testAlreadyAskedForDefaultDialer_shouldNotShowScreen() {
+ when(mPermissionsChecker.previouslyRequestedDefaultDialer()).thenReturn(true);
+ assertFalse(mScreen.shouldShowScreen());
+ }
+
+ public void testAlreadySetAsDefaultDialer_shouldNotShowScreen() {
+ when(mPermissionsChecker.previouslyRequestedDefaultDialer()).thenReturn(false);
+ when(mPermissionsChecker.isDefaultOrSystemDialer()).thenReturn(true);
+ assertFalse(mScreen.shouldShowScreen());
+ }
+
+ public void testCanSkipScreen() {
+ assertTrue(mScreen.canSkipScreen());
+ }
+}
diff --git a/tests/src/com/android/dialer/onboard/OnboardingControllerTest.java b/tests/src/com/android/dialer/onboard/OnboardingControllerTest.java
new file mode 100644
index 0000000..d9c8ce5
--- /dev/null
+++ b/tests/src/com/android/dialer/onboard/OnboardingControllerTest.java
@@ -0,0 +1,176 @@
+/*
+ * Copyright (C) 2015 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.dialer.onboard;
+
+import android.app.Activity;
+import android.test.AndroidTestCase;
+
+public class OnboardingControllerTest extends AndroidTestCase {
+ private MockOnboardUi mOnboardUi;
+ private OnboardingController mController;
+
+ public class MockOnboardUi implements OnboardingController.OnboardingUi {
+ public int currentScreen = -1;
+ public boolean completedOnboardingFlow = false;
+
+ @Override
+ public void showScreen(int screenId) {
+ currentScreen = screenId;
+ }
+
+ @Override
+ public void completeOnboardingFlow() {
+ completedOnboardingFlow = true;
+ }
+ }
+
+ public class MockScreen extends OnboardingController.OnboardingScreen {
+ boolean shouldShowScreen;
+ boolean canSkipScreen;
+
+ public MockScreen(boolean shouldShowScreen, boolean canSkipScreen) {
+ this.shouldShowScreen = shouldShowScreen;
+ this.canSkipScreen = canSkipScreen;
+ }
+
+ @Override
+ public boolean shouldShowScreen() {
+ return shouldShowScreen;
+ }
+
+ @Override
+ public boolean canSkipScreen() {
+ return canSkipScreen;
+ }
+
+ @Override
+ public void onNextClicked(Activity activity) {
+ }
+ }
+
+ @Override
+ protected void setUp() throws Exception {
+ super.setUp();
+ mOnboardUi = new MockOnboardUi();
+ mController = new OnboardingController(mOnboardUi);
+ }
+
+ public void testNoScreensToDisplay_OnboardingFlowImmediatelyCompleted() {
+ mController.showNextScreen();
+ assertEquals(-1, mOnboardUi.currentScreen);
+ assertTrue(mOnboardUi.completedOnboardingFlow);
+ }
+
+ public void testSkipAllScreens_OnboardingFlowImmediatelyCompleted() {
+ mController.addScreen(new MockScreen(false /* shouldShowScreen */,
+ true /* canSkipScreen */));
+ mController.addScreen(new MockScreen(false /* shouldShowScreen */,
+ true /* canSkipScreen */));
+ mController.addScreen(new MockScreen(false /* shouldShowScreen */,
+ true /* canSkipScreen */));
+ mController.showNextScreen();
+ assertEquals(-1, mOnboardUi.currentScreen);
+ assertTrue(mOnboardUi.completedOnboardingFlow);
+ }
+
+ public void testFirstScreenNotNeeded_ShowsSecondScreen() {
+ mController.addScreen(new MockScreen(false /* shouldShowScreen */,
+ false /* canSkipScreen */));
+ mController.addScreen(new MockScreen(true /* shouldShowScreen */,
+ false /* canSkipScreen */));
+ mController.showNextScreen();
+ assertEquals(1, mOnboardUi.currentScreen);
+ }
+
+ public void testScreenRequired() {
+ final MockScreen mockScreen =
+ new MockScreen(true /* shouldShowScreen */, false /* canSkipScreen */);
+ mController.addScreen(mockScreen);
+
+ mController.showNextScreen();
+ assertEquals(0, mOnboardUi.currentScreen);
+ assertFalse(mOnboardUi.completedOnboardingFlow);
+
+ // User tried to skip an unskippable screen
+ mController.onScreenResult(0, false);
+ assertEquals(0, mOnboardUi.currentScreen);
+ assertFalse(mOnboardUi.completedOnboardingFlow);
+
+ // User said yes, but the underlying requirements have not been fulfilled yet, so don't
+ // show the next screen. Should be very rare in practice.
+ mController.onScreenResult(0, true);
+ assertEquals(0, mOnboardUi.currentScreen);
+ assertFalse(mOnboardUi.completedOnboardingFlow);
+
+ // Requirement has been fulfiled.
+ mockScreen.shouldShowScreen = false;
+ mController.onScreenResult(0, true);
+ assertTrue(mOnboardUi.completedOnboardingFlow);
+ }
+
+ /**
+ * Verifies the use case where completing the first screen will provide the necessary conditions
+ * to skip the second screen as well.
+ *
+ * For example, setting the default dialer in the first screen will automatically grant
+ * permissions such that the second permissions screen is no longer needed.
+ */
+ public void testFirstScreenCompleted_SkipsSecondScreen() {
+ final MockScreen mockScreen1 =
+ new MockScreen(true /* shouldShowScreen */, true /* canSkipScreen */);
+ final MockScreen mockScreen2 =
+ new MockScreen(true /* shouldShowScreen */, false /* canSkipScreen */);
+ mController.addScreen(mockScreen1);
+ mController.addScreen(mockScreen2);
+
+ mController.showNextScreen();
+ assertEquals(0, mOnboardUi.currentScreen);
+ assertFalse(mOnboardUi.completedOnboardingFlow);
+
+ // Screen 1 succeeded, screen 2 is no longer necessary
+ mockScreen2.shouldShowScreen = false;
+ mController.onScreenResult(0, true);
+ assertEquals(0, mOnboardUi.currentScreen);
+ assertTrue(mOnboardUi.completedOnboardingFlow);
+ }
+
+ /**
+ * Verifies the use case where skipping the first screen will proceed to show the second screen
+ * since the necessary conditions to skip the second screen have not been met.
+ */
+ public void testFirstScreenSkipped_ShowsSecondScreen() {
+ final MockScreen mockScreen1 =
+ new MockScreen(true /* shouldShowScreen */, true /* canSkipScreen */);
+ final MockScreen mockScreen2 =
+ new MockScreen(true /* shouldShowScreen */, false /* canSkipScreen */);
+ mController.addScreen(mockScreen1);
+ mController.addScreen(mockScreen2);
+
+ mController.showNextScreen();
+ assertEquals(0, mOnboardUi.currentScreen);
+ assertFalse(mOnboardUi.completedOnboardingFlow);
+
+ // Screen 1 skipped
+ mController.onScreenResult(0, false);
+ assertEquals(1, mOnboardUi.currentScreen);
+ assertFalse(mOnboardUi.completedOnboardingFlow);
+
+ // Repeatedly trying to skip screen 2 will not work since it is marked as unskippable.
+ mController.onScreenResult(1, false);
+ assertEquals(1, mOnboardUi.currentScreen);
+ assertFalse(mOnboardUi.completedOnboardingFlow);
+ }
+}
diff --git a/tests/src/com/android/dialer/onboard/PermissionsOnboardScreenTest.java b/tests/src/com/android/dialer/onboard/PermissionsOnboardScreenTest.java
new file mode 100644
index 0000000..ff5e3d5
--- /dev/null
+++ b/tests/src/com/android/dialer/onboard/PermissionsOnboardScreenTest.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright (C) 2015 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.dialer.onboard;
+
+import static org.mockito.Mockito.when;
+
+import android.test.AndroidTestCase;
+
+import com.android.dialer.onboard.OnboardingActivity.PermissionsOnboardingScreen;
+
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class PermissionsOnboardScreenTest extends AndroidTestCase {
+ private PermissionsOnboardingScreen mScreen;
+ @Mock private PermissionsChecker mPermissionsChecker;
+
+ @Override
+ protected void setUp() throws Exception {
+ super.setUp();
+ MockitoAnnotations.initMocks(this);
+ mScreen = new PermissionsOnboardingScreen(mPermissionsChecker);
+ }
+
+ public void testMissingContactsAndPhonePermissions_shouldShowScreen() {
+ when(mPermissionsChecker.hasContactsPermissions()).thenReturn(false);
+ when(mPermissionsChecker.hasPhonePermissions()).thenReturn(false);
+ assertTrue(mScreen.shouldShowScreen());
+ }
+
+ public void testMissingContactsPermission_shouldShowScreen() {
+ when(mPermissionsChecker.hasContactsPermissions()).thenReturn(false);
+ when(mPermissionsChecker.hasPhonePermissions()).thenReturn(true);
+ assertTrue(mScreen.shouldShowScreen());
+ }
+
+ public void testMissingPhonePermission_shouldShowScreen() {
+ when(mPermissionsChecker.hasContactsPermissions()).thenReturn(true);
+ when(mPermissionsChecker.hasPhonePermissions()).thenReturn(false);
+ assertTrue(mScreen.shouldShowScreen());
+ }
+
+ public void testHasAllPermissions_shouldNotShowScreen() {
+ when(mPermissionsChecker.hasContactsPermissions()).thenReturn(true);
+ when(mPermissionsChecker.hasPhonePermissions()).thenReturn(true);
+ assertFalse(mScreen.shouldShowScreen());
+ }
+
+ public void testCanSkipScreen() {
+ assertFalse(mScreen.canSkipScreen());
+ }
+}