test_octrc_safe.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_core/test_octrc_safe.py
 
"""
Purpose
-------
OI-519 regression tests — :func:`oct.core.octrc.load_octrc` and its silent
wrapper :func:`load_octrc_safe` must be the single source of truth for
``.octrc.json`` reads. This test exercises the contract that multiple
historical readers (linter, formatter, health, typecheck) now rely on.
 
Responsibilities
----------------
- Missing file → ``({}, [])``; ``load_octrc_safe`` → ``{}``.
- Valid JSON object → parsed dict, no errors.
- Invalid JSON → ``({}, [<error>])``.
- Non-object top-level JSON (e.g. a list) → ``({}, [<error>])``.
- OSError on read → ``({}, [<error>])``.
 
Diagnostics
-----------
Domain: CORE-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- All file reads and writes use ``tmp_path``; no real ``.octrc.json``
  is touched.
"""
 
import json
from pathlib import Path
 
from oct.core.octrc import load_octrc, load_octrc_safe
 
 
def test_missing_file_returns_empty(tmp_path: Path):
    data, errors = load_octrc(tmp_path)
    assert data == {}
    assert errors == []
    assert load_octrc_safe(tmp_path) == {}
 
 
def test_valid_object_returns_dict(tmp_path: Path):
    cfg = {"linter": {"profile": "strict"}, "health": {"test_timeout": 60}}
    (tmp_path / ".octrc.json").write_text(json.dumps(cfg), encoding="utf-8")
 
    data, errors = load_octrc(tmp_path)
    assert data == cfg
    assert errors == []
    assert load_octrc_safe(tmp_path) == cfg
 
 
def test_invalid_json_returns_error(tmp_path: Path):
    (tmp_path / ".octrc.json").write_text("{not valid json", encoding="utf-8")
 
    data, errors = load_octrc(tmp_path)
    assert data == {}
    assert len(errors) == 1
    assert "invalid JSON" in errors[0]
    assert load_octrc_safe(tmp_path) == {}
 
 
def test_non_object_top_level_returns_error(tmp_path: Path):
    (tmp_path / ".octrc.json").write_text("[1, 2, 3]", encoding="utf-8")
 
    data, errors = load_octrc(tmp_path)
    assert data == {}
    assert len(errors) == 1
    assert "JSON object" in errors[0]
    assert "list" in errors[0]