test_option_c_migration.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_migrate/test_option_c_migration.py
 
"""
Purpose
-------
FS-539 regression coverage — :func:`oct.migrate.oct_migrate.run_migrate_option_c`
relocates legacy artefacts into ``.option_c/`` and writes ``oc_status.json``.
 
Responsibilities
----------------
- dry-run is side-effect-free.
- Each legacy artefact is copied (not moved) to ``.option_c/``.
- A ``.bk`` backup is created when the destination exists and differs.
- ``oc_status.json`` records ``migrated_from`` and pillar enablement.
- An idempotent second run skips already-migrated artefacts.
- An unmigrated project with no legacy artefacts produces "nothing to
  migrate".
 
Diagnostics
-----------
Domain: MIGRATE-TESTS
    Levels:
        L2 — test lifecycle
        L3 — assertion details
        L4 — deep tracing
 
Contracts
---------
- All migration operations use ``tmp_path`` as the project root; no
  real project files are touched.
"""
 
from __future__ import annotations
 
import json
from pathlib import Path
 
import pytest
 
from oct.migrate.oct_migrate import run_migrate_option_c
 
 
def _seed_legacy_project(root: Path) -> None:
    """Create a minimal legacy Option C project layout."""
    (root / ".octrc.json").write_text(
        json.dumps({"linter": {"profile": "compact"}}), encoding="utf-8",
    )
    (root / "oc_diagnostics").mkdir()
    (root / "oc_diagnostics" / "debug_config.json").write_text(
        json.dumps({"_schema_version": "2.0", "DEBUG_LEVELS": {}}),
        encoding="utf-8",
    )
    (root / "logs").mkdir()
    (root / "logs" / "audit.jsonl").write_text("line1\n", encoding="utf-8")
    (root / "docs").mkdir()
    (root / "tests").mkdir()
 
 
class TestDryRun:
    def test_dry_run_creates_nothing(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        result = run_migrate_option_c(tmp_path, dry_run=True)
 
        assert not (tmp_path / ".option_c").exists()
        assert any("[DRY RUN]" in m for m in result.messages)
 
    def test_dry_run_lists_all_artefacts(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        result = run_migrate_option_c(tmp_path, dry_run=True)
 
        msgs = "\n".join(result.messages)
        assert "octrc" in msgs
        assert "debug_config" in msgs
        assert "logs" in msgs
 
 
class TestCopySemantics:
    def test_copies_all_artefacts(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        result = run_migrate_option_c(tmp_path)
 
        oc = tmp_path / ".option_c"
        assert (oc / "octrc.json").is_file()
        assert (oc / "debug_config.json").is_file()
        assert (oc / "logs").is_dir()
        assert (oc / "logs" / "audit.jsonl").is_file()
        assert len(result.copied) == 3
 
    def test_legacy_files_preserved(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        run_migrate_option_c(tmp_path)
 
        assert (tmp_path / ".octrc.json").is_file()
        assert (tmp_path / "oc_diagnostics" / "debug_config.json").is_file()
        assert (tmp_path / "logs" / "audit.jsonl").is_file()
 
    def test_cache_dir_created(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        run_migrate_option_c(tmp_path)
 
        assert (tmp_path / ".option_c" / "cache").is_dir()
 
 
class TestBackup:
    def test_backup_on_conflict(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        oc = tmp_path / ".option_c"
        oc.mkdir()
        (oc / "octrc.json").write_text('{"old": true}', encoding="utf-8")
 
        result = run_migrate_option_c(tmp_path)
 
        assert (oc / "octrc.json.bk").is_file()
        bk_data = json.loads(
            (oc / "octrc.json.bk").read_text(encoding="utf-8")
        )
        assert bk_data == {"old": True}
        assert any(oc / "octrc.json.bk" == p for p in result.backed_up)
 
    def test_no_backup_flag_skips_bk(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        oc = tmp_path / ".option_c"
        oc.mkdir()
        (oc / "octrc.json").write_text('{"old": true}', encoding="utf-8")
 
        result = run_migrate_option_c(tmp_path, no_backup=True)
 
        assert not (oc / "octrc.json.bk").exists()
        assert result.backed_up == []
 
 
class TestOcStatus:
    def test_oc_status_written(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        run_migrate_option_c(tmp_path)
 
        path = tmp_path / ".option_c" / "oc_status.json"
        assert path.is_file()
        raw = json.loads(path.read_text(encoding="utf-8"))
        assert raw["_schema_version"] == "1.0"
        assert raw["stage"] in ("bootstrap", "migrating", "compliant")
 
    def test_migrated_from_records_sources(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        run_migrate_option_c(tmp_path)
 
        raw = json.loads(
            (tmp_path / ".option_c" / "oc_status.json").read_text(
                encoding="utf-8",
            )
        )
        mf = raw["migrated_from"]
        assert mf["octrc"] == ".octrc.json"
        assert "debug_config" in mf
 
 
class TestIdempotent:
    def test_second_run_skips_identical(self, tmp_path: Path):
        _seed_legacy_project(tmp_path)
        run_migrate_option_c(tmp_path)
        second = run_migrate_option_c(tmp_path)
 
        assert second.copied == []
        assert any(
            reason == "already migrated" for _, reason in second.skipped
        )
 
 
class TestEmptyProject:
    def test_no_artefacts_found(self, tmp_path: Path):
        result = run_migrate_option_c(tmp_path)
 
        assert result.copied == []
        assert all(
            reason == "not found" for _, reason in result.skipped
        )