duckrails mock api

有5个月没写技术文章了......最近Android也没什么技术好写，MVVM、Clean Architecture满大街，也不太好衡量好与不好，干脆就不写了。事实上，这大半年，很重视怎么让测试流程更加顺畅。

例如，一个活动，有未开始、进行中、已结束三个阶段。创建一个活动，活动在未开始阶段，要等到明天状态才变成进行中，再过两天才已结束。无论是开发还是测试，肯定要对这类需求mock数据来测试。一般可以改后端数据库，或者charles改返回数据，而duckrails让mock数据更加方便。

安装

安装docker

请移步《docker入门——安装(CentOS)、镜像、容器》。

安装duckrails

官方镜像iridakos/duckrails. 安装命令：

docker pull iridakos/duckrails

因为duckrails比较大，如果直接用docker官方镜像，需要挺久的（国外主机随意）。笔者建议你设置一下国内镜像加速： Docker 中国官方镜像加速。

拉取镜像后，检查镜像：

$ docker images

REPOSITORY           TAG                 IMAGE ID            CREATED             SIZE
iridakos/duckrails   latest              ec0cac3fbb05        1 minute ago         1.01GB

证明拉取成功了。

启动duckrails容器

执行docker命令

docker run -p 4000:80 -v 本地目录:/opt/duckrails/share --name duckrails -d iridakos/duckrails

参数说明：

-p 4000:80 : 映射本地4000端口到容器80端口；

-v 本地目录:/opt/duckrails/share : 映射"本地目录"到容器/opt/duckrails/share。例如，本地目录=$PWD/share，指本地当前文件夹下share目录；

--name duckrails : 指定容器名duckrails。

访问duckrails主页

linux、mac系统，docker容器ip地址一般是localhost即127.0.0.1，而windows下是通常是192.168.99.100。查看容器ip地址：

$ docker-machine ip
127.0.0.1

在浏览器访问http://localhost:4000：

duckrails部署成功了！

使用

如果你英文还OK，直接看github官方文档就OK了 iridakos/duckrails。

创建静态json接口

View all mocks -> Create new mock进入创建界面

create new mock - general.png

填好General后，先别急着保存，字段说明：

name : 名称而已，给你看的；

Description：描述，也是给你看的；

Request method：get、post等呗；

Status：http状态码，一般填200，参考HTTP状态码；

Route path：接口路径，例子填test_api；

接下来填返回内容：

response body.png

Response body选项卡，字段说明：

Body type：有三个，Embedded Ruby、Javascript、Static，就是下面所填内容的语言或属性；

Content type：mock接口一般选application/json，指返回json数据，其他选项不解释了；

Body content：与上面的Body type有关，如果body type选static，此处输入json字符串即可；如果选Ruby、Javascript，此处输入对应语言代码；

点击保存吧！在All mocks界面，可以看到刚才创建的接口：

在浏览器输入http://localhost:4000/test_api：

显示刚才输入的json，证明接口没问题！

Javascript动态接口

（不懂js的同学自觉面壁去）

静态json数据，当然不能满足复杂的需求，这时我们需要动态修改response body。例如，某个字段返回starttime和endtime，当前时间在这starttime和endtime范围内。

以Javascript为例，编辑test_api，Body type填入选JavaScript，Body content填：

var obj = {
  "data":{
    "starttime": new Date(Date.now()- 3600*1000).toLocaleString(),
    "endtime": new Date(Date.now()+ 3600*1000).toLocaleString(),
  },
  "status": 0,
  "msg": "请求成功"
}

保存接口后，再次访问http://localhost:4000/test_api:

可以看到，starttime和endtime根据js代码动态生成了值。（可能会遇到docker容器时间不一致，自行google解决）

接口重定向

笔者介绍Charles接口重定向方法（不懂Charles的同学自觉面壁去）。

Tools -> Map remote -> Add

Edit Mapping填写重定向策略：

Map From
Host : 原接口域名/ip，例子：thejoyrun.com
Path : 原接口path，例子：api

Map To
Host : duckrails ip
Path : duckrails 接口path

手机代理charles，请求（浏览器输入）http://thejoyrun.com/api，charles界面查看：

有返回数据的话，证明重定向成功了。

截取已有接口数据

官方文档Creating a dynamic mock that wraps an existing API call

duckrails可以先请求已有接口，再对数据进行处理。例如，接口test_api_1，先请求test_api，把返回字段"status":0改成"status":1。

先创建test_api_1接口，Body content（ruby语法）：

<%
  original_response = RestClient.get "http://localhost:4000/test_api" rescue '{}'
  result = JSON.parse(original_response)

  result[:status] = 1
%>

<%= result.to_json %>

访问http://localhost:4000/test_api_1：

{
  "data":...,
  "status": 1,
  "msg": "请求成功"
}

官方只给出ruby语法例子，并没有javascript例子。只能学学ruby了......

小结

实际上，不仅仅是开发方便，duckrails也让测试工程师更加方便做数据。有动态mock数据的特性，duckrails为开发、测试提供更多可能性。

尽管duckrails有js动态数据功能，但有些场景，duckrails还不够灵活。例如，返回数据有很多状态，测试人员一次测这么多状态，需要charles breakpoint修改duckrails返回数据，会更快捷。希望同学们根据实际情况，来组合测试方式。

关于作者

我是键盘男。
在广州生活，在互联网公司上班，猥琐文艺码农。喜欢科学、历史，玩玩投资。