前言
做接口测试时,大部分接口都需要登录鉴权。笔者在项目中进行接口测试时需要在请求头部添加Authentication token
,使用requests.get()
、requests.post()
等函数发送请求时,通常需要传入参数headers
,像这样requests.post(url='', json=payload, headers={'Authorization': ''})
,但每个请求都需要手动添加headers
,还是比较麻烦的,如何自动添加Authentication token
认证呢?这篇文章将揭晓。
知识回顾
在进入正文前,需要先知道什么是requests.Session
。
requests.Session
是 requests
库提供的一个会话对象,用于管理和处理 HTTP 请求。相比于单独使用 requests.get()
、requests.post()
等函数发送请求,使用 Session
对象可以更加灵活和高效地处理请求和响应,同时还可以共享一些相关数据和状态信息。
什么是 Session 对象
Session 对象是在 HTTP 请求过程中通信的一部分,是与服务器交互的一种方式。HTTP 协议是无状态的,也就是说每个请求之间是没有联系的。而通过使用 Session 对象,我们可以在多个请求之间保持某些状态信息的一致性,比如 cookies、身份验证信息等。
使用 Session
对象时,可以先创建一个实例,然后使用该实例发送多个请求,这些请求会自动共享相同的 cookies、身份验证信息等状态。例如:
ini
import requests
s = requests.Session()
s.get('http://httpbin.org/cookies/set/sessioncookie/123456789')
r = s.get('http://httpbin.org/cookies')
print(r.text)
# 输出结果:
# {
# "cookies": {
# "sessioncookie": "123456789"
# }
# }
在上述代码中,首先使用 requests.Session()
创建了一个 Session
对象实例 s
,然后使用 s.get()
发送了两个请求,其中第一个请求设置了名为 sessioncookie
的 cookie 值为 123456789
,第二个请求获取了当前会话中的所有 cookies 并打印出来。由于这两个请求共用了同一个 Session
对象,所以第二个请求可以正确获取到第一个请求设置的 cookie 值。
Session 对象的优点
相比于单独使用 requests.get()
、requests.post()
等函数发送请求,使用 Session
对象有以下优点:
- 自动管理 cookies:
Session
对象会自动保存和发送 cookies,使得多次请求时不需要手动添加或传递 cookies。 - 保持状态信息的一致性:
Session
对象可以共享所有相关的状态信息,如 cookies、headers、身份验证信息等,避免了多个请求之间信息不一致的问题。 - 多次请求共享底层 TCP 连接:使用
Session
对象可以通过复用底层的 TCP 连接,减少 HTTP 连接的建立和关闭的开销,提高请求效率。 - 方便错误处理:
Session
对象提供了一个类似于 try-except 的机制,对网络错误、服务器返回的错误响应等进行统一处理,进一步简化了代码。
使用示例
下面是一个简单的使用 Session
对象发送 HTTP GET 请求的示例:
dart
import requests
with requests.Session() as s:
response = s.get('https://www.baidu.com/')
print(response.content)
在上述代码中,首先使用 requests.Session()
创建了一个 Session
对象实例 s
,然后使用 s.get()
发送 GET 请求获取百度首页的内容,并将相应结果打印出来。
另外,Session
对象还支持一些其他的方法和属性:
s.headers
: 用于设置请求头s.auth
: 用于设置身份验证信息s.cert
: 用于设置 SSL 证书路径s.proxies
: 用于设置代理地址s.stream
: 用于设置响应是否分块下载s.cookies
: 用于设置和获取 cookiess.purge(url, **kwargs)
: 用于清除指定 URL 的缓存s.resolve(url, **kwargs)
: 用于解析指定 URL
下面是一个使用 Session
对象发送 POST 请求的示例:
ini
import requests
payload = {'username': 'user', 'password': 'password'}
with requests.Session() as s:
s.post('http://httpbin.org/post', data=payload, headers={'Content-Type': 'application/json'})
r = s.get('http://httpbin.org/headers')
print(r.json())
在上述代码中,首先创建了一个字典对象 payload
来设置 POST 请求时的传输数据,然后使用 s.post()
方法发送 POST 请求,同时传入参数 data
和 headers
,分别表示 POST 请求的传输数据和请求头信息。接下来,使用 s.get()
方法发送 GET 请求获取当前会话中的所有 headers 并打印出来。
实现自动添加Authentication
当然,这里我们还是会借助fixture
来实现。还不了解fixture
如何使用的同学,可以查看这两篇文章掌握 pytest fixture:优化你的测试代码(一)和掌握 pytest fixture:优化你的测试代码(二)
实现过程
定义会话级别的Session fixture
ini
from requests import Session
@pytest.fixture(scope="session")
def requests_session():
s = Session()
s.mount('http://', HTTPAdapter(max_retries=2))
s.mount('https://', HTTPAdapter(max_retries=2))
yield s
s.close()
这段代码,通过 s = Session()
创建一个 requests.Session
对象,并为此会话对象设置了最大重试次数为 2 次。接下来,将该会话对象作为 fixture 的返回值,使用 yield
关键字进行暂停,以便在测试环境中使用这个会话对象进行请求。当测试完成后,使用 s.close()
关闭会话,释放相关资源。
自动添加headers
ini
@pytest.fixture(scope="session", autouse=True)
def headers(requests_session):
authorization = "Bearer ******"
headers = {'Authorization': authorization}
requests_session.headers.update(headers)
这段代码,在每个测试会话开始之前,它会自动调用 headers
函数,使用了 requests_session.headers.update(headers)
将设置好的请求头信息更新到 requests_session
对象中。通过这样的操作,后续的所有使用 requests_session
对象发送的 HTTP 请求都会自动带上这个请求头信息。
最后
本文介绍了 requests.Session
对象的基本使用方法和优势,并通过fixture
实现了自动添加请求头的功能。其实比较简单,只要了解了requests.Session
以及fixture
的使用还是比较容易实现的。这样在进行接口测试时,可以通过设置统一的请求头信息,避免在每个测试用例中重复设置请求头,提高了代码的可读性和可维护性。同时,它还能够确保在整个测试会话期间,所有的请求都使用相同的请求头,保持了一致性。