test_octrc_template.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_scaffold/test_octrc_template.py
 
"""
Purpose
-------
OI-530 regression coverage — the scaffolded ``.octrc.json`` must ship
with a live ``linter.profile`` default plus a discoverable (but inert)
``_git_example`` stanza so new projects inherit sensible defaults and
can copy-paste branch protection into place without reading docs.
 
Responsibilities
----------------
- ``linter.profile == "compact"`` after scaffold.
- ``_git_example`` is present and documents ``protected_branches`` +
  ``branch_profile_map``.
- :func:`oct.core.octrc.load_octrc_safe` round-trips the template without
  dropping the underscore-prefixed example key.
 
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.octrc import load_octrc_safe
from oct.scaffold import run_scaffold
 
 
def test_octrc_template_has_linter_profile(tmp_path: Path):
    run_scaffold("demo", tmp_path, include_venv=False)
    octrc = tmp_path / "demo" / ".option_c" / "octrc.json"
    data = json.loads(octrc.read_text(encoding="utf-8"))
 
    assert data["linter"]["profile"] == "compact"
 
 
def test_octrc_template_has_git_example(tmp_path: Path):
    run_scaffold("demo", tmp_path, include_venv=False)
    octrc = tmp_path / "demo" / ".option_c" / "octrc.json"
    data = json.loads(octrc.read_text(encoding="utf-8"))
 
    example = data.get("_git_example")
    assert isinstance(example, dict)
    assert "main" in example["protected_branches"]
    assert example["branch_profile_map"]["main"] == "strict"
 
 
def test_octrc_template_round_trips_through_safe_loader(tmp_path: Path):
    run_scaffold("demo", tmp_path, include_venv=False)
    project = tmp_path / "demo"
 
    data = load_octrc_safe(project)
 
    # The underscore key is preserved (the loader does not strip it).
    # OI-530: its purpose is discoverability; consumers never read it.
    assert "_git_example" in data
    assert data["linter"]["profile"] == "compact"