Mocha API 测试：获取“TypeError：app.address 不是函数”

Posted 2023-02-15

【中文标题】Mocha API 测试：获取“TypeError：app.address 不是函数”

【英文标题】：Mocha API Testing: getting 'TypeError: app.address is not a function'

【发布时间】：2016-03-03 09:30:09

【问题描述】：

我的问题

我编写了一个非常简单的 CRUD API，最近我还开始使用 chai 和 chai-http 编写一些测试，但是在使用 $ mocha 运行测试时遇到了问题。

当我运行测试时，我在 shell 上收到以下错误：

TypeError: app.address 不是函数

我的代码

这是我的一个测试示例 (/tests/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);
);

和（/server/routes/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;

补充说明

我已尝试在运行测试之前注销 /tests/server-test.js 文件中的 server 变量：

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

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

结果是一个空对象：server: 。

【参考方案1】：

您不会在应用模块中导出任何内容。尝试将此添加到您的 app.js 文件中：

module.exports = server

【讨论】：

我唯一遇到的问题是应用程序代码不应该被更改以适应测试。

@chovy 你解决了吗？我在下面有一个对我有用的替代方法。

潜在的问题是处理包含异步服务的服务器，因为 chai-http 不知道其中的逻辑，它甚至会在您的服务器完全启动之前直接运行

@Nabuska 在这种情况下，服务器可能已经设置了 app.listen(...)

对于您的测试，您不应该使用启动实际服务器的 app.listen()，而是使用 http.createServer()

【参考方案2】：

重要的是导出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 ...', () => 

【讨论】：

您应该在回答中为什么“导出http.Server 对象很重要”。

@GrumpyCrouton 我添加了你会得到的错误，否则

谢谢你，金。我给了你一个+1，因为我认为这确实可以改善你的答案。以后，你应该解释为什么。想象一下，如果有人看到这个问题并且只有基本知识，那么经过深思熟虑和解释的答案会教给他们很多东西。

对于您的测试，您应该不使用启动实际服务器的 app.listen()，而是使用 http.createServer()

【参考方案3】：

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

根据需要向本地主机和端口提出请求 chai.request('http://localhost:5000')

而不是

chai.request(server)

这修复了我在使用 Koa JS (v2) 和 ava js 时遇到的相同错误消息。

【讨论】：

执行此错误后不会出现，但在获取数据时会出现 null 并且状态码 200 ok。

【参考方案4】：

上面的答案正确地解决了这个问题：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));
);

【讨论】：

老实说，我认为这应该是公认的答案，在应用程序中调用 app.listen() 会让您以后遇到问题。

这个答案的问题是你创建了一个单独的应用程序来运行你的测试，它不包括你的路由处理程序的实际代码。我一直以来如何解决这个问题只是有一个函数，它接受一个关于是否调用 app.listen 的参数，并且该函数总是返回 app 对象。

【参考方案5】：

以防万一，如果有人使用 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()
      )
    )
  )

【参考方案6】：

当我们在 node + typescript 无服务器项目中使用 ts-node 运行 mocha 时，我们遇到了同样的问题。

我们的 tsconfig.json 有 "sourceMap": true 。如此生成的 .js 和 .js.map 文件会导致一些有趣的转译问题（类似于此）。当我们使用 ts-node 运行 mocha runner 时。因此，我将 sourceMap 标志设置为 false 并删除我们 src 目录中的所有 .js 和 .js.map 文件。然后问题就解决了。

如果您已经在 src 文件夹中生成了文件，那么下面的命令将非常有用。

find src -name ".js.map" -exec rm \; find src -name ".js" -exec rm \;

【参考方案7】：

我正在使用 Jest 和 Supertest，但收到相同的错误。这是因为我的服务器需要时间来设置（设置数据库、读取配置等是异步的）。我需要使用 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();

test.ts

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...