Using Pytest for Enterprise API Test Case Management

In enterprise development environments, interface automation testing is a key step for ensuring software quality, and Pytest provides a powerful framework to support it.

1. Test Case Writing Standards

(a) Follow a unified naming convention: test files start with test_ , classes with Test , and methods with test_ . Example:

# 文件名：test_user_api.py

class TestUserApi:

    def test_get_user_info(self):
        # 测试代码
        pass

    def test_update_user_profile(self):
        # 测试代码
        pass

(b) Use clear comments and docstrings to describe purpose and logic. Example:

class TestUserApi:
    """
    测试用户相关接口
    """
    def test_get_user_info(self):
        """
        测试获取用户信息接口
        """
        # 测试代码
        pass

    def test_update_user_profile(self):
        """
        测试更新用户资料接口
        """
        # 测试代码
        pass

(c) Parameterize test cases to avoid duplication. Example:

import pytest

@pytest.mark.parametrize("user_id, expected_status", [
    (1, 200),
    (2, 404),
    (3, 500)
])

def test_get_user_info(user_id, expected_status):
    """
    测试获取用户信息接口
    """
    # 测试代码
    pass

2. Test Case Organization Structure

(a) Divide by functional modules, e.g., user and order directories:

project/

├── tests/

│   ├── user/
│   │   ├── test_user_api.py
│   │   └── test_user_profile.py
│   ├── order/
│   │   ├── test_order_api.py
│   │   └── test_order_status.py
│   └── common/
│       ├── test_common_functions.py

(b) Use fixtures to manage test data and environment setup/teardown:

import pytest

@pytest.fixture

def user_data():
    """
    提供用户测试数据
    """
    return {
        "username": "test_user",
        "password": "test_password"
    }

def test_user_login(user_data):
    """
    测试用户登录接口
    """
    # 使用 user_data 进行测试
    pass

3. Test Execution Process

(a) Choose execution method – command line or CI/CD integration. Example Jenkins command:

pytest tests/ --alluredir=allure-results

(b) Use markers to filter tests, e.g., @pytest.mark.smoke and run with:

pytest -m smoke

(c) Run tests in parallel with pytest-xdist :

pip install pytest-xdist
pytest -n 4

4. Report Generation and Analysis

(a) Generate Allure reports by installing pytest-allure-adaptor and running:

pip install pytest-allure-adaptor
pytest --alluredir=allure-results
allure generate allure-results -o allure-report

(b) Customize report content with Allure decorators, e.g., steps and links:

import allure

@allure.step("执行登录操作")
def login(username, password):
    # 登录代码
    pass

@allure.link("https://example.com", name="测试链接")
def test_user_login():
    """
    测试用户登录接口
    """
    login("test_user", "test_password")

(c) Analyze the report to locate failures quickly, leveraging statistics and detailed failure reasons.

5. Conclusion

In enterprise projects, API automation testing is essential for software quality. Using Pytest for test case management enables efficient writing, organization, execution, and reporting. Following consistent naming, modular structure, flexible execution, and detailed reporting significantly improves testing efficiency and quality.