使用 Chai-http 测试 Express 服务

Chai-http 是一个基于 Chai 的 HTTP 测试插件，它可以让我们轻松地对 Express 服务进行测试。在前端开发的过程中，我们经常需要测试我们的服务端接口是否正常工作。使用 Chai-http 可以方便我们自动化这个过程，让测试更加高效和准确。

安装 Chai-http

在开始使用 Chai-http 之前，我们需要先安装它，可以通过 npm 安装。

npm install chai chai-http --save-dev

测试服务端接口

接下来，我们将介绍一些常见的测试用例，包括 GET、POST、PUT 和 DELETE 请求。

GET 请求

首先我们来测试一个 GET 请求。以下是一个简单的 Express 服务端应用程序，它定义了一个 GET 路由。

const express = require("express");
const app = express();

app.get("/hello", (req, res) => {
  res.send("Hello World!");
});

app.listen(3000, () => {
  console.log("Server is running on port 3000");
});

module.exports = app;

在测试文件中，使用 Chai-http 来发送 GET 请求并检查响应。以下是一个示例测试代码。

const chai = require("chai");
const chaiHttp = require("chai-http");
const app = require("../app");

chai.should();
chai.use(chaiHttp);

describe("Test GET /hello", () => {
  it("It should return status 200 and message 'Hello World!'", (done) => {
    chai.request(app)
      .get("/hello")
      .end((err, res) => {
        res.should.have.status(200);
        res.text.should.equal("Hello World!");
        done();
      });
  });
});

在测试用例中，我们使用 chai.request() 来发送 GET 请求，然后使用 end() 方法来接收响应并进行断言。

在断言中，我们使用 should.have.status() 来检查响应的状态码，使用 res.text.should.equal() 来检查响应的文本。

POST 请求

现在，我们来测试一个 POST 请求。以下是一个示例的 Express 应用程序，它定义了一个 POST 路由。

const express = require("express");
const app = express();
const bodyParser = require("body-parser");

app.use(bodyParser.json());

app.post("/api/users", (req, res) => {
  const user = req.body;
  user.id = 1;
  res.json(user);
});

app.listen(3000, () => {
  console.log("Server is running on port 3000");
});

module.exports = app;

在测试用例中，我们使用 chai.request() 来发送 POST 请求，并在请求的正文中包含要发送的数据。以下是一个示例测试代码。

const chai = require("chai");
const chaiHttp = require("chai-http");
const app = require("../app");
const expect = chai.expect;

chai.should();
chai.use(chaiHttp);

describe("Test POST /api/users", () => {
  it("It should return status 200 and an object with id property", (done) => {
    chai.request(app)
      .post("/api/users")
      .send({
        name: "John Doe",
        email: "john@example.com",
      })
      .end((err, res) => {
        expect(err).to.be.null;
        res.should.have.status(200);
        res.body.should.be.an("object").to.have.property("id");
        done();
      });
  });
});

在测试用例中，我们使用 chai.request() 来发送 POST 请求，并使用 send() 方法来发送请求正文。在断言中，我们使用 res.body 来访问响应的正文，使用 .should.be.an("object").to.have.property() 来检查响应正文中是否包含指定属性。

PUT 请求

接下来，我们来测试一个 PUT 请求。以下是一个示例的 Express 应用程序，它定义了一个 PUT 路由。

const express = require("express");
const app = express();
const bodyParser = require("body-parser");

app.use(bodyParser.json());

let users = [
  {
    id: 1,
    name: "John Doe",
    email: "john@example.com",
  },
];

app.put("/api/users/:id", (req, res) => {
  const userId = parseInt(req.params.id);
  const updateUser = req.body;
  const index = users.findIndex((user) => user.id === userId);
  users[index] = {
    id: userId,
    ...updateUser,
  };
  res.json(users[index]);
});

app.listen(3000, () => {
  console.log("Server is running on port 3000");
});

module.exports = app;

在测试用例中，我们使用 chai.request() 来发送 PUT 请求，并在请求的正文中包含要更新的数据。以下是一个示例测试代码。

const chai = require("chai");
const chaiHttp = require("chai-http");
const app = require("../app");
const expect = chai.expect;

chai.should();
chai.use(chaiHttp);

describe("Test PUT /api/users/:id", () => {
  it("It should return status 200 and an object with updated data", (done) => {
    const user = {
      name: "Jane Doe",
      email: "jane@example.com",
    };
    chai.request(app)
      .put("/api/users/1")
      .send(user)
      .end((err, res) => {
        expect(err).to.be.null;
        res.should.have.status(200);
        res.body.should.be.an("object").to.deep.equal({
          id: 1,
          ...user,
        });
        done();
      });
  });
});

在测试用例中，我们使用 chai.request() 来发送 PUT 请求，并使用 send() 方法来发送请求正文。在断言中，我们使用 res.body 来访问响应的正文，使用 .should.be.an("object").to.deep.equal() 来检查响应正文是否包含指定的数据。

DELETE 请求

最后，我们来测试一个 DELETE 请求。以下是一个示例的 Express 应用程序，它定义了一个 DELETE 路由。

const express = require("express");
const app = express();

let users = [
  {
    id: 1,
    name: "John Doe",
    email: "john@example.com",
  },
];

app.delete("/api/users/:id", (req, res) => {
  const userId = parseInt(req.params.id);
  users = users.filter((user) => user.id !== userId);
  res.status(204).send();
});

app.listen(3000, () => {
  console.log("Server is running on port 3000");
});

module.exports = app;

在测试用例中，我们使用 chai.request() 来发送 DELETE 请求。以下是一个示例测试代码。

const chai = require("chai");
const chaiHttp = require("chai-http");
const app = require("../app");

chai.should();
chai.use(chaiHttp);

describe("Test DELETE /api/users/:id", () => {
  it("It should return status 204", (done) => {
    chai.request(app)
      .delete("/api/users/1")
      .end((err, res) => {
        res.should.have.status(204);
        done();
      });
  });
});

在测试用例中，我们使用 chai.request() 来发送 DELETE 请求，并使用 res.should.have.status() 来检查响应的状态码。

总结

本文介绍了如何使用 Chai-http 来测试 Express 服务端接口。我们通过一个简单的示例介绍了如何编写 GET、POST、PUT 和 DELETE 请求的测试用例，让我们能够更加高效地测试我们的服务端接口，提高代码质量和可靠性。希望这篇文章对您学习和使用 Chai-http 有所帮助。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65913bf5eb4cecbf2d6733a3

阅读全文
纠错
反馈

精选内容

相关推荐

    暂无