围绕SharedPreference对帮助器类进行单元测试

Question

现在，我的助手类名为SharedPreferenceUserstore.kt，它接受Context对象。代码是：

class SharedPreferenceUserStore(context: Context) {
    companion object {
        val TAG = SharedPreferenceUserStore::class.java.simpleName
    }

    var userLocalSharedPref: SharedPreferences =
        context.getSharedPreferences(USER_LOCAL_STORE_SHARED_PREF_NAME, Context.MODE_PRIVATE)

    /*
    Store the required data to shared preference
     */
    @SuppressLint("ApplySharedPref")
    fun storeUserData(user: User) {
        val userLocalDatabaseEditor = userLocalSharedPref.edit()
        val serializedData = user.serialize()

        userLocalDatabaseEditor.putString(
            USER_LOCAL_STORE_SHARED_PREF_SERIALIZED_DATA_KEY,
            serializedData
        )
        if (userLocalDatabaseEditor.commit()) {
            Log.d(TAG, " Store Commit return true")
        }
    }


    /*
    Clear all the locally stored data from the shared pref
     */
    @SuppressLint("ApplySharedPref")
    fun clearUserData() {
        val userLocalDatabaseEditor = userLocalSharedPref.edit()
        userLocalDatabaseEditor.clear()
        userLocalDatabaseEditor.commit()
    }

    fun getLoggedInUser(): User? {
        val stringUser = userLocalSharedPref.getString(
            USER_LOCAL_STORE_SHARED_PREF_SERIALIZED_DATA_KEY, "")

        return if (stringUser==null || stringUser == ""){
            null
        } else{
            User.create(stringUser)
        }
    }

并且我为这个助手类编写了一些单元测试，如下所示：

@RunWith(JUnit4::class)
class SharedPreferenceUserStoreTest {

    lateinit var sharedPreferenceUserStore: SharedPreferenceUserStore
    lateinit var user: User

    //to be mocked
    lateinit var sharedPreferences: SharedPreferences
    lateinit var sharedPreferencesEditor: SharedPreferences.Editor
    lateinit var context: Context

    @Before
    fun setUp() {
        //mocking Context and SharedPreferences class
        context = mock(Context::class.java)
        sharedPreferences = mock(SharedPreferences::class.java)
        sharedPreferencesEditor = mock(SharedPreferences.Editor::class.java)

        //specifying that the context.getSharedPreferences() method call should return the mocked sharedpref
        `when`<SharedPreferences>(context.getSharedPreferences(anyString(), anyInt()))
            .thenReturn(sharedPreferences)
        //specifying that the sharedPreferences.edit() method call should return the mocked sharedpref editor
        `when`(sharedPreferences.edit()).thenReturn(sharedPreferencesEditor)
        //specifying that the sharedPreferencesEditor.putString() method call should return the mocked sharedpref Editor
        `when`(sharedPreferencesEditor.putString(anyString(), anyString())).thenReturn(
            sharedPreferencesEditor
        )
        `when`(sharedPreferences.getString(anyString(), anyString())).thenReturn("")

        //instantiating  SharedPreferenceUserStore from the mocked context
        sharedPreferenceUserStore = SharedPreferenceUserStore(context)


        user = User(
            35,
            "Prashanna Bhandary",
            "[e-mail]",
            "dd58a617ea618010c2052cb54079ad67.jpeg",
            "98********",
            "test address 01",
            1,
            "yes",
            "2019-08-30 04:56:43",
            "2019-08-30 05:14:47",
            0
        )
    }

    @After
    fun tearDown() {
    }

    @Test
    fun passUser_storeUserData() {
        sharedPreferenceUserStore.storeUserData(user)

        verify(sharedPreferencesEditor).putString(
            Constants.USER_LOCAL_STORE_SHARED_PREF_SERIALIZED_DATA_KEY,
            user.serialize()
        )
        verify(sharedPreferencesEditor).commit()
    }

    @Test
    fun testClearUserData() {
        sharedPreferenceUserStore.clearUserData()

        verify(sharedPreferencesEditor).clear()
    }


    @Test
    fun testGetLoggedInUser_storeNotCalled() {
        //calling getLoggedInUser() without calling storeUserData() should give null
        assertEquals(null, sharedPreferenceUserStore.getLoggedInUser())
        //verify that getString() was called on the shared preferences
        verify(sharedPreferences).getString(Constants.USER_LOCAL_STORE_SHARED_PREF_SERIALIZED_DATA_KEY, "")
    }

    @Test
    fun testGetLoggedInUser_storeCalled(){

        //call getLoggedInUser(), we are expecting null
        assertNull(sharedPreferenceUserStore.getLoggedInUser())

        //verify that getString() was called on the shared preferences
        verify(sharedPreferences).getString(Constants.USER_LOCAL_STORE_SHARED_PREF_SERIALIZED_DATA_KEY, "")
    }
}

因为我对单元测试和模拟库（如mockito）非常陌生。现在我的问题是我的测试有什么好处吗？我想测试我的助手类的getLoggedinUser()功能是否在做它应该做的事情（即，如果共享的pref有登录的用户，则获取登录的用户），我该如何做呢？

Answer 1

判断您的测试是什么--在主机上运行的单元测试，使用Mockito模拟了Android依赖项--它看起来很好，像您所期望的那样。

然而，这种测试的收益与努力的比例是有争议的。我个人认为，在设备上针对真正的SharedPreferences实现运行这样一个测试，并根据实际的副作用进行断言，而不是在模拟上进行验证，会更有价值。这比模拟测试有几个好处：

• 您不必使用mocking重新实现SharedPreferences
• 您知道SharedPreferenceUserStore将使用真正的SharedPreference实现

但是，这样的测试也有一个有争议的利益与努力的比例。对于一个单独的开发人员项目，考虑什么样的测试是最重要的。你的时间是有限的，所以你只有时间花在写最重要的测试上。

最重要的测试是那些以用户使用应用程序的方式测试应用程序的测试。换句话说，编写高级UI自动化程序测试。您可以根据需要编写多少模拟或设备上的单元测试。如果您不测试您的整个应用程序作为一个整体是否有效，您将不知道它是否有效。如果你不知道你的应用程序作为一个整体是有效的，你就不能发布它。因此，在某种程度上，您必须测试您的应用程序的整体。随着您添加越来越多的功能，手动快速地完成它将变得非常劳动密集型。持续测试应用程序的唯一方法是自动化应用程序的高级UI测试。这样，您还将获得重要的代码覆盖率。

值得指出的是，高级UI测试的一大好处是，无论何时更改应用程序中的某些实现细节，都不必更改它们。如果您有很多模拟的单元测试，您将不得不花费大量的时间来重构您的单元测试，因为您重构真实的应用程序代码，这可能非常耗时，因此如果您是一个单独的开发人员，这是一个坏主意。您的UI Automator测试不依赖于低级的实现细节，因此即使您更改了实现细节也会保持不变。