test_log_writer.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_core/test_log_writer.py
 
"""
Purpose
-------
Regression tests for :func:`oct.core.log_writer.write_command_log`.
 
Responsibilities
----------------
- Verify JSON file creation, naming convention, and content fidelity.
- Verify directory auto-creation and UTF-8 encoding.
 
Diagnostics
-----------
Domain: CORE-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- All file writes are confined to ``tmp_path``.
"""
 
import json
from pathlib import Path
 
from oct.core.log_writer import write_command_log
 
 
def _setup_option_c(tmp_path: Path) -> Path:
    (tmp_path / ".option_c").mkdir()
    return tmp_path
 
 
def test_writes_json_file(tmp_path: Path):
    root = _setup_option_c(tmp_path)
    data = {"status": "ok", "count": 42}
    path = write_command_log(root, "health", data)
    assert path.exists()
    content = json.loads(path.read_text(encoding="utf-8"))
    assert content == data
 
 
def test_filename_convention(tmp_path: Path):
    root = _setup_option_c(tmp_path)
    path = write_command_log(root, "health", {})
    assert path.name.startswith("oct-health-")
    assert path.suffix == ".json"
 
 
def test_creates_directory(tmp_path: Path):
    root = _setup_option_c(tmp_path)
    logs_dir = tmp_path / ".option_c" / "logs"
    assert not logs_dir.exists()
    write_command_log(root, "lint", {"ok": True})
    assert logs_dir.is_dir()
 
 
def test_report_content_matches(tmp_path: Path):
    root = _setup_option_c(tmp_path)
    data = {"project": "demo", "checks": [1, 2, 3], "nested": {"a": "b"}}
    path = write_command_log(root, "audit", data)
    assert json.loads(path.read_text(encoding="utf-8")) == data
 
 
def test_returns_path(tmp_path: Path):
    root = _setup_option_c(tmp_path)
    result = write_command_log(root, "test", {})
    assert isinstance(result, Path)
    assert result.exists()
 
 
def test_utf8_encoding(tmp_path: Path):
    root = _setup_option_c(tmp_path)
    data = {"message": "café résumé naïve — ñ ü ö"}
    path = write_command_log(root, "health", data)
    content = json.loads(path.read_text(encoding="utf-8"))
    assert content["message"] == data["message"]