test_integration.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_formatter/test_integration.py
 
"""
Integration tests for the formatter.
 
Purpose
-------
Verify end-to-end formatter behavior with complete projects.
 
Responsibilities
----------------
- Test dry-run mode (no modifications).
- Test fix mode (applies all fixes).
- Test JSON output format.
- Test exclusion list behavior.
- Test verbose output.
 
Diagnostics
-----------
Domain: TESTS.FORMATTER
Levels:
    L2 — test lifecycle
    L3 — full project processing
    L4 — output validation and file state verification
 
Contracts
---------
- Dry-run reports changes without modifying files.
- Fix mode applies all changes and archives originals.
- JSON output is valid JSON with correct schema.
- Excluded directories are never processed.
"""
 
import pytest
import json
import sys
from pathlib import Path
from io import StringIO
 
from oct.formatter.oct_format import run_formatter
 
 
def test_formatter_processes_project(temp_project_root: Path):
    """Test that formatter can process an entire project."""
    # Create test file
    test_file = temp_project_root / "test.py"
    test_file.write_text(
        "# No header\n"
        "def hello():\n"
        "    pass\n"
        + "\n".join(["# padding"] * 20),
        encoding="utf-8"
    )
 
    # Run formatter
    run_formatter(temp_project_root, ["--dry-run"])
 
 
def test_formatter_dry_run_no_changes(temp_project_root: Path):
    """Test that dry-run mode doesn't modify files."""
    test_file = temp_project_root / "test.py"
    original_content = (
        "# No header\n"
        "def hello():\n"
        "    pass\n"
        + "\n".join(["# padding"] * 20)
    )
    test_file.write_text(original_content, encoding="utf-8")
 
    run_formatter(temp_project_root, ["--dry-run"])
 
    assert test_file.read_text(encoding="utf-8") == original_content
 
 
def test_formatter_fix_mode_applies_changes(temp_project_root: Path):
    """Test that fix mode applies changes and archives originals."""
    test_file = temp_project_root / "test.py"
    original_content = (
        "# No header\n"
        "def hello():\n"
        "    pass\n"
        + "\n".join(["# padding"] * 20)
    )
    test_file.write_text(original_content, encoding="utf-8")
 
    run_formatter(temp_project_root, ["--fix"])
 
    # Verify file was modified
    new_content = test_file.read_text(encoding="utf-8")
    assert new_content != original_content
    assert new_content.startswith("#!/usr/bin/env python3")
 
    # Verify original was archived
    archive_dir = test_file.parent / ".formatter_archive"
    assert archive_dir.exists()
    backups = list(archive_dir.glob("test.py.*"))
    assert len(backups) == 1
 
 
def test_formatter_json_output(temp_project_root: Path, capsys):
    """Test that JSON output is valid and has correct schema."""
    test_file = temp_project_root / "test.py"
    test_file.write_text(
        "# No header\n"
        "def hello():\n"
        "    pass\n"
        + "\n".join(["# padding"] * 20),
        encoding="utf-8"
    )
 
    run_formatter(temp_project_root, ["--dry-run", "--json"])
 
    captured = capsys.readouterr()
    output = captured.out
 
    # Parse JSON
    data = json.loads(output)
 
    # Verify schema
    assert "project" in data
    assert "oct_version" in data
    assert "timestamp" in data
    assert "summary" in data
    assert "files" in data
    assert "dry_run" in data
 
    # Verify summary structure
    assert "total_files" in data["summary"]
    assert "total_changed" in data["summary"]
    assert "fixes" in data["summary"]
 
 
def test_formatter_verbose_output(temp_project_root: Path, capsys):
    """Test that verbose mode shows per-file details."""
    test_file = temp_project_root / "test.py"
    test_file.write_text(
        "# No header\n"
        "def hello():\n"
        "    pass\n"
        + "\n".join(["# padding"] * 20),
        encoding="utf-8"
    )
 
    run_formatter(temp_project_root, ["--dry-run", "--verbose"])
 
    captured = capsys.readouterr()
    output = captured.out
 
    # Verify detailed output
    assert "Detailed results:" in output
    assert "test.py" in output
 
 
def test_formatter_respects_exclusions(temp_project_root: Path):
    """Test that excluded directories are not processed."""
    # Create excluded directory
    excluded_dir = temp_project_root / ".git"
    excluded_dir.mkdir()
    excluded_file = excluded_dir / "test.py"
    original_content = "# No header\n" + "\n".join(["# padding"] * 20)
    excluded_file.write_text(original_content, encoding="utf-8")
 
    run_formatter(temp_project_root, ["--fix"])
 
    # Verify excluded file was not modified
    assert excluded_file.read_text(encoding="utf-8") == original_content
 
 
def test_formatter_handles_syntax_errors(temp_project_root: Path):
    """Test that formatter handles syntax errors gracefully."""
    bad_file = temp_project_root / "bad_syntax.py"
    bad_file.write_text("def foo(:\n    pass\n" + "\n".join(["# padding"] * 20), encoding="utf-8")
 
    # Should not crash
    run_formatter(temp_project_root, ["--dry-run"])
 
 
def test_formatter_counts_files_correctly(temp_project_root: Path, capsys):
    """Test that file counts are accurate."""
    # Create multiple files
    for i in range(3):
        test_file = temp_project_root / f"test{i}.py"
        test_file.write_text(
            "# No header\n"
            + "\n".join(["# padding"] * 20),
            encoding="utf-8"
        )
 
    run_formatter(temp_project_root, ["--dry-run"])
 
    captured = capsys.readouterr()
    output = captured.out
 
    # Verify counts
    assert "Files processed:      3" in output or "Files processed: 3" in output