test: PreferencesAnalyticsTest

ankidroid · Jul 26, 2023 · e8f3dba · e8f3dba
1 parent 72e96cc
commit e8f3dba
Showing 1 changed file with 130 additions and 0 deletions.
diff --git a/AnkiDroid/src/test/java/com/ichi2/anki/analytics/PreferencesAnalyticsTest.kt b/AnkiDroid/src/test/java/com/ichi2/anki/analytics/PreferencesAnalyticsTest.kt
@@ -0,0 +1,130 @@
+/*
+ *  Copyright (c) 2023 Brayan Oliveira <[email protected]>
+ *
+ *  This program is free software; you can redistribute it and/or modify it under
+ *  the terms of the GNU General Public License as published by the Free Software
+ *  Foundation; either version 3 of the License, or (at your option) any later
+ *  version.
+ *
+ *  This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ *  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ *  PARTICULAR PURPOSE. See the GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along with
+ *  this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.ichi2.anki.analytics
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.ichi2.anki.R
+import com.ichi2.anki.RobolectricTest
+import com.ichi2.anki.analytics.UsageAnalytics.preferencesWhoseChangesShouldBeReported
+import com.ichi2.anki.preferences.PreferenceTestUtils
+import com.ichi2.anki.preferences.SettingsFragment
+import org.hamcrest.MatcherAssert.assertThat
+import org.hamcrest.Matchers
+import org.junit.Test
+import org.junit.runner.RunWith
+import kotlin.test.assertNull
+
+@RunWith(AndroidJUnit4::class)
+class PreferencesAnalyticsTest : RobolectricTest() {
+    /** Keys of preferences that shouldn't be reported */
+    private val excludedPrefs = setOf(
+        "analyticsOptIn", // Share feature usage: analytics are only reported if this is enabled :)
+        "useRustBackend", // Rust backend: is going to be the default in the future
+        // Screens: don't have a value
+        "generalScreen",
+        "reviewingScreen",
+        "syncScreen",
+        "notificationsScreen",
+        "controlsScreen",
+        "accessibilityScreen",
+        "customSyncServerScreen",
+        "appBarButtonsScreen",
+        "advancedStatisticsScreen",
+        "pref_screen_advanced",
+        // Dev options: only aimed at devs
+        "devOptionsKey",
+        "devOptionsEnabledByUser",
+        "html_javascript_debugging",
+        "trigger_crash_preference",
+        "analytics_debug_preference",
+        "debug_lock_database",
+        "showOnboarding",
+        "resetOnboarding",
+        "fillCollectionNumberFile",
+        "fillCollectionSizeFile",
+        "fillCollection",
+        // Categories: don't have a value
+        "appearance_preference_group",
+        "category_plugins",
+        "key_map_category",
+        "category_workarounds",
+        // Preferences that only click: don't have a value
+        "tts",
+        "resetLanguages",
+        "custom_buttons_link", // Opens App Bar buttons fragment
+        "custom_sync_server_link", // Opens Custom sync server fragment
+        "thirdpartyapps_link",
+        // will be reworked in the future
+        "minimumCardsDueForNotification", // Notify when
+        "widgetVibrate", // Vibrate
+        "widgetBlink", // Blink light
+        // potential personal data
+        "syncAccount",
+        "syncBaseUrl",
+        "language",
+        // Advanced statistics: will be removed when the new backend is the default
+        "stats_default_deck",
+        "advanced_statistics_link",
+        "advanced_statistics_enabled",
+        "advanced_forecast_stats_compute_n_days",
+        "advanced_forecast_stats_compute_precision",
+        "advanced_forecast_stats_mc_n_iterations"
+    )
+
+    @Test
+    fun `The include and excluded prefs lists don't share elements`() {
+        val intersection = preferencesWhoseChangesShouldBeReported.intersect(excludedPrefs)
+        assertThat(
+            "The include and exclude prefs list shouldn't share elements: $intersection",
+            intersection.isEmpty()
+        )
+    }
+
+    @Test
+    fun `All preferences are either included or excluded in the report list`() {
+        val keysNotInAList = PreferenceTestUtils.getAllPreferenceKeys(targetContext)
+            .subtract(excludedPrefs)
+            .subtract(preferencesWhoseChangesShouldBeReported)
+
+        assertThat(
+            "All preference keys must be included in either the" +
+                " `preferencesWhoseChangesShouldBeReported` or the `excludedPrefs` list" +
+                ": $keysNotInAList",
+            keysNotInAList.isEmpty()
+        )
+    }
+
+    @Test
+    fun `Dev options changes must not be reported`() {
+        val devOptionsKeys = PreferenceTestUtils.getKeysFromXml(targetContext, R.xml.preferences_dev_options)
+        val devOptionsAtReportList = preferencesWhoseChangesShouldBeReported.intersect(devOptionsKeys.toSet())
+
+        assertThat(
+            "dev options keys must not be in the `preferencesWhoseChangesShouldBeReported` list" +
+                ": $devOptionsAtReportList",
+            devOptionsAtReportList.isEmpty()
+        )
+    }
+
+    @Test
+    fun `getPreferenceReportableValue - String`() {
+        assertThat(
+            SettingsFragment.getPreferenceReportableValue("3"),
+            Matchers.equalTo(3)
+        )
+        assertNull(SettingsFragment.getPreferenceReportableValue("foo"))
+    }
+}