From 221792c074c45a9b94424c95de304194249f2270 Mon Sep 17 00:00:00 2001
From: Tiger Oakes <toakes@mozilla.com>
Date: Fri, 29 May 2020 17:26:07 -0700
Subject: [PATCH] Add tests for FenixOnboarding (#11057)

---
 .../fenix/onboarding/FenixOnboarding.kt       | 34 +++++++---
 .../fenix/onboarding/FenixOnboardingTest.kt   | 63 +++++++++++++++++++
 2 files changed, 87 insertions(+), 10 deletions(-)
 create mode 100644 app/src/test/java/org/mozilla/fenix/onboarding/FenixOnboardingTest.kt

diff --git a/app/src/main/java/org/mozilla/fenix/onboarding/FenixOnboarding.kt b/app/src/main/java/org/mozilla/fenix/onboarding/FenixOnboarding.kt
index 2ee112163..0af973195 100644
--- a/app/src/main/java/org/mozilla/fenix/onboarding/FenixOnboarding.kt
+++ b/app/src/main/java/org/mozilla/fenix/onboarding/FenixOnboarding.kt
@@ -6,32 +6,46 @@ package org.mozilla.fenix.onboarding
 
 import android.content.Context
 import android.content.SharedPreferences
-import androidx.core.content.edit
+import androidx.annotation.VisibleForTesting
+import mozilla.components.support.ktx.android.content.PreferencesHolder
+import mozilla.components.support.ktx.android.content.intPreference
 import org.mozilla.fenix.components.metrics.Event
 import org.mozilla.fenix.ext.components
 
-class FenixOnboarding(context: Context) {
+class FenixOnboarding(context: Context) : PreferencesHolder {
+
     private val metrics = context.components.analytics.metrics
-    private val onboardingPrefs = context.getSharedPreferences(
+    override val preferences: SharedPreferences = context.getSharedPreferences(
         PREF_NAME_ONBOARDING_KEY,
         Context.MODE_PRIVATE
     )
 
-    private var SharedPreferences.onboardedVersion: Int
-        get() = getInt(LAST_VERSION_ONBOARDING_KEY, 0)
-        set(version) { edit { putInt(LAST_VERSION_ONBOARDING_KEY, version) } }
+    private var onboardedVersion by intPreference(LAST_VERSION_ONBOARDING_KEY, default = 0)
 
     fun finish() {
-        onboardingPrefs.onboardedVersion = CURRENT_ONBOARDING_VERSION
+        onboardedVersion = CURRENT_ONBOARDING_VERSION
         metrics.track(Event.DismissedOnboarding)
     }
 
-    fun userHasBeenOnboarded() = onboardingPrefs.onboardedVersion == CURRENT_ONBOARDING_VERSION
+    fun userHasBeenOnboarded() = onboardedVersion == CURRENT_ONBOARDING_VERSION
 
     companion object {
-        private const val CURRENT_ONBOARDING_VERSION = 1
+        /**
+         * The current onboarding version. When incremented,
+         * users who were previously onboarded will be show the onboarding again.
+         */
+        @VisibleForTesting
+        internal const val CURRENT_ONBOARDING_VERSION = 1
 
+        /**
+         * Name of the shared preferences file.
+         */
         private const val PREF_NAME_ONBOARDING_KEY = "fenix.onboarding"
-        private const val LAST_VERSION_ONBOARDING_KEY = "fenix.onboarding.last_version"
+
+        /**
+         * Key for [onboardedVersion].
+         */
+        @VisibleForTesting
+        internal const val LAST_VERSION_ONBOARDING_KEY = "fenix.onboarding.last_version"
     }
 }
diff --git a/app/src/test/java/org/mozilla/fenix/onboarding/FenixOnboardingTest.kt b/app/src/test/java/org/mozilla/fenix/onboarding/FenixOnboardingTest.kt
new file mode 100644
index 000000000..a62996181
--- /dev/null
+++ b/app/src/test/java/org/mozilla/fenix/onboarding/FenixOnboardingTest.kt
@@ -0,0 +1,63 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package org.mozilla.fenix.onboarding
+
+import android.content.Context
+import android.content.Context.MODE_PRIVATE
+import android.content.SharedPreferences
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import org.junit.Assert.assertFalse
+import org.junit.Assert.assertTrue
+import org.junit.Before
+import org.junit.Test
+import org.mozilla.fenix.components.metrics.Event
+import org.mozilla.fenix.components.metrics.MetricController
+import org.mozilla.fenix.ext.components
+import org.mozilla.fenix.onboarding.FenixOnboarding.Companion.CURRENT_ONBOARDING_VERSION
+import org.mozilla.fenix.onboarding.FenixOnboarding.Companion.LAST_VERSION_ONBOARDING_KEY
+
+class FenixOnboardingTest {
+
+    private lateinit var onboarding: FenixOnboarding
+    private lateinit var preferences: SharedPreferences
+    private lateinit var preferencesEditor: SharedPreferences.Editor
+    private lateinit var metrics: MetricController
+
+    @Before
+    fun setup() {
+        preferences = mockk()
+        preferencesEditor = mockk(relaxed = true)
+        metrics = mockk()
+        val context = mockk<Context>()
+        every { preferences.edit() } returns preferencesEditor
+        every { metrics.track(any()) } returns Unit
+        every { context.components.analytics.metrics } returns metrics
+        every { context.getSharedPreferences(any(), MODE_PRIVATE) } returns preferences
+
+        onboarding = FenixOnboarding(context)
+    }
+
+    @Test
+    fun testUserHasBeenOnboarded() {
+        every {
+            preferences.getInt(LAST_VERSION_ONBOARDING_KEY, any())
+        } returns 0
+        assertFalse(onboarding.userHasBeenOnboarded())
+
+        every {
+            preferences.getInt(LAST_VERSION_ONBOARDING_KEY, any())
+        } returns CURRENT_ONBOARDING_VERSION
+        assertTrue(onboarding.userHasBeenOnboarded())
+    }
+
+    @Test
+    fun testFinish() {
+        onboarding.finish()
+        verify { preferencesEditor.putInt(LAST_VERSION_ONBOARDING_KEY, CURRENT_ONBOARDING_VERSION) }
+        verify { metrics.track(Event.DismissedOnboarding) }
+    }
+}