test_option_c_layout.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_scaffold/test_option_c_layout.py
 
"""
Purpose
-------
FS-539 regression coverage — :func:`oct.scaffold.run_scaffold` must emit
the canonical ``.option_c/`` dotdir layout (not the legacy root-level
``.octrc.json`` + ``oc_diagnostics/debug_config.json`` + ``logs/``
layout) and stamp a ``stage="compliant"`` ``oc_status.json`` so newly
scaffolded projects are born migrated.
 
Responsibilities
----------------
- ``.option_c/`` + ``.option_c/logs/`` + ``.option_c/cache/`` exist.
- ``.option_c/oc_status.json`` is a well-formed v1 schema blob with
  every pillar enabled.
- Legacy paths (``.octrc.json``, ``oc_diagnostics/``, root-level
  ``logs/``) are absent — the scaffold does not dual-write.
 
Diagnostics
-----------
Domain: SCAFFOLD-TESTS
    Levels:
        L2 — test lifecycle
        L3 — assertion details
        L4 — deep tracing
 
Contracts
---------
- All scaffold operations write to ``tmp_path``; no real project
  directories are created.
"""
 
from __future__ import annotations
 
import json
from pathlib import Path
 
from oct.core.option_c_dir import VALID_STAGES, load_oc_status
from oct.scaffold import run_scaffold
 
 
def test_scaffold_emits_option_c_dotdir(tmp_path: Path):
    run_scaffold("demo", tmp_path, include_venv=False)
    project = tmp_path / "demo"
 
    assert (project / ".option_c").is_dir()
    assert (project / ".option_c" / "logs").is_dir()
    assert (project / ".option_c" / "cache").is_dir()
    assert (project / ".option_c" / "octrc.json").is_file()
    assert (project / ".option_c" / "debug_config.json").is_file()
    assert (project / ".option_c" / "oc_status.json").is_file()
 
 
def test_scaffold_oc_status_is_compliant_with_all_pillars(tmp_path: Path):
    run_scaffold("demo", tmp_path, include_venv=False)
    project = tmp_path / "demo"
 
    status = load_oc_status(project)
    assert status is not None
    assert status.stage == "compliant"
    assert status.stage in VALID_STAGES
    for pillar in ("linter", "diagnostics", "git", "docs", "tests", "scaffold"):
        assert pillar in status.pillars, pillar
        assert status.pillars[pillar]["enabled"] is True
    # Fresh scaffold — nothing migrated in from legacy paths.
    assert status.migrated_from == {}
 
 
def test_scaffold_oc_status_schema_version_is_v1(tmp_path: Path):
    run_scaffold("demo", tmp_path, include_venv=False)
    raw = json.loads(
        (tmp_path / "demo" / ".option_c" / "oc_status.json").read_text(
            encoding="utf-8",
        )
    )
    assert raw["_schema_version"] == "1.0"
 
 
def test_scaffold_does_not_emit_legacy_paths(tmp_path: Path):
    run_scaffold("demo", tmp_path, include_venv=False)
    project = tmp_path / "demo"
 
    # FS-539: the legacy layout is intentionally not dual-written —
    # the scaffold is the migrated-from-birth form.
    assert not (project / ".octrc.json").exists()
    assert not (project / "oc_diagnostics").exists()
    assert not (project / "logs").exists()