Macaroon —— 来自阿里的反向代理测试套件

Macaroon 详细介绍
Macaroon 是一个高效的反向代理测试套件，测试框架本身基于python2.7开发，方便跨平台移植；测试例使用格式化描述，做到编程语言无关性。使用 Macaroon能够简便快捷的完成测试场景的构造、线上失效案例的重建及被测软件（DUT）的功能、模块、协议一致性测试等。

安装及使用

社区公共测试平台地址：

目前公共测试环境已经搭建配置完成，测试用户名：Tester；
登录qa1机器：ssh -l Tester -p 22292 qa1.zymlinux.net, /home/Macaroon安装有Macaroon；
登录qa2机器：ssh -l Tester -p 22293 qa2.zymlinux.net，安装有ts、squid等方向代理软件；
如有需要，请联系宗仪（QQ：624740707）或怀财（QQ：262765996）添加长期用户权限；

自行安装及使用：

1. 硬件准备：

两台机器A和B，A机器执行测试并同时作为client端与server端，B机器安装被测软件DUT--例如TrafficServer(Proxy).

ii.软件准备：

执行install.sh文件
Client&Server:
   Linux
   Python2.7
   PyYaml包
   Macaroon
   git

DUT( Device Under Testing) :
   被测软件(proxy or cache, 如TrafficServer, Swift等)
   Bind

1. 配置DUT：

使从A机器client端发出的http请求能够通过DUT(proxy)后正确到达A机器server端 ----- *重要   
例如： 在proxy上安装bind, 修改named的相关配置信息,使得named中存在一个域名可以指向A机器(Client的IP)，使用dig <域名>确认是否成功.

1. 修改config文件：

在macaroon目录下, 找到config.py文件,将_server的内容修改为proxy的ip或者hostname.   
_port修改为proxy提供的对外服务的端口, 例如：默认为80.     
将DUT_Strart, DUT_Stop和DUT_Clean分别修改为proxy对应的启动, 停止和清理缓存命令.

1. 将macaroon目录下的agentsever.py 拷贝至proxy机器,并使用sudo权限执行：

sudo python agentserver.py

1. 环境验证：

在client端执行httpmockserver.py：python httpmockserver.py   
在proxy端执行curl命令，验证proxy到client的request是否可达：
curl http://<proxyip>:<port>/ -H "Host:XXX:[port]"

更多问题参见：doc/Q&A

框架及case设计

参见doc/Case_Design

如何运行用例

1. 运行单个case

在根目录下执行如下命令: sh runcase.sh case文件

1. 运行多个case

在根目录下执行如下命令：python runner.py -p your-case-path -s your-email

详见：python runner.py -h
查看case输出及日志

1. 执行和调试单个测试例

sh runcase.sh <case文件>, case执行日志屏幕输出

1. 执行多个case

执行日志输出至日志文件，./log/record_XXXX.log，按时间排序
如何编写你的用例

1. case/下创建your case dir
2. 拷贝case模板example/case_template_example.yaml至your case dir，并重命名

iii.编辑该文件

a. 文件头部添加case相关说明     
   b. 填写case步骤并准备对应步骤的数据块    
   c. 填充和完善每步的数据,如request header, response header, response body, 需要检查的header等    
   d. 保存和调试用例