在React Native Keychain项目中使用Jest进行单元测试的完整指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00326/article/details/148578438

在React Native Keychain项目中使用Jest进行单元测试的完整指南

react-native-keychain :key: Keychain Access for React Native 项目地址: https://gitcode.com/gh_mirrors/re/react-native-keychain

前言

在React Native开发中，react-native-keychain是一个用于安全存储敏感信息（如用户凭证）的流行库。由于它需要与原生平台交互，在纯JavaScript环境中进行测试会面临挑战。本文将详细介绍如何使用Jest来模拟react-native-keychain模块，以便进行有效的单元测试。

为什么需要模拟Keychain模块

react-native-keychain的核心功能依赖于iOS和Android的原生API，这些API在Jest测试环境中是不可用的。直接调用这些方法会导致测试失败，因为：

没有真实的原生环境来执行安全存储操作
无法访问设备的安全存储区域
生物识别认证等硬件功能在测试环境中不可用

因此，我们需要创建模拟(mock)来替代真实的Keychain功能。

创建Keychain模拟对象

基础模拟结构

首先，我们需要创建一个完整的模拟对象，它应该包含:

所有枚举类型(SECURITY_LEVEL, ACCESSIBLE等)
所有异步方法(setGenericPassword, getGenericPassword等)
适当的模拟返回值

// keychainMock.ts

const keychainMock = {
  // 枚举类型
  SECURITY_LEVEL: {
    SECURE_SOFTWARE: 'MOCK_SECURITY_LEVEL_SECURE_SOFTWARE',
    // 其他枚举值...
  },
  
  // 异步方法
  setGenericPassword: jest.fn().mockResolvedValue({
    service: 'mockService',
    storage: 'mockStorage',
  }),
  
  getGenericPassword: jest.fn().mockResolvedValue({
    username: 'mockUser',
    password: 'mockPassword',
    service: 'mockService',
    storage: 'mockStorage',
  }),
  
  // 其他方法...
};

export default keychainMock;

模拟方法详解

对于每个模拟方法，我们可以根据测试需求进行定制：

mockResolvedValue - 模拟成功的Promise返回值
mockRejectedValue - 模拟失败的Promise返回值
mockImplementation - 自定义实现逻辑

例如，模拟一个失败的密码获取操作：

getGenericPassword: jest.fn().mockRejectedValue(new Error('密码不存在'))

两种主要的模拟方式

1. 使用mocks目录

这是Jest推荐的模块模拟方式，适用于全局模拟：

在项目根目录创建__mocks__文件夹
在内部创建react-native-keychain子目录
添加index.ts文件并导出模拟对象

// __mocks__/react-native-keychain/index.ts

const keychainMock = {
  // 完整的模拟对象
};

module.exports = keychainMock;

这种方式会自动应用于所有测试文件中对该模块的引用。

2. 使用Jest Setup文件

对于更灵活的模拟控制，可以使用setup文件：

在Jest配置中添加setup文件路径
在setup文件中手动模拟模块

// jest.config.js
module.exports = {
  setupFiles: ['<rootDir>/jest.setup.js'],
};

// jest.setup.js
import keychainMock from './path/to/keychainMock';
jest.mock('react-native-keychain', () => keychainMock);

编写测试用例

有了模拟设置后，我们可以编写各种测试场景：

基本功能测试

import Keychain from 'react-native-keychain';

describe('Keychain功能测试', () => {
  beforeEach(() => {
    jest.clearAllMocks();
  });

  it('应该能保存和读取凭证', async () => {
    await Keychain.setGenericPassword('user', 'pass');
    expect(Keychain.setGenericPassword).toHaveBeenCalledWith('user', 'pass');
    
    const creds = await Keychain.getGenericPassword();
    expect(creds.username).toBe('mockUser');
  });
});

错误场景测试

it('应该处理密码不存在的场景', async () => {
  Keychain.getGenericPassword.mockRejectedValueOnce(new Error('密码不存在'));
  
  await expect(Keychain.getGenericPassword()).rejects.toThrow('密码不存在');
});

生物识别测试

it('应该返回支持的生物识别类型', async () => {
  const type = await Keychain.getSupportedBiometryType();
  expect(type).toBe('MOCK_TouchID');
  
  // 可以动态修改模拟返回值
  Keychain.getSupportedBiometryType.mockResolvedValueOnce('MOCK_FaceID');
  const newType = await Keychain.getSupportedBiometryType();
  expect(newType).toBe('MOCK_FaceID');
});

高级技巧

模拟方法链式调用

Keychain.setGenericPassword
  .mockResolvedValueOnce({service: 'service1'}) // 第一次调用
  .mockRejectedValueOnce(new Error('存储失败')) // 第二次调用
  .mockResolvedValue({service: 'default'}); // 后续调用

验证调用参数

expect(Keychain.setGenericPassword).toHaveBeenCalledWith(
  expect.any(String), // 用户名可以是任何字符串
  'specificPassword', // 密码必须是特定值
  expect.objectContaining({ // 选项包含特定属性
    accessible: Keychain.ACCESSIBLE.WHEN_UNLOCKED
  })
);