Question

我刚开始使用Koa应用程序，我需要测试从配置文件中获取数据的内容。

我需要使用特定数据进行测试，但我不确定如何修改测试从配置文件中接收的数据。

示例：

app.js

var router = require('koa-router');
var config = require('./config.js');
var db     = require('./db.js');
var auth   = require('./auth');
var app    = require('koa')();

router.get('/', function *() {
  if(auth(this.req, config.credentials.secret)) { // Authenticates request based on a hash created using a shared secret
    this.body = "Request has been authenticated";
  }
});

app.use(router.routes());
app = module.exports = http.createServer(app.callback());

app.listen(3000);

appSpec.js

var request = require('supertest');
var app = require('../app.js');

describe('app', function() {
  it('should authenticate all requests against config shared secret', function() {
    var secret    = 'some_secret';
    var validHash = /* hash created from test secret and query */;

    request(app)
      .get('/')
      .query({query: 'some_query'})
      .query({hash: validHash})
      .expect(403, done);

  });
});

此规范将失败，因为应用程序将使用配置文件中的密码（空字符串）而不是我的测试密钥。

Answer 1

好吧，我用一些不同的方法来处理这个问题。

对于我的特定用例，我找到的最佳选项是proxyquire。它是一个npm包，允许您覆盖测试套件中所需的任何文件中的依赖项。

所以，如果我正在测试这个模块：

./控制器/ myController.js

var config = require('../config.js');

module.exports = function() {
 // Do some stuff
};

我会做这样的事情：

./测试/控制器/ myControllerSpec.js

var proxyquire = require('proxyquire');
var config = {
  credentials: {
    secret: 'my_secret'
  }
  // other fake config stuff
};
var myController = proxyquire('../../controllers/myController.js', {'../config.js', config});

describe('myController', function() {
  // TESTS
});

此myController的实例将使用我的测试配置。

除非您导入配置的唯一位置是主应用文件，否则这不适用于端到端测试。

Answer 2

我使用node-config作为我的配置文件和基于机器或env变量的配置加载。

您可以使用各种格式（.json，.js，yaml等）指定配置。使用默认设置，您需要在应用根目录中创建config文件夹并{{1使用默认配置。

要覆盖测试，您可以在default.<format>目录中创建test.<format>文件。当您设置config时，NODE_ENV=test会看到加载您的默认配置文件，然后它将加载您的测试配置文件，如果值存在任何冲突，您的测试配置文件将覆盖这些值在您的默认文件中。

以下是在node-config

中设置Configuration Files的完整文档

以下是使用node-config配置文件格式的node-config的示例。

<强> ./配置/ default.js

.js

<强> ./配置/ test.js

module.exports = {
  credentials: {
    secret: ''
  }
}

<强> app.js

module.exports = {
  credentials: {
    secret: 'abcdef123456'
  }
}

Answer 3

Jest 对这种情况有很好的支持。在您的测试文件中，添加

jest.mock('../config.js', () => ({ 
  credentials: {
    secret: 'my_secret'
  }
  // other fake config stuff }));

如何模拟我的配置文件进行测试？

3 个答案: