Mockito: 如何在Mockito中使用getString?

6

我参考了谷歌的一个关于如何测试你的SharedPreferences代码的示例,创建了一个SharedPreferencesHelper类:

https://github.com/googlesamples/android-https://github.com/googlesamples/android-testing/blob/master/unit/BasicSample/app/src/main/java/com/example/android/testing/unittesting/BasicSample/SharedPreferencesHelper.java

你可以看到该类使用实际字符串硬编码作为 sharedPreferences 的键 - 下面是该类的一部分代码片段:
public class SharedPreferencesHelper {

    // Keys for saving values in SharedPreferences.
    static final String KEY_NAME = "key_name";
    static final String KEY_DOB = "key_dob_millis";
    static final String KEY_EMAIL = "key_email";

    public boolean savePersonalInfo(SharedPreferenceEntry sharedPreferenceEntry){
        // Start a SharedPreferences transaction.
        SharedPreferences.Editor editor = mSharedPreferences.edit();
        editor.putString(KEY_NAME, sharedPreferenceEntry.getName());
        editor.putLong(KEY_DOB, sharedPreferenceEntry.getDateOfBirth().getTimeInMillis());
        editor.putString(KEY_EMAIL, sharedPreferenceEntry.getEmail());

        // Commit changes to SharedPreferences.
        return editor.commit();
    }

当在这里使用他们的 SharedPreferencesHelperTest 类进行测试时,他们使用上述类中定义的相同变量访问模拟的 sharedPreferences

https://github.com/googlesamples/android-testing/blob/master/unit/BasicSample/app/src/test/java/com/example/android/testing/unittesting/BasicSample/SharedPreferencesHelperTest.java

以下是该类的一部分内容:
when(mMockSharedPreferences.getString(eq(SharedPreferencesHelper.KEY_NAME), anyString()))
            .thenReturn(mSharedPreferenceEntry.getName());
    when(mMockSharedPreferences.getString(eq(SharedPreferencesHelper.KEY_EMAIL), anyString()))
            .thenReturn(mSharedPreferenceEntry.getEmail());
    when(mMockSharedPreferences.getLong(eq(SharedPreferencesHelper.KEY_DOB), anyLong()))
            .thenReturn(mSharedPreferenceEntry.getDateOfBirth().getTimeInMillis());

谷歌的方式允许他们绕过使用contextstring.xml资源文件中提取字符串并在sharedPreferences中查询它的问题,就像通常使用getString()一样。
mSharedPreferences.getString(context.getString(R.string.name),"");

然而,我已经阅读到context.getString不可能使用,因为它是一个final方法,mockito无法模拟final方法:

Mockito - Overriding a method that takes primitive parameters

那么,我如何使用mockito来单元测试任何带有getString的方法呢?任何带有getString的方法都将无法工作,我的单元测试将会失败。

这是我为SharedPreferences编写的类,我想用getStrings编写的sharedPreferences键来测试它:

public class SharedPreferencesHelper {

    // The injected SharedPreferences implementation to use for persistence.
    private final SharedPreferences mSharedPreferences;
    private Context context;

    public SharedPreferencesHelper(SharedPreferences sharedPreferences, Context context) {
        mSharedPreferences = sharedPreferences;
        this.context = context;
    }

    public boolean saveName(String name) {
        // Start a SharedPreferences transaction.
        SharedPreferences.Editor editor = mSharedPreferences.edit();
        editor.putString(context.getString(R.string.name), name);
        return editor.commit();
    }

    public String fetchName() {
        // Start a SharedPreferences transaction.
        return mSharedPreferences.getString(context.getString(R.string.name),"");
    }

    public boolean saveGender(String gender) {
        SharedPreferences.Editor editor = mSharedPreferences.edit();
        editor.putString(context.getString(R.string.gender), gender);
        return editor.commit();
    }

}

这是我为上述类编写的测试,它与Google的SharedPreferencesHelperTest非常相似:

@RunWith(MockitoJUnitRunner.class)
public class SharedPreferencesHelperTest {

    private static final String TEST_NAME = "Test name";

    private SharedPreferencesHelper mMockSharedPreferencesHelper;

    @Mock
    SharedPreferences mMockSharedPreferences;
    @Mock
    SharedPreferences.Editor mMockEditor;
    @Mock
    MockContext context;

    @Before
    public void setUp() throws Exception {
        // Create a mocked SharedPreferences.
        mMockSharedPreferencesHelper = createMockSharedPreference();
    }

    @Test
    public void testSaveName() throws Exception {
        boolean success = mMockSharedPreferencesHelper.saveName(TEST_NAME);
        Timber.e("success " + success);
        assertThat("Checking that name was saved... returns true = " + success,
                success, is(true));
        String name = mMockSharedPreferencesHelper.fetchName();
        Timber.e("name " + name);
        assertThat("Checking that name has been persisted and read correctly " + name,
                TEST_NAME,
                is(name));
    }

    /**
     * Creates a mocked SharedPreferences.
     */
    private SharedPreferencesHelper createMockSharedPreference() {
        // Mocking reading the SharedPreferences as if mMockSharedPreferences was previously written
        // correctly.
        when(mMockSharedPreferences.getString(Matchers.eq("name"), anyString()))
                .thenReturn(TEST_NAME);
        when(mMockSharedPreferences.getString(Matchers.eq("gender"), anyString()))
                .thenReturn("M");
        // Mocking a successful commit.
        when(mMockEditor.commit()).thenReturn(true);
        // Return the MockEditor when requesting it.
        when(mMockSharedPreferences.edit()).thenReturn(mMockEditor);
        return new SharedPreferencesHelper(mMockSharedPreferences, context);
    }
}

运行测试失败,因为我在我的SharedPreferencesHelper类中使用了getString。如果我硬编码键,就不会出现错误,即:

public String fetchName() {
    // Start a SharedPreferences transaction.
    return mSharedPreferences.getString("name","");
}

在代码中不应该硬编码字符串,那么我该如何解决这个困境?

4个回答

6

2

2017.06答案:

我按照jbarat的建议使用了Robolectric。开始有点陡峭,因为每个版本的Robolectric/Android Studio都会发生改变/弃用/删除/不兼容。

以下是我使用Android Studio 2.3.3和Robolectric 3.3.2使其正常工作的步骤:

build.gradle

testCompile "org.robolectric:robolectric:3.3.2"
testCompile "org.robolectric:shadows-multidex:3.3.2"

MyClass.java:

public static String myGetString(Context context) {
    return context.getString(R.string.my_string);
}

测试:

@RunWith(RobolectricTestRunner.class)
@Config(constants = BuildConfig.class, packageName = "com.myapplication", sdk = 19)
public class MyTest {
    private Context mockContext;

    @Before
    public void setUp() {
        // inject context provided by Robolectric
        mockContext = RuntimeEnvironment.application.getApplicationContext();
    }

    @Test
    public void test_myGetString() {
        assertEquals("MY STRING", MyClass.myGetString(mockContext));
    }
}

1
要启用对final方法的模拟,您需要使用Mockito v2,并按照此处的说明进行操作:Mock the unmockable: opt-in mocking of final classes/methods

create a file in src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker containing a single line:

mock-maker-inline
一旦您这样做,就可以模拟getString() when(mMockContext.getString(R.string.string_name)).thenReturn("Mocked String");

似乎这在Android上不起作用,getString总是返回null(使用Gradle 3.3.2和Mockito 2.23.4进行测试)。这可能解释了为什么(他们建议为Android制作的Mockito变体):https://medium.com/androiddevelopers/mock-final-and-static-methods-on-android-devices-b383da1363ad - user905686

0

我希望这是模拟字符串资源的一种可能性。

applicationMock = Mockito.mock(BaseApplication::class.java)
`when`(applicationMock.getString(R.string.primary_contact)).thenReturn("Primary Contact")

将此代码添加到测试类中。
@RunWith(RobolectricTestRunner::class)

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接