无需编码的魔法：用YAML配置文件实现接口自动化测试

引言

在现代软件开发过程中，接口测试的需求越来越重要。随着微服务架构的普及，Web API的数量激增，这意味着我们需要一种高效、灵活的方法来验证API的正确性和稳定性。手动进行接口测试不仅耗时且容易出错，因此，自动化测试成为了当前开发流程中的一项关键实践。

关键字驱动测试（Keyword Driven Testing）是一种将测试逻辑与测试步骤分离的方法，通过定义一些关键字（如click、input、assert等），使得测试人员可以更加容易地编写和维护测试用例。结合Python的Requests库和pytest框架，我们可以构建一个高效、易于扩展的接口自动化测试框架。

在本文中，我们将详细介绍如何实现一个免编码的接口自动化框架，用户只需要通过编写YAML配置文件来定义测试用例，轻松实现自动化测试。

框架设计概述

1.1 设计理念
我们的接口自动化框架将实现以下设计理念：

免编码：测试人员可以直接通过YAML文件编写测试用例，无需深入编写代码。
灵活性：通过关键字驱动的方式，使得测试用例更易理解和修改。
可维护性：通过模块化设计和配置管理，降低维护成本，提高测试效率。

1. 框架结构

在项目结构中引入 YAML 文件来编写和维护测试用例。我们将使用 pyyaml 库来解析 YAML 文件。

api_auto_framework/
│
├── keywords.py       # 关键字定义与实现
├── executor.py       # 测试执行器
├── test_runner.py    # pytest 集成入口
├── test_cases.yaml   # 测试用例，使用 YAML 编写
├── requirements.txt  # 依赖库
└── README.md         # 框架说明文档

2. 新增依赖：pyyaml

在 requirements.txt 中添加 pyyaml 依赖：

requests==2.25.1
pytest==6.2.2
pyyaml==5.4.1

通过 pip 安装：

pip install -r requirements.txt

3. 使用 YAML 编写测试用例

将测试用例从 JSON 格式切换为 YAML 格式，YAML 更加直观且结构清晰。

例如，下面是一个示例 YAML 测试用例文件 test_cases.yaml：

- case_id: TC001
  description: 验证 GET 请求的状态码和响应数据
  steps:
    - keyword: get
      params:
        url: "https://jsonplaceholder.typicode.com/posts/1"
    - keyword: assert_status_code
      params:
        expected_code: 200
    - keyword: assert_json_value
      params:
        key: id
        expected_value: 1

- case_id: TC002
  description: 验证 POST 请求成功创建资源
  steps:
    - keyword: post
      params:
        url: "https://jsonplaceholder.typicode.com/posts"
        json:
          title: "foo"
          body: "bar"
          userId: 1
    - keyword: assert_status_code
      params:
        expected_code: 201
    - keyword: assert_json_value
      params:
        key: title
        expected_value: "foo"

4. 更新测试用例执行器 (executor.py)

为了能够读取 YAML 文件并执行其中的测试用例，我们需要对 executor.py 进行修改，使用 pyyaml 来解析 YAML 文件。

import yaml
from keywords import APIKeywords

class TestExecutor:
    def __init__(self, case_file):
        self.case_file = case_file
        self.keywords = APIKeywords()

    def load_cases(self):
        """加载测试用例（YAML 格式）"""
        with open(self.case_file, 'r', encoding='utf-8') as f:
            test_cases = yaml.safe_load(f)
        return test_cases

    def execute(self):
        """执行测试用例"""
        test_cases = self.load_cases()
        for case in test_cases:
            print(f"Executing test case: {case['case_id']} - {case['description']}")
            response = None
            for step in case['steps']:
                keyword = step['keyword']
                params = step['params']
                # 动态调用关键字
                if 'response' in params:
                    response = getattr(self.keywords, keyword)(response, **params)
                else:
                    response = getattr(self.keywords, keyword)(**params)
            print(f"Test case {case['case_id']} completed.\n")

5. 关键字 keywords.py 进一步优化

关键字部分的代码保持不变。这里再贴一次 keywords.py 的主要功能代码，以便参考：

import requests

class APIKeywords:
    def __init__(self):
        self.session = requests.Session()

    def get(self, url, headers=None, params=None):
        """发送GET请求"""
        response = self.session.get(url, headers=headers, params=params)
        return response

    def post(self, url, headers=None, data=None, json=None):
        """发送POST请求"""
        response = self.session.post(url, headers=headers, data=data, json=json)
        return response

    def put(self, url, headers=None, data=None, json=None):
        """发送PUT请求"""
        response = self.session.put(url, headers=headers, data=data, json=json)
        return response

    def delete(self, url, headers=None, params=None):
        """发送DELETE请求"""
        response = self.session.delete(url, headers=headers, params=params)
        return response

    def assert_status_code(self, response, expected_code):
        """断言响应状态码"""
        assert response.status_code == expected_code, f"Expected {expected_code}, got {response.status_code}"

    def assert_json_value(self, response, key, expected_value):
        """断言响应JSON中的特定字段"""
        json_data = response.json()
        assert key in json_data, f"{key} not found in response"
        assert json_data[key] == expected_value, f"Expected {expected_value}, got {json_data[key]}"

6. test_runner.py：pytest 集成

保持 pytest 集成部分不变，可以继续使用 pytest 来执行测试。

import pytest
from executor import TestExecutor

@pytest.fixture(scope="module")
def test_executor():
    """初始化测试执行器"""
    return TestExecutor("test_cases.yaml")

def test_run_cases(test_executor):
    """执行所有测试用例"""
    test_executor.execute()

7. 使用方式

1. 编写测试用例：在 test_cases.yaml 文件中添加接口自动化测试用例，使用 YAML 格式定义测试步骤。
2. 运行测试：通过 pytest 运行接口测试，执行所有用例。

pytest test_runner.py

8. 测试用例维护

使用 YAML 编写测试用例具有以下优势：

• 可读性高：YAML 的语法简洁，结构清晰，适合手动编辑和维护。
• 支持复杂数据结构：YAML 能够轻松表示列表、字典等复杂数据结构，适合配置文件和测试数据。
• 易于扩展：可以在 YAML 文件中灵活添加新字段和新测试步骤，适合大型项目。

9. 问题定位与优化

框架在设计和执行过程中，可能会遇到一些常见问题以及优化方向：

1. 关键字扩展：

   • 新增关键字：在框架基础上，可以增加更多 HTTP 方法的支持（如 PATCH、HEAD 请求），以及更多断言类型（如响应时间、特定字段存在性等）。
   • 通用断言机制：引入更加灵活的断言机制，例如支持自定义的断言函数，或者通过 YAML 定义更复杂的断言逻辑。

2. 参数化测试：

   • 可以通过 pytest 的参数化功能，将测试用例参数化，减少重复的代码和数据配置。例如，对于同一个接口的不同数据输入，可以在一个用例中完成参数化执行。

3. 测试报告集成：

   • 使用 pytest-html 或 pytest-allure 生成更加丰富的测试报告，方便查看每个测试步骤的执行详情和测试结果。

   pip install pytest-html
   pytest --html=report.html
   

4. 环境管理：

   • 可以通过 YAML 或其他配置文件动态管理不同的测试环境（如 dev、staging、prod），在运行时根据不同的环境加载相应的接口地址、认证信息等。

5. 日志管理：

   • 引入日志功能，对每个测试步骤进行详细记录，便于后续排查问题。例如，可以在关键字执行时记录请求 URL、请求参数、响应结果、断言结果等。

10. 总结

通过结合 requests、pytest 和 YAML，我们可以构建一个基于关键字驱动的接口自动化测试框架。YAML 提供了更加直观的测试用例编写方式，框架则可以通过简单的扩展支持更多的 HTTP 请求方法和断言类型。