Python+Requests：搭建基础接口自动化测试框架
在接口自动化测试领域，Python 结合 Requests 库是一种非常流行且高效的组合。今天，我们就一起利用这两者来搭建一个基础的接口自动化测试框架。这个框架将包含用例管理、请求发送以及结果断言等重要功能，帮助你开启接口自动化测试的大门。
核心技术点
Requests 库使用
Requests 库是 Python 中一个强大且易用的 HTTP 库，它可以让你方便地发送各种 HTTP 请求，如 GET、POST、PUT、DELETE 等。在接口自动化测试中，我们主要用它来模拟客户端向服务器发送请求，并获取响应结果。
- 安装 Requests 库
首先，你需要安装 Requests 库。可以使用 pip 命令进行安装，打开命令行工具，输入以下命令：
pip install requests 这就好比你为自己的测试工具箱添加了一个新的工具，有了它，你就能更轻松地完成接口测试的任务。
- 发送 GET 请求
下面是一个简单的发送 GET 请求的示例代码：
import requests # 发送 GET 请求 response = requests.get('https://api.example.com/data')# 打印响应状态码print(response.status_code)# 打印响应内容print(response.text)在这段代码中，我们使用 requests.get() 方法发送了一个 GET 请求到指定的 URL。response.status_code 可以获取响应的状态码，比如 200 表示请求成功，404 表示请求的资源不存在。response.text 则可以获取响应的文本内容。
- 发送 POST 请求
如果需要发送 POST 请求，可以使用requests.post()方法，示例代码如下：
import requests # 定义请求数据 data ={'key1':'value1','key2':'value2'}# 发送 POST 请求 response = requests.post('https://api.example.com/submit', data=data)# 打印响应状态码print(response.status_code)# 打印响应内容print(response.text)这里我们定义了一个字典 data 作为请求的数据，然后使用 requests.post() 方法将数据发送到指定的 URL。
框架基础结构设计
一个基础的接口自动化测试框架通常包含用例管理、请求发送和结果断言等模块。下面我们来详细设计这个框架的基础结构。
- 用例管理模块
用例管理模块主要负责管理测试用例，包括用例的添加、执行和结果记录。我们可以使用 Python 的类来实现这个模块。示例代码如下：
classTestCaseManager:def__init__(self): self.test_cases =[]defadd_test_case(self, test_case): self.test_cases.append(test_case)defrun_test_cases(self):for test_case in self.test_cases: test_case.run()在这个类中，__init__ 方法初始化了一个空的测试用例列表 self.test_cases。add_test_case 方法用于向列表中添加测试用例，而 run_test_cases 方法则遍历列表，依次执行每个测试用例。
- 请求发送模块
请求发送模块负责使用 Requests 库发送 HTTP 请求。我们可以将请求发送的逻辑封装在一个类中，示例代码如下：
import requests classRequestSender:defsend_request(self, method, url, data=None):if method =='GET': response = requests.get(url)elif method =='POST': response = requests.post(url, data=data)return response 在这个类中，send_request 方法根据传入的请求方法（GET 或 POST）和 URL 发送相应的请求，并返回响应结果。
- 结果断言模块
结果断言模块用于验证接口的响应结果是否符合预期。我们可以使用 Python 的assert语句来实现简单的断言。示例代码如下：
classAssertion:defassert_status_code(self, response, expected_status_code):assert response.status_code == expected_status_code,f"Expected status code {expected_status_code}, but got {response.status_code}"在这个类中，assert_status_code 方法接收响应对象和预期的状态码作为参数，使用 assert 语句进行断言。如果实际状态码与预期状态码不相等，会抛出一个异常并输出错误信息。
实操模块：逐步搭建基础框架
现在，我们将上述模块组合起来，逐步搭建一个完整的基础接口自动化测试框架。
完整代码示例
import requests # 请求发送模块classRequestSender:defsend_request(self, method, url, data=None):if method =='GET': response = requests.get(url)elif method =='POST': response = requests.post(url, data=data)return response # 结果断言模块classAssertion:defassert_status_code(self, response, expected_status_code):assert response.status_code == expected_status_code,f"Expected status code {expected_status_code}, but got {response.status_code}"# 用例管理模块classTestCase:def__init__(self, method, url, data=None, expected_status_code=200): self.method = method self.url = url self.data = data self.expected_status_code = expected_status_code self.sender = RequestSender() self.assertion = Assertion()defrun(self): response = self.sender.send_request(self.method, self.url, self.data) self.assertion.assert_status_code(response, self.expected_status_code)print(f"Test case passed: {self.method}{self.url}")classTestCaseManager:def__init__(self): self.test_cases =[]defadd_test_case(self, test_case): self.test_cases.append(test_case)defrun_test_cases(self):for test_case in self.test_cases:try: test_case.run()except AssertionError as e:print(f"Test case failed: {e}")# 示例使用if __name__ =="__main__": manager = TestCaseManager()# 添加 GET 请求测试用例 get_test_case = TestCase('GET','https://api.example.com/data') manager.add_test_case(get_test_case)# 添加 POST 请求测试用例 post_data ={'key1':'value1','key2':'value2'} post_test_case = TestCase('POST','https://api.example.com/submit', data=post_data) manager.add_test_case(post_test_case)# 运行所有测试用例 manager.run_test_cases()代码解释
RequestSender类负责发送 HTTP 请求，根据传入的请求方法和 URL 发送相应的请求。Assertion类负责结果断言，使用assert语句验证响应的状态码是否符合预期。TestCase类表示一个测试用例，包含请求方法、URL、请求数据和预期状态码等信息。run方法负责执行测试用例，发送请求并进行断言。TestCaseManager类负责管理测试用例，包括添加测试用例和运行所有测试用例。在运行测试用例时，如果发生断言失败，会捕获异常并输出错误信息。
问题解决
Requests 请求异常
在使用 Requests 库发送请求时，可能会遇到各种异常，如网络连接失败、请求超时等。可以使用 try-except 语句来捕获并处理这些异常。示例代码如下：
import requests try: response = requests.get('https://api.example.com/data', timeout=5)except requests.exceptions.RequestException as e:print(f"Request error: {e}")在这段代码中，我们使用 timeout 参数设置了请求的超时时间为 5 秒。如果请求超时或发生其他网络异常，会捕获 requests.exceptions.RequestException 异常并输出错误信息。
断言失败问题
如果断言失败，会抛出 AssertionError 异常。可以在 TestCaseManager 类的 run_test_cases 方法中捕获这个异常，并输出详细的错误信息，帮助我们定位问题。示例代码如下：
classTestCaseManager:def__init__(self): self.test_cases =[]defadd_test_case(self, test_case): self.test_cases.append(test_case)defrun_test_cases(self):for test_case in self.test_cases:try: test_case.run()except AssertionError as e:print(f"Test case failed: {e}")在这个方法中，如果某个测试用例的断言失败，会捕获 AssertionError 异常并输出错误信息，让我们知道哪个测试用例失败以及具体的错误原因。
总结
通过本节的学习，我们掌握了使用 Python 和 Requests 库搭建基础接口自动化测试框架的方法。我们学习了 Requests 库的基本使用，包括发送 GET 和 POST 请求，还设计了框架的基础结构，包括用例管理、请求发送和结果断言等模块。同时，我们也解决了 Requests 请求异常和断言失败等常见问题。掌握了这些内容后，下一节我们将深入学习框架的扩展和优化，进一步完善对本章接口自动化测试框架搭建主题的认知。
🍃 系列专栏导航
- 🍃 博客概览：《程序员技术成长导航，专栏汇总》
