test_dotted_keys.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_deps/test_dotted_keys.py
 
"""
Purpose
-------
OI-521 regression coverage — ``oct.deps.oct_deps.build_dependency_graph``
must key modules by their dotted import path (``pkg.sub.module``) rather
than the bare file stem (``module``). The old behaviour silently dropped
every occurrence of a repeated stem on top of a single graph entry,
hiding both modules and their dependencies.
 
Responsibilities
----------------
- Verify ``module_name_for`` returns the dotted import path.
- Verify ``__init__.py`` resolves to its parent package's dotted name.
- Verify two files with the same stem in different packages produce
  distinct graph keys.
 
Diagnostics
-----------
Domain: DEPS-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- ``module_name_for(py_file, root)`` returns the dotted path.
- ``__init__.py`` resolves to its parent package's dotted name.
- Two files with the same stem in different packages both appear in the
  graph with distinct dotted keys (no collision).
"""
 
from __future__ import annotations
 
from pathlib import Path
 
import pytest
 
from oct.deps.oct_deps import build_dependency_graph, module_name_for
 
 
def test_module_name_for_nested_module(tmp_path: Path) -> None:
    """OI-521: a module two packages deep gets a three-segment dotted key."""
    (tmp_path / "pkg" / "sub").mkdir(parents=True)
    module = tmp_path / "pkg" / "sub" / "util.py"
    module.write_text("", encoding="utf-8")
    assert module_name_for(module, tmp_path) == "pkg.sub.util"
 
 
def test_module_name_for_init_collapses_to_package(tmp_path: Path) -> None:
    """OI-521: ``pkg/__init__.py`` resolves to the package name ``pkg``."""
    (tmp_path / "pkg").mkdir()
    init = tmp_path / "pkg" / "__init__.py"
    init.write_text("", encoding="utf-8")
    assert module_name_for(init, tmp_path) == "pkg"
 
 
def test_build_dependency_graph_no_stem_collision(tmp_path: Path) -> None:
    """Two ``util.py`` files in different packages both land in the graph."""
    src = (
        '"""Mod.\n\n'
        "Dependencies\n"
        "------------\n"
        "- some.other\n"
        '"""\n'
    )
    (tmp_path / "pkg_a").mkdir()
    (tmp_path / "pkg_a" / "__init__.py").write_text("", encoding="utf-8")
    (tmp_path / "pkg_a" / "util.py").write_text(src, encoding="utf-8")
 
    (tmp_path / "pkg_b").mkdir()
    (tmp_path / "pkg_b" / "__init__.py").write_text("", encoding="utf-8")
    (tmp_path / "pkg_b" / "util.py").write_text(src, encoding="utf-8")
 
    graph = build_dependency_graph(tmp_path)
 
    assert "pkg_a.util" in graph
    assert "pkg_b.util" in graph
    # Old stem-based key must not exist.
    assert "util" not in graph