使用 Jest 测试 React Native 应用程序

Testing React Native apps with Jest

我一直在尝试让 Jest 与我的 React Native 项目一起工作,但运气不佳。似乎大多数线程都是黑客解决方案来解决问题 运行ning 并且我似乎无法克服我面临的最后一个障碍。

问题

我在尝试 运行 以下代码段时遇到以下错误。如果我在 jestSupport/env.js 文件中模拟 react-native 我可以克服错误但显然我不能使用任何结构如 AsyncStorage 来实际测试我的代码(因为我将只有模拟功能).

问题

有人对如何解决这个问题有什么建议吗?

在这个阶段,我愿意尝试任何事情,包括放弃我拥有的所有与测试相关的内容,然后再试一次。如果是这样的话,我需要遵循一些指导方针,因为关于 Jest 的 React Native 文档已经非常过时了,而且我对 React 场景还比较陌生。

错误

Runtime Error
Error: Cannot find module 'ReactNative' from 'react-native.js'
    at Runtime._resolveNodeModule (/Users/Yulfy/Downloads/COMPANY-Mobile/node_modules/jest-cli/src/Runtime/Runtime.js:451:11)
    at Object.<anonymous> (/Users/Yulfy/Downloads/COMPANY-Mobile/node_modules/react-native/Libraries/react-native/react-native.js:181:25)
    at Object.<anonymous> (/Users/Yulfy/Downloads/COMPANY-Mobile/network/connections.js:8:18)

测试代码

jest.unmock('../network/connections');

import Authorisation from '../network/connections';

describe('connections', () => {
  it('Should store and retrieve a mocked user object', () => {
    Auth = new Authorisation();
    const TEST_STRING = "CONNECTION TEST PASS";
    var userObj = {
      test_string: TEST_STRING
    };
    Auth._localStore(userObj, (storeRes) => {
      Auth._localRetrieve((retRes) => {
        expect(retRes.test_string).toEqual(TEST_STRING);
      });
    });
  });
});

connection.js

/*
*  All returns should give the following structure:
*  {isSuccess: boolean, data: object}
*/


import React, { Component } from 'react';
import { AsyncStorage } from 'react-native';

const Firebase = require('firebase');
const FIREBASE_URL = 'https://COMPANY-test.firebaseio.com';
const STORAGE_KEY = 'USER_DATA';
class Authorisation{
  _ref = null;
  user = null;

  constructor(){

  }

  getOne(){return 1;}
  _setSystemUser(userObj, authObj, callback){
    var ref = this.connect();
    if(ref === null){
      callback({isSuccess:false, data:{message:"Could not connect to the server"}});
    }
    ref = ref.child('users').child(authObj.uid);
    ref.once("value", function(snapshot){
      if(snapshot.exists()){
        callback({isSuccess:false, data:{message:"Email is currently in use"}});
        return;
      }
      ref.set(userObj, function(error){
        if(error){
          callback({isSuccess:false, data:error});
        }else{
          callback({isSuccess:true, data:authObj});
        }
      });
    });
  }

  _localStore(userObj, callback){
    AsyncStorage.setItem(STORAGE_KEY, userObj, (error) => {
      console.log("_localStore::setItem -> ", error);
      if(error){
        callback({
          isSuccess:false,
          data:'Failed to store user object in storage.'
        });
      }else{
        callback({
          isSuccess:true,
          data: userObj
        });
      }
    });
  }
  _localRetrieve(callback){
    AsyncStorage.getItem(STORAGE_KEY, (error, res) => {
      console.log("_localStore::getItem:error -> ", error);
      console.log("_localStore::getItem:result -> ", res);
      if(error){
        callback({
          isSuccess:false,
          data:error
        });
      }else{
        callback({
          isSuccess: true,
          data: res
        });
      }
    });
  }

  connect(){
    if(this._ref === null){
      _ref = new Firebase(FIREBASE_URL);
    }
    return _ref;
  }

  getUser(){

  }

  isLoggedIn(){

  }

  registerUser(userObj, callback){
    var ref = this.connect();
    if(ref === null){
      callback({isSuccess:false, data:{message:"Could not connect to the server"}});
    }
    var that = this;
    ref.createUser({
      email: userObj.username,
      password: userObj.password
    }, function(error, userData){
      if(error){
        callback({isSuccess:false, data:error});
        return;
      }
      var parseObj = {
        email: userObj.username,
        fullName: userObj.fullName
      };
      that.loginUser(parseObj, function(res){
        if(res.isSuccess){
          that._setSystemUser(parseObj, res.data, callback);
        }else{
          callback(res);//Fail
        }
      });
    });
  }

  loginUser(userObj, callback){
    var ref = this.connect();
    if(ref === null){
      callback({isSuccess:false, data:{message:"Could not connect to the server"}});
    }
    ref.authWithPassword({
      email: userObj.email,
      password: userObj.password
    }, function(error, authData){
      if(error){
        callback({isSuccess:false, data:error.message});
      }else{
        callback({isSuccess:true, data:authData});
      }
    });

  }
}

export default Authorisation;

如果您已经读到这里,感谢您的宝贵时间!

-尤尔菲

您是否尝试在测试文件中模拟 react-native?

它适用于我的测试用例:

jest.dontMock(`../my-module-that-uses React-native.AsyncStorage`);

jest.setMock(`react-native`, {
  AsyncStorage: {
    multiGet: jest.fn(),
  },
});

const ReactNative = require(`react-native`);
const {AsyncStorage, } = ReactNative;

const myModule = require(`../my-module-that-uses React-native.AsyncStorage`);

// Do some tests and assert ReactNative.AsyncStorage.multiGet calls

TL;DR

我在这个 GitHub Repo.

中有一个 Jest 运行 最新版本 React Native (v0.28.0) 的工作示例

-

在调查这个问题一段时间后,我终于找到了解决方案。

有一些与 Jest 集成的 React Native 应用程序的在线示例,但不幸的是,您不能简单地将代码复制并粘贴到您的代码库中并期望它能正常工作。这是因为RN版本差异。

v0.20.0 之前的 React Native 版本在打包器 (node_modules/react-native/packager/react-packager/.babelrc) 中包含一个 .babelrc 文件,一些在线示例直接将其包含在 package.json 中。但是,版本 v0.20.0 及更高版本更改为不再包含此文件,这意味着您不能再尝试包含它。因此,我建议使用您自己的 .babelrc 文件并定义您自己的预设和插件。

我不知道你的 package.json 文件是什么样的,但它是解决这个问题的一个非常重要的部分。

{
    "name": "ReactNativeJest",
    "version": "0.0.1",
    "jest": {
        "scriptPreprocessor": "<rootDir>/node_modules/babel-jest",
        "unmockedModulePathPatterns": [
            "node_modules"
        ],
        "verbose": true,
        "collectCoverage": true
    },
    "scripts": {
        "test": "jest"
    },
    "dependencies": {
        "react": "^15.1.0",
        "react-native": "^0.27.2"
    },
    "devDependencies": {
        "babel-core": "^6.4.5",
        "babel-jest": "^12.1.0",
        "babel-plugin-transform-regenerator": "^6.0.18",
        "babel-polyfill": "^6.0.16",
        "babel-preset-react-native": "^1.9.0",
        "babel-types": "^6.1.2",
        "chai": "^3.5.0",
        "enzyme": "^2.3.0",
        "jest-cli": "^12.1.1",
        "react-addons-test-utils": "^15.1.0",
        "react-dom": "^15.1.0"
    }
}

另一个重要的部分是模拟 React Native。我创建了一个 __mocks__/react-native.js 文件,如下所示:

'use strict';

var React = require('react');
var ReactNative = React;

ReactNative.StyleSheet = {
    create: function(styles) {
        return styles;
    }
};

class View extends React.Component {}
class Text extends React.Component {}
class TouchableHighlight extends React.Component {}

// Continue to patch other components as you need them
ReactNative.View = View;
ReactNative.Text = Text;
ReactNative.TouchableHighlight = TouchableHighlight;

module.exports = ReactNative;

通过像这样猴子修补 React Native 函数,您可以成功避免在尝试 运行 测试时遇到奇怪的 Jest 错误。

最后,确保在项目的根目录中创建一个 .babelrc 文件,该文件至少包含以下几行:

{
    "presets": ["react-native"],
    "plugins": [
        "transform-regenerator"
    ]
}

这个文件将用来告诉 babel 如何正确转换你的 ES6 代码。

完成此设置后,运行将 Jest 与 React Native 结合使用应该没有任何问题。我相信 React Native 的未来版本将使将这两个框架集成在一起变得更加容易,但这项技术将完美地适用于当前版本:)

编辑

无需在 __mocks__/react-native.js 文件中手动模拟 ReactNative 元素,您可以使用 react-native-mock 库为您进行模拟(确保将库添加到 package.json 文件):

// __mocks__/react-native.js

module.exports = require('react-native-mock');

我更新了 GitHub Repo 示例来演示此方法。