软件测试基础二十三 （接口测试 集成UnitTest）

集成UnitTest

1. unittest概述

• 定义：unittest是Python内置的标准测试框架，用于编写和运行单元测试。它提供了一组工具和约定，帮助开发者创建测试用例、组织测试套件，并执行测试和检查测试结果。通过使用unittest，可以对代码中的各个单元（如函数、方法、类）进行独立的测试，确保它们的功能符合预期。
• 主要组件：

• • 测试用例（TestCase）：这是unittest的基本单元，用于定义一个具体的测试场景。一个测试用例通常包含一个或多个测试方法，每个测试方法针对被测试对象的一个特定功能进行测试。例如，对于一个数学计算函数，可能有一个测试用例，其中包含测试加法、减法等不同运算的测试方法。
  • 测试套件（TestSuite）：它是一组测试用例的集合。可以将多个相关的测试用例组合成一个测试套件，以便一起执行。这对于组织和管理大量的测试用例非常有用，例如，可以将所有与用户认证相关的测试用例放在一个测试套件中，将与订单处理相关的测试用例放在另一个测试套件中。
  • 测试运行器（TestRunner）：负责执行测试套件或单个测试用例，并输出测试结果。unittest提供了多种测试运行器，包括文本测试运行器（用于在控制台输出简单的测试结果）和图形化测试运行器（用于生成更直观的测试报告）。
  • 测试夹具（Test Fixture）：用于设置和清理测试环境。它包括在每个测试方法执行前的初始化操作（如创建数据库连接、初始化对象等），以及在测试方法执行后的清理操作（如关闭数据库连接、释放资源等）。

2. 将requests库与unittest集成

• 基本思路：在unittest测试用例中使用requests库发送HTTP请求，然后对请求的响应进行断言，以验证被测试的API或Web服务是否符合预期。这样可以结合requests的强大功能和unittest的测试框架，对网络请求相关的功能进行全面的单元测试。
• 示例步骤：

• • 导入必要的模块：

import unittest
import requests

• • 定义测试用例类：

class APITestCase(unittest.TestCase):def test_get_request(self):url = "https://api.example.com/data"response = requests.get(url)self.assertEqual(response.status_code, 200)

• • 运行测试：

if __name__ == '__main__':unittest.main()

• • • 可以在脚本的末尾添加以下代码来运行测试：
    • 当运行这个脚本时，unittest.main()会自动发现并执行APITestCase类中的测试方法。在test_get_request方法中，首先使用requests库发送一个GET请求，然后使用self.assertEqual()断言来检查响应状态码是否为200。如果状态码不是200，测试方法将失败，并输出相应的错误信息。

3. 测试用例的详细设计

• 多种请求方法测试：

• • 除了测试GET请求，还可以测试POST、PUT、DELETE等其他请求方法。例如，测试一个POST请求的测试方法可以如下设计：

def test_post_request(self):url = "https://api.example.com/create_data"data = {"key": "value"}response = requests.post(url, json=data)self.assertEqual(response.status_code, 201)

• • 这里发送一个POST请求，并根据API的预期行为，断言响应状态码应该为201（表示资源成功创建）。

• 请求头和请求体测试：

• • 请求头测试：可以在请求中设置特定的请求头，并在测试中验证服务器是否正确处理这些请求头。例如，测试服务器是否根据Accept请求头返回正确的数据类型：

def test_request_headers(self):url = "https://api.example.com/data"headers = {"Accept": "application/json"}response = requests.get(url, headers=headers)self.assertEqual(response.headers.get("Content - Type"), "application/json")

• • 请求体测试：对于包含请求体的请求（如POST、PUT），可以测试请求体的数据是否正确发送和处理。例如，测试一个POST请求发送的JSON数据是否被正确接收和处理：

def test_post_request_body(self):url = "https://api.example.com/create_data"data = {"name": "John", "age": 30}response = requests.post(url, json=data)response_data = response.json()self.assertEqual(response_data.get("name"), "John")self.assertEqual(response_data.get("age"), 30)

• 异常情况测试：

• • • 测试API在遇到异常情况（如错误的请求方法、无效的URL、服务器内部错误等）时的响应。例如，测试发送一个无效的请求方法时是否返回正确的状态码：

def test_invalid_request_method(self):url = "https://api.example.com/data"try:requests.patch(url)  # 假设该API不支持PATCH方法self.fail("Expected an error for invalid request method")except requests.exceptions.MethodNotAllowed as e:self.assertEqual(e.response.status_code, 405)

• • • 这里尝试发送一个不被允许的PATCH请求，预期会抛出MethodNotAllowed异常，并且检查异常中的响应状态码是否为405（表示方法不被允许）。如果没有抛出预期的异常，self.fail()会使测试方法失败。

4. 测试套件和测试运行器的使用

• 创建测试套件：

• • 如果有多个测试用例类，想要一起执行它们，可以创建一个测试套件。例如：

import unittest
from test_case1 import APITestCase1
from test_case2 import APITestCase2
suite = unittest.TestSuite()
suite.addTest(unittest.makeSuite(APITestCase1))
suite.addTest(unittest.makeSuite(APITestCase2))

• • 这里假设test_case1和test_case2是两个包含测试用例的模块，分别定义了APITestCase1和APITestCase2两个测试用例类。通过unittest.makeSuite()方法将每个测试用例类转换为一个测试套件，然后添加到总的测试套件suite中。

• 选择测试运行器并运行测试套件：

• • 可以使用不同的测试运行器来运行测试套件。例如，使用文本测试运行器：

runner = unittest.TextTestRunner()
runner.run(suite)

• • 文本测试运行器会在控制台输出测试结果，包括每个测试用例的执行情况（通过或失败）、详细的错误信息（如果有）等。如果想要更详细的图形化报告，可以使用第三方的测试运行器，如HTMLTestRunner（需要单独安装），并按照其文档进行配置和使用。

5. 装饰器

5.1. @pytest.mark.allure.feature

• • 定义和用途：

• • • 在使用pytest和Allure进行测试报告生成时，@pytest.mark.allure.feature是一个装饰器，用于标记测试用例所属的功能模块。它主要用于从较高层次的功能角度对测试用例进行分类，使得测试报告的组织结构更加清晰，便于阅读者快速理解测试用例所覆盖的主要功能区域。

• • 示例场景：

• • • 假设正在测试一个电商系统的接口，其中包括用户管理、商品管理和订单管理等多个功能模块。可以使用@pytest.mark.allure.feature来标记不同功能模块的测试用例。例如：

import pytest@pytest.mark.allure.feature("用户管理")
def test_user_login():# 测试用户登录接口的代码pass@pytest.mark.allure.feature("商品管理")
def test_product_search():# 测试商品搜索接口的代码pass

• • • 在上述示例中，test_user_login测试用例被标记为属于“用户管理”功能，test_product_search测试用例被标记为属于“商品管理”功能。当生成Allure测试报告时，这些测试用例将在报告中按照“用户管理”和“商品管理”等功能分类展示，方便查看者一目了然地了解测试覆盖的功能范围。

5.2. @pytest.mark.allure.story

• • 定义和用途：

• • • @pytest.mark.allure.story也是一个装饰器，它用于在功能模块（由@pytest.mark.allure.feature定义）的基础上，进一步细分测试用例所属的具体业务场景或用户故事。这个装饰器可以帮助更详细地描述测试用例的具体测试场景，使得测试报告不仅能体现功能覆盖情况，还能展示针对每个功能的不同业务场景的测试情况。

• • 示例场景：

• • • 继续以电商系统为例，在“用户管理”功能模块下，可能有不同的业务场景，如用户注册、用户登录、用户信息修改等。可以使用@pytest.mark.allure.story来区分这些不同的场景。例如：

import pytest@pytest.mark.allure.feature("用户管理")
@pytest.mark.allure.story("用户登录")
def test_user_login_success():# 测试用户登录成功的代码pass@pytest.mark.allure.feature("用户管理")
@pytest.mark.allure.story("用户登录")
def test_user_login_failure():# 测试用户登录失败的代码pass@pytest.mark.allure.feature("用户管理")
@pytest.mark.allure.story("用户注册")
def test_user_register():# 测试用户注册接口的代码pass

• • • 在这个示例中，test_user_login_success和test_user_login_failure测试用例都属于“用户管理”功能模块下的“用户登录”业务场景，test_user_register属于“用户管理”功能模块下的“用户注册”业务场景。在Allure测试报告中，这些测试用例将在“用户管理”功能分类下，进一步按照“用户登录”和“用户注册”等业务场景进行细分展示，提供了更详细的测试用例组织结构，有助于深入分析测试覆盖情况和业务场景的完整性。

6. 测试数据参数化

6.1. 测试数据参数化概述

测试数据参数化是一种在软件测试中广泛使用的技术，它允许测试人员使用多组不同的数据来执行相同的测试逻辑。通过参数化，可以提高测试用例的复用性和覆盖范围，减少重复代码的编写，并且更有效地发现软件在不同数据输入情况下的潜在问题。

6.2. 基于JSON文件实现参数化

6.2.1. JSON文件格式用于测试数据的优势

• 易于理解和编写：JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，其语法简单易懂。它基于键 - 值对的方式来组织数据，与大多数编程语言中的字典或对象结构相似。例如，下面是一个简单的JSON数据示例：

{"test_cases": [{"input": "user1","password": "password1","expected_result": "success"},{"input": "user2","password": "wrong_password","expected_result": "failure"}]
}

这个JSON数据表示了两个测试用例，每个测试用例包含用户名（input）、密码（password）和预期结果（expected_result）。

• 数据独立性和可维护性：将测试数据存储在JSON文件中使得数据与测试代码分离。这意味着当需要修改测试数据时，无需修改测试脚本的逻辑部分，只需要在JSON文件中更新数据即可。这种分离提高了测试数据的可维护性，并且方便测试人员和开发人员协作，因为他们可以独立地修改代码和数据。

6.2.2. 读取JSON文件中的测试数据

• 在Python中的实现（以pytest测试框架为例）：

import jsondef test_login():with open("test_data.json", "r") as file:data = json.load(file)for test_case in data["test_cases"]:# 在这里进行测试逻辑，例如发送登录请求并验证结果input_value = test_case["input"]password = test_case["password"]expected_result = test_case["expected_result"]# 假设这里有一个发送登录请求并返回结果的函数loginresult = login(input_value, password)assert result == expected_result

• • 首先需要导入json模块来处理JSON数据。假设上述JSON文件名为test_data.json，并且位于测试脚本的同一目录下，可以使用以下代码读取数据：
  • 在上述代码中，json.load(file)将JSON文件中的数据读取并转换为Python中的字典对象。然后通过循环遍历test_cases列表中的每个测试用例，获取其中的输入数据和预期结果，并将其用于测试逻辑中，如调用login函数发送登录请求，并使用assert语句验证实际结果是否与预期结果相符。

6.2.3. 应用场景和局限性

• 应用场景：

• • 功能测试：适用于各种功能测试场景，如用户登录、注册、搜索功能等。例如，在测试用户登录功能时，可以通过JSON文件参数化不同的用户名和密码组合，以及对应的预期登录结果，从而全面测试登录功能在多种情况下的正确性。
  • 接口测试：对于接口测试，JSON文件可以存储接口的不同输入参数和预期响应。可以方便地测试接口在接收不同请求参数时是否返回正确的响应。例如，对于一个获取用户信息的接口，可以在JSON文件中参数化不同的用户ID，以及对应的完整用户信息作为预期响应，以验证接口的准确性。

• 局限性：

• • 数据规模和复杂性：当测试数据规模非常大或者数据结构非常复杂时，JSON文件可能会变得难以管理。例如，对于包含大量嵌套结构的数据或者具有复杂关系的数据，JSON文件的维护成本会增加，并且在读取和处理数据时可能会导致性能问题。
  • 数据安全性：如果JSON文件包含敏感信息（如用户密码、密钥等），需要注意文件的安全性。虽然可以采取一些加密措施，但这会增加额外的复杂性。

6.3. 基于数据库实现参数化

6.3.1. 数据库用于存储测试数据的优势

• 数据存储的高效性和可扩展性：数据库是专门用于存储和管理大量数据的系统。它可以高效地处理数据的插入、查询、更新和删除操作。对于大规模的测试数据，数据库能够更好地组织和存储，并且可以方便地进行扩展。例如，当需要添加新的测试数据或者修改现有数据时，可以通过数据库管理系统（DBMS）提供的工具和操作来完成，而不会受到文件大小或格式的限制。
• 数据完整性和一致性保障：数据库通过各种约束（如主键、外键、唯一约束等）来确保数据的完整性和一致性。在测试数据管理中，这意味着可以确保测试数据的准确性和有效性。例如，如果测试数据中有一个表用于存储用户信息，通过设置主键约束可以防止重复的用户记录，通过外键约束可以确保用户与其他相关表（如订单表、权限表等）之间的数据关系正确。

6.3.2. 从数据库中读取测试数据

• 在Python中的实现（以pytest测试框架和MySQL数据库为例）：
• 首先需要安装和导入相应的数据库连接库，如pymysql。假设已经有一个MySQL数据库，其中包含一个名为test_data的表，表结构如下：

id	input	password	expected_result
1	user1	password1	success
2	user2	wrong_password	failure

• • 以下是读取数据库中测试数据并进行测试的代码示例：

import pymysqldef test_login():connection = pymysql.connect(host="localhost",user="root",password="password",database="test_database")try:cursor = connection.cursor()query = "SELECT input, password, expected_result FROM test_data"cursor.execute(query)results = cursor.fetchall()for row in results:input_value = row[0]password = row[1]expected_result = row[2]# 假设这里有一个发送登录请求并返回结果的函数loginresult = login(input_value, password)assert result == expected_resultexcept pymysql.Error as e:print(f"数据库操作出现错误: {e}")finally:cursor.close()connection.close()

• • 在上述代码中，首先通过pymysql.connect建立与MySQL数据库的连接，然后创建游标对象cursor。接着执行查询语句，获取test_data表中的所有测试数据。通过fetchall方法将查询结果存储在results变量中，它是一个包含所有查询行的元组列表。然后通过循环遍历每一行数据，获取其中的输入数据、密码和预期结果，并用于测试逻辑中，最后关闭游标和数据库连接。

6.3.3. 应用场景和局限性

• 应用场景：

• • 大数据量测试：当需要处理大量的测试数据时，数据库是更好的选择。例如，在性能测试或压力测试中，需要模拟大量的用户请求或者数据输入，数据库可以方便地存储和提供这些数据。
  • 数据关联测试：如果测试用例涉及多个相关的数据表或者需要验证数据之间的复杂关系，数据库可以很好地满足需求。例如，在测试一个电商系统的订单处理功能时，需要涉及用户表、商品表、订单表和库存表等多个表的数据，通过数据库可以方便地获取和管理这些相关数据，以测试整个业务流程的正确性。

• 局限性：

• • 数据库配置和依赖：使用数据库实现参数化需要配置数据库连接，包括安装数据库管理系统、设置数据库服务器、配置连接参数等。这增加了测试环境的复杂性和对外部资源的依赖。如果数据库服务器出现问题或者连接配置错误，会影响测试的正常进行。
  • 性能开销：与从简单的文件中读取数据相比，从数据库中读取数据可能会带来一定的性能开销，尤其是在频繁地进行小数据量读取或者数据库服务器负载较高的情况下。需要合理优化数据库查询操作和连接管理，以减少性能影响。