自动化测试工具 Fitnesse+RestFixture：Web 服务回归测试利器

超爱fitnesse · 2014年08月16日 · 最后由 Michael_Wang 回复于 2016年05月05日 · 4170 次阅读

本帖已被设为精华帖！

摘要：RestFixture 是 Fitnesse 的一个测试 REST 服务的插件，用于调用标准的 http GET/POST 等请求方法，并可以用 XPath 语法和 Javascript 语法检验 http 响应。本文介绍安装运行 RestFixture 的步骤，并给出测试用例示例。

首先普及一下概念，什么是Fitnesse，听一听.NET 版 Cucumber 的创始人 Aslak Hellesøy 谈Fitnesse与 Cucumber 对比：

FIT/Fitnesse和 Cucumber 都执行高级语言编写的验收测试。FIT 仅识别 HTML，Fitnesse 则通过提供 Wiki 语法来简化编写测试的过程。在 FIT/Fitnesse 当中，所有的测试都以表格的形式呈现。

FitNesse 比 Cucumber 的优势在于 Wiki 支持。

原文链接：http://www.infoq.com/cn/news/2009/11/interview-cucumber-for-dotnet

1.几句题外话

对于 http 请求的测试，有几种方式：

浏览器中输入 http url，只适用于 GET 方法
curl 命令手工测试
junit 中直接用 java network api 调用 GET/POST 方法
在自动化测试框架中封装指令，如 cucumber, fitnesse, robotframework

上述 1、2 手工测试，不能用于回归测试；3、4 能用于回归测试，但要开发测试脚本代码，维护非常麻烦。

今日回想起两年前浅尝辄止的fitnesse，想碰运气看看有没有好的测试插件，结果真找到了用于 Restful API 测试的插件：RestFixture

2.Fitnesse 20111026+RestFixture 3.0 ——最佳拍档

2.1 http 响应格式是 xml 的示例

废话少说，先上图：
用Xpath语法检查GET响应内容

上面的测试用例的目的是：

检查 url: http://www.w3school.com.cn/example/xmle/note.xml 中有一 tag<body>

并且 tag 内容是

Don't forget the meeting!

note.xml 的内容：

<?xml version="1.0" encoding="ISO-8859-1"?> 
<!--  Copyright w3school.com.cn --> 
<note> 
    <to>George</to> 
    <from>John</from> 
    <heading>Reminder</heading> 
    <body>Don't forget the meeting!</body> 
</note>

fitnesse 测试用例 wiki 文本：

!define TEST_SYSTEM {slim}

!path D:\fitnesse\fitnesse-20111026\smartrics-RestFixture-3.0\lib\*

| Table:smartrics.rest.fitnesse.fixture.RestFixture | http://www.w3school.com.cn |
| GET | /example/xmle/note.xml | 200 | Content-Type: text/xml | //body[text()="Don't forget the meeting!"]|

2.2 http 响应格式是 json 的示例

用IP获取地址信息

上面的测试用例的目的是：

调用百度地图 Web API，根据 IP 获取地图地址信息，检查服务响应内容中的 status 字段必须是 0，下面判断语句是 javascript 表达式：

jsonbody.status==0

GET 访问的 url：

http://api.map.baidu.com/location/ip?ip=202.198.16.3&coor=bd09ll&ak=60IFKTCwlIsSpDcGfkx36L8u

url 返回的内容：

{"address":"CN|\u5409\u6797|\u957f\u6625|None|CERNET|1|None","content":{"address":"\u5409\u6797\u7701\u957f\u6625\u5e02","address_detail":{"city":"\u957f\u6625\u5e02","city_code":53,"district":"","province":"\u5409\u6797\u7701","street":"","street_number":""},"point":{"x":"125.31364243","y":"43.89833761"}},"status":0}

被调用 Web API 文档：

http://developer.baidu.com/map/wiki/index.php?title=webapi/ip-api#.E6.8E.A5.E5.8F.A3.E7.A4.BA.E4.BE.8B

fitnesse 测试用例 wiki 文本：

!define TEST_SYSTEM {slim}

!path D:\fitnesse\fitnesse-20111026\smartrics-RestFixture-3.0\lib\*

| Table:smartrics.rest.fitnesse.fixture.RestFixture | http://api.map.baidu.com |
| GET | /location/ip?ip=202.198.16.3&coor=bd09ll&ak=60IFKTCwlIsSpDcGfkx36L8u | 200 | Content-Type: application/json | jsonbody.status==0 |

2.3 用 javascript 处理 json 对象

我们再来看上面的 GET 响应文本：

{"address":"CN|\u5409\u6797|\u957f\u6625|None|CERNET|1|None","content":{"address":"\u5409\u6797\u7701\u957f\u6625\u5e02","address_detail":{"city":"\u957f\u6625\u5e02","city_code":53,"district":"","province":"\u5409\u6797\u7701","street":"","street_number":""},"point":{"x":"125.31364243","y":"43.89833761"}},"status":0}

\u5409\u6797|\u957f\u6625是什么？

按照百度 API 文档，应该返回这样的：

 {  
    address: "CN|吉林|长春|None|CERNET|1|None",  
    content: {  
    address: "吉林省长春市",  
    address_detail: {  
    city: "长春市",  
    city_code: 53,  
    district: "",  
    province: "吉林省",  
    street: "",  
    street_number: ""  
    },  
    point: {       
    x: "125.31364243",      
    y: "43.89833761"  
    }  
    },  
    status: 0  
}

原来\u5409\u6797|\u957f\u6625是 吉林 | 长春 encodeURI 的结果

可以在 Chrome 浏览器 > 菜单 > 工具 > JavaScript 控制台（Firefox/IE/Opera 都有对应的控制台）中使用 String.replace 函数来把\u5409 变成"吉"：

替换字符串

下一步在 Fitnesse 中要见证奇迹了，RestFixture 居然支持 Javascript 语法和全局函数，也可以调用 String.replace 函数：

!define TEST_SYSTEM {slim}

!path D:\fitnesse\fitnesse-20111026\smartrics-RestFixture-3.0\lib\*

| Table:smartrics.rest.fitnesse.fixture.RestFixture | http://api.map.baidu.com |
| GET | /location/ip?ip=202.198.16.3&coor=bd09ll&ak=60IFKTCwlIsSpDcGfkx36L8u | 200 | Content-Type: application/json | jsonbody.status==0 |
| let | bodyDecoded | js | response.body.replace(/\\u[\dabcdef]{4}/g, function(word){return String.fromCharCode(parseInt(word.substr(2),16))}) | |

body替换后测试结果

RestFixture 变量 bodyDecoded 的内容是中文化后的 json：

{"address":"CN|吉林|长春|None|CERNET|1|None","content":{"address":"吉林省长春市","address_detail":{"city":"长春市","city_code":53,"district":"","province":"吉林省","street":"","street_number":""},"point":{"x":"125.31364243","y":"43.89833761"}},"status":0}

下面，还可以把 bodyDecoded 作为表达式文本计算，生成一个 js 对象：

| let | printJsonMembers | js | !-
var jsonObject = eval('a=%bodyDecoded%');
var str1="";
function printObject(obj, indent){
  for(var i in obj){
    if(typeof obj[i] == "object"){
      str1+= indent + i+":"+"\n";
      printObject(obj[i], indent+"\t\t");
    } else
      str1+= indent + i +":"+obj[i] + "\n";
  }
}
printObject(jsonObject, "");
str1-! | |

这里要演示的第二个 let 行使用了第一个 let 行定义的变量：%bodyDecoded%，显然借鉴了 Windows Bat 文件的语法。

测试结果：

address:CN|吉林|长春|None|CERNET|1|None
content:
        address:吉林省长春市
        address_detail:
                city:长春市
                city_code:53
                district:
                province:吉林省
                street:
                street_number:
        point:
                x:125.31364243
                y:43.89833761
status:0

3.RestFixture 参考资料

3.1 RestFixture 使用文档

RestFixture 使用文档链接

https://cloud.github.com/downloads/smartrics/RestFixture/RestFixture-3.0.pdf

RestFixture使用文档片段

3.2 运行环境

fitnesse 运行环境文件目录：

fitnesse文件目录
restfixture文件目录

注意：其中的 slf4j-simple-1.6.6.jar 需要额外下载

启动 fitnesse 命令：
启动fitnesse

D:\fitnesse\fitnesse-20111026>java -jar fitnesse.jar -p 11026

-p 11026 是让 fitnesse 网站使用 11026 端口，因为我要在后面的例子中使用多个 fitnesse 版本，所以用版本号作为端口。

3.3 相关安装包下载地址

RestFixture 安装包下载地址：

https://github.com/downloads/smartrics/RestFixture/smartrics-RestFixture-3.0-bin.zip

slf4j-simple-1.6.6.jar 下载地址：

http://repo2.maven.org/maven2/org/slf4j/slf4j-simple/1.6.6/slf4j-simple-1.6.6.jar
注意：RestFixture 安装包中未包含此 jar 包，但运行时需要。

Fitnesse 安装包下载地址：

http://fitnesse.org/fitnesse.jar?responder=releaseDownload&release=20111026
注意：RestFixture 只维护到 20111026 的 Fitnesse 版本，所以只能下载与之匹配的 Fitnesse 安装包。

3.4 相关网址

Fitnesse 首页：
- http://www.fitnesse.org/
Fitnesse 安装包下载： Fitnesse 首页 > Download > release 20111026 > fitnesse.jar
Fitnesse 插件列表： Fitnesse 首页 > Plug-ins
RestFixture 首页： Fitnesse 首页 > Plug-ins > SLiM Fixtures > RestFixture =>
- https://github.com/smartrics/RestFixture
RestFixture 安装包下载： RestFixture 首页 > Wiki > Live documentation > download > smartrics-RestFixture-3.0-bin.zip
RestFixture 使用文档： RestFixture 首页 > Wiki > Live documentation > download > RestFixture-3.0.pdf

4.Fitnesse 20140630+RestFixture 3.0 ——水土不服

RestFixture 在最新版 Fitnesse 20140630 的运行结果：
最新版Fitnesse的运行结果

其中的 GET 行，只有第 2、3 列正确显示，4、5 列显示为 HTML 文本，看上去十分杂乱，

旧版的 Fitnesse 是这样显示的：

用Xpath语法检查GET响应内容

后续的博客中，我会介绍如何让 RestFixture 3.0 在 Fitnesse 20140630 中也能打印出漂亮的测试结果。

为 Fitnesse-20140630 定制 RestFixture 代码

4 个赞

共收到 14 条回复时间点赞

思寒_seveniruby #1 · 2014年08月16日

这个东西也是流行了很久了. 只是国内用的少. 也是个不错的框架.
不过依赖 wiki 有点重.

超爱fitnesse #15 · 2014年08月17日 Author

wiki 就是 fitnesse 的突出特点，如果看上这个特点，就会选它。
有人因为 python 的缩进方式喜欢他，有人正好相反。哈哈！

超爱fitnesse #3 · 2014年08月17日 Author

testerhome 的 markdown 语法不支持缩进 4 个空格当代码显示，只支持用一对```显示代码

四个空格后的代码

一对```里的代码

KevinXu #13 · 2014年08月18日

very helpful,之前就在想有没有哪个工具测 web service，postman/restclient 只是开发人员调试用的工具，对于测试来说最重要的是结果的断言，之前用 jmeter 去试过，但是断言部分还是没办法解决，可能我指望其能够做功能测试要求太高了，这个工具可以尝试下。

KevinXu #5 · 2014年08月18日

http://my.oschina.net/fitnessefan 看来你实在是比较喜欢 fitnesse

虎卧荒丘 #11 · 2014年08月18日

真实要啥来啥~最近正好要测 webservice~赞

超爱fitnesse #7 · 2014年08月18日 Author

这里同道还蛮多的。：）

Vincent #8 · 2014年08月18日

我用 3，在 jvm 跑速度杠杠的，集成到 jenkins 也很方便

超爱fitnesse #8 · 2014年08月18日 Author

#8 楼 @cjtcwyk
3 是什么？

Vincent #10 · 2014年08月18日

#9 楼 @htmlbiji
您列出来的 junit 中直接用 java network api 调用 GET/POST 方法

超爱fitnesse #11 · 2014年08月18日 Author

#10 楼 @cjtcwyk
各有所长

5楼已删除

zhangzhao_lenovo #13 · 2015年11月27日

#7 楼 @htmlbiji 看上去很赞，这个 RestFixture 支持正则吗？

超爱fitnesse #3 · 2015年11月29日 Author

#13 楼 @zhangzhao_lenovo javascript 的核心对象都支持，核心对象是指http://www.w3school.com.cn/js/index.asp里 JS 对象
JS 对象
JS 数字
JS 字符串
JS 日期
JS 数组
JS 逻辑
JS 算数
JS 正则表达式

15楼已删除

Michael_Wang #1 · 2016年05月05日

RestFixture 支持 Scenario 吗？
在 RestFixture.java 中找到有如下注释，但没有发现相关功能

// Split out of completeHttpMethodExecution so RestScriptFixture can call
// this

需要登录后方可回复, 如果你还没有账号请点击这里注册。