test_paths.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_core/test_paths.py
 
"""
Purpose
-------
OI-533 regression tests — :func:`oct.core.paths.to_project_relative`
renders filesystem paths as project-relative POSIX strings for
user-facing output (lint findings, health reports, git status, etc.)
so absolute machine paths never leak into CI logs or pasted errors.
 
Responsibilities
----------------
- In-tree paths are rendered relative to *project_root*.
- Out-of-tree paths fall back to the absolute POSIX form.
- Windows-style backslashes are normalised to forward slashes on
  every platform.
 
Diagnostics
-----------
Domain: CORE-TESTS
Levels:
    L2 — test lifecycle
    L3 — individual assertions
    L4 — deep tracing
 
Contracts
---------
- Tests use synthetic paths; no real filesystem reads or writes.
"""
 
from __future__ import annotations
 
from pathlib import Path, PureWindowsPath
 
from oct.core.paths import to_project_relative
 
 
def test_in_tree_path_is_rendered_project_relative(tmp_path):
    root = tmp_path
    target = root / "oct" / "foo.py"
    target.parent.mkdir(parents=True)
    target.touch()
 
    assert to_project_relative(target, root) == "oct/foo.py"
 
 
def test_out_of_tree_path_falls_back_to_absolute_posix(tmp_path):
    root = tmp_path / "proj"
    root.mkdir()
    outside = tmp_path / "elsewhere" / "bar.py"
    outside.parent.mkdir()
    outside.touch()
 
    result = to_project_relative(outside, root)
 
    assert result == outside.as_posix()
    assert "\\" not in result
 
 
def test_backslashes_are_normalised_to_posix(tmp_path):
    root = tmp_path
    target = root / "a" / "b" / "c.py"
    target.parent.mkdir(parents=True)
    target.touch()
 
    rel = to_project_relative(target, root)
 
    assert "\\" not in rel
    assert rel == "a/b/c.py"