pytest-datadriver 0.1.0__tar.gz

pytest_datadriver-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: pytest-datadriver
+Version: 0.1.0
+Summary: A pytest plugin for data-driven testing with YAML/JSON external data files
+Author: CIB Test Team
+License-Expression: MIT
+Keywords: pytest,data-driven,yaml,json,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pytest>=7.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+
+# pytest-datadriver
+
+一个 pytest 插件，支持通过 YAML/JSON 外部数据文件实现数据驱动测试。
+
+## 特性
+
+- **多格式支持**：YAML 和 JSON 外部数据文件，可扩展架构
+- **零侵入**：无需修改现有测试代码，通过 CLI 参数可选激活
+- **参数自动提取**：基于 AST 静态分析，从现有测试代码提取 parametrize 参数并导出
+- **双模式覆盖**：智能覆盖（按 case_no 匹配）和完全替换模式
+- **两种数据布局**：case-first 和 function-first
+- **fixture 支持**：自动识别 fixture 参数与 parametrize 参数
+
+## 安装
+
+```bash
+pip install pytest-datadriver
+```
+
+或从源码安装：
+
+```bash
+git clone <repo-url>
+cd cib-pytest-datadriver
+pip install -e .
+```
+
+## 快速开始
+
+### 1. 在测试代码中添加标记
+
+```python
+import pytest
+
+@pytest.mark.caseNo("TC-001")
+@pytest.mark.caseName("加法测试")
+@pytest.mark.parametrize("a,b,expected", [
+    (1, 2, 3),
+    (5, 10, 15),
+])
+def test_addition(a, b, expected):
+    assert a + b == expected
+```
+
+### 2. 提取参数到数据文件
+
+```bash
+pytest --data-extract --data-output TestData/data.yaml --test-path tests/
+```
+
+### 3. 使用数据文件运行测试
+
+```bash
+# 智能覆盖（默认）：按 case_no 匹配覆盖参数
+pytest tests/ --data-file TestData/data.yaml --data-mode smart
+
+# 完全替换：只执行文件中的用例
+pytest tests/ --data-file TestData/data.yaml --data-mode replace
+```
+
+## CLI 参数
+
+| 参数 | 说明 | 可选值 | 默认值 |
+|------|------|--------|--------|
+| `--data-file` | 数据文件路径 | - | 自动查找 TestData/data.yaml |
+| `--data-mode` | 覆盖模式 | smart, replace | smart |
+| `--data-layout` | 数据布局 | case, func | case |
+| `--data-format` | 数据格式 | yaml, json, auto | auto |
+| `--data-extract` | 触发提取模式 | - | - |
+| `--data-output` | 提取输出路径 | - | TestData/data.yaml |
+| `--data-export-format` | 导出详情级别 | simple, full | simple |
+| `--data-export-filter` | 导出过滤 | all, case-only | all |
+| `--data-module-match` | 模块匹配策略 | fullpath, filename | fullpath |
+| `--test-path` | 提取扫描目录 | - | tests/ |
+
+## 数据文件格式
+
+### case-first 布局（默认）
+
+```yaml
+TC-001:
+  case_name: "加法测试"
+  module: "tests/test_math.py"
+  function: "test_addition"
+  params:
+    a: 1
+    b: 2
+    expected: 3
+```
+
+### function-first 布局
+
+```yaml
+"tests/test_math.py::test_addition":
+  - case_no: "TC-001"
+    case_name: "加法测试"
+    params:
+      a: 1
+      b: 2
+      expected: 3
+```
+
+## 依赖
+
+- Python >= 3.9
+- pytest >= 7.0
+- pyyaml >= 6.0
+
+## 打包与发布
+
+### 本地打包
+
+```bash
+# 安装构建工具
+pip install build twine
+
+# 构建分发包（sdist + wheel）
+python -m build
+
+# 构建产物位于 dist/ 目录：
+# dist/pytest_datadriver-0.1.0.tar.gz
+# dist/pytest_datadriver-0.1.0-py3-none-any.whl
+```
+
+### 上传到 PyPI
+
+```bash
+# 上传到 PyPI（需先配置 ~/.pypirc 或使用 Token）
+twine upload dist/*
+
+# 上传到 Test PyPI（预发布验证）
+twine upload --repository testpypi dist/*
+```
+
+### 上传到私有制品库
+
+```bash
+# 上传到私有 PyPI 仓库（需在 ~/.pypirc 中配置仓库地址）
+twine upload --repository <your-repo-name> dist/*
+
+# 示例：上传到腾讯云软件源
+twine upload --repository-url https://mirrors.tencent.com/repository/pypi/tencent_pypi/simple dist/*
+```
+
+### 从制品库安装
+
+```bash
+# 从 PyPI 安装
+pip install pytest-datadriver
+
+# 从私有制品库安装
+pip install pytest-datadriver -i https://mirrors.tencent.com/repository/pypi/tencent_pypi/simple --trusted-host mirrors.tencent.com
+```
+
+### ~/.pypirc 配置示例
+
+```ini
+[distutils]
+index-servers =
+    pypi
+    tencent
+
+[pypi]
+username = __token__
+password = pypi-xxxxxxxxxxxx
+
+[tencent]
+repository = https://mirrors.tencent.com/repository/pypi/tencent_pypi/simple
+username = <your-username>
+password = <your-password>
+```
+
+## 许可证
+
+MIT

pytest_datadriver-0.1.0/README.md

@@ -0,0 +1,175 @@
+# pytest-datadriver
+
+一个 pytest 插件，支持通过 YAML/JSON 外部数据文件实现数据驱动测试。
+
+## 特性
+
+- **多格式支持**：YAML 和 JSON 外部数据文件，可扩展架构
+- **零侵入**：无需修改现有测试代码，通过 CLI 参数可选激活
+- **参数自动提取**：基于 AST 静态分析，从现有测试代码提取 parametrize 参数并导出
+- **双模式覆盖**：智能覆盖（按 case_no 匹配）和完全替换模式
+- **两种数据布局**：case-first 和 function-first
+- **fixture 支持**：自动识别 fixture 参数与 parametrize 参数
+
+## 安装
+
+```bash
+pip install pytest-datadriver
+```
+
+或从源码安装：
+
+```bash
+git clone <repo-url>
+cd cib-pytest-datadriver
+pip install -e .
+```
+
+## 快速开始
+
+### 1. 在测试代码中添加标记
+
+```python
+import pytest
+
+@pytest.mark.caseNo("TC-001")
+@pytest.mark.caseName("加法测试")
+@pytest.mark.parametrize("a,b,expected", [
+    (1, 2, 3),
+    (5, 10, 15),
+])
+def test_addition(a, b, expected):
+    assert a + b == expected
+```
+
+### 2. 提取参数到数据文件
+
+```bash
+pytest --data-extract --data-output TestData/data.yaml --test-path tests/
+```
+
+### 3. 使用数据文件运行测试
+
+```bash
+# 智能覆盖（默认）：按 case_no 匹配覆盖参数
+pytest tests/ --data-file TestData/data.yaml --data-mode smart
+
+# 完全替换：只执行文件中的用例
+pytest tests/ --data-file TestData/data.yaml --data-mode replace
+```
+
+## CLI 参数
+
+| 参数 | 说明 | 可选值 | 默认值 |
+|------|------|--------|--------|
+| `--data-file` | 数据文件路径 | - | 自动查找 TestData/data.yaml |
+| `--data-mode` | 覆盖模式 | smart, replace | smart |
+| `--data-layout` | 数据布局 | case, func | case |
+| `--data-format` | 数据格式 | yaml, json, auto | auto |
+| `--data-extract` | 触发提取模式 | - | - |
+| `--data-output` | 提取输出路径 | - | TestData/data.yaml |
+| `--data-export-format` | 导出详情级别 | simple, full | simple |
+| `--data-export-filter` | 导出过滤 | all, case-only | all |
+| `--data-module-match` | 模块匹配策略 | fullpath, filename | fullpath |
+| `--test-path` | 提取扫描目录 | - | tests/ |
+
+## 数据文件格式
+
+### case-first 布局（默认）
+
+```yaml
+TC-001:
+  case_name: "加法测试"
+  module: "tests/test_math.py"
+  function: "test_addition"
+  params:
+    a: 1
+    b: 2
+    expected: 3
+```
+
+### function-first 布局
+
+```yaml
+"tests/test_math.py::test_addition":
+  - case_no: "TC-001"
+    case_name: "加法测试"
+    params:
+      a: 1
+      b: 2
+      expected: 3
+```
+
+## 依赖
+
+- Python >= 3.9
+- pytest >= 7.0
+- pyyaml >= 6.0
+
+## 打包与发布
+
+### 本地打包
+
+```bash
+# 安装构建工具
+pip install build twine
+
+# 构建分发包（sdist + wheel）
+python -m build
+
+# 构建产物位于 dist/ 目录：
+# dist/pytest_datadriver-0.1.0.tar.gz
+# dist/pytest_datadriver-0.1.0-py3-none-any.whl
+```
+
+### 上传到 PyPI
+
+```bash
+# 上传到 PyPI（需先配置 ~/.pypirc 或使用 Token）
+twine upload dist/*
+
+# 上传到 Test PyPI（预发布验证）
+twine upload --repository testpypi dist/*
+```
+
+### 上传到私有制品库
+
+```bash
+# 上传到私有 PyPI 仓库（需在 ~/.pypirc 中配置仓库地址）
+twine upload --repository <your-repo-name> dist/*
+
+# 示例：上传到腾讯云软件源
+twine upload --repository-url https://mirrors.tencent.com/repository/pypi/tencent_pypi/simple dist/*
+```
+
+### 从制品库安装
+
+```bash
+# 从 PyPI 安装
+pip install pytest-datadriver
+
+# 从私有制品库安装
+pip install pytest-datadriver -i https://mirrors.tencent.com/repository/pypi/tencent_pypi/simple --trusted-host mirrors.tencent.com
+```
+
+### ~/.pypirc 配置示例
+
+```ini
+[distutils]
+index-servers =
+    pypi
+    tencent
+
+[pypi]
+username = __token__
+password = pypi-xxxxxxxxxxxx
+
+[tencent]
+repository = https://mirrors.tencent.com/repository/pypi/tencent_pypi/simple
+username = <your-username>
+password = <your-password>
+```
+
+## 许可证
+
+MIT

pytest_datadriver-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytest-datadriver"
+version = "0.1.0"
+description = "A pytest plugin for data-driven testing with YAML/JSON external data files"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+    { name = "CIB Test Team" }
+]
+keywords = ["pytest", "data-driven", "yaml", "json", "testing"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Testing",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "pytest>=7.0",
+    "pyyaml>=6.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+]
+
+[project.entry-points.pytest11]
+datadriver = "pytest_datadriver.plugin"
+
+[tool.setuptools.packages.find]
+include = ["pytest_datadriver*"]

pytest_datadriver-0.1.0/pytest_datadriver/__init__.py

@@ -0,0 +1,28 @@
+"""pytest-datadriver: A pytest plugin for data-driven testing with YAML/JSON external data files."""
+
+__version__ = "0.1.0"
+
+from pytest_datadriver.exceptions import (
+    DataDriverError,
+    DataFileNotFoundError,
+    DataFileFormatError,
+    DuplicateModuleError,
+    CaseNotFoundError,
+    ExtractionError,
+)
+from pytest_datadriver.models import CaseEntry, ParamSet, ExportContext, LayoutMode, OverrideMode
+
+__all__ = [
+    "__version__",
+    "DataDriverError",
+    "DataFileNotFoundError",
+    "DataFileFormatError",
+    "DuplicateModuleError",
+    "CaseNotFoundError",
+    "ExtractionError",
+    "CaseEntry",
+    "ParamSet",
+    "ExportContext",
+    "LayoutMode",
+    "OverrideMode",
+]

pytest_datadriver-0.1.0/pytest_datadriver/constants.py

@@ -0,0 +1,61 @@
+"""Constants and default values for pytest-datadriver."""
+
+from pytest_datadriver.models import (
+    DataFormat,
+    ExportFilter,
+    ExportFormat,
+    LayoutMode,
+    ModuleMatchMode,
+    OverrideMode,
+)
+
+# Default data file search paths (relative to project root)
+DEFAULT_DATA_PATHS = [
+    "TestData/data.yaml",
+    "TestData/data.yml",
+    "TestData/data.json",
+]
+
+# Default test directory for extraction
+DEFAULT_TEST_PATH = "tests/"
+
+# Default output path for extraction
+DEFAULT_OUTPUT_PATH = "TestData/data.yaml"
+
+# CLI option defaults
+DEFAULT_LAYOUT = LayoutMode.CASE
+DEFAULT_MODE = OverrideMode.SMART
+DEFAULT_DATA_FORMAT = DataFormat.AUTO
+DEFAULT_EXPORT_FORMAT = ExportFormat.SIMPLE
+DEFAULT_EXPORT_FILTER = ExportFilter.ALL
+DEFAULT_MODULE_MATCH = ModuleMatchMode.FULLPATH
+
+# Mark names used by the library
+MARK_CASE_NO = "caseNo"
+MARK_CASE_NAME = "caseName"
+
+# pytest hook marker for skipping items in replace mode
+SKIP_MARKER_NAME = "_skip_by_datadriver"
+
+# Case number prefix for auto-generated IDs
+AUTO_CASE_NO_PREFIX = "AUTO-"
+
+# CLI option names
+OPTION_DATA_FILE = "--data-file"
+OPTION_DATA_MODE = "--data-mode"
+OPTION_DATA_LAYOUT = "--data-layout"
+OPTION_DATA_FORMAT = "--data-format"
+OPTION_DATA_EXTRACT = "--data-extract"
+OPTION_DATA_OUTPUT = "--data-output"
+OPTION_DATA_EXPORT_FORMAT = "--data-export-format"
+OPTION_DATA_EXPORT_FILTER = "--data-export-filter"
+OPTION_DATA_MODULE_MATCH = "--data-module-match"
+OPTION_TEST_PATH = "--test-path"
+
+# Valid choices for CLI options
+VALID_DATA_MODES = [m.value for m in OverrideMode]
+VALID_LAYOUTS = [m.value for m in LayoutMode]
+VALID_FORMATS = [m.value for m in DataFormat]
+VALID_EXPORT_FORMATS = [m.value for m in ExportFormat]
+VALID_EXPORT_FILTERS = [m.value for m in ExportFilter]
+VALID_MODULE_MATCHES = [m.value for m in ModuleMatchMode]

pytest_datadriver-0.1.0/pytest_datadriver/exceptions.py

@@ -0,0 +1,52 @@
+"""Custom exceptions for pytest-datadriver."""
+
+
+class DataDriverError(Exception):
+    """Base exception for all pytest-datadriver errors."""
+    pass
+
+
+class DataFileNotFoundError(DataDriverError):
+    """Raised when the specified data file does not exist."""
+
+    def __init__(self, file_path: str):
+        self.file_path = file_path
+        super().__init__(f"Data file not found: {file_path}")
+
+
+class DataFileFormatError(DataDriverError):
+    """Raised when the data file has invalid YAML/JSON syntax."""
+
+    def __init__(self, file_path: str, detail: str):
+        self.file_path = file_path
+        self.detail = detail
+        super().__init__(f"Data file format error in '{file_path}': {detail}")
+
+
+class DuplicateModuleError(DataDriverError):
+    """Raised when duplicate module filenames are detected in function-first layout with filename matching."""
+
+    def __init__(self, filename: str, paths: list):
+        self.filename = filename
+        self.paths = paths
+        super().__init__(
+            f"Duplicate module filename '{filename}' found in multiple directories: {paths}. "
+            f"Use --data-module-match fullpath to resolve."
+        )
+
+
+class CaseNotFoundError(DataDriverError):
+    """Raised when a case_no in the data file has no matching test function in code."""
+
+    def __init__(self, case_no: str):
+        self.case_no = case_no
+        super().__init__(f"Case '{case_no}' not found in any collected test item")
+
+
+class ExtractionError(DataDriverError):
+    """Raised when AST extraction encounters an error."""
+
+    def __init__(self, file_path: str, detail: str):
+        self.file_path = file_path
+        self.detail = detail
+        super().__init__(f"Extraction error in '{file_path}': {detail}")

pytest_datadriver-0.1.0/pytest_datadriver/exporters/__init__.py

@@ -0,0 +1,60 @@
+"""Data exporter factory with auto-detection of file format."""
+
+from typing import List
+
+from pytest_datadriver.exporters.base import DataExporter
+from pytest_datadriver.exporters.yaml_exporter import YamlExporter
+from pytest_datadriver.exporters.json_exporter import JsonExporter
+from pytest_datadriver.models import CaseEntry, DataFormat, LayoutMode
+
+
+def create_exporter(fmt: DataFormat = DataFormat.AUTO) -> DataExporter:
+    """Create a data exporter for the specified format.
+
+    Args:
+        fmt: Output format (AUTO uses extension detection, YAML or JSON).
+
+    Returns:
+        A DataExporter instance.
+
+    Raises:
+        ValueError: If the format is not supported.
+    """
+    if fmt == DataFormat.YAML:
+        return YamlExporter()
+    elif fmt == DataFormat.JSON:
+        return JsonExporter()
+    elif fmt == DataFormat.AUTO:
+        # Default to YAML
+        return YamlExporter()
+    else:
+        raise ValueError(f"Unsupported export format: {fmt}")
+
+
+def export_cases(
+    cases: List[CaseEntry],
+    output_path: str,
+    layout: LayoutMode = LayoutMode.CASE,
+    fmt: DataFormat = DataFormat.AUTO,
+) -> None:
+    """Export cases to a data file, auto-detecting format from extension if AUTO.
+
+    Args:
+        cases: List of CaseEntry objects to export.
+        output_path: Path to write the output file.
+        layout: Layout mode (case-first or function-first).
+        fmt: Output format.
+    """
+    if fmt == DataFormat.AUTO:
+        lower = output_path.lower()
+        if lower.endswith(".json"):
+            exporter = JsonExporter()
+        else:
+            exporter = YamlExporter()
+    else:
+        exporter = create_exporter(fmt)
+
+    exporter.export(cases, output_path, layout)
+
+
+__all__ = ["DataExporter", "YamlExporter", "JsonExporter", "create_exporter", "export_cases"]

pytest_datadriver-0.1.0/pytest_datadriver/exporters/base.py

@@ -0,0 +1,63 @@
+"""Abstract base class for data exporters."""
+
+from abc import ABC, abstractmethod
+from typing import List
+
+from pytest_datadriver.models import CaseEntry, LayoutMode
+
+
+class DataExporter(ABC):
+    """Abstract base class for exporting CaseEntry objects to data files."""
+
+    @abstractmethod
+    def export(self, cases: List[CaseEntry], output_path: str, layout: LayoutMode = LayoutMode.CASE) -> None:
+        """
+        Export a list of CaseEntry objects to a data file.
+
+        Args:
+            cases: List of CaseEntry objects to export.
+            output_path: Path to write the output file.
+            layout: Layout mode (case-first or function-first).
+        """
+        ...
+
+    def _to_case_first(self, cases: List[CaseEntry]) -> dict:
+        """Convert cases to case-first layout dict."""
+        result = {}
+        for case in cases:
+            entry = {
+                "case_name": case.case_name,
+                "module": case.module,
+                "function": case.function,
+                "params": case.params,
+            }
+            # Add optional fields if present
+            if case.fixtures:
+                entry["fixtures"] = case.fixtures
+            if case.marks:
+                entry["marks"] = case.marks
+            if case.parametrize_meta:
+                entry["parametrize_meta"] = case.parametrize_meta
+            if case.source_location:
+                entry["source_location"] = case.source_location
+            result[case.case_no] = entry
+        return result
+
+    def _to_function_first(self, cases: List[CaseEntry]) -> dict:
+        """Convert cases to function-first layout dict."""
+        result = {}
+        for case in cases:
+            key = f"{case.module}::{case.function}"
+            if key not in result:
+                result[key] = []
+            entry = {
+                "case_no": case.case_no,
+                "case_name": case.case_name,
+                "params": case.params,
+            }
+            if case.fixtures:
+                entry["fixtures"] = case.fixtures
+            if case.marks:
+                entry["marks"] = case.marks
+            result[key].append(entry)
+        return result

pytest_datadriver-0.1.0/pytest_datadriver/exporters/json_exporter.py

@@ -0,0 +1,24 @@
+"""JSON data exporter."""
+
+import json
+import os
+from typing import List
+
+from pytest_datadriver.exporters.base import DataExporter
+from pytest_datadriver.models import CaseEntry, LayoutMode
+
+
+class JsonExporter(DataExporter):
+    """Export test case data to JSON files."""
+
+    def export(self, cases: List[CaseEntry], output_path: str, layout: LayoutMode = LayoutMode.CASE) -> None:
+        """Export cases to a JSON file."""
+        if layout == LayoutMode.CASE:
+            data = self._to_case_first(cases)
+        else:
+            data = self._to_function_first(cases)
+
+        os.makedirs(os.path.dirname(output_path) or ".", exist_ok=True)
+
+        with open(output_path, "w", encoding="utf-8") as f:
+            json.dump(data, f, ensure_ascii=False, indent=2)