Mocha API 测试: 获取‘ TypeError: app.address is not a function’

我的问题

我已经编写了一个非常简单的 CRUD API,并且最近开始使用 chaichai-http编写一些测试代码,但是在使用 $ mocha运行测试时遇到了一个问题。

当我运行测试时,我在 shell 上得到以下错误:

Address 不是函数

我的准则

下面是我的一个测试(/test/server-test. js)的例子:

var chai = require('chai');
var mongoose = require('mongoose');
var chaiHttp = require('chai-http');
var server = require('../server/app'); // my express app
var should = chai.should();
var testUtils = require('./test-utils');


chai.use(chaiHttp);


describe('API Tests', function() {
before(function() {
mongoose.createConnection('mongodb://localhost/bot-test', myOptionsObj);
});


beforeEach(function(done) {
// I do stuff like populating db
});


afterEach(function(done) {
// I do stuff like deleting populated db
});


after(function() {
mongoose.connection.close();
});


describe('Boxes', function() {


it.only('should list ALL boxes on /boxes GET', function(done) {
chai.request(server)
.get('/api/boxes')
.end(function(err, res){
res.should.have.status(200);
done();
});
});


// the rest of the tests would continue here...


});


});

还有我的 express应用程序文件(/server/app.js) :

var mongoose = require('mongoose');
var express = require('express');
var api = require('./routes/api.js');
var app = express();


mongoose.connect('mongodb://localhost/db-dev', myOptionsObj);


// application configuration
require('./config/express')(app);


// routing set up
app.use('/api', api);


var server = app.listen(3000, function () {
var host = server.address().address;
var port = server.address().port;


console.log('App listening at http://%s:%s', host, port);
});

及(服务器/路由/api.js) :

var express = require('express');
var boxController = require('../modules/box/controller');
var thingController = require('../modules/thing/controller');
var router = express.Router();


// API routing
router.get('/boxes', boxController.getAll);
// etc.


module.exports = router;

附加提示

在运行测试之前,我已经尝试在 /test/server-test. js文件中注销 server变量:

...
var server = require('../server/app'); // my express app
...


console.log('server: ', server);
...

结果是一个空对象: server: {}

101137 次浏览

您不需要导出应用程序模块中的任何内容,尝试将其添加到 app.js 文件中:

module.exports = server

这也可能有所帮助,并满足@dman 更改应用程序代码以适应测试的要求。

根据需要向本地主机和端口发出请求 Chai.request (「 http://localhost:5000」)

而不是

Chai.request (服务器)

这修复了我使用 Koa JS (v2)和 ava JS 得到的错误消息。

一定要导出由 app.listen(3000)返回的 http.Server对象,而不仅仅是函数 app,否则您将得到 TypeError: app.address is not a function

例如:

Index.js

const koa = require('koa');
const app = new koa();
module.exports = app.listen(3000);

Index.spec.js

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


describe('User Registration', () => {
const agent = request.agent(app);


it('should ...', () => {

当我们在 node + typecript serverless 项目中使用 ts-node 运行 mocha 时,我们遇到了同样的问题。

我们的 tsconfig.json 有“ source Map”: true。如此产生。JS 和。Map 文件会导致一些有趣的传递问题(类似于这个)。当我们使用 t-node 运行摩卡运行程序时。因此,我会将 sourceMap 标志设置为 false 并删除所有。JS 和。Src 目录中的 js.map 文件。那问题就解决了。

如果您已经在 src 文件夹中生成了文件,下面的命令将非常有帮助。

查找 src-name“ < em > . js.map”-exec rm {} ; 查找 src-name“ . js”-exec rm {} ;

上面的答案正确地解决了这个问题: supertest希望处理 http.Server。然而,调用 app.listen()来获取服务器也会启动监听服务器,这是不好的做法,也是不必要的。

你可以通过使用 http.createServer():

import * as http from 'http';
import * as supertest from 'supertest';
import * as test from 'tape';
import * as Koa from 'koa';


const app = new Koa();


# add some routes here


const apptest = supertest(http.createServer(app.callback()));


test('GET /healthcheck', (t) => {
apptest.get('/healthcheck')
.expect(200)
.expect(res => {
t.equal(res.text, 'Ok');
})
.end(t.end.bind(t));
});


以防万一,如果有人使用 Hapijs,问题仍然会发生,因为它不使用 Express.js,因此 address ()函数不存在。

TypeError: app.address is not a function
at serverAddress (node_modules/chai-http/lib/request.js:282:18)

解决办法

// this makes the server to start up
let server = require('../../server')


// pass this instead of server to avoid error
const API = 'http://localhost:3000'


describe('/GET token ', () => {
it('JWT token', (done) => {
chai.request(API)
.get('/api/token?....')
.end((err, res) => {
res.should.have.status(200)
res.body.should.be.a('object')
res.body.should.have.property('token')
done()
})
})
})

我正在使用 Jest 和 Supertest,但是收到了同样的错误。这是因为我的服务器需要时间来安装(安装 db、读取 config 等是异步的)。我需要使用 Jest 的 beforeAll助手来运行异步设置。我还需要重构我的服务器以分离监听,而是使用@Whyhankee 的建议来创建测试的服务器。

Index.js

export async function createServer() {
//setup db, server,config, middleware
return express();
}


async function startServer(){
let app = await createServer();
await app.listen({ port: 4000 });
console.log("Server has started!");
}


if(process.env.NODE_ENV ==="dev") startServer();

测试

import {createServer as createMyAppServer} from '@index';
import { test, expect, beforeAll } from '@jest/globals'
const supertest = require("supertest");
import * as http from 'http';
let request :any;


beforeAll(async ()=>{
request = supertest(http.createServer(await createMyAppServer()));
})


test("fetch users", async (done: any) => {
request
.post("/graphql")
.send({
query: "{ getQueryFromGqlServer (id:1) { id} }",
})
.set("Accept", "application/json")
.expect("Content-Type", /json/)
.expect(200)
.end(function (err: any, res: any) {
if (err) return done(err);
expect(res.body).toBeInstanceOf(Object);
let serverErrors = JSON.parse(res.text)['errors'];
expect(serverErrors.length).toEqual(0);
expect(res.body.data.id).toEqual(1);
done();
});
});

编辑:

我在使用 data.foreach(async()=>...时也有错误,应该在我的测试中使用 for(let x of...

在主 API 文件(如 index.js)的末尾导出 app

module.exports = app;