VCR.py：自动模拟 HTTP 交互，以简化和加速测试

Posted 2021-09-25 开源前哨

【导语】：Ruby 的 VCR 库的 Python 版本，用于加快测试执行速度和确定性。

简介

VCR.py 简化并加快了 HTTP 请求的测试，它是 Ruby 的 VCR 库的 Python 版本，首次运行 VCR.py 时，它所支持的 HTTP 库所执行的请求都会被记录下来并序列化，将其写入到平面文件中，文件默认是 yaml 文件。

该平面文件被称为磁带（cassette）。当再次执行相关代码时，VCR.py 会读取上述磁带中存储的序列化的请求和响应数据，并拦截 HTTP 请求，返回与这些请求相对应的响应值。

也就是说，对于同一个 HTTP 请求，第一次是一个完整的到服务器的 HTTP 请求，VCR.py 会记录下来，从第二次开始，VCR.py 会拦截这些相同请求，并读取磁带，返回第一次请求的数据，第二次实际上不会产生 HTTP 通信。

这样有以下好处：

• 可以离线工作，不依赖网络
• 确定的服务响应值，不受服务影响
• 加快测试执行速度

如果服务器修改了API，导致数据内容或格式变化，只需要删除磁带文件，再次运行测试即可。

项目地址：

https://github.com/kevin1024/...

安装

VCR.py 是 PyPI 上的软件包，支持 Python 3.5+，使用 pip 即可安装：

pip install vcrpy  

VCR.py支持以下HTTP网络库：

• aiohttp
• boto
• boto3
• http.client
• httplib2
• requests (1.x和2.x都支持)
• tornado.httpclient
• urllib2
• urllib3

简单使用

先看以下代码：

import vcr  
import urllib2  
  
with vcr.use_cassette(\'fixtures/vcr_cassettes/synopsis.yaml\'):  
    response = urllib2.urlopen(\'http://www.iana.org/domains/reserved\').read()  
    assert \'Example domains\' in response  

运行以上代码，VCR.py 会将请求记录到 fixtures/vcr\\_cassettes/synopsis.yaml。

再次运行时，发出HTTP请求时，VCR.py会将文件中保存的响应值直接返回。

这个测试现在是快速的（不再发出HTTP请求，不再访问网络）、确定的（客户端离线或者服务宕机也依然可以测试）、准确的（响应值都是从真实请求中获得的）。

也可以通过装饰器来使用，以下代码和上面的代码是一样的：

@vcr.use_cassette(\'fixtures/vcr_cassettes/synopsis.yaml\')  
def test_iana():  
    response = urllib2.urlopen(\'http://www.iana.org/domains/reserved\').read()  
    assert \'Example domains\' in response  

使用装饰器时可以省略磁带路径，在这种情况下，磁带文件会被放在与测试文件相同的目录中，文件名与测试函数相同。

配置

如果你不喜欢VCR的默认配置，可以自行实例化一个VCR实例，并自定义参数：

import vcr  
  
my_vcr = vcr.VCR(  
    serializer=\'json\',  
    cassette_library_dir=\'fixtures/cassettes\',  
    record_mode=\'once\',  
    match_on=[\'uri\', \'method\'],  
)  
  
with my_vcr.use_cassette(\'test.json\'):  
    # your http code here  

也可以这样来修改默认配置：

with vcr.use_cassette(\'test.yml\', serializer=\'json\', record_mode=\'once\'):  
    # your http code here  

请求匹配

请求匹配也是可以配置的，也就是说，可以修改如何判断两个HTTP请求是否为同一个请求的规则。默认的规则是具有相同URL和HTTP方法（POST、GET等）的请求就是相同的请求。可以通过match\\_on进行设置，提供以下可配置项：

• 请求方法（如POST或GET）
• uri（完整的URI）
• 主机（接收请求的服务器的主机名）
• 端口（接收请求的服务器的端口）
• 路径（请求的路径）
• query参数（请求中的query字符串）
• raw\\_body（整个请求主题）
• body
• 请求头
• 如果以上还无法满足要求，还可以自定义匹配器，详细请参考官网。

开源前哨 日常分享热门、有趣和实用的开源项目。参与维护 10万+ Star 的开源技术资源库，包括：Python、Java、C/C++、Go、JS、CSS、Node.js、php、.NET 等。