Skip to content

paths

paths

Filesystem path resolution for the spec-search subsystem.

The keystone of artifact isolation (spec §11): the resolved spec-search root must NEVER be inside the OpenJarvis source tree. resolve_spec_search_root walks up from this module's __file__ looking for a pyproject.toml that identifies the OpenJarvis source root, then refuses to operate if the resolved root is inside it. Defense in depth — if a user accidentally points OPENJARVIS_HOME at the repo, the system fails loudly instead of silently writing artifacts into the working tree.

Classes

ConfigurationError

Bases: RuntimeError

Raised when path configuration would violate isolation guarantees.

Functions

resolve_spec_search_root 

resolve_spec_search_root() -> Path

Return the absolute path of the spec-search root directory.

The root is $OPENJARVIS_HOME/learning (or ~/.openjarvis/learning by default). Raises ConfigurationError if the resolved path lies inside the OpenJarvis source tree, to prevent dev artifacts from leaking into the repo.

Source code in src/openjarvis/learning/spec_search/storage/paths.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def resolve_spec_search_root() -> Path:
    """Return the absolute path of the spec-search root directory.

    The root is ``$OPENJARVIS_HOME/learning`` (or ``~/.openjarvis/learning``
    by default). Raises ``ConfigurationError`` if the resolved path lies
    inside the OpenJarvis source tree, to prevent dev artifacts from leaking
    into the repo.
    """
    home = _resolve_openjarvis_home()
    source_root = _find_source_root()
    if source_root is not None:
        try:
            home.relative_to(source_root)
        except ValueError:
            pass  # Good — not inside the source tree.
        else:
            raise ConfigurationError(
                f"OPENJARVIS_HOME ({home}) is inside the source tree "
                f"({source_root}). Spec search refuses to write runtime "
                "artifacts inside the OpenJarvis repo. Set OPENJARVIS_HOME "
                "to a directory outside the repo (default: ~/.openjarvis)."
            )
    return home / "learning"

ensure_spec_search_dirs 

ensure_spec_search_dirs() -> Path

Create the spec-search directory layout if missing.

Returns the spec-search root. Creates sessions/, benchmarks/, benchmarks/reference_outputs/, and pending_review/ underneath it, all with restrictive 0o700 permissions via secure_mkdir.

Source code in src/openjarvis/learning/spec_search/storage/paths.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def ensure_spec_search_dirs() -> Path:
    """Create the spec-search directory layout if missing.

    Returns the spec-search root. Creates ``sessions/``, ``benchmarks/``,
    ``benchmarks/reference_outputs/``, and ``pending_review/`` underneath it,
    all with restrictive ``0o700`` permissions via ``secure_mkdir``.
    """
    root = resolve_spec_search_root()
    secure_mkdir(root)
    secure_mkdir(root / "sessions")
    secure_mkdir(root / "benchmarks")
    secure_mkdir(root / "benchmarks" / "reference_outputs")
    secure_mkdir(root / "pending_review")
    return root