conftest.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_formatter/conftest.py
 
"""
Shared fixtures for formatter tests.
 
Purpose
-------
Provide reusable test fixtures for formatter unit and integration tests.
 
Responsibilities
----------------
- Create temporary Option C projects with required directory structure.
- Provide FormatterContext for testing.
- Copy test fixture files into temporary project.
- Clean up after tests.
 
Diagnostics
-----------
Domain: TESTS.FORMATTER
Levels:
    L2 — test lifecycle and setup
    L3 — fixture creation and teardown
    L4 — file operations and structure verification
 
Contracts
---------
- temp_project_root fixture provides a clean, isolated test project.
- All fixture files are available in the temporary project.
- FormatterContext is properly configured for the temporary project.
"""
 
import pytest
from pathlib import Path
from dataclasses import dataclass
 
from oct.formatter.oct_format import FormatterContext
 
 
@pytest.fixture
def temp_project_root(tmp_path: Path) -> Path:
    """
    Create a temporary Option C project root with required directory structure.
 
    Returns the project root path. All required directories are created.
    """
    root = tmp_path / "test-project"
    root.mkdir()
 
    # Create required directories
    (root / "docs").mkdir()
    (root / "tests").mkdir()
    (root / "oc_diagnostics").mkdir()
    (root / "logs").mkdir()
 
    return root
 
 
@pytest.fixture
def formatter_ctx(temp_project_root: Path) -> FormatterContext:
    """
    Return a FormatterContext configured for the temporary test project.
 
    Context is in dry-run mode (not fix mode) by default.
    """
    return FormatterContext(
        project_root=temp_project_root,
        project_name=temp_project_root.name,
        diagnostics_dir=temp_project_root / "oc_diagnostics",
        tests_dir=temp_project_root / "tests",
        docs_dir=temp_project_root / "docs",
        fix_mode=False,
        dry_run_mode=True,
        json_mode=False,
        verbose=False,
    )
 
 
@pytest.fixture
def formatter_ctx_fix(temp_project_root: Path) -> FormatterContext:
    """
    Return a FormatterContext in fix mode for actual file modifications.
    """
    return FormatterContext(
        project_root=temp_project_root,
        project_name=temp_project_root.name,
        diagnostics_dir=temp_project_root / "oc_diagnostics",
        tests_dir=temp_project_root / "tests",
        docs_dir=temp_project_root / "docs",
        fix_mode=True,
        dry_run_mode=False,
        json_mode=False,
        verbose=False,
    )