乐趣区

关于ide:VCRpy自动模拟-HTTP-交互以简化和加速测试

jiezi

【导语】：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 等。

退出移动版