RestFixture：Web服务回归测试利器

浏览数：29 / 时间：2015年06月09日

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

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的示例

废话少说，先上图：

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

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

<body>

并且 tag内容是

1	`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的示例

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

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

1	`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响应文本：

\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))}) | |

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

1	`{"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

3.2 运行环境

fitnesse运行环境文件目录：

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

启动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