29

我正在使用 React Native 构建一个应用程序。我想尽量减少与数据库通信的频率,所以我大量使用 AsyncStorage。但是,在 DB 和 AsyncStorage 之间的转换中存在很大的错误空间。因此,我想通过对它运行自动化测试来确保 AsyncStorage 拥有我相信的数据。令人惊讶的是,我还没有找到任何关于如何在网上做到这一点的信息。我自己尝试做这件事并没有成功。

使用笑话:

it("can read asyncstorage", () => {
return AsyncStorage.getItem('foo').then(foo => {
  expect(foo).not.toBe("");
});  });

此方法失败并出现错误:

TypeError: RCTAsyncStorage.multiGet is not a function

删除 return 将导致它立即运行而无需等待 value 并错误地通过测试。

当我尝试使用 await 关键字对其进行测试时,我遇到了完全相同的错误:

it('can read asyncstorage', async () => {
this.foo = "";
await AsyncStorage.getItem('foo').then(foo => {
    this.foo = foo;
});
expect(foo).not.toBe(""); });

有关如何针对 AsyncStorage 中的值成功运行断言的任何建议?我更愿意继续使用 Jest,但如果它只能通过一些备用测试库来完成,我对此持开放态度。

4

7 回答 7

46

对于在 > 2019 中看到此问题的每个人:

2020 年 11 月以来,AsyncStorage 已重命名为@react-native-async-storage/async-storage",如果您从以下位置导入它,则会出现此警告react-native

Warning: Async Storage has been extracted from react-native core and will be removed in a future release.

新模块包含自己的模拟,因此您不必再担心自己编写。

根据项目的文档,您可以通过 2 种不同的方式进行设置:

##带模拟目录

  • 在您的项目根目录中,创建一个__mocks__/@react-native-community目录。
  • 在该文件夹中,创建 async-storage.js 文件。
  • 在该文件中,导出异步存储模拟。
    export default from '@react-native-async-storage/async-storage/jest/async-storage-mock'
    

Jest 应该AsyncStorage在你的所有测试中默认模拟。如果没有,请尝试jest.mock(@react-native-async-storage/async-storage)在测试文件的顶部调用。

使用 Jest 设置文件

  • 在您的 Jest 配置中(可能在package.jsonor中jest.config.js)添加安装文件的位置:
    "jest": {
      "setupFiles": ["./path/to/jestSetupFile.js"]
    }
    
  • 在您的设置文件中,设置 AsyncStorage 模拟:
    import mockAsyncStorage from '@react-native-async-storage/async-storage/jest/async-storage-mock';
    
    jest.mock('@react-native-community/async-storage', () => mockAsyncStorage);
    

如果您使用的是 TypeScript,则使用第二个选项(Jest 设置文件)更容易,因为第一个选项(模拟目录)不会@types/react-native-community__async-storage自动与模拟关联。

于 2019-04-15T16:07:11.823 回答
25

也许你可以尝试这样的事情:

模拟存储.js

export default class MockStorage {
  constructor(cache = {}) {
    this.storageCache = cache;
  }

  setItem = jest.fn((key, value) => {
    return new Promise((resolve, reject) => {
      return (typeof key !== 'string' || typeof value !== 'string')
        ? reject(new Error('key and value must be string'))
        : resolve(this.storageCache[key] = value);
    });
  });

  getItem = jest.fn((key) => {
    return new Promise((resolve) => {
      return this.storageCache.hasOwnProperty(key)
        ? resolve(this.storageCache[key])
        : resolve(null);
    });
  });

  removeItem = jest.fn((key) => {
    return new Promise((resolve, reject) => {
      return this.storageCache.hasOwnProperty(key)
        ? resolve(delete this.storageCache[key])
        : reject('No such key!');
    });
  });

  clear = jest.fn((key) => {
    return new Promise((resolve, reject) =>  resolve(this.storageCache = {}));
  });

  getAllKeys = jest.fn((key) => {
    return new Promise((resolve, reject) => resolve(Object.keys(this.storageCache)));
  });
}

并在您的测试文件中

import MockStorage from './MockStorage';

const storageCache = {};
const AsyncStorage = new MockStorage(storageCache);

jest.setMock('AsyncStorage', AsyncStorage)

// ... do things
于 2016-12-04T10:19:34.450 回答
19

我最初的回答只是指出 react-native-simple-store 的作者是如何处理嘲笑的。我用我自己的模拟更新了我的答案,删除了杰森的硬编码模拟响应。

Jason Merinohttps://github.com/jasonmerino/react-native-simple-store/blob/master/tests/index-test.js#L31-L64有一个很好的简单方法

jest.mock('react-native', () => ({
AsyncStorage: {
    setItem: jest.fn(() => {
        return new Promise((resolve, reject) => {
            resolve(null);
        });
    }),
    multiSet:  jest.fn(() => {
        return new Promise((resolve, reject) => {
            resolve(null);
        });
    }),
    getItem: jest.fn(() => {
        return new Promise((resolve, reject) => {
            resolve(JSON.stringify(getTestData()));
        });
    }),
    multiGet: jest.fn(() => {
        return new Promise((resolve, reject) => {
            resolve(multiGetTestData());
        });
    }),
    removeItem: jest.fn(() => {
        return new Promise((resolve, reject) => {
            resolve(null);
        });
    }),
    getAllKeys: jest.fn(() => {
        return new Promise((resolve) => {
            resolve(['one', 'two', 'three']);
        });
    })
  }
}));

我自己的模拟:

const items = {};

jest.mock('react-native', () => ({

AsyncStorage: {        

    setItem: jest.fn((item, value) => {
        return new Promise((resolve, reject) => {        
    items[item] = value;
            resolve(value);
        });
    }),
    multiSet:  jest.fn((item, value) => {
        return new Promise((resolve, reject) => {
    items[item] = value;
            resolve(value);
        });
    }),
    getItem: jest.fn((item, value) => {
        return new Promise((resolve, reject) => {
            resolve(items[item]);
        });
    }),
    multiGet: jest.fn((item) => {
        return new Promise((resolve, reject) => {
            resolve(items[item]);
        });
    }),
    removeItem: jest.fn((item) => {
        return new Promise((resolve, reject) => {
            resolve(delete items[item]);
        });
    }),
    getAllKeys: jest.fn((items) => {
        return new Promise((resolve) => {
            resolve(items.keys());
        });
    })
  }
}));
于 2017-01-04T17:11:40.847 回答
1

我认为jest.setMock在这种情况下可能比 jest.mock 更好,所以我们可以毫无问题地使用react-native,只是模拟这样的AsyncStorage

jest.setMock('AsyncStorage', {
  getItem: jest.fn(
    item =>
      new Promise((resolve, reject) => {
        resolve({ myMockObjectToReturn: 'myMockObjectToReturn' });
      })
  ),
});
于 2018-11-06T13:50:47.463 回答
1

使用命令安装模块:从项目的根目录运行此命令。

npm install --save mock-async-storage

在项目根目录中创建__mocks__\@react-native-community文件夹。在其中创建一个文件 async-storage.js。async-storage.js 中的代码

export default from '@react-native-community/async-storage/jest/async-storage-mock'

在 package.json 中配置 jest 如下:

"jest": {
    "preset": "jest-expo",
    "transformIgnorePatterns" : ["/node_modules/@react-native-community/async-storage/(?!(lib))"]
  },

这里我使用 jest-expo 进行测试。如果您使用的是 jest,那么预设值将是 jest 而不是 jest-expo。

在项目根目录中,在 jest.config.js 文件中创建一个名为 jest.config.js 的配置文件:

module.exports = {
    setupFilesAfterEnv: [
      './setup-tests.js',
    ],
  };

在项目根目录中创建一个名为 setup-tests.js 的文件。此文件中的代码是:

import MockAsyncStorage from 'mock-async-storage';

const mockImpl = new MockAsyncStorage();
jest.mock('@react-native-community/async-storage', () => mockImpl);

在项目根目录中创建测试文件。这里我称它为 Example.test.js。

import  AsyncStorage  from '@react-native-community/async-storage';

beforeEach(() => {
    AsyncStorage.clear();
    // console.log(`After the data is being reset :`)
    // console.log(AsyncStorage)
});

it('can read asyncstorage', async () => {

    await AsyncStorage.setItem('username', 'testUser')
    let usernameValue = await AsyncStorage.getItem('username')
    // console.log(`After the data is being set :`)
    // console.log(AsyncStorage)
    expect(usernameValue).toBe('testUser')
});

这里使用 AsyncStorage.setItem 将用户名的值设置为testUser。然后使用 getItem 函数获取值。测试用例是比较usernameValue是否等于testUser。如果是,则测试用例通过,否则测试用例将失败。

使用 beforeEach 以便每次运行测试用例时 Asyncstorage 都会被清除并且为空。如果需要,可以使用 console.log 检查 Asyncstorage 中存在的内容

运行命令yarn test来运行测试。输出是:

在此处输入图像描述

于 2020-11-06T06:10:43.117 回答
0

我刚刚在使用最新版本的 Expo 运行 jest 时遇到了这个问题,并按照https://react-native-async-storage.github.io/async-storage/docs/的说明中的“jest setup file”选项解决了这个问题高级/开玩笑/

请注意,AsyncStorage(无论出于何种原因)已重命名\移回“@react-native-async-storage/async-storage”,并且其包名称中不再包含“community”。

于 2020-12-18T17:55:44.883 回答
0

1-__mocks__在根项目中添加文件夹

2-在文件夹@react-native-async-storage中添加文件__mocks__

3-添加async-storage.js文件@react-native-async-storage

4-添加代码:

let db = {};

export default {
    setItem: (item, value) => {
        return new Promise((resolve, reject) => {
            db[item] = value;
            resolve(value);
        });
    },
    multiSet: (item, fun) => {
        return new Promise((resolve, reject) => {
            for (let index = 0; index < item.length; index++) {
                db[item[index][0]] = item[index][1];
            }
            fun()
            resolve(value);
        });
    },
    getItem: (item, value= null) => {
        return new Promise((resolve, reject) => {
            resolve(db[item]);
        });
    },
    multiGet: (item) => {
        return new Promise((resolve, reject) => {
            resolve(db[item]);
        });
    },
    removeItem: (item) => {
        return new Promise((resolve, reject) => {
            resolve(delete db[item]);
        });
    },
    getAllKeys: (db) => {
        return new Promise((resolve) => {
            resolve(db.keys());
        });
    }
}
于 2020-12-27T14:05:46.453 回答