如何使用 Mockito 模拟 SharedPreferences

Question

我刚刚读过有关 Android 中的单元仪表测试的内容，我想知道如何在没有任何 SharedPreferencesHelper 类的情况下模拟 SharedPreferences，就像这里

我的代码是：

public class Auth {
private static SharedPreferences loggedUserData = null;
public static String getValidToken(Context context)
{
    initLoggedUserPreferences(context);
    String token = loggedUserData.getString(Constants.USER_TOKEN,null);
    return token;
}
public static String getLoggedUser(Context context)
{
    initLoggedUserPreferences(context);
    String user = loggedUserData.getString(Constants.LOGGED_USERNAME,null);
    return user;
}
public static void setUserCredentials(Context context, String username, String token)
{
    initLoggedUserPreferences(context);
    loggedUserData.edit().putString(Constants.LOGGED_USERNAME, username).commit();
    loggedUserData.edit().putString(Constants.USER_TOKEN,token).commit();
}

public static HashMap<String, String> setHeaders(String username, String password)
{
    HashMap<String, String> headers = new HashMap<String, String>();
    String auth = username + ":" + password;
    String encoding = Base64.encodeToString(auth.getBytes(), Base64.DEFAULT);
    headers.put("Authorization", "Basic " + encoding);
    return headers;
}

public static void deleteToken(Context context)
{
    initLoggedUserPreferences(context);
    loggedUserData.edit().remove(Constants.LOGGED_USERNAME).commit();
    loggedUserData.edit().remove(Constants.USER_TOKEN).commit();
}

public static HashMap<String, String> setHeadersWithToken(String token) {
    HashMap<String, String> headers = new HashMap<String, String>();
    headers.put("Authorization","Token "+token);
    return headers;
}
private static SharedPreferences initLoggedUserPreferences(Context context)
{
    if(loggedUserData == null)
        loggedUserData = context.getSharedPreferences(Constants.LOGGED_USER_PREFERENCES,0);
    return loggedUserData;
}}

是否可以模拟 SharedPreferences 而无需在其上创建其他类？

Answer 1

所以，因为

SharedPreferences

来自你的

context

，所以很简单：

final SharedPreferences sharedPrefs = Mockito.mock(SharedPreferences.class);
final Context context = Mockito.mock(Context.class);
Mockito.when(context.getSharedPreferences(anyString(), anyInt())).thenReturn(sharedPrefs);

// no use context

例如，对于

getValidToken(Context context)

，测试可以是：

@Before
public void before() throws Exception {
    this.sharedPrefs = Mockito.mock(SharedPreferences.class);
    this.context = Mockito.mock(Context.class);
    Mockito.when(context.getSharedPreferences(anyString(), anyInt())).thenReturn(sharedPrefs);
}

@Test
public void testGetValidToken() throws Exception {
    Mockito.when(sharedPrefs.getString(anyString(), anyString())).thenReturn("foobar");
    assertEquals("foobar", Auth.getValidToken(context));
    // maybe add some verify();
}

Answer 2

以下示例展示了如何创建使用模拟上下文对象（例如共享首选项）的单元测试。

@RunWith(MockitoJUnitRunner.class)
public class MProfileTest {

   @Mock
   Context mockContext;
   @Mock
   SharedPreferences mockPrefs;
   @Mock
   SharedPreferences.Editor mockEditor;

   @Before
   public void before() throws Exception {

      Mockito.when(mockContext.getSharedPreferences(anyString(), anyInt())).thenReturn(mockPrefs);
      Mockito.when(mockContext.getSharedPreferences(anyString(), anyInt()).edit()).thenReturn(mockEditor);

      Mockito.when(mockPrefs.getString("YOUR_KEY", null)).thenReturn("YOUR_VALUE");
   }

   @Test
   public void anyTest() {
      // Any shared preference you can call
      // Assert.assertTrue();
      String val = _mockPrefs.getString("YOUR_KEY", null); // It returns YOUR_VALUE
   }
}

如果您在导入模拟框架时遇到任何问题，只需确保您已在

app/build.gradle

文件中添加了依赖项。

https://developer.android.com/training/testing/unit-testing/local-unit-tests#setup

---

如果您想通过将所有数据存储在内存中来使用真实共享偏好作为您的设备，请按照以下代码操作。

从此 Gist 获取 MockSharedPreference.java 文件 https://gist.github.com/aslamanver/f74a2b3d450fda251d47a0d38b44edb7

@Mock
Context mockContext;

MockSharedPreference mockPrefs;
MockSharedPreference.Editor mockPrefsEditor;

@Before
public void before() {

    mockPrefs = new MockSharedPreference();
    mockPrefsEditor = mockPrefs.edit();

    Mockito.when(mockContext.getSharedPreferences(anyString(), anyInt())).thenReturn(mockPrefs);
}

Answer 3

有一种更好的方法来模拟 SharedPreferences，恕我直言。 我喜欢 Mockito，但在每次测试中模拟 SharedPreferences 是没有效率的。

幸运的是，我们可以使用 shared-preferences-mock 库。该库在 JVM 上实现 SharedPrefences，因此它的行为就像一个真正的类。此外，可以编写本地单元测试。

对于您的情况：

import com.github.ivanshafran.sharedpreferencesmock.SPMockBuilder;

class Test {
    private Context context;
    private SharedPreferences sharedPreferences;

    @Before
    public void setUp() {
        this.sharedPreferences = new SPMockBuilder().createSharedPreferences();
        this.context = Mockito.mock(Context.class);         
        Mockito.when(context.getSharedPreferences(Constants.LOGGED_USER_PREFERENCES,0))
            .thenReturn(sharedPreferences);
    }
    
    @Test
    public void test() {
        sharedPreferences.edit().putString(Constants.LOGGED_USERNAME, "admin").commit();
        String value = Auth.getLoggedUser(context);
        asssertEquals("admin", value);
    }

}

添加依赖：

dependencies {
    testImplementation 'io.github.ivanshafran:shared-preferences-mock:1.2.4'
}