接口自动化测试，听起来是不是有点“高大上”？

作者贝克街的捉虫师

接口自动化测试，听起来是不是有点“高大上”？但对于我们“贝克街的捉虫师”来说，这可是每天都在和Bug斗智斗勇的利器。你是不是还在手动点击页面，一次次地重复着那些枯燥的测试用例？或者，你已经感受到了项目迭代速度越来越快，手动测试根本跟不上趟的压力？别急，今天我们就来聊聊接口自动化测试，以及如何利用开源工具，让你的测试工作变得更高效、更智能。

接口自动化测试：为什么它如此重要？

在软件开发的“测试金字塔”中，接口测试位于金字塔的中层，介于单元测试和UI测试之间。它直接针对应用程序的服务层进行测试，不依赖于用户界面。这意味着什么？

  • 更快的反馈回路：接口测试通常比UI测试运行得快得多。当开发人员提交新代码时，自动化接口测试可以迅速运行，提供即时反馈，帮助他们尽早发现并修复问题，这大大缩短了开发周期，提升了效率。
  • 更早发现缺陷：在UI层的问题暴露之前，接口测试就能在更底层发现逻辑错误、数据处理问题或集成问题。这就像是提前给程序做了“体检”，避免小问题滚雪球变成大麻烦。
  • 更高的稳定性与可靠性：UI界面变化频繁，而API接口相对稳定。针对接口编写的自动化测试用例，复用性更强，受UI改动的影响小，从而提供更稳定的测试结果。
  • 成本效益高：自动化接口测试减少了大量重复的手动劳动，释放了测试人员的精力，让他们可以投入到更复杂的探索性测试和业务测试中。长远来看，这能显著降低测试成本。
  • 更好的覆盖率：有些复杂的业务场景或异常情况，通过UI很难模拟和测试，但在接口层面可以轻松构造数据和请求，实现更全面的测试覆盖。

总而言之，接口自动化测试是现代敏捷开发和持续集成/持续交付（CI/CD）流程中不可或缺的一环，它能让你的测试工作事半功倍。

开源利器选型：Postman + Newman

市面上有很多优秀的开源接口测试工具，比如JMeter、Pytest+Requests、Rest-Assured等。今天我们要重点介绍的是一套非常受欢迎的组合：Postman + Newman。

  • Postman：作为一款广受欢迎的API开发与测试工具，Postman提供了一个直观的图形用户界面（GUI），方便开发者和测试人员进行API请求的构建、发送、调试和管理。它的易用性让即使是API测试新手也能快速上手。
  • Newman：它是Postman的命令行伴侣，可以让你在命令行环境中运行Postman Collection，而无需打开Postman应用。这使得Newman成为集成到CI/CD流程中的理想选择，实现了真正的自动化。

Postman与Newman的结合，既保留了Postman友好的界面优势，又通过Newman弥补了其在自动化和持续集成方面的不足，可谓是强强联合。

Postman实战：从请求到测试脚本

  1. 安装与界面初探

首先，你需要下载并安装Postman桌面应用。安装完成后，打开Postman，你会看到一个简洁的界面。左侧是历史请求和集合（Collections），中间是请求构建区，右侧是响应结果区。

  1. 创建你的第一个API请求

假设我们要测试一个公共的API，例如 https://jsonplaceholder.typicode.com/posts/1，用于获取一篇文章的详情。

  1. 创建新请求：点击左上角的“+”按钮或“New”按钮，选择“HTTP Request”。
  2. 设置请求方法和URL：
    • 在请求方法下拉框中选择 GET。
    • 在URL输入框中输入 https://jsonplaceholder.typicode.com/posts/1。
  3. 发送请求：点击“Send”按钮。

  4. 查看响应：你会在响应区看到API返回的JSON数据和状态码（例如 200 OK）。

  5. 编写测试脚本（Tests）

Postman的强大之处在于，你可以在发送请求后，通过编写JavaScript脚本来验证响应结果。这些脚本写在“Tests”标签页里。

继续上面的例子，我们来验证响应的状态码是否为200，并且返回的数据中 userId 是否为1。

// 验证状态码是否为200
pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

// 验证响应体中userId是否为1
pm.test("userId is 1", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.userId).to.equal(1);
});

// 验证响应体中是否存在id字段
pm.test("Response has 'id' field", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData).to.have.property('id');
});

这段脚本使用了Postman内置的 pm 对象，它提供了丰富的API来访问请求、响应、环境变量等，并支持Chai断言库。 编写完成后，再次点击“Send”，你会看到“Test Results”标签页显示测试通过或失败。

  1. 管理请求与集合（Collections）

为了更好地组织和管理你的API请求，你需要创建“Collection”（集合）。

  1. 创建新集合：在左侧边栏“Collections”旁边点击“+”按钮，给你的集合命名，例如“My API Tests”。
  2. 保存请求到集合：在刚才创建的请求界面，点击“Save”按钮，选择刚才创建的集合。这样，你的请求就归属于某个集合了。
  3. 利用环境变量：在实际项目中，API的URL、认证信息等可能在不同环境（开发、测试、生产）中不同。Postman支持环境变量和全局变量，让你能够轻松切换环境。
    • 点击右上角的“Environment”下拉框，选择“Manage Environments”。
    • 点击“Add”创建新环境，例如“Dev Environment”。
    • 添加变量，例如 baseUrl，值为 https://jsonplaceholder.typicode.com。
    • 在请求URL中使用 {{baseUrl}}/posts/1。切换环境时，URL会自动变化。

Newman集成：命令行与CI/CD的桥梁

现在，我们已经用Postman创建好了API测试用例，接下来就要请出Newman，让这些测试在命令行中跑起来，并最终融入CI/CD流程。

  1. 安装Node.js和Newman

Newman是基于Node.js构建的，所以首先确保你的系统安装了Node.js。然后，通过npm全局安装Newman：

npm install -g newman

  1. 导出Postman Collection

在Postman中，找到你想要运行的Collection，点击它旁边的三个点（…），选择“Export”（导出）。建议选择推荐的Collection v2.1格式，将其保存为JSON文件（例如 My API Tests.postman_collection.json）。

如果你使用了环境变量，也需要导出对应的环境文件（.postman_environment.json）。

  1. 使用Newman运行Collection

打开命令行工具（如CMD、PowerShell或Terminal），导航到你保存Collection JSON文件的目录，然后运行：

newman run “My API Tests.postman_collection.json”

如果你的Collection依赖于环境变量，可以使用 –environment 参数指定：

newman run “My API Tests.postman_collection.json” –environment “Dev Environment.postman_environment.json”

Newman会执行Collection中的所有请求和测试脚本，并在命令行中输出测试结果，包括总请求数、通过/失败的测试数量等。

  1. 生成漂亮的HTML报告（可选）

Newman默认的命令行输出比较简洁，但你可以安装额外的Reporter来生成更友好的报告，比如HTML报告。

首先安装Newman HTML Reporter：

npm install -g newman-reporter-htmlextra

然后，在运行Collection时指定Reporter和报告输出路径：

newman run “My API Tests.postman_collection.json” -r htmlextra –reporter-htmlextra-export “report.html”

执行完成后，你会在当前目录下找到一个 report.html 文件，用浏览器打开即可查看详细的测试报告。

  1. 集成到CI/CD流程

这是接口自动化测试最能发挥价值的地方。你可以将Newman命令集成到你的CI/CD工具中，例如Jenkins、GitLab CI、GitHub Actions等。

以Jenkins为例，你可以在Jenkins Job的“Build Steps”（构建步骤）中添加一个“Execute shell”或“Execute Windows batch command”步骤，然后填入你的Newman命令。

例如，一个简单的Jenkins配置可能如下：

  1. 安装NodeJS插件：在Jenkins的“Manage Jenkins” -> “Plugins”中安装NodeJS Plugin。
  2. 配置NodeJS：在“Manage Jenkins” -> “Global Tool Configuration”中配置NodeJS安装，并全局安装Newman。
  3. 创建Freestyle Project：新建一个Jenkins Job。
  4. 添加构建步骤：在“Build Steps”中添加“Execute shell” (Linux/macOS) 或 “Execute Windows batch command” (Windows)。
  5. 输入Newman命令：

确保你的项目代码中包含Postman Collection文件，或者通过其他方式获取

这里假设你的collection文件位于工作空间的某个路径

newman run path/to/your/My\ API\ Tests.postman_collection.json \
–environment path/to/your/Dev\ Environment.postman_environment.json \
-r cliextra,htmlextra –reporter-htmlextra-export “newman-report/report.html”

  1. 配置构建触发器：根据需要配置定时构建、代码提交后构建等。

这样，每次代码提交或定时触发时，Jenkins都会自动运行你的接口测试，并生成报告，极大地提高了测试效率和反馈速度。

总结与展望

接口自动化测试无疑是提升软件质量和交付效率的“加速器”。通过Postman构建API请求和测试用例，再结合Newman在命令行中运行和集成到CI/CD流程，我们可以构建一套高效、可靠的接口自动化测试体系。这不仅能帮助我们早发现、早修复Bug，更能让测试人员从重复劳动中解脱出来，专注于更有价值的工作。

当然，接口自动化测试的实践远不止于此，数据驱动测试、Mock服务、性能测试等都是可以深入探索的方向。希望这篇教程能为你打开接口自动化测试的大门，让我们一起成为更出色的“捉虫师”！

类似文章