「ArchSummit·深圳」人工智能如何促进工业和制造领域的智能化转型? >>> 了解详情
写点什么

使用 WireMock 模拟 HTTP API 服务

  • 2016-11-29
  • 本文字数:5563 字

    阅读完需:约 18 分钟

要点:

  • 使用 WireMock 可以极大减少创建连线测试桩所需要的时间
  • 在 JUnit 里使用 WireMock 可以更容易地编写各种测试用例
  • 我们会给出一个单独使用 WireMock 的例子
  • 我们还会为手动测试人员介绍如何使用 WireMock 的 UI
  • 还有其它一些内容

开场:我所知道的连线模拟工具

在我的职业生涯中,我有幸在很多大公司工作过。在工作过程中,我发现在开发上存在的一个普遍现象:开发团队总是重复开发一些相似的工具。我亲眼所见两个不同银行的开发团队在公司内部(基于不同的代码库)开发出三个以上基于 HTTP 的连线模拟工具(有时候也被叫作服务可视化工具)。我还在一个媒体公司看到它们同一楼层的几个团队居然开发了五个这种工具。还有一个航空企业,它开发了至少一种这样的工具。

这些基于 HTTP 的模拟工具主要有两方面的用途:

  1. 在自动化测试里,它们提供了可以用于创建远程虚拟服务的接口,这样就可以在 CI(持续集成)环境里构建系统,比如 TeamCity 或 Jenkins。
  2. 它们提供了 Web 界面,那些对技术细节不是很了解的测试人员可以在上面做一些探索性的测试。

因为同一个工具同时被用于自动化测试和手动测试,自然会有很多重叠的地方。测试人员可以使用开发人员创建的桩,这样有助于他们之间的沟通。同时这样也会减少在创建测试桩上所做的工作,相比测试人员和开发人员要分别创建自己的桩,这种方式避免了很多重复性工作。不过有些团队没有测试人员,所以他们只需要编程接口而不需要 Web 界面。

业界使用现成的工具

让我们从日志和数据存储方面来一窥整个行业对这些工具的使用情况。

如果有必要,你可以在一两天内轻松实现一个简单的日志框架。不过经验告诉我们,从头写一个日志框架并不是一个好主意。所以我们会使用 logback、slf4j 或其它一些现成的日志框架。

日志还只是个简单的问题,如果我们要考虑更复杂的数据存储,我们只能使用市场上现成的解决方案,比如 Oracle、MongoDB 或 Neo4J,具体要根据实际需要来选择。

我们举个测试框架的例子。你不会为每个项目从头写一个测试框架,所以你会使用 JUnit 或者其它任何一个可用的框架,有时候可能会基于这些框架做一些定制开发。

总的来说,针对那些常见的问题,总有一些现成的解决方案。

WireMock:一个现成的连线模拟(虚拟服务)工具

在预打包的测试框架解决方案方面,连线模拟工具(虚拟服务)会是一个更好的选择。WireMock 就是这样一个备受关注的开源框架,它使用 Java 编写,可以在 JUnit 里使用,也可以作为独立的 HTTP 服务运行。

在 JUnit 里使用 WireMock

假设我们有一个天气预报程序,它通过调用 HTTP API 从 forecast.io 获取伦敦的风速数据。预报程序获得的数据是 JSON 字符串,需要对它们进行解析,抽取出当前风速,再通过 REST 接口返回给用户。

我们现在使用 JUnit 编写测试用例,需要使用桩来模拟 forecast.io 提供的 Web 服务:

复制代码
public class WeatherApplicationTest {
@Rule
public WireMockRule forecastIoService = new WireMockRule();
}

然后我们把预报程序加入到测试用例里。预报程序的 start 和 stop 方法分别放在 JUnit 的 setup 和 teardown 方法里。我们先测试一个正常的用例 servesWindSpeedBasedOnForecastIoResponse:

复制代码
public class WeatherApplicationTest {
@Rule
public WireMockRule forecastIoService = new WireMockRule();
private WeatherApplication weatherApplication = new WeatherApplication();
@Before
public void setUp() {
weatherApplication.start();
}
@After
public void tearDown() {
weatherApplication.stop();
}
@Test
public void servesWindSpeedBasedOnForecastIoResponse(){
// TODO
}
}

成功的测试用例

测试过程是这样的:先发送请求到预报程序,预报程序从 forecast.io 获取响应数据,然后对其进行解析,加入后缀,再把它返回给用户。

首先我们使用断言检查我们想要的风速数据格式是以英里每小时(mph)为后缀的:

复制代码
@Test
public void servesWindSpeedBasedOnForecastIoResponse() {
assertEquals("12.34mph", content.toString());
}

为了得到这些数据,我们使用 Apache HTTP 客户端向应用程序发起请求:

复制代码
@Test
public void servesWindSpeedBasedOnForecastIoResponse() throws IOException {
Content content = Request.Get("http://localhost:" + weatherApplication.port() + "/wind-speed")
.execute()
.returnContent();
assertEquals("12.34mph", content.toString());
}

现在,应用程序将向 forecast.io 发起获取预报数据的请求,这个时候就要使用桩来模拟真实的 API:

复制代码
@Test
public void servesWindSpeedBasedOnForecastIoResponse() throws IOException {
forecastIoService.stubFor(get(urlEqualTo(
"/forecast/e67b0e3784104669340c3cb089412b67/51.507253,-0.127755")).willReturn(aResponse().withBody(
"{\"currently\":{\"windSpeed\":12.34}}")
));
Content content = Request.Get("http://localhost:" +
weatherApplication.port() + "/wind-speed")
.execute()
.returnContent();
assertEquals("12.34mph", content.toString());
}

我们告诉 WireMock(forecastIoService 对象)为请求“/forecast/e67b0e3784104669340c3cb089412b67/51.507253,-0.127755”创建一个桩,并把指定的 json 串返回。

真实的 forecast.io API 返回的响应数据大概是 2kb,不过为了简单起见,这里只包含我们关心的字节数。这篇文章主要是为了介绍如何使用 WireMock,而不是要讨论如何做测试( TDD 测试金字塔模型)。

失败的测试用例

我们已经知道如何创建一个成功的测试用例,现在让我们看看如何创建一个失败的测试用例。我们不想在 forecast.io 出现问题时抛出异常,而是要把 503 错误码返回给用户。

这次我们仍然使用 /windspeed 这个 URL 端点和相同的 forecast.io 测试桩。我们创建测试桩和请求消息,它将返回一个内部错误码(HTTP 500)。我们要确保用户收到的是一个服务不可用的错误消息和错误码(HTTP 503),而不是异常的堆栈信息:

复制代码
@Test
public void reportsErrorWhenForecastIoReturnsANonSuccessfulResponse()
throws IOException {
forecastIoService.stubFor(get(urlEqualTo("/forecast/e67b0e3784104669340c3cb089412b67/51.507253,-0.127755"))
.willReturn(aResponse().withStatus(SC_INTERNAL_SERVER_ERROR)));
HttpResponse httpResponse = Request.Get("http://localhost:" + weatherApplication.port() + "/wind-speed")
.execute()
.returnResponse();
assertEquals(503,httpResponse.getStatusLine().getStatusCode());
assertEquals("ERROR",IOUtils.toString(httpResponse.getEntity().getContent()));
}

这是一个非常简单的例子,不过它向我们展示了如何使用 WireMock 进行成功和失败用例的自动化测试。

整个测试用例的最终代码看起来是这样的:

复制代码
import com.github.tomakehurst.wiremock.junit.WireMockRule;
import org.apache.commons.io.IOUtils;
import org.apache.http.HttpResponse;
import org.apache.http.client.fluent.Content;
import org.apache.http.client.fluent.Request;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static
javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
import static junit.framework.TestCase.assertEquals;
public class WeatherApplicationTest {
@Rule
public WireMockRule forecastIoService = new WireMockRule();
private WeatherApplication weatherApplication = new WeatherApplication();
@Before
public void setUp() {
weatherApplication.start();
}
@After
public void tearDown() {
weatherApplication.stop();
}
@Test
public void servesWindSpeedBasedOnForecastIoResponse() throws IOException {
forecastIoService.stubFor(get(urlEqualTo(
"/forecast/e67b0e3784104669340c3cb089412b67/51.507253,-0.127755"))
.willReturn(aResponse().withBody("{\"currently\":{\"windSpeed\":12.34}}"
)));
Content content = Request.Get("http://localhost:" +
weatherApplication.port() + "/wind-speed")
.execute()
.returnContent();
assertEquals("12.34mph", content.toString());
}
@Test
public void reportsErrorWhenForecastIoReturnsANonSuccessfulResponse()
throws IOException {
forecastIoService.stubFor(get(urlEqualTo(
"/forecast/e67b0e3784104669340c3cb089412b67/51.507253,-0.127755"))
.willReturn(aResponse().withStatus(SC_INTERNAL_SERVER_ERROR)));
HttpResponse httpResponse = Request.Get("http://localhost:" +
weatherApplication.port() + "/wind-speed")
.execute()
.returnResponse();
assertEquals(503, httpResponse.getStatusLine().getStatusCode());
assertEquals("ERROR",
IOUtils.toString(httpResponse.getEntity().getContent()));
}
}

上面的例子只反应了这个工具所有功能的一小方面。它的所有代码可以在我的Github 主页找到,更多的细节可以查看 WireMock 文档

手动测试

在开场白部分,我们已经介绍了连线模拟工具的两个主要用途。第一个是作为自动化测试的模拟组件,这个我们已经举过例子了。接下来,我们来看看如何使用图形化 Web 控制台界面做手动测试。

WireMock 的控制台

WireMock 可以通过命令行来调用,也可以通过 Postman 或 cURL 这样的工具来做设置操作。可以往指定的 URL 发送一个 HTTP POST 请求来新建一个桩,比如往 http://:/__admin/mappings/new 发送请求

复制代码
{
"request": {
"method": "GET",
"url": "/some/thing"
},
"response": {
"status": 200,
"body": "Hello world!",
"headers": {
"Content-Type": "text/plain"
}
}
}

,这个就相当于在 Java 里执行了以下代码:

复制代码
stubFor(get(urlEqualTo("/some/thing"))
.willReturn(aResponse()
.withHeader("Content-Type", "text/plain")
.withBody("Hello world!")));

解决手动测试的问题

如果你的测试人员对技术细节不是很了解或者他们不希望花太多时间在技术细节上,那你可以帮助他们把精力集中在他们擅长的手动测试上。

首先,可以基于 WireMock 开发一个 Web 界面或 Swing 图形界面。经验告诉我,这样可能需要 1 到 10 个开发人员花费最多 12 个月的时间。

还有一种选择,就是使用现成的产品,比如专门为敏捷团队打造的 Traffic Parrot 。Traffic Parrot 是一款带有 Web 界面的连线模拟工具,一般敏捷开发团队会用到它。开发人员可以使用 WireMock 创建测试用例,再把它们的定义导出到 Traffic Parrot。测试人员可以使用 Traffic Parrot 的 Web 界面为手动测试创建测试桩。因为工作原因,我曾经在多个公司使用这个工具,现在我收集了一些常用的场景,并把它们共享出来。也许它们可以为大家节省一些时间,避免那些我曾经犯过的错误。

模拟场景

在我的咨询顾问职业生涯中,我遇到了另一类有关虚拟服务的问题,就是经常出现一个用例需要用到多个端点或需要返回多种响应的情况。例如,如果你要为用户提供基于位置的当前风速数据,需要调用两个 Web 服务,一个用于获取 GPS 坐标信息,另一个用于获取天气预报数据。在 JUnit 里看起来是这样的:

复制代码
gpsService.stubFor(get(urlEqualTo("/what-are-my-coordinates"))
.willReturn(aResponse().withBody("12.34,-0.12")));
weatherService.stubFor(get(urlEqualTo("/forecast/12.34,-0.12"))
.willReturn(aResponse().withBody("{\"currently\":{\"windSpeed\":3.55}}")));

在这个用例里,测试人员希望在 Web 界面上看到已经计算好的地理坐标和相应的预报结果下拉列表。这样,在切换地理坐标时可以直接得到相应的预报结果,而不需要再次发出请求。

Traffic Parrot 已经包含了这个功能,所以可以直接使用。

其它工具

如果你想在选定一个工具之前先挑挑拣拣,那么你真的有很多选择。除了 Wiremock 之外,我所知道的还有超过 40 个这种类型的工具,它们使用不同的语言编写,运行在不同的平台上,提供各种不同的功能。
这里例举几个:

  • Mountebank (可用于 Java、Python、C#、Clojure 等语言平台)
  • VCR (在 Ruby 和 Ruby on Rails 平台很受欢迎)
  • Stubby4j (基于 Java,提供了另一种设计 API 的方式)

不过基于 Java 的 WireMock 仍然是目前最流行的,它在 Github 上有 1400 多个关注和 40 多个贡献者

更多信息

作为这篇文章的补充阅读,Christopher Batey 在他的文章“构建容错性微服务的六大原则”里介绍了他使用 WireMock 的几种场景,包括连接丢失、连接变慢及其它场景。

下一步

关于作者

Wojciech Bulaty WB 软件咨询公司的高级软件工程师。他通过写作分享了很多他在敏捷、自动化、极限编程、TDD、BDD、结对编程和代码清理等方面的经验。WB 软件咨询公司为 British Sky Broadcasting、Lloyds Bank 以及很多初创公司做过咨询。他们最近发布了 Traffic Parrot ,一款用于创建虚拟服务的软件工具。

查看英文原文: How Java developers can use the Wiremock framework to simulate HTTP-based APIs

2016-11-29 15:048859
用户头像

发布了 322 篇内容, 共 133.0 次阅读, 收获喜欢 142 次。

关注

评论

发布
暂无评论
发现更多内容

SpringBoot 自动装配原理,一文掌握!

程序员小毕

源码 程序员 面试 springboot 自动装配

2023-01-03:超过5名学生的课。编写一个SQL查询来报告 至少有5个学生 的所有班级,返回结果不限顺序。请问sql语句如何写? +---------+ | class | +-----

福大大架构师每日一题

数据库 sql 福大大

模块四作业

张贺

架构训练营

基于 EventBridge API Destination 构建 SaaS 集成实践方案

阿里巴巴云原生

阿里云 云原生 EventBridge

下载速度慢怎么办?使用华为云CDN,让网速更快更稳

i生活i科技

CDN

阿里云 ACK One 多集群管理再升级:GitOps 多集群持续集成,统一报警管理

阿里巴巴云原生

阿里云 云原生 容器服务

架构训练营模块三作业

gigifrog

架构训练营

再快一点?动态内容如何加速

蔡农曰

程序员 互联网

web前端技术培训后怎么不断提高自己

小谷哥

性能测试技术笔记(二):如何准备测试环境和数据

老张

性能测试

云存储生态构建的技术基因和最佳实践

云布道师

阿里云 云存储

网络拥堵?上网体验差,还不赶紧看看华为云CDN!

i生活i科技

CDN

下载速度不尽人意,华为云CDN来助力,尽享高速体验!

i生活i科技

CDN

市面上到底有没有免费的云渲染平台?

Renderbus瑞云渲染农场

云渲染 云渲染平台 免费云渲染平台

RelativeLayout(相对布局)

攻城狮Wayne

Android Studio padding margin

怎么入门大数据开发技术

小谷哥

一些Web安全漏洞

穿过生命散发芬芳

HTTP 1月月更

华为云CDN,多场景网络加速服务,为企业发展强势赋能

i生活i科技

CDN

为什么说IO密集型业务,线程数是CPU数的2倍?

Java永远的神

程序员 程序人生 后端 cpu io

外包学生管理系统详细架构设计文档

Geek_7d539e

大数据培训和自学哪个适合零基础

小谷哥

爱奇艺:基于龙蜥与 Koordinator 在离线混部的实践解析 | 龙蜥技术

阿里巴巴云原生

阿里云 云原生 Koordinator

云原生技术在离线交付场景中的实践

北京好雨科技有限公司

Kubernetes 云原生交付 离线交付

创业邦2022中国未来独角兽100强揭晓:总估值超3000亿元,累计融资总额达685亿元;红杉中国、顺为资本成年度最佳捕手

创业邦

Wallys/QCN9074 WiFi 6E Card OpenWRT, IPQ6010,802.11ax/Support:QUECTEL RM500Q-GL/QCN9074 11ax 4x4 6G M.2

wallysmeng

华为云弹性负载均衡服务,赋能现代企业加速发展

i生活i科技

ELB

零基础怎么培训学习前端开发技术

小谷哥

java程序员培训学习后好找工作

小谷哥

如何在15分钟内,度量 DORA 指标?

Apache Devlake

Apache 大数据 开源 研发效能 DOAR

架构实战营 - 写出外包学生管理系统的架构文档

huiwen

架构实战营

平安银行携手StarRocks荣获2022金融业数字化转型突出贡献奖

StarRocks

数据库 金融

使用WireMock模拟HTTP API服务_Java_Wojciech Bulaty_InfoQ精选文章