grain.social/grain-android

Switch repository

Loading…

package social.grain

import androidx.test.ext.junit.runners.AndroidJUnit4
import org.junit.After
import org.junit.Assert.assertEquals
import org.junit.Assert.assertFalse
import org.junit.Assert.assertNull
import org.junit.Assert.assertTrue
import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith
import social.grain.data.local.Appearance
import social.grain.data.local.AppearanceStore
import social.grain.data.push.PushManager
import social.grain.feature.settings.SettingsViewModel
import social.grain.support.Harness
import social.grain.support.MainDispatcherRule
import social.grain.support.appContext
import social.grain.support.awaitCall
import social.grain.support.awaitValue
import social.grain.support.settle

/**
 * Settings: three switches, an account, and the two ways out of it.
 *
 * The upload defaults live on the server, so each switch is a write that can
 * fail — and a switch that stays flipped after a failed write is a lie about
 * what the account actually holds.
 */
@RunWith(AndroidJUnit4::class)
class SettingsViewModelTest {

    @get:Rule
    val mainDispatcher = MainDispatcherRule()

    private lateinit var harness: Harness
    private lateinit var appearance: AppearanceStore
    private lateinit var push: PushManager

    @Before
    fun setUp() {
        harness = Harness()
        appearance = AppearanceStore(appContext)
        appearance.set(Appearance.AUTOMATIC)
        push = PushManager(
            appContext,
            harness.client,
            harness.auth,
            social.grain.data.auth.SecureStore(appContext),
            harness.scope,
        )
        harness.server.on(
            "social.grain.actor.getPreferences",
            """{"preferences":[{"${'$'}type":"social.grain.actor.defs#photoMetadataPref",""" +
                """"includeExif":false,"includeLocation":true}]}""",
        )
    }

    @After
    fun tearDown() {
        appearance.set(Appearance.AUTOMATIC)
        harness.tearDown()
    }

    private fun viewModel() =
        SettingsViewModel(harness.client, harness.auth, push, appearance)

    @Test
    fun theSignedInAccountAndItsUploadDefaultsAreShown() {
        val model = viewModel()
        val state = model.state.awaitValue("the preferences") { it.did != null && !it.includeExif }

        assertEquals(harness.handle, state.handle)
        assertEquals(harness.did, state.did)
        assertFalse(state.includeExif)
        assertTrue(state.includeLocation)
        assertEquals(Appearance.AUTOMATIC, state.appearance)
    }

    @Test
    fun preferencesTheServerHasNeverStoredDefaultToOn() {
        harness.server.on("social.grain.actor.getPreferences", """{"preferences":[]}""")
        val model = viewModel()
        val state = model.state.awaitValue("the account") { it.did != null }

        assertTrue(state.includeExif)
        assertTrue(state.includeLocation)
    }

    @Test
    fun aFailedPreferenceReadLeavesTheDefaultsAlone() {
        harness.server.on("social.grain.actor.getPreferences", """{"error":"no"}""", code = 500)
        val model = viewModel()
        val state = model.state.awaitValue("the account") { it.did != null }

        assertTrue(state.includeExif)
        assertNull(state.errorMessage)
    }

    @Test
    fun theAppearanceChoiceIsRememberedAndObserved() {
        val model = viewModel()
        model.state.awaitValue("the account") { it.did != null }

        model.setAppearance(Appearance.DARK)

        assertEquals(
            Appearance.DARK,
            model.state.awaitValue("the appearance") { it.appearance == Appearance.DARK }.appearance,
        )
        assertEquals(
            "It has to survive the process, not just the screen",
            Appearance.DARK,
            AppearanceStore(appContext).appearance.value,
        )
    }

    @Test
    fun aSwitchFlipsImmediatelyAndWritesThePreference() {
        val model = viewModel()
        // Not just the account: the stored preferences land after it, and would
        // otherwise overwrite the flip under test.
        model.state.awaitValue("the preferences") { it.did != null && !it.includeExif }

        model.setIncludeExif(true)
        assertTrue("The switch moves before the write", model.state.value.includeExif)

        val call = harness.server.awaitCall("social.grain.actor.putPreferences")
        assertTrue(call.body.contains("\"${'$'}type\":\"social.grain.actor.defs#photoMetadataPref\""))
        assertTrue(call.body.contains("\"includeExif\":true"))
        assertTrue("The other setting goes back as it was", call.body.contains("\"includeLocation\":true"))
    }

    @Test
    fun aSwitchThatCannotBeSavedFlipsBackAndSaysSo() {
        harness.server.on("social.grain.actor.putPreferences", """{"error":"no"}""", code = 500)
        val model = viewModel()
        model.state.awaitValue("the preferences") { it.did != null && !it.includeExif }

        model.setIncludeLocation(false)

        val state = model.state.awaitValue("the revert") { it.errorMessage != null }
        assertTrue(state.includeLocation)
        assertEquals("Couldn't save that setting.", state.errorMessage)

        model.dismissError()
        assertNull(model.state.value.errorMessage)
    }

    @Test
    fun signingOutClearsTheSessionAndTakesTheDeviceOffPush() {
        val model = viewModel()
        model.state.awaitValue("the account") { it.did != null }

        model.signOut()

        model.state.awaitValue("the sign-out") { it.did == null }
        assertFalse(harness.auth.state.value.isAuthenticated)
    }

    @Test
    fun deletingTheAccountSignsOutOnceTheServerAgrees() {
        harness.server.on("social.grain.server.deleteAccount", """{"deleted":0,"done":true}""")
        val model = viewModel()
        model.state.awaitValue("the account") { it.did != null }

        model.deleteAccount()

        val state = model.state.awaitValue("the deletion") { it.isDeleted }
        assertFalse(state.isDeleting)
        assertFalse(harness.auth.state.value.isAuthenticated)
        harness.server.awaitCall("social.grain.server.deleteAccount")
    }

    @Test
    fun aDeletionThatFailsLeavesTheAccountSignedIn() {
        harness.server.on(
            "social.grain.server.deleteAccount",
            """{"error":"no"}""",
            code = 500,
        )
        val model = viewModel()
        model.state.awaitValue("the account") { it.did != null }

        model.deleteAccount()

        val state = model.state.awaitValue("the error") { it.errorMessage != null }
        assertFalse(state.isDeleted)
        assertEquals("Couldn't delete the account. Try again.", state.errorMessage)
        assertTrue(harness.auth.state.value.isAuthenticated)
    }

    @Test
    fun aSignedOutViewerCannotDeleteAnAccount() {
        harness.tearDown()
        harness = Harness(signedIn = false)
        val model = viewModel()
        settle()

        model.deleteAccount()

        val state = model.state.awaitValue("the error") { it.errorMessage != null }
        assertEquals("You're signed out.", state.errorMessage)
        assertEquals(0, harness.server.countOf("social.grain.server.deleteAccount"))
    }
}