test_project_root.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_core/test_project_root.py
 
"""
Purpose
-------
Validate path containment (OI-405) and ``.octrc.json`` size cap (OI-414)
logic in ``oct.core.project_root``.
 
Responsibilities
----------------
- Confirm ``validate_path_containment`` accepts paths within the project.
- Confirm it rejects paths outside unless ``allow_outside=True``.
- Confirm oversized ``.octrc.json`` files are skipped during root
  discovery and a warning is emitted.
 
Diagnostics
-----------
Domain: CORE-TESTS
L2: test lifecycle
L3: assertion details
L4: deep tracing
 
Contracts
---------
Inputs:  tmp_path fixture
Outputs: pass/fail assertions
"""
 
import json
 
import click
import pytest
 
from oct.core import project_root
 
 
def test_validate_path_containment_inside_passes(tmp_path):
    root = tmp_path / "proj"
    root.mkdir()
    inner = root / "src" / "mod"
    inner.mkdir(parents=True)
    result = project_root.validate_path_containment(inner, root)
    assert result == inner.resolve()
 
 
def test_validate_path_containment_outside_raises(tmp_path):
    root = tmp_path / "proj"
    root.mkdir()
    outside = tmp_path / "other"
    outside.mkdir()
    with pytest.raises(click.ClickException) as exc:
        project_root.validate_path_containment(outside, root)
    assert "outside project root" in str(exc.value.message)
 
 
def test_validate_path_containment_allow_outside_passes(tmp_path):
    root = tmp_path / "proj"
    root.mkdir()
    outside = tmp_path / "other"
    outside.mkdir()
    result = project_root.validate_path_containment(
        outside, root, allow_outside=True
    )
    assert result == outside.resolve()
 
 
def test_octrc_size_cap_skipped(tmp_path, capsys):
    """A ``.octrc.json`` larger than MAX_OCTRC_SIZE is skipped with a warning."""
    # Build a valid Option C project layout at tmp_path/proj
    proj = tmp_path / "proj"
    (proj / "docs").mkdir(parents=True)
    (proj / "tests").mkdir()
    (proj / "oc_diagnostics").mkdir()
 
    # Place an oversized .octrc.json at the project root
    octrc = proj / ".octrc.json"
    # Valid JSON but padded to exceed the size cap
    padding = "x" * (project_root.MAX_OCTRC_SIZE + 1024)
    octrc.write_text(json.dumps({"root_marker": True, "_pad": padding}))
 
    # find_project_root should still locate the directory structure,
    # and the size cap warning should be emitted to stderr.
    result = project_root.find_project_root(proj / "docs")
    captured = capsys.readouterr()
    assert "skipping" in captured.err
    assert str(project_root.MAX_OCTRC_SIZE) in captured.err
    # Root must still resolve via the directory-marker path
    assert result == proj.resolve()
 
 
def test_small_octrc_with_root_marker_found(tmp_path):
    """A small ``.octrc.json`` with root_marker=True wins over structural detection."""
    proj = tmp_path / "proj"
    proj.mkdir()
    (proj / ".octrc.json").write_text('{"root_marker": true}')
    # Nested sub-dir should still resolve up to proj
    sub = proj / "a" / "b"
    sub.mkdir(parents=True)
    result = project_root.find_project_root(sub)
    assert result == proj.resolve()