技术分享 | 服务端接口自动化测试, Requests 库的这些功能你了解吗?

原文链接

本文节选自霍格沃兹测试开发学社内部教材

如果要设计一个强大的接口测试框架,首先需要一个足够好用的 HTTP 第三库,在其基础上进行二次开发。而这个第三库的最佳选择就是 Requests,Requests 是一个优雅而简单的 python HTTP 库,而且内置的功能除了基础的发送请求,返回响应信息之外,还有非常实用且强大的代理功能、auth 认证等,接下来的接口自动化测试的实战练习,都和 requests 息息相关。

接口测试框架安装

pip 命令安装 requests。

pip install requests

Requests 官方文档:

https://2.python-requests.org/en/master/

接下来使用最流行的 Requests 进行接口测试。Requests 提供了几乎所有的 HTTP 请求构造方法,以及通过传入参数的方法,对发送的请求进行定制化的配置。可以用来应对各种不同的请求场景。常见的 HTTP 请求构造方法分别为 get、post、put、delete、head、options 等。

接口请求构造

http 请求构造

发送 get 请求

import requests
r = requests.get('https://api.github.com/events')

在请求中添加 data 参数,并发送 post 请求

import requests
r = requests.post('https://httpbin.ceshiren.com/post',
data = {'key':'value'})

在请求中添加 data 参数,并发送 put 请求

import requests
r = requests.put('https://httpbin.ceshiren.com/put',
data = {'key':'value'})

发送 delete 请求

import requests
r = requests.delete(
  'https://httpbin.ceshiren.com/delete')

发送 head 请求

import requests
r = requests.head('https://httpbin.ceshiren.com/get')

发送 options 请求

import requests
r = requests.options('https://httpbin.ceshiren.com/get')

也可以直接使用 request 函数,传入不同的 method,例如使用这个方法发送 get 请求

import requests
requests.request("get", "http://www.baidu.com")

其他重要参数

下面的参数都是非必须参数,但是如果需要对请求做额外的定制化,则需要以下这些参数的作用。

  • header 参数

通过传入 dict 定制请求头

import requests
url = 'https://api.github.com/some/endpoint'
headers = {'user-agent': 'my-app/0.0.1'}
r = requests.get(url, headers=headers)

  • data 参数

发送编码为表单形式的数据单

>>> payload = {'key1': 'value1', 'key2': 'value2'}
>>> r = requests.post("https://httpbin.ceshiren.com/post"
, data=payload)
>>> r.text
{
  ...
  "form": {
    "key2": "value2",
    "key1": "value1"
  },
  ...
}

  • timeout 参数

设定超时时间(秒),到达这个时间之后会停止等待响应:

>>> requests.get('http://github.com', timeout=0.001)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
requests.exceptions.Timeout:\
 HTTPConnectionPool(host='github.com', port=80):\
  Request timed out. (timeout=0.001)

  • allow_redirects 参数

如果在接口自动化测试过程中,被测接口本身会在某些场景触发重定向操作,若不想让其触发重定向,需要此接口重定向前的响应内容,则可以使用allow_redirects参数直接拿到其重定向前的响应内容。控制是否启用重定向,默认为 True 则是启用,选择 False 为禁用。

>>> import requests
>>> r = requests.get('http://github.com', allow_redirects=False)
>>> r.status_code
301

  • proxies 参数

若想让请求数据经过指定的端口,则可以通过 proxies 参数设置代理。设置之后,该条数据在请求过程中,均会经过代理工具。此参数可以应用于需要抓包工具获取对应的请求数据信息。参数要求为 dict 格式,key 值为选择的协议,可以分别设置 http 请求和 https 请求的代理。

>>> import requests
>>> proxies = {
...   'http': 'http://127.0.0.1:8080',
...   'https': 'http://127.0.0.1:8080',
... }
>>> r = requests.get('https://httpbin.ceshiren.com/get',
proxies=proxies,  verify=False)
>>> r.text

代码如此编写之后,可以在 Charles 中配置好代理设置(配置方法参考 HTTP、HTTPS 抓包分析),然后运行代码,然后就可以清楚的抓取到此次请求信息。

注意:需要有代理工具监听相关的端口(本示例为 8080),否则代码运行失败

  • verify 参数

如果在使用代理过程中,https 协议的数据信息默认是需要校验证书信息的,如果不传入证书信息,或者关闭证书验证,那么在请求的过程中 requests 则会返回错误信息。verify 参数可以传入 bool 值或者 string,默认为 True。如果设置为 False 的即为忽略对 SSL 证书的验证;反之就是需要做验证;如果传入值为 string 的话,代表指定本地的证书作为客户端证书。

不使用 verify 参数或者 verify 参数默认为 True

>>> import requests
>>> proxies = {
'http': 'http://127.0.0.1:8080',
'https': 'http://127.0.0.1:8080'
}
>>> r = requests.get('https://httpbin.ceshiren.com/get',
proxies=proxies, verify=True)

结果为证书验证失败信息

  File "/usr/local/lib/python3.7/site-packages/requests/adapters.py", line 514, in send
    raise SSLError(e, request=request)
requests.exceptions.SSLError: HTTPSConnectionPool(host='httpbin.ceshiren.com', port=443): Max retries exceeded with url: /get (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self signed certificate in certificate chain (_ssl.c:1076)')))

忽略对 SSL 证书的验证

>>> import requests
>>> proxies = {
...   'http': 'http://127.0.0.1:8080',
...   'https': 'http://127.0.0.1:8080',
... }
>>>
>>> r = requests.get('https://httpbin.ceshiren.com/get',
... proxies=proxies,  verify=False)
>>> r.text

结果为正常的响应信息,但是带有 warning 警告,警告信息为正常提示,可以忽略。

/usr/local/lib/python3.7/site-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host '127.0.0.1'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings
  InsecureRequestWarning,
{
  "args": {},
  "headers": {
 ...中间内容省略...
  },
  "origin": "10.7.152.0",
  "url": "https://httpbin.ceshiren.com/get"
}

从本地传入 charles 证书

>>> import requests
>>> proxies = {
  'http': 'http://127.0.0.1:8080',
  'https': 'http://127.0.0.1:8080',
  }
>>> r = requests.get('https://httpbin.ceshiren.com/get',
proxies=proxies,
verify="charles-ssl-proxying-certificate.pem")
>>> r.text

结果为正常的响应信息,且没有 warning 警告

{
  "args": {},
  "headers": {
 ...中间内容省略...
  },
  "origin": "10.7.152.0",
  "url": "https://httpbin.ceshiren.com/get"
}

另外三个重要参数 json、cookies、auth 则会在后面的章节进行详细的介绍。

关闭