一. 什么是token
token 由服务端产生,是客户端用于请求的身份令牌。第一次登录成功时,服务端会生成一个包含用户信息的加密字符串token,返回给客户端并保存在本地,后续客户端只需要带上token进行请求即可,无需带上用户名密码。
token原理简单概括如下:
- 用户首次登录成功后,服务端会生成一个token值,服务端会将它保存保存在数据库中,同时也会将它返回给客户端;
- 客户端拿到token值后,保存在本地;
- 后续客户端再次发送除登录外的其他请求时,会把保存在本地的token值作为参数一起发送给服务端;
- 服务端收到客户端的请求后,会拿发送过来的token值与保存在数据库中的token值进行比较;
- 如果两个token值相同, 则说明当前用户处于登录状态;
- 如果数据库中没有这个token值或者token值已经生效,则需用户重新登录。
二. token场景处理
公司某管理后台系统,登录后返回token,接着去请求其他接口时请求头中都需要加上这个token,否则提示请先登录。
请求该系统的登录接口如下:
# @author: 给你一页白纸 # 微信公众号:测试上分之路 import requests import json headers = {"Content-Type": "application/json;charset=utf8"} url = "http://127.0.0.1:5000/login" _data = { "username": "刘德华", "password": "123456" } res = requests.post(url=url, headers=headers, json=_data).text print(res)
结果如下:
{ "code": 1000, "msg": "登录成功!", "token": "sh34ljjl08s32730djsh34ljjl08s32730djsh34ljjl08s32730djsh34ljjl08s32730djsh34ljjl08s32730djsh34ljjl08s32730dj" }
在对扎样的项目做接口自动化测试时,需要先请求登录接口拿到token,再去请求别的接口。每次请求其他接口时先请求一次登录接口,这样做虽然可行,但这样不仅会降低自动化的执行效率,而且每次都请求登录也会对服务器资源造成浪费。
这里介绍如下两种处理思路。
1. 思路一
在执行用例之前,先请求登录接口,并将返回的token值存储在文件中(如yaml文件),后续请求需要用到token值则从该文件。
python中yaml文件的读写请参考我之前的文章Python读写yaml文件(使用PyYAML库)。
1,运行接口自动化测试框架,初始化时先请求登录接口,获取token值,并写入指定的yaml文件中。
# @author: 给你一页白纸 # 微信公众号:测试上分之路 import requests import json import yaml def get_token(): ''' 请求登录接口,获取token :return: ''' headers = {"Content-Type": "application/json;charset=utf8"} url = "http://127.0.0.1:5000/login" _data = { "username": "刘德华", "password": "123456" } res = requests.post(url=url, headers=headers, json=_data).text res = json.loads(res) token = res["token"] return token def write_yaml(token): ''' 写入yaml文件 :return: ''' t_data = { "token": token } with open("yaml文件路径", "w", encoding="utf-8") as f: yaml.dump(data=t_data, stream=f, allow_unicode=True) if __name__ == '__main__': token = get_token() # 获取token write_yaml(token) # 将token值写入yaml文件
2,执行测试用例时先读取yaml文件中token值,并将token加入headers中(也有些是将token放在请求参数中,视被测试项目具体情况而定),再发送请求。
# @author: 给你一页白纸 # 微信公众号:测试上分之路 import requests import yaml import pytest import json def read_yaml(): ''' 读yaml文件 :return: ''' with open('yaml文件路径', 'r', encoding='utf-8') as f: result = yaml.load(f.read(), Loader=yaml.FullLoader) token = result["token"] return token def test_check_user(): ''' 查询个人信息(需要先登录系统) :return: ''' # 先从yaml文件中读取token token = read_yaml() # 再将token添加到请求头中 headers = { "Content-Type": "application/json;charset=utf8", "token": token } url = "http://127.0.0.1:5000/users/3" res = requests.get(url=url, headers=headers).text # 返回结果为json格式,转换为字典 res = json.loads(res) # 断言code是否为1000 assert res["code"] == 1000 if __name__ == '__main__': pytest.main()
这里仅仅只是举例说明,而在实际的框架中,我们需要把这些诸如yaml文件的读写这样的函数单独封装在某个模块中,供其他模块调用,这样会代码会更加清晰简洁。
2. 思路二
利用pytest中的Fixture函数,作用域设置为session,并返回token值,后续测试方法/函数调用该Fixture函数。
pytest中Fixture的使用请参考我之前的文章pytest(6)-Fixture(固件)。
1,首先,在conftest中定义一个作用域为session的Fixture函数,用于请求登录接口返回token。
# @author: 给你一页白纸 # 微信公众号:测试上分之路 import pytest import requests import json @pytest.fixture(scope="session") def get_token_fixture(): ''' 作用域为session的fixture函数,返回token :return: ''' headers = {"Content-Type": "application/json;charset=utf8"} url = "http://127.0.0.1:5000/login" _data = { "username": "刘德华", "password": "123456" } res = requests.post(url=url, headers=headers, json=_data).text res = json.loads(res) token = res["token"] return token
2,接着,测试用例调用该Fixture。
def test_check_user(get_token_fixture): ''' 查询个人信息(需要先登录系统) :return: ''' # 通过Fixture函数g获取et_token_fixture值,即token,再将token添加到请求头中 headers = { "Content-Type": "application/json;charset=utf8", "token": get_token_fixture } url = "http://127.0.0.1:5000/users/3" res = requests.get(url=url, headers=headers).text res = json.loads(res) print(res) print(headers) assert res["code"] == 1000 if __name__ == '__main__': pytest.main()
执行测试用例结果如下:
说明思路二也是可行的,当然这里只执行了一条测试用例,如果执行很多的用例,效果会是怎样还没去验证,大家可以试试看。
三. 总结
- 相对于Session/Cookies来说,请求量较大或者涉及第三方接口的系统,使用token更适合。
- 有些项目token是放在请求头中发送的,而有一些项目则是放在请求参数里发送的,做接口自动化时要明确是哪种方式。
- 接口自动化处理token时这两种思路可任选一种,如果使用pytest框架的话建议尝试思路二。